bingads.v13.bulk.entities.audiences package

Submodules

bingads.v13.bulk.entities.audiences.bulk_ad_group_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_audience_association.BulkAdGroupAudienceAssociation(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.target_criterions.bulk_ad_group_biddable_criterion.BulkAdGroupBiddableCriterion

Base class for all Ad Group Audience Association subclasses that can be read or written in a bulk file.

See also:

property audience_name

Defines the name of the Audience

Return type

str

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.audiences.bulk_ad_group_combined_list_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_combined_list_association.BulkAdGroupCombinedListAssociation(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_audience_association.BulkAdGroupAudienceAssociation

Represents an Ad Group Combined List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_ad_group_custom_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_custom_audience_association.BulkAdGroupCustomAudienceAssociation(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_audience_association.BulkAdGroupAudienceAssociation

Represents an Ad Group Custom Audience Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_ad_group_customer_list_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_customer_list_association.BulkAdGroupCustomerListAssociation(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_audience_association.BulkAdGroupAudienceAssociation

Represents an Ad Group Customer List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_ad_group_in_market_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_in_market_audience_association.BulkAdGroupInMarketAudienceAssociation(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_audience_association.BulkAdGroupAudienceAssociation

Represents an Ad Group In Market Audience Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_audience_association.BulkAdGroupNegativeAudienceAssociation(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_criterion.BulkAdGroupNegativeCriterion

Base class for all Ad Group Negative Audience Association subclasses that can be read or written in a bulk file.

See also:

property audience_name

Defines the name of the Audience

Return type

str

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.audiences.bulk_ad_group_negative_combined_list_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_combined_list_association.BulkAdGroupNegativeCombinedListAssociation(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_audience_association.BulkAdGroupNegativeAudienceAssociation

Represents an Ad Group Negative Combined list Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_custom_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_custom_audience_association.BulkAdGroupNegativeCustomAudienceAssociation(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_audience_association.BulkAdGroupNegativeAudienceAssociation

Represents an Ad Group Negative Custom Audience Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_customer_list_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_customer_list_association.BulkAdGroupNegativeCustomerListAssociation(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_audience_association.BulkAdGroupNegativeAudienceAssociation

Represents an Ad Group Negative Customer list Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_in_market_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_in_market_audience_association.BulkAdGroupNegativeInMarketAudienceAssociation(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_audience_association.BulkAdGroupNegativeAudienceAssociation

Represents an Ad Group Negative In Market Audience Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_product_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_product_audience_association.BulkAdGroupNegativeProductAudienceAssociation(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_audience_association.BulkAdGroupNegativeAudienceAssociation

Represents an Ad Group Negative Product Audience Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_remarketing_list_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_remarketing_list_association.BulkAdGroupNegativeRemarketingListAssociation(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_audience_association.BulkAdGroupNegativeAudienceAssociation

Represents an Ad Group Negative Remarketing List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_similar_remarketing_list_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_similar_remarketing_list_association.BulkAdGroupNegativeSimilarRemarketingListAssociation(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_negative_audience_association.BulkAdGroupNegativeAudienceAssociation

Represents an Ad Group Negative Similar Remarketing List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_ad_group_product_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_product_audience_association.BulkAdGroupProductAudienceAssociation(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_audience_association.BulkAdGroupAudienceAssociation

Represents an Ad Group Product Audience Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_ad_group_remarketing_list_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_remarketing_list_association.BulkAdGroupRemarketingListAssociation(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_audience_association.BulkAdGroupAudienceAssociation

Represents an Ad Group Remarketing List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_ad_group_similar_remarketing_list_association module

class bingads.v13.bulk.entities.audiences.bulk_ad_group_similar_remarketing_list_association.BulkAdGroupSimilarRemarketingListAssociation(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_ad_group_audience_association.BulkAdGroupAudienceAssociation

Represents an Ad Group Similar Remarketing List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_audience module

class bingads.v13.bulk.entities.audiences.bulk_audience.BulkAudience(audience=None, status=None)[source]

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

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

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

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

See also:

property audience

Defines a Audience

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 Audience

Return type

str

bingads.v13.bulk.entities.audiences.bulk_campaign_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_audience_association.BulkCampaignAudienceAssociation(biddable_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.target_criterions.bulk_campaign_biddable_criterion.BulkCampaignBiddableCriterion

Base class for all Campaign Audience Association subclasses that can be read or written in a bulk file.

See also:

property audience_name

Defines the name of the Audience

Return type

str

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.audiences.bulk_campaign_combined_list_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_combined_list_association.BulkCampaignCombinedListAssociation(biddable_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_audience_association.BulkCampaignAudienceAssociation

Represents an Campaign Combined List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_campaign_custom_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_custom_audience_association.BulkCampaignCustomAudienceAssociation(biddable_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_audience_association.BulkCampaignAudienceAssociation

Represents an Campaign Custom Audience Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_campaign_customer_list_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_customer_list_association.BulkCampaignCustomerListAssociation(biddable_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_audience_association.BulkCampaignAudienceAssociation

Represents an Campaign Customer List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_campaign_in_market_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_in_market_audience_association.BulkCampaignInMarketAudienceAssociation(biddable_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_audience_association.BulkCampaignAudienceAssociation

Represents an Campaign In Market Audience Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_campaign_negative_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_negative_audience_association.BulkCampaignNegativeAudienceAssociation(negative_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.target_criterions.bulk_campaign_negative_criterion.BulkCampaignNegativeCriterion

Base class for all Campaign Negative Audience Association subclasses that can be read or written in a bulk file.

See also:

property audience_name

Defines the name of the Audience

Return type

str

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.audiences.bulk_campaign_negative_combined_list_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_negative_combined_list_association.BulkCampaignNegativeCombinedListAssociation(negative_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_negative_audience_association.BulkCampaignNegativeAudienceAssociation

Represents an Campaign Negative Combined List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_campaign_negative_custom_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_negative_custom_audience_association.BulkCampaignNegativeCustomAudienceAssociation(negative_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_negative_audience_association.BulkCampaignNegativeAudienceAssociation

Represents an Campaign Negative Custom Audience Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_campaign_negative_customer_list_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_negative_customer_list_association.BulkCampaignNegativeCustomerListAssociation(negative_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_negative_audience_association.BulkCampaignNegativeAudienceAssociation

Represents an Campaign Negative Customer List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_campaign_negative_in_market_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_negative_in_market_audience_association.BulkCampaignNegativeInMarketAudienceAssociation(negative_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_negative_audience_association.BulkCampaignNegativeAudienceAssociation

Represents an Campaign Negative In Market Audience Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_campaign_negative_product_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_negative_product_audience_association.BulkCampaignNegativeProductAudienceAssociation(negative_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_negative_audience_association.BulkCampaignNegativeAudienceAssociation

Represents an Campaign Negative Product Audience Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_campaign_negative_remarketing_list_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_negative_remarketing_list_association.BulkCampaignNegativeRemarketingListAssociation(negative_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_negative_audience_association.BulkCampaignNegativeAudienceAssociation

Represents an Campaign Negative Remarketing List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_campaign_negative_similar_remarketing_list_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_negative_similar_remarketing_list_association.BulkCampaignNegativeSimilarRemarketingListAssociation(negative_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_negative_audience_association.BulkCampaignNegativeAudienceAssociation

Represents an Campaign Negative Similar Remarketing List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_campaign_product_audience_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_product_audience_association.BulkCampaignProductAudienceAssociation(biddable_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_audience_association.BulkCampaignAudienceAssociation

Represents an Campaign Product Audience Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_campaign_remarketing_list_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_remarketing_list_association.BulkCampaignRemarketingListAssociation(biddable_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_audience_association.BulkCampaignAudienceAssociation

Represents an Campaign Remarketing List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_campaign_similar_remarketing_list_association module

class bingads.v13.bulk.entities.audiences.bulk_campaign_similar_remarketing_list_association.BulkCampaignSimilarRemarketingListAssociation(biddable_campaign_criterion=None, campaign_name=None, audience_name=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_campaign_audience_association.BulkCampaignAudienceAssociation

Represents an Campaign Similar Remarketing List Association that can be read or written in a bulk file.

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

See also:

bingads.v13.bulk.entities.audiences.bulk_combined_list module

class bingads.v13.bulk.entities.audiences.bulk_combined_list.BulkCombinedList(combined_list=None, status=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_audience.BulkAudience

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

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

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

See also:

property combined_list

Defines a CombinedList

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

bingads.v13.bulk.entities.audiences.bulk_custom_audience module

class bingads.v13.bulk.entities.audiences.bulk_custom_audience.BulkCustomAudience(custom_audience=None, status=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_audience.BulkAudience

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

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

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

See also:

property custom_audience

Defines a Custom Audience

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

bingads.v13.bulk.entities.audiences.bulk_customer_list module

class bingads.v13.bulk.entities.audiences.bulk_customer_list.BulkCustomerList(customer_list=None, status=None, action_type=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_audience.BulkAudience

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

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

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

See also:

property action_type

Defines a action_type

property customer_list

Defines a CustomerList

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

bingads.v13.bulk.entities.audiences.bulk_customer_list_item module

class bingads.v13.bulk.entities.audiences.bulk_customer_list_item.BulkCustomerListItem(audience=None, parent_id=None, sub_type=None, text=None)[source]

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

Represents a customer list item 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 Customer List Item record in a bulk file. For more information, see Budget at https://go.microsoft.com/fwlink/?linkid=846127

See also:

property audience

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

Return type

str

property parent_id

the parent id of bulk record 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 sub_type

the sub type of bulk record Corresponds to the ‘Sub Type’ field in the bulk file.

Return type

str

property text

the text of bulk record Corresponds to the ‘Text’ field in the bulk file.

Return type

str

bingads.v13.bulk.entities.audiences.bulk_in_market_audience module

class bingads.v13.bulk.entities.audiences.bulk_in_market_audience.BulkInMarketAudience(in_market_audience=None, status=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_audience.BulkAudience

Represents an In Market Audience that can be read or written in a bulk file.

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

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

See also:

property in_market_audience

Defines an In Market Audience

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

bingads.v13.bulk.entities.audiences.bulk_product_audience module

class bingads.v13.bulk.entities.audiences.bulk_product_audience.BulkProductAudience(product_audience=None, status=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_audience.BulkAudience

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

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

For more information, see Product Audience 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_audience

Defines a Product Audience

bingads.v13.bulk.entities.audiences.bulk_remarketing_list module

class bingads.v13.bulk.entities.audiences.bulk_remarketing_list.BulkRemarketingList(remarketing_list=None, status=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_audience.BulkAudience

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

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

For more information, see Remarketing List 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 remarketing_list

Defines a Remarketing List

bingads.v13.bulk.entities.audiences.bulk_similar_remarketing_list module

class bingads.v13.bulk.entities.audiences.bulk_similar_remarketing_list.BulkSimilarRemarketingList(similar_remarketing_list=None, status=None)[source]

Bases: bingads.v13.bulk.entities.audiences.bulk_audience.BulkAudience

Represents an Similar Remarketing List that can be read or written in a bulk file.

This class exposes the similar_remarketing_list property that can be read and written as fields of the Similar Remarketing List record in a bulk file.

For more information, see Similar Remarketing List 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 similar_remarketing_list

Defines a Similar Remarketing List

Module contents