bingads.v13.bulk.entities package

Subpackages

Submodules

bingads.v13.bulk.entities.bid_suggestion_data module

class bingads.v13.bulk.entities.bid_suggestion_data.BidSuggestionData[source]

Bases: object

The best position, main line, and first page bid suggestion data corresponding to one keyword.

If the requested DataScope includes BidSuggestionsData, the download will include bulk records corresponding to the properties of this class.

See also:

property best_position

Represents a best position bid suggestion that is derived from _BulkObject.

It can only be read from a bulk file by the BulkFileReader when reading the corresponding BulkKeyword. An instance of this class can represent a single best position bid, and thus one record in the bulk file. Properties of this class and of classes that it is derived from, correspond to fields of the Keyword Best Position Bid record in a bulk file.

For more information, see Keyword Best Position Bid at https://go.microsoft.com/fwlink/?linkid=846127.

Returns

The best position bid suggestion.

Return type

BulkKeywordBidSuggestion

property first_page

Represents a first page bid suggestion that is derived from _BulkObject. can only be read from a bulk file by the BulkFileReader when reading the corresponding BulkKeyword. An instance of this class can represent a single first page bid, and thus one record in the bulk file. Properties of this class and of classes that it is derived from, correspond to fields of the Keyword First Page Bid record in a bulk file.

For more information, see Keyword First Page Bid at https://go.microsoft.com/fwlink/?linkid=846127.

Returns

The first page bid suggestion.

Return type

BulkKeywordBidSuggestion

property main_line

Represents a main line bid suggestion that is derived from _BulkObject.

It can only be read from a bulk file by the BulkFileReader when reading the corresponding BulkKeyword. An instance of this class can represent a single main line bid, and thus one record in the bulk file. Properties of this class and of classes that it is derived from, correspond to fields of the Keyword Main Line Bid record in a bulk file.

For more information, see Keyword Main Line Bid at https://go.microsoft.com/fwlink/?linkid=846127.

Returns

The main line bid suggestion.

Return type

BulkKeywordBidSuggestion

class bingads.v13.bulk.entities.bid_suggestion_data.BulkKeywordBestPositionBid[source]

Bases: bingads.v13.bulk.entities.bid_suggestion_data.BulkKeywordBidSuggestion

class bingads.v13.bulk.entities.bid_suggestion_data.BulkKeywordBidSuggestion[source]

Bases: bingads.v13.internal.bulk.bulk_object._BulkObject

Represents a best position bid suggestion.

It can only be read from a bulk file by the BulkFileReader when reading the corresponding BulkKeyword. An instance of this class can represent a single keyword bid position, and thus one record in the bulk file.

property bid

The suggested bid for the keyword.

Return type

float

property keyword_text

The keyword corresponding to the suggested bid.

Corresponds to the ‘Keyword’ field in the bulk file. :rtype: str

read_from_row_values(row_values)[source]

Read object data from a single row.

Example:

  • SingleLineBulkEntity: reads entity fields.

  • BulkError: reads error fields.

  • BulkEntityIdentifier: reads identifier fields (Id, status etc.).

Parameters

row_values (_RowValues) –

static write_if_not_null(keyword_bid_suggestion, row_writer)[source]
write_to_row_values(row_values, exclude_readonly_data)[source]

Writes object data to a single row.

Example:

  • SingleLineBulkEntity: writes entity fields.

  • BulkEntityIdentifier: writes identifier fields (Id, status etc.)

Parameters

row_values (_RowValues) –

class bingads.v13.bulk.entities.bid_suggestion_data.BulkKeywordFirstPageBid[source]

Bases: bingads.v13.bulk.entities.bid_suggestion_data.BulkKeywordBidSuggestion

class bingads.v13.bulk.entities.bid_suggestion_data.BulkKeywordMainLineBid[source]

Bases: bingads.v13.bulk.entities.bid_suggestion_data.BulkKeywordBidSuggestion

bingads.v13.bulk.entities.bulk_account module

class bingads.v13.bulk.entities.bulk_account.BulkAccount(account_id=None, customer_id=None, sync_time=None)[source]

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

Represents an account that can be read or written in a bulk file.

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

See also:

property ad_click_parallel_tracking

The setting of parallel tracking in the account.

Returns

The setting of parallel tracking of the account

Return type

bool

property allow_image_auto_retrieve

The setting of allowing image auto retrieve in the account.

Returns

The setting of allowing image auto retrieve of the account

Return type

bool

property auto_apply_recommendations

The setting of allowing image auto retrieve in the account.

Returns

The setting of allowing image auto retrieve of the account

Return type

dict

property business_attributes

The setting of business attributes in the account.

Returns

The setting of business attributes of the account

Return type

dict

property customer_id

The identifier of the customer that contains the account.

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

Returns

The identifier of the customer that contains the account.

Return type

int

property final_url_suffix

The final url suffix to use as a default for all URLs in your account.

Returns

The tracking template of the account

Return type

str

property id

The identifier of the account.

Corresponds to the ‘Id’ field in the bulk file.

Returns

The identifier of the account.

Return type

int

property include_view_through_conversions
Returns

The ‘Include View Through Conversions’ field of the account

Return type

bool

property msclkid_auto_tagging_enabled

Determines whether auto-tagging of the MSCLKID query string parameter is enabled. The MSCLKID is a 32-character GUID that is unique for each ad click. :return: The msclkid autotag setting of the account :rtype: bool

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.)

property profile_expansion_enabled
Returns

The ‘Profile Expansion Enabled’ field of the account

Return type

bool

read_additional_data(stream_reader)[source]
property sync_time

The date and time that you last synced your account using the bulk service.

You should keep track of this value in UTC time. Corresponds to the ‘Sync Time’ field in the bulk file.

Returns

The date and time that you last synced your account using the bulk service.

Return type

datetime.datetime

property tracking_url_template

The tracking template to use as a default for all URLs in your account.

Returns

The tracking template of the account

Return type

str

bingads.v13.bulk.entities.bulk_account_negative_keyword_list module

class bingads.v13.bulk.entities.bulk_account_negative_keyword_list.BulkAccountNegativeKeywordList(status=None, account_negative_keyword_list=None)[source]

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

Represents an account negative keyword list association that can be read or written in a bulk file.

This class exposes the BulkAccountNegativeKeywordList.account_negative_keyword_list property that can be read and written as fields of the account negative keyword list association record in a bulk file.

For more information, see account negative keyword list association at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property account_negative_keyword_list

The account negative keyword list association.

