bingads.v13.bulk.entities.labels package

Submodules

bingads.v13.bulk.entities.labels.bulk_label module

class bingads.v13.bulk.entities.labels.bulk_label.BulkLabel(label=None, status=None)[source]

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

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

This class exposes the label 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 label

The Label Data Object of the Campaign Management Service.

A subset of Label properties are available in the Ad Group record.

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.labels.bulk_label_associations module

class bingads.v13.bulk.entities.labels.bulk_label_associations.BulkAdGroupLabel(label_association=None, status=None, campaign=None, ad_group=None)[source]

Bases: bingads.v13.bulk.entities.labels.bulk_label_associations._BulkLabelAssociation

Represents a AdGroup label.

Defines an association record between a AdGroup and a Label that can be uploaded and downloaded in a bulk file.

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

See also:

property ad_group

The ad group name of the Campaign Management Service.

A subset of Label properties are available in the Ad Group record.

property campaign

The campaign name of the Campaign Management Service.

A subset of Label properties are available in the Ad Group record.

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.labels.bulk_label_associations.BulkAppInstallAdLabel(label_association=None, status=None)[source]

Bases: bingads.v13.bulk.entities.labels.bulk_label_associations._BulkLabelAssociation

Represents a AppInstallAd label.

Defines an association record between a AppInstallAd and a Label that can be uploaded and downloaded in a bulk file.

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

See also:

class bingads.v13.bulk.entities.labels.bulk_label_associations.BulkCampaignLabel(label_association=None, status=None, campaign=None)[source]

Bases: bingads.v13.bulk.entities.labels.bulk_label_associations._BulkLabelAssociation

Represents a campaign label.

Defines an association record between a Campaign and a Label that can be uploaded and downloaded in a bulk file.

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

See also:

property campaign

The campaign name of the Campaign Management Service.

A subset of Label properties are available in the Ad Group record.

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.labels.bulk_label_associations.BulkDynamicSearchAdLabel(label_association=None, status=None)[source]

Bases: bingads.v13.bulk.entities.labels.bulk_label_associations._BulkLabelAssociation

Represents a DynamicSearchAd label.

Defines an association record between a DynamicSearchAd and a Label that can be uploaded and downloaded in a bulk file.

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

See also:

class bingads.v13.bulk.entities.labels.bulk_label_associations.BulkExpandedTextAdLabel(label_association=None, status=None)[source]

Bases: bingads.v13.bulk.entities.labels.bulk_label_associations._BulkLabelAssociation

Represents a ExpandedTextAd label.

Defines an association record between a ExpandedTextAd and a Label that can be uploaded and downloaded in a bulk file.

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

See also:

class bingads.v13.bulk.entities.labels.bulk_label_associations.BulkKeywordLabel(label_association=None, status=None)[source]

Bases: bingads.v13.bulk.entities.labels.bulk_label_associations._BulkLabelAssociation

Represents a Keyword label.

Defines an association record between a Keyword and a Label that can be uploaded and downloaded in a bulk file.

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

See also:

class bingads.v13.bulk.entities.labels.bulk_label_associations.BulkProductAdLabel(label_association=None, status=None)[source]

Bases: bingads.v13.bulk.entities.labels.bulk_label_associations._BulkLabelAssociation

Represents a ProductAd label.

Defines an association record between a ProductAd and a Label that can be uploaded and downloaded in a bulk file.

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

See also:

class bingads.v13.bulk.entities.labels.bulk_label_associations.BulkResponsiveAdLabel(label_association=None, status=None)[source]

Bases: bingads.v13.bulk.entities.labels.bulk_label_associations._BulkLabelAssociation

Represents a ResponsiveAd label.

Defines an association record between a ResponsiveAd and a Label that can be uploaded and downloaded in a bulk file.

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

See also:

class bingads.v13.bulk.entities.labels.bulk_label_associations.BulkResponsiveSearchAdLabel(label_association=None, status=None)[source]

Bases: bingads.v13.bulk.entities.labels.bulk_label_associations._BulkLabelAssociation

Represents a ResponsiveSearchAd label.

Defines an association record between a ResponsiveSearchAd and a Label that can be uploaded and downloaded in a bulk file.

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

See also:

class bingads.v13.bulk.entities.labels.bulk_label_associations.BulkTextAdLabel(label_association=None, status=None)[source]

Bases: bingads.v13.bulk.entities.labels.bulk_label_associations._BulkLabelAssociation

Represents a TextAd label.

Defines an association record between a TextAd and a Label that can be uploaded and downloaded in a bulk file.

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

See also:

Module contents