bingads.v13.bulk.entities.target_criterions package

Submodules

bingads.v13.bulk.entities.target_criterions.bulk_ad_group_age_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_age_criterion.BulkAdGroupAgeCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Age 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 Age Criterion record in a bulk file.

For more information, see Ad Group Age Criterion 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.target_criterions.bulk_ad_group_biddable_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_biddable_criterion.BulkAdGroupBiddableCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Biddable 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 Biddable Criterion record in a bulk file.

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

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.target_criterions.bulk_ad_group_day_time_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_day_time_criterion.BulkAdGroupDayTimeCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Day Time 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 Day Time Criterion record in a bulk file.

For more information, see Ad Group Day Time Criterion 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.target_criterions.bulk_ad_group_device_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_device_criterion.BulkAdGroupDeviceCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Device 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 Device Criterion record in a bulk file.

For more information, see Ad Group Device Criterion 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.target_criterions.bulk_ad_group_gender_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_gender_criterion.BulkAdGroupGenderCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Gender 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 Gender Criterion record in a bulk file.

For more information, see Ad Group Gender Criterion 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.target_criterions.bulk_ad_group_genre_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_genre_criterion.BulkAdGroupGenreCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Genre 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 Genre Criterion record in a bulk file.

For more information, see Ad Group Genre Criterion 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.target_criterions.bulk_ad_group_hotel_advance_booking_window_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_hotel_advance_booking_window_criterion.BulkAdGroupHotelAdvanceBookingWindowCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Hotel Advance Booking Window 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 Hotel Advance Booking Window Criterion record in a bulk file.

For more information, see Ad Group Hotel Advance Booking Window Criterion 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.target_criterions.bulk_ad_group_hotel_check_in_date_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_hotel_check_in_date_criterion.BulkAdGroupHotelCheckInDateCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Hotel Check In Date 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 Hotel Check In Date Criterion record in a bulk file.

For more information, see Ad Group Hotel Check In Date Criterion 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.target_criterions.bulk_ad_group_hotel_check_in_day_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_hotel_check_in_day_criterion.BulkAdGroupHotelCheckInDayCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Hotel Check In Day 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 Hotel Check In Day Criterion record in a bulk file.

For more information, see Ad Group Hotel Check In Day Criterion 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.target_criterions.bulk_ad_group_hotel_date_selection_type_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_hotel_date_selection_type_criterion.BulkAdGroupHotelDateSelectionTypeCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Hotel Date Selection Type 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 Hotel Date Selection Type Criterion record in a bulk file.

For more information, see Ad Group Hotel Date Selection Type Criterion 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.target_criterions.bulk_ad_group_hotel_length_of_stay_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_hotel_length_of_stay_criterion.BulkAdGroupHotelLengthOfStayCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Hotel Length Of Stay 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 Hotel Length Of Stay Criterion record in a bulk file.

For more information, see Ad Group Hotel Length Of Stay Criterion 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.target_criterions.bulk_ad_group_location_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_location_criterion.BulkAdGroupLocationCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Location 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 Location Criterion record in a bulk file.

For more information, see Ad Group Location Criterion 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.target_criterions.bulk_ad_group_location_intent_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_location_intent_criterion.BulkAdGroupLocationIntentCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Location Intent 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 Location Intent Criterion record in a bulk file.

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

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]

bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_age_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_age_criterion.BulkAdGroupNegativeAgeCriterion(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Negative Age 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 Age Criterion record in a bulk file.

For more information, see Ad Group Negative Age Criterion 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.target_criterions.bulk_ad_group_negative_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_criterion.BulkAdGroupNegativeCriterion(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Negative 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 Criterion record in a bulk file.

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

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

bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_gender_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_gender_criterion.BulkAdGroupNegativeGenderCriterion(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Negative Gender 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 Gender Criterion record in a bulk file.

For more information, see Ad Group Negative Gender Criterion 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.target_criterions.bulk_ad_group_negative_location_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_location_criterion.BulkAdGroupNegativeLocationCriterion(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Negative Location 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 Location Criterion record in a bulk file.

For more information, see Ad Group Negative Location Criterion 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.target_criterions.bulk_ad_group_negative_profile_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_profile_criterion.BulkAdGroupNegativeCompanyNameCriterion(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

Bases: bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_profile_criterion.BulkAdGroupNegativeProfileCriterion

Represents an Ad Group Negative CompanyName 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 CompanyName Criterion record in a bulk file.

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

See also:

profile_type()[source]
class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_profile_criterion.BulkAdGroupNegativeIndustryCriterion(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

Bases: bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_profile_criterion.BulkAdGroupNegativeProfileCriterion

Represents an Ad Group Negative Industry 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 Industry Criterion record in a bulk file.

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

See also:

profile_type()[source]
class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_profile_criterion.BulkAdGroupNegativeJobFunctionCriterion(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

Bases: bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_profile_criterion.BulkAdGroupNegativeProfileCriterion

Represents an Ad Group Negative JobFunction 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 JobFunction Criterion record in a bulk file.

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

See also:

profile_type()[source]
class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_negative_profile_criterion.BulkAdGroupNegativeProfileCriterion(negative_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Negative Profile 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 Profile Criterion record in a bulk file.

For more information, see Ad Group Negative Profile Criterion 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.)

abstract profile_type()[source]
read_additional_data(stream_reader)[source]

bingads.v13.bulk.entities.target_criterions.bulk_ad_group_profile_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_profile_criterion.BulkAdGroupCompanyNameCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

Bases: bingads.v13.bulk.entities.target_criterions.bulk_ad_group_profile_criterion.BulkAdGroupProfileCriterion

Represents an Ad Group CompanyName 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 CompanyName Criterion record in a bulk file.

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

See also:

profile_type()[source]
class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_profile_criterion.BulkAdGroupIndustryCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

Bases: bingads.v13.bulk.entities.target_criterions.bulk_ad_group_profile_criterion.BulkAdGroupProfileCriterion

Represents an Ad Group Industry 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 Industry Criterion record in a bulk file.

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

See also:

profile_type()[source]
class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_profile_criterion.BulkAdGroupJobFunctionCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

Bases: bingads.v13.bulk.entities.target_criterions.bulk_ad_group_profile_criterion.BulkAdGroupProfileCriterion

Represents an Ad Group JobFunction 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 JobFunction Criterion record in a bulk file.

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

See also:

profile_type()[source]
class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_profile_criterion.BulkAdGroupProfileCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

The base class for Ad Group level profile 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 in a bulk file.

For more information, see Bulk File Schema 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.target_criterions.bulk_ad_group_radius_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_ad_group_radius_criterion.BulkAdGroupRadiusCriterion(biddable_ad_group_criterion=None, campaign_name=None, ad_group_name=None)[source]

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

Represents an Ad Group Radius 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 Radius Criterion record in a bulk file.

For more information, see Ad Group Radius Criterion 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.target_criterions.bulk_campaign_age_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_campaign_age_criterion.BulkCampaignAgeCriterion(biddable_campaign_criterion=None, campaign_name=None)[source]

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

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

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

For more information, see Campaign Age Criterion 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.target_criterions.bulk_campaign_biddable_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_campaign_biddable_criterion.BulkCampaignBiddableCriterion(biddable_campaign_criterion=None, campaign_name=None)[source]

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

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

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

See also:

property biddable_campaign_criterion

Defines a Campaign Criterion

property campaign_name

The name of the Campaign

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.target_criterions.bulk_campaign_day_time_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_campaign_day_time_criterion.BulkCampaignDayTimeCriterion(biddable_campaign_criterion=None, campaign_name=None)[source]

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

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

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

For more information, see Campaign Day Time Criterion 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.target_criterions.bulk_campaign_deal_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_campaign_deal_criterion.BulkCampaignDealCriterion(biddable_campaign_criterion=None, campaign_name=None)[source]

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

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

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

For more information, see Campaign Deal Criterion 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.target_criterions.bulk_campaign_device_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_campaign_device_criterion.BulkCampaignDeviceCriterion(biddable_campaign_criterion=None, campaign_name=None)[source]

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

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

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

For more information, see Campaign Device Criterion 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.target_criterions.bulk_campaign_gender_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_campaign_gender_criterion.BulkCampaignGenderCriterion(biddable_campaign_criterion=None, campaign_name=None)[source]

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

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

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

For more information, see Campaign Gender Criterion 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.target_criterions.bulk_campaign_location_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_campaign_location_criterion.BulkCampaignLocationCriterion(biddable_campaign_criterion=None, campaign_name=None)[source]

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

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

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

For more information, see Campaign Location Criterion 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.target_criterions.bulk_campaign_location_intent_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_campaign_location_intent_criterion.BulkCampaignLocationIntentCriterion(biddable_campaign_criterion=None, campaign_name=None)[source]

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

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

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

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

See also:

property biddable_campaign_criterion

Defines a 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]

bingads.v13.bulk.entities.target_criterions.bulk_campaign_negative_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_campaign_negative_criterion.BulkCampaignNegativeCriterion(negative_campaign_criterion=None, campaign_name=None)[source]

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

Represents an Campaign Negative 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 Criterion record in a bulk file.

See also:

property campaign_name

The name of the Campaign

Return type

str

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

bingads.v13.bulk.entities.target_criterions.bulk_campaign_negative_location_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_campaign_negative_location_criterion.BulkCampaignNegativeLocationCriterion(negative_campaign_criterion=None, campaign_name=None)[source]

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

Represents an Campaign Negative Location 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 Location Criterion record in a bulk file.

For more information, see Campaign Negative Location Criterion 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.target_criterions.bulk_campaign_profile_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_campaign_profile_criterion.BulkCampaignCompanyNameCriterion(biddable_campaign_criterion=None, campaign_name=None)[source]

Bases: bingads.v13.bulk.entities.target_criterions.bulk_campaign_profile_criterion.BulkCampaignProfileCriterion

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

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

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

See also:

profile_type()[source]
class bingads.v13.bulk.entities.target_criterions.bulk_campaign_profile_criterion.BulkCampaignIndustryCriterion(biddable_campaign_criterion=None, campaign_name=None)[source]

Bases: bingads.v13.bulk.entities.target_criterions.bulk_campaign_profile_criterion.BulkCampaignProfileCriterion

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

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

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

See also:

profile_type()[source]
class bingads.v13.bulk.entities.target_criterions.bulk_campaign_profile_criterion.BulkCampaignJobFunctionCriterion(biddable_campaign_criterion=None, campaign_name=None)[source]

Bases: bingads.v13.bulk.entities.target_criterions.bulk_campaign_profile_criterion.BulkCampaignProfileCriterion

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

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

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

See also:

profile_type()[source]
class bingads.v13.bulk.entities.target_criterions.bulk_campaign_profile_criterion.BulkCampaignProfileCriterion(biddable_campaign_criterion=None, campaign_name=None)[source]

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

The base class for campaign level profile criterion that can be read or written in a bulk file.

This class exposes the biddable_campaign_criterion property that can be read and written in a bulk file.

For more information, see Bulk File Schema 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.)

abstract profile_type()[source]
read_additional_data(stream_reader)[source]

bingads.v13.bulk.entities.target_criterions.bulk_campaign_radius_criterion module

class bingads.v13.bulk.entities.target_criterions.bulk_campaign_radius_criterion.BulkCampaignRadiusCriterion(biddable_campaign_criterion=None, campaign_name=None)[source]

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

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

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

For more information, see Campaign Radius Criterion 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]

Module contents