see account negative keyword list association at https://go.microsoft.com/fwlink/?linkid=846127.

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 status

The status of the account negative keyword list association.

Return type

str

class bingads.v13.bulk.entities.bulk_account_negative_keyword_list.BulkAccountNegativeKeywordListAssociation(status=None, shared_entity_association=None)[source]

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

Represents an account negative keyword list association that is assigned to a campaign. Each account negative keyword list association can be read or written in a bulk file.

This class exposes the BulkAccountNegativeKeywordListAssociation.SharedEntityAssociation property that can be read and written as fields of the account negative keyword list association record in a bulk file.

For more information, see account negative keyword list association at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

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 shared_entity_association

The campaign and account negative keyword list association identifiers.

see Campaign account negative keyword list association at https://go.microsoft.com/fwlink/?linkid=846127.

property status

The status of the account negative keyword list association.

Return type

str

bingads.v13.bulk.entities.bulk_ad_customizer_attribute module

class bingads.v13.bulk.entities.bulk_ad_customizer_attribute.BulkAdCustomizerAttribute(id=None, name=None, account_value=None, data_type=None, editorial_status=None, status=None)[source]

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

Represents an AdCustomizerAttribute.

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

See also:

property account_value

the value of the account of ad customizer attribute Corresponds to the ‘AdCustomizer AttributeValue’ field in the bulk file.

Return type

str

property data_type

the data type of ad customizer attribute Corresponds to the ‘AdCustomizer DataType’ field in the bulk file.

Return type

str

property editorial_status

the editorial status of ad customizer attribute Corresponds to the ‘Editorial Status’ field in the bulk file.

Return type

str

property id

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

Return type

str

property name

the name of the ad customizer attribute Corresponds to the ‘Name’ 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 status

the status of ad customizer attribute Corresponds to the ‘Status’ field in the bulk file.

Return type

str

bingads.v13.bulk.entities.bulk_ad_customizer_attribute_ad_group module

class bingads.v13.bulk.entities.bulk_ad_customizer_attribute_ad_group.BulkAdGroupAdCustomizerAttribute(id=None, name=None, parent_id=None, attribute_value=None, editorial_status=None)[source]

Bases: bingads.v13.bulk.entities.bulk_ad_customizer_attribute_entity_base.BulkAdCustomizerAttributeEntityBase

Represents an AdGroupAdCustomizerAttribute.

See also:

property ad_group_id

the ad group id of bulk record Corresponds to the ‘ParentId’ field in the bulk file.

Return type

str

bingads.v13.bulk.entities.bulk_ad_customizer_attribute_campaign module

class bingads.v13.bulk.entities.bulk_ad_customizer_attribute_campaign.BulkCampaignAdCustomizerAttribute(id=None, name=None, parent_id=None, attribute_value=None, editorial_status=None)[source]

Bases: bingads.v13.bulk.entities.bulk_ad_customizer_attribute_entity_base.BulkAdCustomizerAttributeEntityBase

Represents a CampaignAdCustomizerAttribute.

See also:

property campaign_id

the campaign id of bulk record Corresponds to the ‘ParentId’ field in the bulk file.

Return type

str

bingads.v13.bulk.entities.bulk_ad_customizer_attribute_entity_base module

class bingads.v13.bulk.entities.bulk_ad_customizer_attribute_entity_base.BulkAdCustomizerAttributeEntityBase(id=None, name=None, parent_id=None, attribute_value=None, editorial_status=None)[source]

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

Represents an AdCustomizerAttributeEntity.

See also:

property attribute_value

the value of ad customizer attribute Corresponds to the ‘AdCustomizer AttributeValue’ field in the bulk file.

Return type

str

property editorial_status

the editorial status of ad customizer attribute Corresponds to the ‘Editorial Status’ field in the bulk file.

Return type

str

property id

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

Return type

str

property name

the name of the ad customizer attribute entity Corresponds to the ‘Name’ field in the bulk file.

Return type

str

property parent_id

the parent id of bulk record Corresponds to the ‘ParentId’ 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]

bingads.v13.bulk.entities.bulk_ad_customizer_attribute_keyword module

class bingads.v13.bulk.entities.bulk_ad_customizer_attribute_keyword.BulkKeywordAdCustomizerAttribute(id=None, name=None, parent_id=None, attribute_value=None, editorial_status=None)[source]

Bases: bingads.v13.bulk.entities.bulk_ad_customizer_attribute_entity_base.BulkAdCustomizerAttributeEntityBase

Represents a KeywordAdCustomizerAttribute.

See also:

property keyword_id

the keyword id of bulk record Corresponds to the ‘ParentId’ field in the bulk file.

Return type

str

bingads.v13.bulk.entities.bulk_ad_group module

class bingads.v13.bulk.entities.bulk_ad_group.BulkAdGroup(campaign_id=None, campaign_name=None, ad_group=None)[source]

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

Represents an ad group.

This class exposes the property ad_group that can be read and written as fields of the Ad Group record in a bulk file.

For more information, see Ad Group at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property ad_group

The AdGroup Data Object of the Campaign Management Service.

A subset of AdGroup properties are available in the Ad Group record. For more information, see Ad Group at https://go.microsoft.com/fwlink/?linkid=846127.

property campaign_id

The identifier of the campaign that contains the ad group.

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

Return type

int

property campaign_name

The name of the campaign that contains the ad group.

Corresponds to the ‘Campaign’ 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.)

property quality_score_data

The quality score data for the ad group.

Return type

QualityScoreData

read_additional_data(stream_reader)[source]
bingads.v13.bulk.entities.bulk_ad_group.bidding_scheme_to_csv(bulk_ad_group, row_values)[source]
bingads.v13.bulk.entities.bulk_ad_group.coop_setting_to_csv(bulk_ad_group, row_values)[source]
bingads.v13.bulk.entities.bulk_ad_group.csv_to_bidding_scheme(row_values, bulk_ad_group)[source]
bingads.v13.bulk.entities.bulk_ad_group.csv_to_coop_setting(row_values, bulk_ad_group)[source]

bingads.v13.bulk.entities.bulk_ad_group_criterion module

class bingads.v13.bulk.entities.bulk_ad_group_criterion.BulkAdGroupCriterion(campaign_name=None, ad_group_name=None, ad_group_criterion=None)[source]

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

Represents a Ad Group Criterion that can be read or written in a bulk file.

This class exposes the ad_group_criterion property that can be read and written as fields of the Ad Group Criterion record in a bulk file.

For more information, see Ad Group Criterion at https://go.microsoft.com/fwlink/?linkid=836837.

