bingads.v13.bulk.entities.feeds package

Submodules

bingads.v13.bulk.entities.feeds.bulk_feed module

class bingads.v13.bulk.entities.feeds.bulk_feed.BulkFeed(id=None, status=None, account_id=None, sub_type=None, feed_name=None, custom_attr=None, schedule=None)[source]

Bases: bingads.v13.internal.bulk.entities.single_record_bulk_entity._SingleRecordBulkEntity

Represents a feed.

Properties of this class and of classes that it is derived from, correspond to fields of the Feed record in a bulk file. For more information, see Feed at https://go.microsoft.com/fwlink/?linkid=846127

See also:

property account_id

the id of the account which contains the feed Corresponds to the ‘Parent Id’ field in the bulk file.

Return type

long

property custom_attributes

the id of the account which contains the feed Corresponds to the ‘Custom Attributes’ field in the bulk file.

Return type

long

property id

the status of bulk record Corresponds to the ‘Id’ field in the bulk file.

Return type

str

property name

the id of the account which contains the feed Corresponds to the ‘Feed Name’ field in the bulk file.

Return type

long

process_mappings_from_row_values(row_values)[source]

Process specific entity mappings from CSV values. Must be implemented by each entity.

Parameters

row_values (_RowValues) –

process_mappings_to_row_values(row_values, exclude_readonly_data)[source]

Process specific entity mappings to CSV values. Must be implemented by each entity.

Parameters

  • row_values (_RowValues) – Row values.

  • exclude_readonly_data (bool) – excludeReadonlyData indicates whether readonly data should be written (such as errors, performance data etc.)

read_additional_data(stream_reader)[source]
property schedule

the schedule of the feed Corresponds to the ‘Schedule’ field in the bulk file.

Return type

string

property status

the status of bulk record Corresponds to the ‘Status’ field in the bulk file.

Return type

str

property sub_type

the id of the account which contains the feed Corresponds to the ‘Sub Type’ field in the bulk file.

Return type

long

bingads.v13.bulk.entities.feeds.bulk_feed_item module

class bingads.v13.bulk.entities.feeds.bulk_feed_item.BulkFeedItem[source]

Bases: bingads.v13.internal.bulk.entities.single_record_bulk_entity._SingleRecordBulkEntity

Represents a feed item.

Properties of this class and of classes that it is derived from, correspond to fields of the Feed Item record in a bulk file. For more information, see Feed at https://go.microsoft.com/fwlink/?linkid=846127

See also:

property ad_group

the status of bulk record Corresponds to the ‘Ad Group’ field in the bulk file.

Return type

str

property adgroup_id

the id of the account which contains the feed Corresponds to the ‘Target Ad Group Id’ field in the bulk file.

Return type

long

property audience_id

the status of bulk record Corresponds to the ‘Audience Id’ field in the bulk file.

Return type

long

property campaign

the id of the account which contains the feed Corresponds to the ‘campaign’ field in the bulk file.

Return type

str

property campaign_id

the id of the account which contains the feed Corresponds to the ‘Target Campaign Id’ field in the bulk file.

Return type

long

property custom_attributes

the status of bulk record Corresponds to the ‘Custom Attributes’ field in the bulk file.

Return type

str

property daytime_ranges

the status of bulk record Corresponds to the ‘Ad Schedule’ field in the bulk file.

Return type

str

property device_preference

the id of the account which contains the feed Corresponds to the ‘Device Preference’ field in the bulk file.

Return type

long

property end_date

the status of bulk record Corresponds to the ‘End Date’ field in the bulk file.

Return type

str

property feed_id

the status of bulk record Corresponds to the ‘Parent Id’ field in the bulk file.

Return type

long

property id

the status of bulk record Corresponds to the ‘Id’ field in the bulk file.

Return type

long

property intent_option

the id of the account which contains the feed Corresponds to the ‘Physical Intent’ field in the bulk file.

Return type

str

property keyword

the status of bulk record Corresponds to the ‘Keyword’ field in the bulk file.

Return type

str

property location_id

the id of the account which contains the feed Corresponds to the ‘Target’ field in the bulk file.

Return type

long

property match_type

the match type of bulk record Corresponds to the ‘Match Type’ field in the bulk file.

Return type

str

process_mappings_from_row_values(row_values)[source]

Process specific entity mappings from CSV values. Must be implemented by each entity.

Parameters

row_values (_RowValues) –

process_mappings_to_row_values(row_values, exclude_readonly_data)[source]

Process specific entity mappings to CSV values. Must be implemented by each entity.

Parameters

  • row_values (_RowValues) – Row values.

  • exclude_readonly_data (bool) – excludeReadonlyData indicates whether readonly data should be written (such as errors, performance data etc.)

read_additional_data(stream_reader)[source]
property start_date

the status of bulk record Corresponds to the ‘Start Date’ field in the bulk file.

Return type

str

property status

the status of bulk record Corresponds to the ‘Status’ field in the bulk file.

Return type

str

Module contents