See also:

property ad_group_criterion

Defines an Ad Group Criterion

property ad_group_name

Defines the name of the Ad Group

Return type

str

property campaign_name

Defines the name of the Campaign.

Return type

str

abstract create_criterion()[source]
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]
bingads.v13.bulk.entities.bulk_ad_group_criterion.bidding_to_csv(entity, row_values)[source]
bingads.v13.bulk.entities.bulk_ad_group_criterion.csv_to_bidding(row_values, entity)[source]

bingads.v13.bulk.entities.bulk_ad_group_dynamic_search_ad_target module

class bingads.v13.bulk.entities.bulk_ad_group_dynamic_search_ad_target.BulkAdGroupDynamicSearchAdTarget(campaign_name=None, ad_group_name=None, status=None, biddable_ad_group_criterion=None)[source]

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

Represents a Ad Group Criterion that can be read or written in a bulk file.

This class exposes the biddable_ad_group_criterion property that can be read and written as fields of the Ad Group Dynamic Search Ad Target record in a bulk file.

For more information, see Ad Group Dynamic Search Ad Target at https://go.microsoft.com/fwlink/?linkid=836837.

See also:

property ad_group_name

The name of the Ad Group

Return type

str

property biddable_ad_group_criterion

Defines a Ad Group Criterion

property campaign_name

The name of the Campaign

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 status

The status of the Ad Group Criterion

Return type

str

bingads.v13.bulk.entities.bulk_ad_group_hotel_listing_group module

class bingads.v13.bulk.entities.bulk_ad_group_hotel_listing_group.BulkAdGroupHotelListingGroup(campaign_name=None, ad_group_name=None, ad_group_criterion=None)[source]

Bases: bingads.v13.bulk.entities.bulk_ad_group_criterion.BulkAdGroupCriterion

Represents an Ad Group Hotel Group that can be read or written in a bulk file.

This class exposes the ad_group_criterion property that can be read and written as fields of the Ad Group Hotel Group record in a bulk file.

For more information, see Ad Group Product Scope at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

create_criterion()[source]
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]

bingads.v13.bulk.entities.bulk_ad_group_negative_dynamic_search_ad_target module

class bingads.v13.bulk.entities.bulk_ad_group_negative_dynamic_search_ad_target.BulkAdGroupNegativeDynamicSearchAdTarget(campaign_name=None, ad_group_name=None, status=None, negative_ad_group_criterion=None)[source]

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

Represents a Ad Group Criterion that can be read or written in a bulk file.

This class exposes the negative_ad_group_criterion property that can be read and written as fields of the Ad Group Negative Dynamic Search Ad Target record in a bulk file.

For more information, see Ad Group Negative Dynamic Search Ad Target at https://go.microsoft.com/fwlink/?linkid=836838.

See also:

property ad_group_name

The name of the Ad Group

Return type

str

property campaign_name

The name of the Campaign

Return type

str

property negative_ad_group_criterion

Defines a Ad Group Criterion

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 status

The status of the Ad Group Criterion

Return type

str

bingads.v13.bulk.entities.bulk_ad_group_product_partition module

class bingads.v13.bulk.entities.bulk_ad_group_product_partition.BulkAdGroupProductPartition(campaign_name=None, ad_group_name=None, ad_group_criterion=None)[source]

Bases: bingads.v13.bulk.entities.bulk_ad_group_criterion.BulkAdGroupCriterion

Represents an Ad Group Criterion that can be read or written in a bulk file.

This class exposes the ad_group_criterion property that can be read and written as fields of the Ad Group Product Partition record in a bulk file.

For more information, see Ad Group Product Scope at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

create_criterion()[source]
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]

bingads.v13.bulk.entities.bulk_ads module

class bingads.v13.bulk.entities.bulk_ads.BulkAppInstallAd(ad_group_id=None, campaign_name=None, ad_group_name=None, ad=None)[source]

Bases: bingads.v13.bulk.entities.bulk_ads._BulkAd

Represents an App Install Ad.

This class exposes the app_install_ad property that can be read and written as fields of the App Install Ad record in a bulk file.

For more information, see App Install Ad at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property app_install_ad

The App Install Ad.

see App Install Ad at https://go.microsoft.com/fwlink/?linkid=846127.

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.)

class bingads.v13.bulk.entities.bulk_ads.BulkDynamicSearchAd(ad_group_id=None, campaign_name=None, ad_group_name=None, ad=None)[source]

Bases: bingads.v13.bulk.entities.bulk_ads._BulkAd

Represents a Dynamic Search Ad.

This class exposes the dynamic_search_ad property that can be read and written as fields of the Dynamic Search Ad record in a bulk file.

For more information, see Dynamic Search Ad at https://go.microsoft.com/fwlink/?linkid=836840.

See also:

property dynamic_search_ad

The dynamic search ad.

see Dynamic Search Ad at https://go.microsoft.com/fwlink/?linkid=836840.

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.)

class bingads.v13.bulk.entities.bulk_ads.BulkExpandedTextAd(ad_group_id=None, campaign_name=None, ad_group_name=None, ad=None)[source]

Bases: bingads.v13.bulk.entities.bulk_ads._BulkAd

Represents an Expanded Text Ad.

This class exposes the expanded_text_ad property that can be read and written as fields of the Expanded Text Ad record in a bulk file.

For more information, see Expanded Text Ad at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property expanded_text_ad

The Expanded Text Ad.

see Expanded Text Ad at https://go.microsoft.com/fwlink/?linkid=846127.

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.)

class bingads.v13.bulk.entities.bulk_ads.BulkProductAd(ad_group_id=None, campaign_name=None, ad_group_name=None, ad=None)[source]

Bases: bingads.v13.bulk.entities.bulk_ads._BulkAd

Represents a product ad.

This class exposes the product_ad property that can be read and written as fields of the Product Ad record in a bulk file.

For more information, see Product Ad at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

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.)

property product_ad

The product ad.

See Product Ad at: https://go.microsoft.com/fwlink/?linkid=846127.

class bingads.v13.bulk.entities.bulk_ads.BulkResponsiveAd(ad_group_id=None, campaign_name=None, ad_group_name=None, ad=None)[source]

Bases: bingads.v13.bulk.entities.bulk_ads._BulkAd

Represents a Responsive Ad.

This class exposes the responsive_ad property that can be read and written as fields of the Responsive Ad record in a bulk file.

For more information, see Responsive Ad at https://go.microsoft.com/fwlink/?linkid=836840.

See also:

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.)

property responsive_ad

The responsive search ad.

see Responsive Ad at https://go.microsoft.com/fwlink/?linkid=836840.

property verified_tracking_data

The verified tracking data that the ad associated

Corresponds to ‘Verified Tracking Setting’ field in bulk file. :rtype: ArrayOfArrayOfKeyValuePairOfstringstring

class bingads.v13.bulk.entities.bulk_ads.BulkResponsiveSearchAd(ad_group_id=None, campaign_name=None, ad_group_name=None, ad=None)[source]

Bases: bingads.v13.bulk.entities.bulk_ads._BulkAd

Represents a Responsive Search Ad.

This class exposes the responsive_search_ad property that can be read and written as fields of the Responsive Search Ad record in a bulk file.

For more information, see Responsive Search Ad at https://go.microsoft.com/fwlink/?linkid=836840.

See also:

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.)

property responsive_search_ad

The responsive search ad.

see Responsive Search Ad at https://go.microsoft.com/fwlink/?linkid=836840.

class bingads.v13.bulk.entities.bulk_ads.BulkTextAd(ad_group_id=None, campaign_name=None, ad_group_name=None, ad=None)[source]

Bases: bingads.v13.bulk.entities.bulk_ads._BulkAd

Represents a Text Ad.

This class exposes the text_ad property that can be read and written as fields of the Text Ad record in a bulk file.

For more information, see Text Ad at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

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.)

property text_ad

The text ad.

see Text Ad at https://go.microsoft.com/fwlink/?linkid=846127.

bingads.v13.bulk.entities.bulk_asset_group module

class bingads.v13.bulk.entities.bulk_asset_group.BulkAssetGroup(campaign_id=None, campaign_name=None, asset_group=None)[source]

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

Represents an asset group.

This class exposes the property asset_group that can be read and written as fields of the Asset Group record in a bulk file.

For more information, see Asset Group at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property asset_group

The AssetGroup Data Object of the Campaign Management Service.

A subset of AssetGroup properties are available in the Ad Group record. For more information, see Ad Group at https://go.microsoft.com/fwlink/?linkid=846127.

property campaign_id

The identifier of the campaign that contains the asset group.

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

Return type

int

property campaign_name

The name of the campaign that contains the asset group.

Corresponds to the ‘Campaign’ 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]

bingads.v13.bulk.entities.bulk_asset_group_listing_group module

class bingads.v13.bulk.entities.bulk_asset_group_listing_group.BulkAssetGroupListingGroup(status=None, asset_group_listing_group=None)[source]

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

Represents an asset group listing group.

This class exposes the property asset_group_listing_group that can be read and written as fields of the Asset Group Listing Group record in a bulk file.

For more information, see Asset Group at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property asset_group_listing_group

The AssetGroupListingGroup Data Object of the Campaign Management Service.

A subset of AssetGroupListingGroup properties are available in the Ad Group record. For more information, see Ad Group at https://go.microsoft.com/fwlink/?linkid=846127.

property asset_group_name
property campaign_name
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 status

bingads.v13.bulk.entities.bulk_audience_group module

class bingads.v13.bulk.entities.bulk_audience_group.BulkAudienceGroup(account_id=None, status=None, audience_group=None, audience_ids=None)[source]

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

Represents an audience group.

This class exposes the property audience_group that can be read and written as fields of the Audience Group record in a bulk file.

For more information, see Audience Group at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property account_id

The identifier of the account that contains the audience group.

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

Return type

int

property age_ranges
property audience_group

The AudienceGroup Data Object of the Campaign Management Service.

A subset of AudienceGroup properties are available in the Audience Group record. For more information, see Ad Group at https://go.microsoft.com/fwlink/?linkid=846127.

property audience_ids
property gender_types
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 status

bingads.v13.bulk.entities.bulk_audience_group_asset_group_association module

class bingads.v13.bulk.entities.bulk_audience_group_asset_group_association.BulkAudienceGroupAssetGroupAssociation(status=None, audience_group_asset_group_association=None)[source]

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

Represents an audience group asset group association.

This class exposes the property audience_group_asset_group_association that can be read and written as fields of the audience group asset group association record in a bulk file.

For more information, see audience group asset group association at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property asset_group_name
property audience_group_asset_group_association

The AudienceGroupAssetGroupAssociation Data Object of the Campaign Management Service.

A subset of AudienceGroupAssetGroupAssociation properties are available in the Ad Group record. For more information, see Ad Group at https://go.microsoft.com/fwlink/?linkid=846127.

property campaign_name
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 status

bingads.v13.bulk.entities.bulk_bid_strategy module

class bingads.v13.bulk.entities.bulk_bid_strategy.BulkBidStrategy(bid_strategy=None, status=None, account_id=None)[source]

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

Represents a bid strategy that can be read or written in a bulk file.

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

See also:

property account_id

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

Return type

long

property bid_strategy

the Bid Strategy object, see more detail at: https://go.microsoft.com/fwlink/?linkid=846127

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 status

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

Return type

str

bingads.v13.bulk.entities.bulk_budget module

class bingads.v13.bulk.entities.bulk_budget.BulkBudget(budget=None, status=None, account_id=None)[source]

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

Represents a budget that can be read or written in a bulk file.

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

See also:

property account_id

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

Return type

long

property budget

the Budget object, see more detail at: https://go.microsoft.com/fwlink/?linkid=846127

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 status

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

Return type

str

bingads.v13.bulk.entities.bulk_campaign module

class bingads.v13.bulk.entities.bulk_campaign.BulkCampaign(account_id=None, campaign=None)[source]

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

Represents a campaign that can be read or written in a bulk file.

This class exposes the campaign property that can be read and written as fields of the Campaign record in a bulk file.

For more information, see Campaign at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property account_id

The identifier of the account that contains the campaign.

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

Return type

int

property bid_strategy_name

The budget name that the campaign associated, only for campaigns that use a shared budget

Corresponds to ‘Budget Name’ field in bulk file. :rtype: str

property budget_name

The budget name that the campaign associated, only for campaigns that use a shared budget

Corresponds to ‘Budget Name’ field in bulk file. :rtype: str

property campaign

Defines a campaign within an account.

See Campaign at https://docs.microsoft.com/en-us/bingads/campaign-management-service/campaign?view=bingads-13

property destination_channel
property is_multi_channel_campaign
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.)

property quality_score_data

The quality score data for the campaign.

Return type

QualityScoreData

read_additional_data(stream_reader)[source]
property should_serve_on_msan
property verified_tracking_data

The verified tracking data that the campaign associated, only for audience campaigns

Corresponds to ‘Verified Tracking Setting’ field in bulk file. :rtype: ArrayOfArrayOfKeyValuePairOfstringstring

bingads.v13.bulk.entities.bulk_campaign_conversion_goal module

class bingads.v13.bulk.entities.bulk_campaign_conversion_goal.BulkCampaignConversionGoal(campaign_conversion_goal=None)[source]

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

Represents a CampaignConversionGoal.

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

See also:

property campaign_conversion_goal

define a campaign conversion goal association

Return type

CampaignConversionGoal

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]

bingads.v13.bulk.entities.bulk_campaign_negative_dynamic_search_ad_target module

class bingads.v13.bulk.entities.bulk_campaign_negative_dynamic_search_ad_target.BulkCampaignNegativeDynamicSearchAdTarget(campaign_name=None, status=None, negative_campaign_criterion=None)[source]

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

Represents a Campaign Criterion that can be read or written in a bulk file.

This class exposes the negative_campaign_criterion property that can be read and written as fields of the Campaign Negative Dynamic Search Ad Target record in a bulk file.

For more information, see Campaign Negative Dynamic Search Ad Target at https://go.microsoft.com/fwlink/?linkid=836839.

See also:

property campaign_name

The name of the Campaign

Return type

str

property negative_campaign_criterion

Defines a Campaign Criterion

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 status

The status of the Campaign Criterion

Return type

str

bingads.v13.bulk.entities.bulk_campaign_negative_store_criterion module

class bingads.v13.bulk.entities.bulk_campaign_negative_store_criterion.BulkCampaignNegativeStoreCriterion(campaign_name=None, status=None, negative_campaign_criterion=None)[source]

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

Represents a Campaign Criterion that can be read or written in a bulk file.

This class exposes the negative_campaign_criterion property that can be read and written as fields of the Campaign Negative Store Criterion record in a bulk file.

For more information, see Campaign Negative Store Criterion at https://go.microsoft.com/fwlink/?linkid=836839.

See also:

property campaign_name

The name of the Campaign

Return type

str

property negative_campaign_criterion

Defines a Campaign Criterion

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 status

The status of the Campaign Criterion

Return type

str

bingads.v13.bulk.entities.bulk_campaign_negative_webpage module

class bingads.v13.bulk.entities.bulk_campaign_negative_webpage.BulkCampaignNegativeWebpage(campaign_name=None, status=None, negative_campaign_criterion=None)[source]

Bases: bingads.v13.bulk.entities.bulk_campaign_negative_dynamic_search_ad_target.BulkCampaignNegativeDynamicSearchAdTarget

Represents an Campaign Negative Webpage that can be read or written in a bulk file.

For more information, see Campaign Negative Webpage at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

bingads.v13.bulk.entities.bulk_campaign_product_scope module

class bingads.v13.bulk.entities.bulk_campaign_product_scope.BulkCampaignProductScope(campaign_name=None, status=None, biddable_campaign_criterion=None)[source]

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

Represents a Campaign Criterion that can be read or written in a bulk file.

This class exposes the campaign_criterion property that can be read and written as fields of the Campaign Product Scope record in a bulk file.

For more information, see Campaign Product Scope at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property biddable_campaign_criterion

Defines a Biddable Campaign Criterion

property campaign_name

The name of the Campaign

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 status

The status of the Campaign Criterion

Return type

str

bingads.v13.bulk.entities.bulk_data_exclusion module

class bingads.v13.bulk.entities.bulk_data_exclusion.BulkDataExclusion(campaign_id=None, campaign_name=None, data_exclusion=None)[source]

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

Represents an data exclusion.

This class exposes the property data_exclusion that can be read and written as fields of the data exclusion record in a bulk file.

For more information, see data exclusion at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property data_exclusion

The DataExclusion Data Object of the Campaign Management Service.

A subset of DataExclusion properties are available in the Ad Group record. For more information, see Ad Group at https://go.microsoft.com/fwlink/?linkid=846127.

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]

bingads.v13.bulk.entities.bulk_entity module

class bingads.v13.bulk.entities.bulk_entity.BulkEntity[source]

Bases: bingads.v13.internal.bulk.bulk_object._BulkObject

The abstract base class for all bulk entities that can be read or written in a bulk file.

For more information, see Bulk File Schema at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

abstract property has_errors

Determines whether the bulk entity has associated errors.

Return type

bool

abstract property last_modified_time

Gets the last modified time for the entity.

Return type

datetime.datetime

bingads.v13.bulk.entities.bulk_error module

class bingads.v13.bulk.entities.bulk_error.BulkError[source]

Bases: bingads.v13.internal.bulk.bulk_object._BulkObject

Contains bulk file error details in a separate record that corresponds to the record of a BulkEntity derived instance.

Properties of this class and of classes that it is derived from, correspond to error fields of the ‘Error’ records in a bulk file. For more information, see Bulk File Schema at https://go.microsoft.com/fwlink/?linkid=846127.

Example:

If you upload a BulkCampaign without setting the campaign name using BulkServiceManager.upload_entities, and if you request errors to be returned in the results using the corresponding :attr:`SubmitUploadParameters.response_mode(), then the upload result file will contain a record that can be read with a BulkFileReader as an instance of BulkError.

can_enclose_in_multiline_entity()[source]

Returns true if the entity is part of multiline entity, false otherwise.

Example:

  • BulkSiteLinkAdExtension: returns true

  • BulkCampaignTarget: returns true

  • BulkAdGroup: returns false

  • BulkKeyword: returns false

Return type

bool

property editorial_location

The location of the entity property that resulted in the editorial error, for example ‘AdDescription’.

Corresponds to the ‘Editorial Location’ field in the bulk file.

Return type

str

property editorial_reason_code

The term that resulted in the editorial error, for example ‘17’.

Corresponds to the ‘Editorial Reason Code’ field in the bulk file. For more information, see Bing Ads Editorial Failure Reason Codes at https://go.microsoft.com/fwlink/?linkid=846127.

Return type

int

property editorial_term

The term that resulted in the editorial error, for example ‘bing’.

Corresponds to the ‘Editorial Term’ field in the bulk file.

Return type

str

enclose_in_multiline_entity()[source]

Creates a multiline entity containing this entity

Example:

  • BulkSiteLink: returns BulkSiteLinkAdExtension containing this BulkSiteLink

  • BulkCampaignAgeTargetBid: return BulkCampaignTarget containing this BulkCampaignAgeTargetBid

Returns

the wrapping multi-line entity

Return type

_MultiRecordBulkEntity

property entity
property error

The error code, for example ‘CampaignServiceEditorialValidationError’.

Corresponds to the ‘Error’ field in the bulk file. For more information, see Bing Ads Operation Error Codes at https://go.microsoft.com/fwlink/?linkid=846127.

Return type

str

property field_path

The term that resulted in the editorial error.

Corresponds to the ‘Field Path’ field in the bulk file.

Return type

int

property number

The error number, for example ‘1042’.

Corresponds to the ‘Error Number’ field in the bulk file. For more information, see Bing Ads Operation Error Codes at https://go.microsoft.com/fwlink/?linkid=846127.

Return type

int

property publisher_countries

The publisher countries where editorial restriction is enforced, for example ‘US’.

Corresponds to the ‘Publisher Countries’ field in the bulk file.

Remarks:

In a bulk file, the list of publisher countries are delimited with a semicolon (;).

Return type

str

read_from_row_values(row_values)[source]

Read object data from a single row.

Example:

  • SingleLineBulkEntity: reads entity fields.

  • BulkError: reads error fields.

  • BulkEntityIdentifier: reads identifier fields (Id, status etc.).

Parameters

row_values (_RowValues) –

Reads object data from consecutive rows.

Example:

  • SingleLineBulkEntity: reads entity errors.

  • MultilineBulkEntity: reads child entities.

Parameters

stream_reader (_BulkStreamReader) –

write_to_row_values(row_values, exclude_readonly_data)[source]

Writes object data to a single row.

Example:

  • SingleLineBulkEntity: writes entity fields.

  • BulkEntityIdentifier: writes identifier fields (Id, status etc.)

Parameters

row_values (_RowValues) –

write_to_stream(stream_writer, exclude_readonly_data)[source]

Writes object data to consecutive rows.

Example:

  • SingleLineBulkEntity: writes entity.

  • MultilineBulkEntity: writes child entities.

  • BulkEntityIdentifier: writes identifier information (Id, status etc.)

Parameters

row_writer (_BulkObjectWriter) –

bingads.v13.bulk.entities.bulk_experiment module

class bingads.v13.bulk.entities.bulk_experiment.BulkExperiment(experiment=None)[source]

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

Represents an experiment.

This class exposes the property experiment that can be read and written as fields of the Experiment record in a bulk file.

For more information, see Experiment at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property experiment

The experiment.

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]

bingads.v13.bulk.entities.bulk_image module

class bingads.v13.bulk.entities.bulk_image.BulkImage(status=None)[source]

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

Represents a image that can be read or written in a bulk file.

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

See also:

property account_id

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

Return type

long

property height
property id

the Id object, see more detail at: https://go.microsoft.com/fwlink/?linkid=846127

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 status

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

Return type

str

property subtype
property text
property url
property width

bingads.v13.bulk.entities.bulk_keyword module

class bingads.v13.bulk.entities.bulk_keyword.BulkKeyword(ad_group_id=None, campaign_name=None, ad_group_name=None, keyword=None)[source]

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

Represents a keyword that can be read or written in a bulk file.

This class exposes the keyword property that can be read and written as fields of the Keyword record in a bulk file. Properties of this class and of classes that it is derived from, correspond to fields of the Keyword record in a bulk file. For more information, see Keyword at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property ad_group_id

The identifier of the ad group that contains the keyword.

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

Return type

int

property ad_group_name

The name of the ad group that contains the keyword.

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

Return type

str

property bid_suggestions

The bid suggestion data for the keyword.

Return type

BidSuggestionData

property campaign_name

The name of the campaign that contains the keyword.

Corresponds to the ‘Campaign’ field in the bulk file.

Return type

str

property keyword

Defines a keyword within an ad group.

See Keyword at https://docs.microsoft.com/en-us/bingads/campaign-management-service/keyword?view=bingads-13

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.)

property quality_score_data

The quality score data for the keyword.

Return type

QualityScoreData

read_additional_data(stream_reader)[source]
write_additional_data(row_writer)[source]
bingads.v13.bulk.entities.bulk_keyword.bidding_scheme_to_csv(bulk_keyword, row_values)[source]
bingads.v13.bulk.entities.bulk_keyword.csv_to_bidding_scheme(row_values, bulk_keyword)[source]

bingads.v13.bulk.entities.bulk_negative_keywords module

class bingads.v13.bulk.entities.bulk_negative_keywords.BulkAccountSharedNegativeKeyword(status=None, negative_keyword=None, negative_keyword_list_id=None)[source]

Bases: bingads.v13.bulk.entities.bulk_negative_keywords._BulkNegativeKeyword

Represents an account negative keyword that is shared in a negative keyword list.

Each shared negative keyword can be read or written in a bulk file. This class exposes the BulkNegativeKeyword.NegativeKeyword property that can be read and written as fields of the Account Shared Negative Keyword record in a bulk file.

For more information, see Account Shared Negative Keyword at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property negative_keyword_list_id
class bingads.v13.bulk.entities.bulk_negative_keywords.BulkAdGroupNegativeKeyword(status=None, negative_keyword=None, ad_group_id=None, ad_group_name=None, campaign_name=None)[source]

Bases: bingads.v13.bulk.entities.bulk_negative_keywords._BulkEntityNegativeKeyword

Represents a negative keyword that is assigned to a ad group. Each negative keyword can be read or written in a bulk file.

This class exposes the BulkNegativeKeyword.negative_keyword property that can be read and written as fields of the Ad Group Negative Keyword record in a bulk file.

For more information, see Ad Group Negative Keyword at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property ad_group_id

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

Returns

The identifier of the ad group that the negative keyword is assigned.

Return type

int

property ad_group_name

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

Returns

The name of the ad group that the negative keyword is assigned.

Return type

str

property campaign_name

The name of the campaign that the negative keyword is assigned.

Corresponds to the ‘Campaign’ 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]
class bingads.v13.bulk.entities.bulk_negative_keywords.BulkCampaignNegativeKeyword(status=None, negative_keyword=None, campaign_id=None, campaign_name=None)[source]

Bases: bingads.v13.bulk.entities.bulk_negative_keywords._BulkEntityNegativeKeyword

Represents a negative keyword that is assigned to a campaign. Each negative keyword can be read or written in a bulk file.

This class exposes the BulkNegativeKeyword.negative_keyword property that can be read and written as fields of the Campaign Negative Keyword record in a bulk file.

For more information, see Campaign Negative Keyword at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property campaign_id

The identifier of the campaign that the negative keyword is assigned.

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

Return type

int

property campaign_name

The name of the campaign that the negative keyword is assigned.

Corresponds to the ‘Campaign’ field in the bulk file.

Return type

str

class bingads.v13.bulk.entities.bulk_negative_keywords.BulkCampaignNegativeKeywordList(status=None, shared_entity_association=None)[source]

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

Represents a negative keyword list that is assigned to a campaign. Each negative keyword list can be read or written in a bulk file.

This class exposes the BulkCampaignNegativeKeywordList.SharedEntityAssociation property that can be read and written as fields of the Campaign Negative Keyword List Association record in a bulk file.

For more information, see Campaign Negative Keyword List Association at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

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 shared_entity_association

The campaign and negative keyword list identifiers.

see Campaign Negative Keyword List Association at https://go.microsoft.com/fwlink/?linkid=846127.

property status

The status of the negative keyword list association.

Return type

str

class bingads.v13.bulk.entities.bulk_negative_keywords.BulkNegativeKeywordList(status=None, negative_keyword_list=None)[source]

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

Represents a negative keyword list that can be read or written in a bulk file.

This class exposes the BulkNegativeKeywordList.negative_keyword_list property that can be read and written as fields of the Negative Keyword List record in a bulk file.

For more information, see Negative Keyword List at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property negative_keyword_list

The negative keyword list.

see Negative Keyword List at https://go.microsoft.com/fwlink/?linkid=846127.

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 status

The status of the negative keyword list.

Return type

str

class bingads.v13.bulk.entities.bulk_negative_keywords.BulkSharedNegativeKeyword(status=None, negative_keyword=None, negative_keyword_list_id=None)[source]

Bases: bingads.v13.bulk.entities.bulk_negative_keywords._BulkNegativeKeyword

Represents a negative keyword that is shared in a negative keyword list.

Each shared negative keyword can be read or written in a bulk file. This class exposes the BulkNegativeKeyword.NegativeKeyword property that can be read and written as fields of the Shared Negative Keyword record in a bulk file.

For more information, see Shared Negative Keyword at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property negative_keyword_list_id

bingads.v13.bulk.entities.bulk_negative_sites module

class bingads.v13.bulk.entities.bulk_negative_sites.BulkAdGroupNegativeSite(status=None, ad_group_id=None, ad_group_name=None, campaign_name=None, website=None)[source]

Bases: bingads.v13.bulk.entities.bulk_negative_sites._BulkNegativeSite

Represents a negative site that is assigned to an ad group. Each negative site can be read or written in a bulk file.

This class exposes properties that can be read and written as fields of the Ad Group Negative Site record in a bulk file.

For more information, see Ad Group Negative Site at https://go.microsoft.com/fwlink/?linkid=846127.

One BulkAdGroupNegativeSites exposes a read only list of BulkAdGroupNegativeSite. Each BulkAdGroupNegativeSite instance corresponds to one Ad Group Negative Site record in the bulk file. If you upload a BulkAdGroupNegativeSites, then you are effectively replacing any existing negative sites assigned to the ad group.

See also:

property ad_group_id

The identifier of the ad group that the negative site is assigned.

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

Return type

int

property ad_group_name

The name of the ad group that the negative site is assigned.

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

Return type

str

property campaign_name

The name of the ad group that the negative site is assigned.

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

Return type

str

create_negative_sites_with_this_negative_site()[source]
class bingads.v13.bulk.entities.bulk_negative_sites.BulkAdGroupNegativeSites(ad_group_negative_sites=None, ad_group_name=None, campaign_name=None, status=None, site=None, identifier=None)[source]

Bases: bingads.v13.bulk.entities.bulk_negative_sites._BulkNegativeSites

Represents one or more negative sites that are assigned to an ad group. Each negative site can be read or written in a bulk file.

This class exposes properties that can be read and written as fields of the Ad Group Negative Site record in a bulk file.

For more information, see Ad Group Negative Site at https://go.microsoft.com/fwlink/?linkid=846127.

One BulkAdGroupNegativeSites has one or more BulkAdGroupNegativeSite. Each BulkAdGroupNegativeSite instance corresponds to one Ad Group Negative Site record in the bulk file. If you upload a BulkAdGroupNegativeSites, then you are effectively replacing any existing negative sites assigned to the ad group.

See also:

property ad_group_name

The name of the ad group that the negative site is assigned.

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

Return type

str

property ad_group_negative_sites

The AdGroupNegativeSites Data Object of the Campaign Management Service.

subset of AdGroupNegativeSites properties are available in the Ad Group Negative Site record. For more information, see Ad Group Negative Site at https://go.microsoft.com/fwlink/?linkid=846127.

property campaign_name

The name of the campaign that the negative site is assigned.

Corresponds to the ‘Campaign’ field in the bulk file.

Return type

str

convert_api_to_bulk_negative_sites()[source]
property identifier_class
reconstruct_api_objects()[source]
set_data_from_identifier(identifier)[source]
property site_class
class bingads.v13.bulk.entities.bulk_negative_sites.BulkCampaignNegativeSite(status=None, campaign_id=None, campaign_name=None, website=None)[source]

Bases: bingads.v13.bulk.entities.bulk_negative_sites._BulkNegativeSite

Represents a negative site that is assigned to an campaign. Each negative site can be read or written in a bulk file.

This class exposes properties that can be read and written as fields of the Campaign Negative Site record in a bulk file.

For more information, see Campaign Negative Site at https://go.microsoft.com/fwlink/?linkid=846127.

One BulkCampaignNegativeSites exposes a read only list of BulkCampaignNegativeSite. Each BulkCampaignNegativeSite instance corresponds to one Campaign Negative Site record in the bulk file. If you upload a BulkCampaignNegativeSites, then you are effectively replacing any existing negative sites assigned to the campaign.

See also:

property campaign_id

The identifier of the campaign that the negative site is assigned.

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

Return type

int

property campaign_name

The name of the campaign that the negative site is assigned.

Corresponds to the ‘Campaign’ field in the bulk file.

Return type

str

create_negative_sites_with_this_negative_site()[source]
class bingads.v13.bulk.entities.bulk_negative_sites.BulkCampaignNegativeSites(campaign_negative_sites=None, campaign_name=None, status=None, site=None, identifier=None)[source]

Bases: bingads.v13.bulk.entities.bulk_negative_sites._BulkNegativeSites

Represents one or more negative sites that are assigned to an campaign. Each negative site can be read or written in a bulk file.

This class exposes properties that can be read and written as fields of the Campaign Negative Site record in a bulk file.

For more information, see Campaign Negative Site at https://go.microsoft.com/fwlink/?linkid=846127.

One BulkCampaignNegativeSites has one or more BulkCampaignNegativeSite. Each BulkCampaignNegativeSite instance corresponds to one Campaign Negative Site record in the bulk file. If you upload a BulkCampaignNegativeSites, then you are effectively replacing any existing negative sites assigned to the campaign.

See also:

property campaign_name

The name of the campaign that the negative site is assigned.

Corresponds to the ‘Campaign’ field in the bulk file. :rtype: str

property campaign_negative_sites

The CampaignNegativeSites Data Object of the Campaign Management Service.

A subset of CampaignNegativeSites properties are available in the Campaign Negative Site record. For more information, see Campaign Negative Site at https://go.microsoft.com/fwlink/?linkid=846127.

convert_api_to_bulk_negative_sites()[source]
property identifier_class
reconstruct_api_objects()[source]
set_data_from_identifier(identifier)[source]
property site_class

bingads.v13.bulk.entities.bulk_offline_conversion module

class bingads.v13.bulk.entities.bulk_offline_conversion.BulkOfflineConversion(offline_conversion=None)[source]

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

Represents an offline conversion that can be read or written in a bulk file.

This class exposes the offline_conversion property that can be read and written as fields of the Keyword record in a bulk file. Properties of this class and of classes that it is derived from, correspond to fields of the Keyword record in a bulk file. For more information, see Keyword at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property adjustment_currency_code
property adjustment_time
property adjustment_type
property adjustment_value
property external_attribution_credit
property external_attribution_model
property offline_conversion

The offline conversion Data Object of the Campaign Management Service.

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]

bingads.v13.bulk.entities.bulk_online_conversion_adjustment module

class bingads.v13.bulk.entities.bulk_online_conversion_adjustment.BulkOnlineConversionAdjustment(online_conversion_adjustment=None)[source]

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

Represents an online conversion adjustment that can be read or written in a bulk file.

This class exposes the online_conversion_adjustment property that can be read and written as fields of the Keyword record in a bulk file. Properties of this class and of classes that it is derived from, correspond to fields of the Keyword record in a bulk file. For more information, see Keyword at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

property online_conversion_adjustment

The online conversion adjustment Data Object of the Campaign Management Service.

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]

bingads.v13.bulk.entities.bulk_seasonality_adjustment module

class bingads.v13.bulk.entities.bulk_seasonality_adjustment.BulkSeasonalityAdjustment(campaign_id=None, campaign_name=None, seasonality_adjustment=None)[source]

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

Represents an seasonality adjustment.

This class exposes the property seasonality_adjustment that can be read and written as fields of the seasonality adjustment record in a bulk file.

For more information, see seasonality adjustment at https://go.microsoft.com/fwlink/?linkid=846127.

See also:

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 seasonality_adjustment

The SeasonalityAdjustment Data Object of the Campaign Management Service.

A subset of SeasonalityAdjustment properties are available in the Ad Group record. For more information, see Ad Group at https://go.microsoft.com/fwlink/?linkid=846127.

bingads.v13.bulk.entities.bulk_video module

class bingads.v13.bulk.entities.bulk_video.BulkVideo(video=None, account_id=None)[source]

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

Represents a video that can be read or written in a bulk file.

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

See also:

property account_id

the id of the account which contains the video Corresponds to the ‘Parent Id’ 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 video

the Video object

bingads.v13.bulk.entities.common module

class bingads.v13.bulk.entities.common.QualityScoreData[source]

Bases: bingads.v13.internal.bulk.bulk_object._BulkObject

Represents a subset of the fields available in bulk records that support quality score data.

For example BulkKeyword. For more information, see Bulk File Schema at https://go.microsoft.com/fwlink/?linkid=846127.

property can_enclose_in_multiline_entity

Returns true if the entity is part of multiline entity, false otherwise.

Example:

  • BulkSiteLinkAdExtension: returns true

  • BulkCampaignTarget: returns true

  • BulkAdGroup: returns false

  • BulkKeyword: returns false

Return type

bool

enclose_in_multiline_entity()[source]

Creates a multiline entity containing this entity

Example:

  • BulkSiteLink: returns BulkSiteLinkAdExtension containing this BulkSiteLink

  • BulkCampaignAgeTargetBid: return BulkCampaignTarget containing this BulkCampaignAgeTargetBid

Returns

the wrapping multi-line entity

Return type

_MultiRecordBulkEntity

property has_any_values
property keyword_relevance

Corresponds to the ‘Keyword Relevance’ field in the bulk file.

Return type

int

property landing_page_relevance

Corresponds to the ‘Landing Page Relevance’ field in the bulk file.

Return type

int

property landing_page_user_experience

Corresponds to the ‘Landing Page User Experience’ field in the bulk file.

Return type

int

property quality_score

Corresponds to the ‘Quality Score’ field in the bulk file.

Return type

int

read_from_row_values(row_values)[source]

Read object data from a single row.

Example:

  • SingleLineBulkEntity: reads entity fields.

  • BulkError: reads error fields.

  • BulkEntityIdentifier: reads identifier fields (Id, status etc.).

Parameters

row_values (_RowValues) –

static read_from_row_values_or_null(row_values)[source]

Reads object data from consecutive rows.

Example:

  • SingleLineBulkEntity: reads entity errors.

  • MultilineBulkEntity: reads child entities.

Parameters

stream_reader (_BulkStreamReader) –

write_to_row_values(row_values, exclude_readonly_data)[source]

Writes object data to a single row.

Example:

  • SingleLineBulkEntity: writes entity fields.

  • BulkEntityIdentifier: writes identifier fields (Id, status etc.)

Parameters

row_values (_RowValues) –

static write_to_row_values_if_not_null(quality_score_data, row_values)[source]
write_to_stream(row_writer, exclude_readonly_data)[source]

Writes object data to consecutive rows.

Example:

  • SingleLineBulkEntity: writes entity.

  • MultilineBulkEntity: writes child entities.

  • BulkEntityIdentifier: writes identifier information (Id, status etc.)

Parameters

row_writer (_BulkObjectWriter) –

bingads.v13.bulk.entities.unknown_bulk_entity module

class bingads.v13.bulk.entities.unknown_bulk_entity.UnknownBulkEntity[source]

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

Reserved to support new record types that may be added to the Bulk schema.

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)[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 values

The forward compatibility map of fields and values.

Return type

dict | None

Module contents