As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Ads Admanager v1 API¶

class google.ads.admanager_v1.types.AdManagerError(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

/ AdManagerError contains all the information required for processing a / particular error thrown by the AdManager API. / / At least one AdManagerError should be included in all error messages sent to / the client.

error_code¶

The unique identifying string for this error.

Type: str

message¶

A publisher appropriate explanation of this error.

Type: str

field_path¶

The field path that triggered this error.

Type: str

trigger¶

The value that triggered this error.

Type: str

stack_trace¶

The stack trace that accompanies this error.

Type: str

details¶

A list of messages that carry any additional error details.

Type: MutableSequence[google.protobuf.any_pb2.Any]

class google.ads.admanager_v1.types.AdUnit(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The AdUnit resource.

name¶

Identifier. The resource name of the AdUnit. Format: networks/{network_code}/adUnits/{ad_unit_id}

Type: str

ad_unit_id¶

Output only. AdUnit ID.

Type: int

parent_ad_unit¶

Required. Immutable. The AdUnit’s parent. Every ad unit has a parent except for the root ad unit, which is created by Google. Format: “networks/{network_code}/adUnits/{ad_unit_id}”.

Type: str

parent_path¶

Output only. The path to this AdUnit in the ad unit hierarchy represented as a list from the root to this ad unit’s parent. For root ad units, this list is empty.

Type: MutableSequence[google.ads.admanager_v1.types.AdUnitParent]

display_name¶

Required. The display name of the ad unit. Its maximum length is 255 characters.

Type: str

ad_unit_code¶

Immutable. A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based on the ad unit ID.

Type: str

status¶

Output only. The status of this ad unit. It defaults to ACTIVE.

Type: google.ads.admanager_v1.types.AdUnitStatusEnum.AdUnitStatus

applied_target_window¶

Optional. The target window directly applied to this AdUnit. If this field is not set, this AdUnit uses the target window specified in effectiveTargetWindow.

Type: google.ads.admanager_v1.types.TargetWindowEnum.TargetWindow

effective_target_window¶

Output only. Non-empty default. The target window of this AdUnit. This value is inherited from ancestor AdUnits and defaults to TOP if no AdUnit in the hierarchy specifies it.

Type: google.ads.admanager_v1.types.TargetWindowEnum.TargetWindow

applied_teams¶

Optional. The resource names of Teams directly applied to this AdUnit. Format: “networks/{network_code}/teams/{team_id}”.

Type: MutableSequence[str]

teams¶

Output only. The resource names of all Teams that this AdUnit is on as well as those inherited from parent AdUnits. Format: “networks/{network_code}/teams/{team_id}”.

Type: MutableSequence[str]

description¶

Optional. A description of the ad unit. The maximum length is 65,535 characters.

Type: str

explicitly_targeted¶

Optional. If this field is set to true, then the AdUnit will not be implicitly targeted when its parent is. Traffickers must explicitly target such an AdUnit or else no line items will serve to it. This feature is only available for Ad Manager 360 accounts.

Type: bool

has_children¶

Output only. This field is set to true if the ad unit has any children.

Type: bool

update_time¶

Output only. The time this AdUnit was last modified.

Type: google.protobuf.timestamp_pb2.Timestamp

ad_unit_sizes¶

Optional. The sizes that can be served inside this ad unit.

Type: MutableSequence[google.ads.admanager_v1.types.AdUnitSize]

external_set_top_box_channel_id¶

Optional. Determines what set top box video on demand channel this ad unit corresponds to in an external set top box ad campaign system.

Type: str

refresh_delay¶

Optional. The duration after which an Ad Unit will automatically refresh. This is only valid for ad units in mobile apps. If not set, the ad unit will not refresh.

Type: google.protobuf.duration_pb2.Duration

applied_labels¶

Optional. The set of labels applied directly to this ad unit.

Type: MutableSequence[google.ads.admanager_v1.types.AppliedLabel]

effective_applied_labels¶

Output only. Contains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.

Type: MutableSequence[google.ads.admanager_v1.types.AppliedLabel]

applied_label_frequency_caps¶

Optional. The set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.

Type: MutableSequence[google.ads.admanager_v1.types.LabelFrequencyCap]

effective_label_frequency_caps¶

Output only. The label frequency caps applied directly to the ad unit as well as those inherited from parent ad units.

Type: MutableSequence[google.ads.admanager_v1.types.LabelFrequencyCap]

smart_size_mode¶

Optional. The smart size mode for this ad unit. This attribute is optional and defaults to SmartSizeMode.NONE for fixed sizes.

Type: google.ads.admanager_v1.types.SmartSizeModeEnum.SmartSizeMode

applied_adsense_enabled¶

Optional. The value of AdSense enabled directly applied to this ad unit. This attribute is optional and if not specified this ad unit will inherit the value of effectiveAdsenseEnabled from its ancestors.

This field is a member of oneof _applied_adsense_enabled.

Type: bool

effective_adsense_enabled¶

Output only. Specifies whether or not the AdUnit is enabled for serving ads from the AdSense content network. This attribute defaults to the ad unit’s parent or ancestor’s setting if one has been set. If no ancestor of the ad unit has set appliedAdsenseEnabled, the attribute is defaulted to true.

Type: bool

class google.ads.admanager_v1.types.AdUnitParent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The summary of a parent AdUnit.

parent_ad_unit¶

Output only. The parent of the current AdUnit Format: networks/{network_code}/adUnits/{ad_unit_id}

Type: str

display_name¶

Output only. The display name of the parent AdUnit.

Type: str

ad_unit_code¶

Output only. A string used to uniquely identify the ad unit for the purposes of serving the ad.

Type: str

class google.ads.admanager_v1.types.AdUnitSize(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represents the size, environment, and companions of an ad in an ad unit.

size¶

Required. The Size of the AdUnit.

Type: google.ads.admanager_v1.types.Size

environment_type¶

Required. The EnvironmentType of the AdUnit

Type: google.ads.admanager_v1.types.EnvironmentTypeEnum.EnvironmentType

companions¶

The companions for this ad unit size. Companions are only valid if the environment is [VIDEO_PLAYER][google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType].

Type: MutableSequence[google.ads.admanager_v1.types.Size]

class google.ads.admanager_v1.types.AdUnitStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [AdUnitStatus][google.ads.admanager.v1.AdUnitStatusEnum.AdUnitStatus]

class AdUnitStatus(value)[source]¶

Bases: proto.enums.Enum

The status of an AdUnit.

Values:

AD_UNIT_STATUS_UNSPECIFIED (0):: Default value. This value is unused.
ACTIVE (1):: The ad unit is active, available for targeting, and serving.
INACTIVE (2):: The ad unit will be visible in the UI, but ignored by serving.
ARCHIVED (3):: The ad unit will be hidden in the UI and ignored by serving.

class google.ads.admanager_v1.types.AppliedLabel(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represents a Label that can be applied to an entity.

label¶

Required. The label to be applied. Format: “networks/{network_code}/labels/{label_id}”.

Type: str

negated¶

Specifies whether or not to negate the effects of the label.

Type: bool

class google.ads.admanager_v1.types.BatchCreateEntitySignalsMappingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for BatchCreateEntitySignalsMappings method.

parent¶

Required. The parent resource where EntitySignalsMappings will be created. Format: networks/{network_code} The parent field in the CreateEntitySignalsMappingRequest must match this field.

Type: str

requests¶

Required. The EntitySignalsMapping objects to create. A maximum of 100 objects can be created in a batch.

Type: MutableSequence[google.ads.admanager_v1.types.CreateEntitySignalsMappingRequest]

class google.ads.admanager_v1.types.BatchCreateEntitySignalsMappingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for BatchCreateEntitySignalsMappings method.

entity_signals_mappings¶

The EntitySignalsMapping objects created.

Type: MutableSequence[google.ads.admanager_v1.types.EntitySignalsMapping]

class google.ads.admanager_v1.types.BatchUpdateEntitySignalsMappingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for BatchUpdateEntitySignalsMappings method.

parent¶

Required. The parent resource where EntitySignalsMappings will be updated. Format: networks/{network_code} The parent field in the UpdateEntitySignalsMappingRequest must match this field.

Type: str

requests¶

Required. The EntitySignalsMapping objects to update. A maximum of 100 objects can be updated in a batch.

Type: MutableSequence[google.ads.admanager_v1.types.UpdateEntitySignalsMappingRequest]

class google.ads.admanager_v1.types.BatchUpdateEntitySignalsMappingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for BatchUpdateEntitySignalsMappings method.

entity_signals_mappings¶

The EntitySignalsMapping objects updated.

Type: MutableSequence[google.ads.admanager_v1.types.EntitySignalsMapping]

class google.ads.admanager_v1.types.Company(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The Company resource.

name¶

Identifier. The resource name of the Company. Format: networks/{network_code}/companies/{company_id}

Type: str

company_id¶

Output only. Company ID.

Type: int

display_name¶

Required. The display name of the Company.

This value has a maximum length of 127 characters.

Type: str

type_¶

Required. The type of the Company.

Type: google.ads.admanager_v1.types.CompanyTypeEnum.CompanyType

address¶

Optional. The address for the Company.

This value has a maximum length of 1024 characters.

Type: str

email¶

Optional. The email for the Company.

This value has a maximum length of 128 characters.

Type: str

fax¶

Optional. The fax number for the Company.

This value has a maximum length of 63 characters.

Type: str

phone¶

Optional. The phone number for the Company.

This value has a maximum length of 63 characters.

Type: str

external_id¶

Optional. The external ID for the Company.

This value has a maximum length of 255 characters.

Type: str

comment¶

Optional. Comments about the Company.

This value has a maximum length of 1024 characters.

Type: str

credit_status¶

Optional. The credit status of the Company.

This attribute defaults to ACTIVE if basic settings are enabled and ON_HOLD if advance settings are enabled.

Type: google.ads.admanager_v1.types.CompanyCreditStatusEnum.CompanyCreditStatus

applied_labels¶

Optional. The labels that are directly applied to the Company.

Type: MutableSequence[google.ads.admanager_v1.types.AppliedLabel]

primary_contact¶

Optional. The resource names of primary Contact of the Company. Format: “networks/{network_code}/contacts/{contact_id}”.

This field is a member of oneof _primary_contact.

Type: str

applied_teams¶

Optional. The resource names of Teams that are directly associated with the Company. Format: “networks/{network_code}/teams/{team_id}”.

Type: MutableSequence[str]

update_time¶

Output only. The time the Company was last modified.

Type: google.protobuf.timestamp_pb2.Timestamp

third_party_company_id¶

Optional. The ID of the Google-recognized canonicalized form of the Company.

Type: int

class google.ads.admanager_v1.types.CompanyCreditStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [CompanyCreditStatus][google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus]

class CompanyCreditStatus(value)[source]¶

Bases: proto.enums.Enum

The credit status of a company.

Credit statuses specify the credit-worthiness of a company and affect the ad serving of campaigns belonging to the company.

In basic settings, only the [ACTIVE][google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus.ACTIVE] and [INACTIVE][google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus.INACTIVE] credit statuses are applicable. In advance settings, all credit statuses are applicable.

Values:

COMPANY_CREDIT_STATUS_UNSPECIFIED (0):

No value specified

ACTIVE (1):

The company’s credit status is active.

Line items belonging to the company can serve.

This credit status is the default for basic settings and is available in both basic and advance settings.

INACTIVE (2):

The company’s credit status is inactive.

Line items belonging to the company cannot be activated. However, line items that were activated before the credit status changed will remain active. New orders or line items belonging to the company cannot be created.

Companies with this credit status will be hidden by default in company search results.

This credit status is available in both basic and advance settings.

ON_HOLD (3):

The company’s credit status is on hold.

Line items belonging to the company cannot be activated. However, line items that were activated before the credit status changed will remain active. New orders or line items belonging to the company can be created.

This credit status is the default in advance settings and is only available in advance settings.

STOP (4):

The company’s credit status is stopped.

Line items belonging to the company cannot be activated. However, line items that were activated before the credit status changed will remain active. New orders or line items belonging to the company cannot be created.

This credit status is only available in advance settings.

BLOCKED (5):

The company’s credit status is blocked.

All active line items belonging to the company will stop serving with immediate effect. Line items belonging to the company cannot be activated, and new orders or line items belonging to the company cannot be created.

This credit status is only available in advance settings.

class google.ads.admanager_v1.types.CompanyTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [CompanyType][google.ads.admanager.v1.CompanyTypeEnum.CompanyType]

class CompanyType(value)[source]¶

Bases: proto.enums.Enum

The type of a company.

Values:

COMPANY_TYPE_UNSPECIFIED (0):: No value specified
ADVERTISER (1):: A business entity that purchases ad inventory.
HOUSE_ADVERTISER (2):: A company representing the publisher’s own advertiser for house ads.
AGENCY (3):: An organization that manages ad accounts and offers services, such as ad creation, placement, and management to advertisers.
HOUSE_AGENCY (4):: A company representing the publisher’s own agency.
AD_NETWORK (5):: A company representing multiple advertisers and agencies.

class google.ads.admanager_v1.types.Contact(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A contact represents a person who is affiliated with a single company. A contact can have a variety of contact information associated to it, and can be invited to view their company’s orders, line items, creatives, and reports.

name¶

Identifier. The resource name of the Contact. Format: networks/{network_code}/contacts/{contact_id}

Type: str

contact_id¶

Output only. The unique ID of the contact. This value is readonly and is assigned by Google.

Type: int

class google.ads.admanager_v1.types.CreateEntitySignalsMappingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ‘CreateEntitySignalsMapping’ method.

parent¶

Required. The parent resource where this EntitySignalsMapping will be created. Format: networks/{network_code}

Type: str

entity_signals_mapping¶

Required. The EntitySignalsMapping object to create.

Type: google.ads.admanager_v1.types.EntitySignalsMapping

class google.ads.admanager_v1.types.CreateReportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for CreateReport method.

parent¶

Required. The parent resource where this Report will be created. Format: networks/{network_code}

Type: str

report¶

Required. The Report to create.

Type: google.ads.admanager_v1.types.Report

class google.ads.admanager_v1.types.CustomField(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

An additional, user-created field on an entity.

name¶

Identifier. The resource name of the CustomField. Format: networks/{network_code}/customFields/{custom_field_id}

Type: str

custom_field_id¶

Output only. Unique ID of the CustomField. This value is readonly and is assigned by Google.

Type: int

display_name¶

Required. Name of the CustomField. The max length is 127 characters.

Type: str

description¶

Optional. A description of the custom field. The maximum length is 511 characters.

Type: str

status¶

Output only. The status of the CustomField.

Type: google.ads.admanager_v1.types.CustomFieldStatusEnum.CustomFieldStatus

entity_type¶

Required. The type of entity the CustomField can be applied to.

Type: google.ads.admanager_v1.types.CustomFieldEntityTypeEnum.CustomFieldEntityType

data_type¶

Required. The data type of the CustomField.

Type: google.ads.admanager_v1.types.CustomFieldDataTypeEnum.CustomFieldDataType

visibility¶

Required. The visibility of the CustomField.

Type: google.ads.admanager_v1.types.CustomFieldVisibilityEnum.CustomFieldVisibility

options¶

Optional. The drop-down options for the CustomField.

Only applicable for CustomField with the drop-down data type.

Type: MutableSequence[google.ads.admanager_v1.types.CustomFieldOption]

class google.ads.admanager_v1.types.CustomFieldDataTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [CustomFieldDataType][google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataType]

class CustomFieldDataType(value)[source]¶

Bases: proto.enums.Enum

The data type for a CustomField.

Values:

CUSTOM_FIELD_DATA_TYPE_UNSPECIFIED (0):

No value specified

STRING (1):

A string field

The max length is 255 characters.

NUMBER (2):

A number field.

TOGGLE (3):

A “Yes” or “No” toggle field.

DROP_DOWN (4):

A drop-down field.

class google.ads.admanager_v1.types.CustomFieldEntityTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [CustomFieldEntityType][google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityType]

class CustomFieldEntityType(value)[source]¶

Bases: proto.enums.Enum

The types of entities that a CustomField can be applied to.

Values:

CUSTOM_FIELD_ENTITY_TYPE_UNSPECIFIED (0):: No value specified
LINE_ITEM (1):: The CustomField is applied to LineItems.
ORDER (2):: The CustomField is applied to Orders.
CREATIVE (3):: The CustomField is applied to Creatives.
PROPOSAL (4):: The CustomField is applied to Proposals.
PROPOSAL_LINE_ITEM (5):: The CustomField is applied to ProposalLineItems.

class google.ads.admanager_v1.types.CustomFieldOption(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

An option for a drop-down CustomField.

custom_field_option_id¶

Output only. CustomFieldOption ID.

Type: int

display_name¶

Required. The display name of the CustomFieldOption.

This value has a maximum length of 127 characters.

Type: str

class google.ads.admanager_v1.types.CustomFieldStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [CustomFieldStatus][google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatus]

class CustomFieldStatus(value)[source]¶

Bases: proto.enums.Enum

The status of the CustomField.

Values:

CUSTOM_FIELD_STATUS_UNSPECIFIED (0):: No value specified
ACTIVE (1):: The CustomField is active.
INACTIVE (2):: The CustomField is inactive.

class google.ads.admanager_v1.types.CustomFieldValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A value for a CustomField on a resource.

custom_field¶

Required. The custom field for which this is a value. Format: “networks/{network_code}/customFields/{custom_field_id}”.

Type: str

value¶

Required. A typed value representation of the value.

This field is a member of oneof _value.

Type: google.ads.admanager_v1.types.CustomFieldValue.Value

class Value(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represent custom field value type. Next Id: 5

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

dropdown_value¶

The custom_field_option_id, if the CustomFieldDataType is DROPDOWN.

This field is a member of oneof value.

Type: int

string_value¶

The value, if the CustomFieldDataType is STRING.

This field is a member of oneof value.

Type: str

number_value¶

The value, if the CustomFieldDataType is NUMBER.

This field is a member of oneof value.

Type: float

toggle_value¶

The value, if the CustomFieldDataType is TOGGLE.

This field is a member of oneof value.

Type: bool

class google.ads.admanager_v1.types.CustomFieldVisibilityEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [CustomFieldVisibility][google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility]

class CustomFieldVisibility(value)[source]¶

Bases: proto.enums.Enum

The visibility level of a CustomField.

Values:

CUSTOM_FIELD_VISIBILITY_UNSPECIFIED (0):: No value specified
HIDDEN (1):: The CustomField is not visible in the UI and only visible through the API.
READ_ONLY (2):: The CustomField is visible in the UI and only editable through the API.
EDITABLE (3):: The CustomField is visible and editable in both the API and UI.

class google.ads.admanager_v1.types.CustomTargetingKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The CustomTargetingKey resource.

name¶

Identifier. The resource name of the CustomTargetingKey. Format: networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}

Type: str

custom_targeting_key_id¶

Output only. CustomTargetingKey ID.

Type: int

ad_tag_name¶

Immutable. Name of the key. Keys can contain up to 10 characters each. You can use alphanumeric characters and symbols other than the following: “, ‘, =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.

Type: str

display_name¶

Optional. Descriptive name for the CustomTargetingKey.

Type: str

type_¶

Required. Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item.

Type: google.ads.admanager_v1.types.CustomTargetingKeyTypeEnum.CustomTargetingKeyType

status¶

Output only. Status of the CustomTargetingKey.

Type: google.ads.admanager_v1.types.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus

reportable_type¶

Required. Reportable state of the CustomTargetingKey.

Type: google.ads.admanager_v1.types.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType

class google.ads.admanager_v1.types.CustomTargetingKeyReportableTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [CustomTargetingKeyReportableType][google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType]

class CustomTargetingKeyReportableType(value)[source]¶

Bases: proto.enums.Enum

Reportable type of the custom targeting key.

Values:

CUSTOM_TARGETING_KEY_REPORTABLE_TYPE_UNSPECIFIED (0):: Not specified value.
OFF (1):: Not available for reporting in the Ad Manager query tool.
ON (2):: Available for reporting in the Ad Manager query tool.
CUSTOM_DIMENSION (3):: Custom dimension available for reporting in the AdManager query tool.

class google.ads.admanager_v1.types.CustomTargetingKeyStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [CustomTargetingKeyStatus][google.ads.admanager.v1.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus]

class CustomTargetingKeyStatus(value)[source]¶

Bases: proto.enums.Enum

Status of the custom targeting key.

Values:

CUSTOM_TARGETING_KEY_STATUS_UNSPECIFIED (0):: Not specified value.
ACTIVE (1):: Custom targeting key is active.
INACTIVE (2):: Custom targeting key is inactive.

class google.ads.admanager_v1.types.CustomTargetingKeyTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [CustomTargetingKeyType][google.ads.admanager.v1.CustomTargetingKeyTypeEnum.CustomTargetingKeyType]

class CustomTargetingKeyType(value)[source]¶

Bases: proto.enums.Enum

Type of the custom targeting key.

Values:

CUSTOM_TARGETING_KEY_TYPE_UNSPECIFIED (0):: Not specified value.
PREDEFINED (1):: Key with a fixed set of values.
FREEFORM (2):: Key without a fixed set of values

class google.ads.admanager_v1.types.CustomTargetingValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The CustomTargetingValue resource.

name¶

Identifier. The resource name of the CustomTargetingValue. Format: networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}

Type: str

ad_tag_name¶

Immutable. Name of the CustomTargetingValue. Values can contain up to 40 characters each. You can use alphanumeric characters and symbols other than the following: “, ‘, =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are not data-specific; all values are treated as strings. For example, instead of using “age>=18 AND <=34”, try “18-34”.

Type: str

display_name¶

Optional. Descriptive name for the CustomTargetingValue.

Type: str

match_type¶

Required. Immutable. The way in which the CustomTargetingValue.name strings will be matched.

Type: google.ads.admanager_v1.types.CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchType

status¶

Output only. Status of the CustomTargetingValue.

Type: google.ads.admanager_v1.types.CustomTargetingValueStatusEnum.CustomTargetingValueStatus

class google.ads.admanager_v1.types.CustomTargetingValueMatchTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [CustomTargetingValueMatchType][google.ads.admanager.v1.CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchType]

class CustomTargetingValueMatchType(value)[source]¶

Bases: proto.enums.Enum

Match type of the custom targeting value.

Values:

CUSTOM_TARGETING_VALUE_MATCH_TYPE_UNSPECIFIED (0):: Not specified value.
EXACT (1):: Used for exact matching. For example, the targeting value car=honda will only match to the ad request car=honda.
BROAD (2):: Used for lenient matching when at least one of the words in the ad request matches the targeted value. The targeting value car=honda will match to ad requests containing the word honda. So ad requests car=honda or car=honda civic or car=buy honda or car=how much does a honda cost will all have the line item delivered. This match type can not be used within an audience segment rule.
PREFIX (3):: Used for ‘starts with’ matching when the first few characters in the ad request match all of the characters in the targeted value. The targeting value car=honda will match to ad requests car=honda or car=hondas for sale but not to car=I want a honda.
BROAD_PREFIX (4):: This is a combination of MatchType#BROAD and MatchType#PREFIX matching. The targeting value car=honda will match to ad requests that contain words that start with the characters in the targeted value, for example with car=civic hondas. This match type can not be used within an audience segment rule.
SUFFIX (5):: Used for ‘ends with’ matching when the last characters in the ad request match all of the characters in the targeted value. The targeting value car=honda will match with ad requests car=honda or car=I want a honda but not to car=hondas for sale. This match type can not be used within line item targeting.
CONTAINS (6):: Used for ‘within’ matching when the string in the ad request contains the string in the targeted value. The targeting value car=honda will match with ad requests car=honda, car=I want a honda, and also with car=hondas for sale, but not with car=misspelled hond a. This match type can not be used within line item targeting.

class google.ads.admanager_v1.types.CustomTargetingValueStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [CustomTargetingValueStatus][google.ads.admanager.v1.CustomTargetingValueStatusEnum.CustomTargetingValueStatus]

class CustomTargetingValueStatus(value)[source]¶

Bases: proto.enums.Enum

Status of the custom targeting value.

Values:

CUSTOM_TARGETING_VALUE_STATUS_UNSPECIFIED (0):: Not specified value.
ACTIVE (1):: Custom targeting value is active.
INACTIVE (2):: Custom targeting value is inactive.

class google.ads.admanager_v1.types.EntitySignalsMapping(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The EntitySignalsMapping resource.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

audience_segment_id¶

ID of an AudienceSegment that this mapping belongs to.

This field is a member of oneof entity.

Type: int

content_bundle_id¶

ID of a ContentBundle that this mapping belongs to.

This field is a member of oneof entity.

Type: int

custom_targeting_value_id¶

ID of a CustomValue that this mapping belongs to.

This field is a member of oneof entity.

Type: int

name¶

Identifier. The resource name of the EntitySignalsMapping. Format: networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}

Type: str

entity_signals_mapping_id¶

Output only. EntitySignalsMapping ID.

Type: int

taxonomy_category_ids¶

Required. The IDs of the categories that are associated with the referencing entity.

Type: MutableSequence[int]

class google.ads.admanager_v1.types.EnvironmentTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [EnvironmentType][google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType].

class EnvironmentType(value)[source]¶

Bases: proto.enums.Enum

The different environments in which an ad can be shown.

Values:

ENVIRONMENT_TYPE_UNSPECIFIED (0):: No value specified
BROWSER (1):: A regular web browser.
VIDEO_PLAYER (2):: Video players.

class google.ads.admanager_v1.types.FetchReportResultRowsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for the fetch report result rows endpoint.

name¶

The report result being fetched. Format: networks/{network_code}/reports/{report_id}/results/{report_result_id}

Type: str

page_size¶

Optional. The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 1,000 rows will be returned. The maximum value is 10,000; values above 10,000 will be reduced to 10,000.

Type: int

page_token¶

Optional. A page token, received from a previous FetchReportResultRows call. Provide this to retrieve the second and subsequent batches of rows.

Type: str

class google.ads.admanager_v1.types.FetchReportResultRowsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response message for the fetch report result rows endpoint.

rows¶

Up to page_size rows of report data.

Type: MutableSequence[google.ads.admanager_v1.types.Report.DataTable.Row]

run_time¶

The time at which the report was scheduled to run. For non-scheduled reports, this is the time at which the report was requested to be run.

Type: google.protobuf.timestamp_pb2.Timestamp

date_ranges¶

The computed fixed date ranges this report includes. Only returned with the first page of results (when page_token is not included in the request).

Type: MutableSequence[google.ads.admanager_v1.types.Report.DateRange.FixedDateRange]

comparison_date_ranges¶

The computed comparison fixed date ranges this report includes. Only returned with the first page of results (when page_token is not included in the request).

Type: MutableSequence[google.ads.admanager_v1.types.Report.DateRange.FixedDateRange]

total_row_count¶

The total number of rows available from this report. Useful for pagination. Only returned with the first page of results (when page_token is not included in the request).

Type: int

next_page_token¶

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

class google.ads.admanager_v1.types.FrequencyCap(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represents a Frequency Cap that can be applied to an entity.

max_impressions¶

The maximum number of impressions for this frequency cap.

This field is a member of oneof _max_impressions.

Type: int

time_amount¶

The number of time units over which the frequency cap is effective.

This field is a member of oneof _time_amount.

Type: int

time_unit¶

The units of time of this frequency cap.

This field is a member of oneof _time_unit.

Type: google.ads.admanager_v1.types.TimeUnitEnum.TimeUnit

class google.ads.admanager_v1.types.GetAdUnitRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for GetAdUnit method.

name¶

Required. The resource name of the AdUnit. Format: networks/{network_code}/adUnits/{ad_unit_id}

Type: str

class google.ads.admanager_v1.types.GetCompanyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for GetCompany method.

name¶

Required. The resource name of the Company. Format: networks/{network_code}/companies/{company_id}

Type: str

class google.ads.admanager_v1.types.GetCustomFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for GetCustomField method.

name¶

Required. The resource name of the CustomField. Format: networks/{network_code}/customFields/{custom_field_id}

Type: str

class google.ads.admanager_v1.types.GetCustomTargetingKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for GetCustomTargetingKey method.

name¶

Required. The resource name of the CustomTargetingKey. Format: networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}

Type: str

class google.ads.admanager_v1.types.GetCustomTargetingValueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for GetCustomTargetingValue method.

name¶

Required. The resource name of the CustomTargetingValue. Format: networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}

Type: str

class google.ads.admanager_v1.types.GetEntitySignalsMappingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for GetEntitySignalsMapping method.

name¶

Required. The resource name of the EntitySignalsMapping. Format: networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}

Type: str

class google.ads.admanager_v1.types.GetNetworkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request to get Network

name¶

Required. Resource name of Network. Format: networks/{network_code}

Type: str

class google.ads.admanager_v1.types.GetOrderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for GetOrder method.

name¶

Required. The resource name of the Order. Format: networks/{network_code}/orders/{order_id}

Type: str

class google.ads.admanager_v1.types.GetPlacementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for GetPlacement method.

name¶

Required. The resource name of the Placement. Format: networks/{network_code}/placements/{placement_id}

Type: str

class google.ads.admanager_v1.types.GetReportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for GetReport method.

name¶

Required. The resource name of the report. Format: networks/{network_code}/reports/{report_id}

Type: str

class google.ads.admanager_v1.types.GetRoleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for GetRole method.

name¶

Required. The resource name of the Role. Format: networks/{network_code}/roles/{role_id}

Type: str

class google.ads.admanager_v1.types.GetTaxonomyCategoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for GetTaxonomyCategory method.

name¶

Required. The resource name of the TaxonomyCategory. Format: networks/{network_code}/taxonomyCategories/{taxonomy_category_id}

Type: str

class google.ads.admanager_v1.types.GetUserRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for GetUser method.

name¶

Required. The resource name of the User. Format: networks/{network_code}/users/{user_id}

Type: str

class google.ads.admanager_v1.types.Label(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A Label is additional information that can be added to an entity.

name¶

Identifier. The resource name of the Label. Format: networks/{network_code}/labels/{label_id}

Type: str

class google.ads.admanager_v1.types.LabelFrequencyCap(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Frequency cap using a label.

label¶

Required. The label to used for frequency capping. Format: “networks/{network_code}/labels/{label_id}”.

Type: str

frequency_cap¶

The frequency cap.

Type: google.ads.admanager_v1.types.FrequencyCap

class google.ads.admanager_v1.types.ListAdUnitSizesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ListAdUnitSizes method.

parent¶

Required. The parent, which owns this collection of AdUnitSizes. Format: networks/{network_code}

Type: str

page_size¶

Optional. The maximum number of AdUnitSizes to return. The service may return fewer than this value. If unspecified, at most 50 ad unit sizes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListAdUnitSizes call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAdUnitSizes must match the call that provided the page token.

Type: str

filter¶

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Type: str

order_by¶

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

Type: str

skip¶

Optional. Number of individual resources to skip while paginating.

Type: int

class google.ads.admanager_v1.types.ListAdUnitSizesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for ListAdUnitSizesRequest containing matching AdUnitSizes.

ad_unit_sizes¶

The AdUnitSizes from the specified network.

Type: MutableSequence[google.ads.admanager_v1.types.AdUnitSize]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

total_size¶

Total number of AdUnitSizes. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.

For more information, see https://developers.google.com/ad-manager/api/beta/field-masks

Type: int

class google.ads.admanager_v1.types.ListAdUnitsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ListAdUnits method.

parent¶

Required. The parent, which owns this collection of AdUnits. Format: networks/{network_code}

Type: str

page_size¶

Optional. The maximum number of AdUnits to return. The service may return fewer than this value. If unspecified, at most 50 ad units will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListAdUnits call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAdUnits must match the call that provided the page token.

Type: str

filter¶

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Type: str

order_by¶

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

Type: str

skip¶

Optional. Number of individual resources to skip while paginating.

Type: int

class google.ads.admanager_v1.types.ListAdUnitsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for ListAdUnitsRequest containing matching AdUnit resources.

ad_units¶

The AdUnit from the specified network.

Type: MutableSequence[google.ads.admanager_v1.types.AdUnit]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

total_size¶

Total number of AdUnits. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.

For more information, see https://developers.google.com/ad-manager/api/beta/field-masks

Type: int

class google.ads.admanager_v1.types.ListCompaniesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ListCompanies method.

parent¶

Required. The parent, which owns this collection of Companies. Format: networks/{network_code}

Type: str

page_size¶

Optional. The maximum number of Companies to return. The service may return fewer than this value. If unspecified, at most 50 Companies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListCompanies call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCompanies must match the call that provided the page token.

Type: str

filter¶

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Type: str

order_by¶

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

Type: str

skip¶

Optional. Number of individual resources to skip while paginating.

Type: int

class google.ads.admanager_v1.types.ListCompaniesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for ListCompaniesRequest containing matching Company objects.

companies¶

The Company objects from the specified network.

Type: MutableSequence[google.ads.admanager_v1.types.Company]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

total_size¶

Total number of Company objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.

For more information, see https://developers.google.com/ad-manager/api/beta/field-masks

Type: int

class google.ads.admanager_v1.types.ListCustomFieldsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ListCustomFields method.

parent¶

Required. The parent, which owns this collection of CustomFields. Format: networks/{network_code}

Type: str

page_size¶

Optional. The maximum number of CustomFields to return. The service may return fewer than this value. If unspecified, at most 50 CustomFields will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListCustomFields call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCustomFields must match the call that provided the page token.

Type: str

filter¶

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Type: str

order_by¶

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

Type: str

skip¶

Optional. Number of individual resources to skip while paginating.

Type: int

class google.ads.admanager_v1.types.ListCustomFieldsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for ListCustomFieldsRequest containing matching CustomField objects.

custom_fields¶

The CustomField objects from the specified network.

Type: MutableSequence[google.ads.admanager_v1.types.CustomField]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

total_size¶

Total number of CustomField objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.

For more information, see https://developers.google.com/ad-manager/api/beta/field-masks

Type: int

class google.ads.admanager_v1.types.ListCustomTargetingKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ListCustomTargetingKeys method.

parent¶

Required. The parent, which owns this collection of CustomTargetingKeys. Format: networks/{network_code}

Type: str

page_size¶

Optional. The maximum number of CustomTargetingKeys to return. The service may return fewer than this value. If unspecified, at most 50 CustomTargetingKeys will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListCustomTargetingKeys call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCustomTargetingKeys must match the call that provided the page token.

Type: str

filter¶

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Type: str

order_by¶

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

Type: str

skip¶

Optional. Number of individual resources to skip while paginating.

Type: int

class google.ads.admanager_v1.types.ListCustomTargetingKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for ListCustomTargetingKeysRequest containing matching CustomTargetingKey objects.

custom_targeting_keys¶

The CustomTargetingKey objects from the specified network.

Type: MutableSequence[google.ads.admanager_v1.types.CustomTargetingKey]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

total_size¶

Total number of CustomTargetingKey objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.

For more information, see https://developers.google.com/ad-manager/api/beta/field-masks

Type: int

class google.ads.admanager_v1.types.ListCustomTargetingValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ListCustomTargetingValues method.

parent¶

Required. The parent, which owns this collection of CustomTargetingValues. Format: networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}

Type: str

page_size¶

Optional. The maximum number of CustomTargetingValues to return. The service may return fewer than this value. If unspecified, at most 50 CustomTargetingValues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListCustomTargetingValues call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCustomTargetingValues must match the call that provided the page token.

Type: str

filter¶

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Type: str

order_by¶

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

Type: str

skip¶

Optional. Number of individual resources to skip while paginating.

Type: int

class google.ads.admanager_v1.types.ListCustomTargetingValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for ListCustomTargetingValuesRequest containing matching CustomTargetingValue objects.

custom_targeting_values¶

The CustomTargetingValue objects from the specified network.

Type: MutableSequence[google.ads.admanager_v1.types.CustomTargetingValue]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

total_size¶

Total number of CustomTargetingValue objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.

For more information, see https://developers.google.com/ad-manager/api/beta/field-masks

Type: int

class google.ads.admanager_v1.types.ListEntitySignalsMappingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ListEntitySignalsMappings method.

parent¶

Required. The parent, which owns this collection of EntitySignalsMappings. Format: networks/{network_code}

Type: str

page_size¶

Optional. The maximum number of EntitySignalsMappings to return. The service may return fewer than this value. If unspecified, at most 50 EntitySignalsMappings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListEntitySignalsMappings call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListEntitySignalsMappings must match the call that provided the page token.

Type: str

filter¶

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Type: str

order_by¶

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

Type: str

skip¶

Optional. Number of individual resources to skip while paginating.

Type: int

class google.ads.admanager_v1.types.ListEntitySignalsMappingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for ListEntitySignalsMappingsRequest containing matching EntitySignalsMapping resources.

entity_signals_mappings¶

The EntitySignalsMapping from the specified network.

Type: MutableSequence[google.ads.admanager_v1.types.EntitySignalsMapping]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

total_size¶

Total number of EntitySignalsMappings. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.

For more information, see https://developers.google.com/ad-manager/api/beta/field-masks

Type: int

class google.ads.admanager_v1.types.ListNetworksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ListNetworks method.

class google.ads.admanager_v1.types.ListNetworksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for ListNetworks method.

networks¶

The Networks a user has access to.

Type: MutableSequence[google.ads.admanager_v1.types.Network]

class google.ads.admanager_v1.types.ListOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ListOrders method.

parent¶

Required. The parent, which owns this collection of Orders. Format: networks/{network_code}

Type: str

page_size¶

Optional. The maximum number of Orders to return. The service may return fewer than this value. If unspecified, at most 50 Orders will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListOrders call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListOrders must match the call that provided the page token.

Type: str

filter¶

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Type: str

order_by¶

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

Type: str

skip¶

Optional. Number of individual resources to skip while paginating.

Type: int

class google.ads.admanager_v1.types.ListOrdersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for ListOrdersRequest containing matching Order resources.

orders¶

The Order from the specified network.

Type: MutableSequence[google.ads.admanager_v1.types.Order]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

total_size¶

Total number of Orders. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.

For more information, see https://developers.google.com/ad-manager/api/beta/field-masks

Type: int

class google.ads.admanager_v1.types.ListPlacementsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ListPlacements method.

parent¶

Required. The parent, which owns this collection of Placements. Format: networks/{network_code}

Type: str

page_size¶

Optional. The maximum number of Placements to return. The service may return fewer than this value. If unspecified, at most 50 Placements will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListPlacements call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListPlacements must match the call that provided the page token.

Type: str

filter¶

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Type: str

order_by¶

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

Type: str

skip¶

Optional. Number of individual resources to skip while paginating.

Type: int

class google.ads.admanager_v1.types.ListPlacementsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for ListPlacementsRequest containing matching Placement objects.

placements¶

The Placement objects from the specified network.

Type: MutableSequence[google.ads.admanager_v1.types.Placement]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

total_size¶

Total number of Placement objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.

For more information, see https://developers.google.com/ad-manager/api/beta/field-masks

Type: int

class google.ads.admanager_v1.types.ListReportsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ListReports method.

parent¶

Required. The parent, which owns this collection of reports. Format: networks/{network_code}

Type: str

page_size¶

Optional. The maximum number of Reports to return. The service may return fewer than this value. If unspecified, at most 50 Reports will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListReports call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListReports must match the call that provided the page token.

Type: str

filter¶

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Type: str

order_by¶

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

Type: str

skip¶

Optional. Number of individual resources to skip while paginating.

Type: int

class google.ads.admanager_v1.types.ListReportsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for ListReportsResponse containing matching Report objects.

reports¶

The Report objects from the specified network.

Type: MutableSequence[google.ads.admanager_v1.types.Report]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

total_size¶

Total number of Report objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.

For more information, see https://developers.google.com/ad-manager/api/beta/field-masks

Type: int

class google.ads.admanager_v1.types.ListRolesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ListRoles method.

parent¶

Required. The parent, which owns this collection of Roles. Format: networks/{network_code}

Type: str

page_size¶

Optional. The maximum number of Roles to return. The service may return fewer than this value. If unspecified, at most 50 Roles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListRoles call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListRoles must match the call that provided the page token.

Type: str

filter¶

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Type: str

order_by¶

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

Type: str

skip¶

Optional. Number of individual resources to skip while paginating.

Type: int

class google.ads.admanager_v1.types.ListRolesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for ListRolesRequest containing matching Role objects.

roles¶

The Role objects from the specified network.

Type: MutableSequence[google.ads.admanager_v1.types.Role]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

total_size¶

Total number of Role objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.

For more information, see https://developers.google.com/ad-manager/api/beta/field-masks

Type: int

class google.ads.admanager_v1.types.ListTaxonomyCategoriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ListTaxonomyCategories method.

parent¶

Required. The parent, which owns this collection of TaxonomyCategories. Format: networks/{network_code}

Type: str

page_size¶

Optional. The maximum number of TaxonomyCategories to return. The service may return fewer than this value. If unspecified, at most 50 TaxonomyCategories will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListTaxonomyCategories call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTaxonomyCategories must match the call that provided the page token.

Type: str

filter¶

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Type: str

order_by¶

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

Type: str

skip¶

Optional. Number of individual resources to skip while paginating.

Type: int

class google.ads.admanager_v1.types.ListTaxonomyCategoriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response object for ListTaxonomyCategoriesRequest containing matching TaxonomyCategory objects.

taxonomy_categories¶

The TaxonomyCategory objects.

Type: MutableSequence[google.ads.admanager_v1.types.TaxonomyCategory]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

total_size¶

Total number of TaxonomyCategory objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.

For more information, see https://developers.google.com/ad-manager/api/beta/field-masks

Type: int

class google.ads.admanager_v1.types.Network(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The Network resource.

name¶

Identifier. The resource name of the Network. Format: networks/{network_code}

Type: str

display_name¶

Optional. Display name for Network.

Type: str

network_code¶

Output only. Network Code.

Type: str

property_code¶

Output only. Property code.

Type: str

time_zone¶

Output only. Time zone associated with the delivery of orders and reporting.

Type: str

currency_code¶

Output only. Primary currency code, in ISO-4217 format.

Type: str

secondary_currency_codes¶

Optional. Currency codes that can be used as an alternative to the primary currency code for trafficking Line Items.

Type: MutableSequence[str]

effective_root_ad_unit¶

Output only. Top most Ad Unit to which descendant Ad Units can be added. Format: networks/{network_code}/adUnit/{ad_unit_id}

Type: str

test_network¶

Output only. Whether this is a test network.

Type: bool

network_id¶

Output only. Network ID.

Type: int

class google.ads.admanager_v1.types.Order(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The Order resource.

name¶

Identifier. The resource name of the Order. Format: networks/{network_code}/orders/{order_id}

Type: str

order_id¶

Output only. Order ID.

Type: int

display_name¶

Required. The display name of the Order. This value has a maximum length of 255 characters.

Type: str

programmatic¶

Optional. Specifies whether or not the Order is a programmatic order.

Type: bool

trafficker¶

Required. The resource name of the User responsible for trafficking the Order. Format: “networks/{network_code}/users/{user_id}”.

Type: str

advertiser_contacts¶

Optional. The resource names of Contacts from the advertiser of this Order. Format: “networks/{network_code}/contacts/{contact_id}”.

Type: MutableSequence[str]

advertiser¶

Required. The resource name of the Company, which is of type Company.Type.ADVERTISER, to which this order belongs. Format: “networks/{network_code}/companies/{company_id}”.

Type: str

agency_contacts¶

Optional. The resource names of Contacts from the advertising Agency of this Order. Format: “networks/{network_code}/contacts/{contact_id}”.

Type: MutableSequence[str]

agency¶

Optional. The resource name of the Company, which is of type Company.Type.AGENCY, with which this order is associated. Format: “networks/{network_code}/companies/{company_id}”.

Type: str

applied_teams¶

Optional. The resource names of Teams directly applied to this Order. Format: “networks/{network_code}/teams/{team_id}”.

Type: MutableSequence[str]

effective_teams¶

Output only. The resource names of Teams applied to this Order including inherited values. Format: “networks/{network_code}/teams/{team_id}”.

Type: MutableSequence[str]

creator¶

Output only. The resource name of the User who created the Order on behalf of the advertiser. This value is assigned by Google. Format: “networks/{network_code}/users/{user_id}”.

Type: str

currency_code¶

Output only. The ISO 4217 3-letter currency code for the currency used by the Order. This value is the network’s currency code.

Type: str

start_time¶

Output only. The instant at which the Order and its associated line items are eligible to begin serving. This attribute is derived from the line item of the order that has the earliest LineItem.start_time.

Type: google.protobuf.timestamp_pb2.Timestamp

end_time¶

Output only. The instant at which the Order and its associated line items stop being served. This attribute is derived from the line item of the order that has the latest LineItem.end_time.

Type: google.protobuf.timestamp_pb2.Timestamp

unlimited_end_time¶

Output only. Indicates whether or not this Order has an end time.

Type: bool

external_order_id¶

Optional. An arbitrary ID to associate to the Order, which can be used as a key to an external system.

Type: int

archived¶

Output only. The archival status of the Order.

Type: bool

last_modified_by_app¶

Output only. The application which modified this order. This attribute is assigned by Google.

Type: str

update_time¶

Output only. The instant this Order was last modified.

Type: google.protobuf.timestamp_pb2.Timestamp

notes¶

Optional. Provides any additional notes that may annotate the Order. This attribute has a maximum length of 65,535 characters.

Type: str

po_number¶

Optional. The purchase order number for the Order. This value has a maximum length of 63 characters.

Type: str

status¶

Output only. The status of the Order.

Type: google.ads.admanager_v1.types.OrderStatusEnum.OrderStatus

salesperson¶

Optional. The resource name of the User responsible for the sales of the Order. Format: “networks/{network_code}/users/{user_id}”.

Type: str

secondary_salespeople¶

Optional. Unordered list. The resource names of the secondary salespeople associated with the order. Format: “networks/{network_code}/users/{user_id}”.

Type: MutableSequence[str]

secondary_traffickers¶

Optional. Unordered list. The resource names of the secondary traffickers associated with the order. Format: “networks/{network_code}/users/{user_id}”.

Type: MutableSequence[str]

applied_labels¶

Optional. The set of labels applied directly to this order.

Type: MutableSequence[google.ads.admanager_v1.types.AppliedLabel]

effective_applied_labels¶

Output only. Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is assigned by Google.

Type: MutableSequence[google.ads.admanager_v1.types.AppliedLabel]

custom_field_values¶

Optional. The set of custom field values to this order.

Type: MutableSequence[google.ads.admanager_v1.types.CustomFieldValue]

class google.ads.admanager_v1.types.OrderStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [OrderStatus][google.ads.admanager.v1.OrderStatusEnum.OrderStatus].

class OrderStatus(value)[source]¶

Bases: proto.enums.Enum

The status of an Order.

Values:

ORDER_STATUS_UNSPECIFIED (0):: Default value. This value is unused.
DRAFT (2):: Indicates that the Order has just been created but no approval has been requested yet.
PENDING_APPROVAL (3):: Indicates that a request for approval for the Order has been made.
APPROVED (4):: Indicates that the Order has been approved and is ready to serve.
DISAPPROVED (5):: Indicates that the Order has been disapproved and is not eligible to serve.
PAUSED (6):: This is a legacy state. Paused status should be checked on LineItems within the order.
CANCELED (7):: Indicates that the Order has been canceled and cannot serve.
DELETED (8):: Indicates that the Order has been deleted.

class google.ads.admanager_v1.types.Placement(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The Placement resource.

name¶

Identifier. The resource name of the Placement. Format: networks/{network_code}/placements/{placement_id}

Type: str

placement_id¶

Output only. Placement ID.

Type: int

display_name¶

Required. The display name of the placement. Its maximum length is 255 characters.

Type: str

description¶

Optional. A description of the Placement. This value is optional and its maximum length is 65,535 characters.

Type: str

placement_code¶

Output only. A string used to uniquely identify the Placement for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created.

Type: str

status¶

Output only. The status of the Placement. This attribute is read-only.

Type: google.ads.admanager_v1.types.PlacementStatusEnum.PlacementStatus

targeted_ad_units¶

Optional. The resource names of AdUnits that constitute the Placement. Format: “networks/{network_code}/adUnits/{ad_unit_id}”.

Type: MutableSequence[str]

update_time¶

Output only. The instant this Placement was last modified.

Type: google.protobuf.timestamp_pb2.Timestamp

class google.ads.admanager_v1.types.PlacementStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [PlacementStatus][google.ads.admanager.v1.PlacementStatusEnum.PlacementStatus]

class PlacementStatus(value)[source]¶

Bases: proto.enums.Enum

Status of the placement.

Values:

PLACEMENT_STATUS_UNSPECIFIED (0):: Not specified value.
ACTIVE (1):: Stats are collected, user-visible.
INACTIVE (2):: No stats collected, not user-visible.
ARCHIVED (3):: No stats collected, user-visible.

class google.ads.admanager_v1.types.Report(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The Report resource.

name¶

Identifier. The resource name of the report. Report resource name have the form: networks/{network_code}/reports/{report_id}

Type: str

report_id¶

Output only. Report ID.

Type: int

visibility¶

Optional. The visibility of a report.

Type: google.ads.admanager_v1.types.Report.Visibility

report_definition¶

Required. The report definition of the report.

Type: google.ads.admanager_v1.types.ReportDefinition

display_name¶

Optional. Display name for the report.

Type: str

update_time¶

Output only. The instant this report was last modified.

Type: google.protobuf.timestamp_pb2.Timestamp

create_time¶

Output only. The instant this report was created.

Type: google.protobuf.timestamp_pb2.Timestamp

locale¶

Output only. The locale of this report. Locale is set from the user’s locale at the time of the request. Locale can not be modified.

Type: str

schedule_options¶

Optional. The schedule options of this report.

Type: google.ads.admanager_v1.types.ScheduleOptions

class DataTable(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A table containing report data including dimension and metric values.

class MetricValueGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Contains all metric values requested for a single date range and set of column dimension values (returned in the columns field of the response). The order of the metrics in each field corresponds to the order of the metrics specified in the request.

primary_values¶

Data for the PRIMARY MetricValueType.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Value]

primary_percent_of_total_values¶

Data for the PRIMARY_PERCENT_OF_TOTAL MetricValueType.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Value]

comparison_values¶

Data for the COMPARISON MetricValueType.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Value]

comparison_percent_of_total_values¶

Data for the COMPARISON_PERCENT_OF_TOTAL MetricValueType.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Value]

absolute_change_values¶

Data for the ABSOLUTE_CHANGE MetricValueType.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Value]

relative_change_values¶

Data for the RELATIVE_CHANGE MetricValueType.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Value]

flag_values¶

If true, the flag’s conditions are met. If false, the flag’s conditions are not met. flag_values has the same length as flags and index i of flag_values represents the flag at index i of flags.

Type: MutableSequence[bool]

class Row(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A row of report data.

dimension_values¶

The order of the dimension values is the same as the order of the dimensions specified in the request.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Value]

metric_value_groups¶

The length of the metric_value_groups field will be equal to the length of the date_ranges field in the fetch response. The metric_value_groups field is ordered such that each index corresponds to the date_range at the same index. For example, given date_ranges [x, y], metric_value_groups will have a length of two. The first entry in metric_value_groups represents the metrics for date x and the second entry in metric_value_groups represents the metrics for date y.

Type: MutableSequence[google.ads.admanager_v1.types.Report.DataTable.MetricValueGroup]

class DateRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A date range for a report.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

fixed¶

A fixed date range.

This field is a member of oneof date_range_type.

Type: google.ads.admanager_v1.types.Report.DateRange.FixedDateRange

relative¶

A relative date range.

This field is a member of oneof date_range_type.

Type: google.ads.admanager_v1.types.Report.DateRange.RelativeDateRange

class FixedDateRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A date range between two fixed dates (inclusive of end date).

start_date¶

Required. The start date of this date range.

Type: google.type.date_pb2.Date

end_date¶

Required. The end date (inclusive) of this date range.

Type: google.type.date_pb2.Date

class RelativeDateRange(value)[source]¶

Bases: proto.enums.Enum

Options for relative date ranges.

Values:

RELATIVE_DATE_RANGE_UNSPECIFIED (0):

Default value. This value is unused.

TODAY (1):

The date the report is run.

YESTERDAY (2):

The date a day before the date that the report is run.

THIS_WEEK (3):

The full week in which this report is run. Could include dates in the future.

THIS_WEEK_TO_DATE (29):

From the beginning of the calendar week (Monday to Sunday) in which the up to and including the day the report is run.

THIS_MONTH (4):

The full month in which this report is run. Could include dates in the future.

THIS_MONTH_TO_DATE (26):

From the beginning of the calendar month in which the report is run, to up to and including the day the report is run.

THIS_QUARTER (5):

The full quarter in which this report is run. Could include dates in the future.

THIS_QUARTER_TO_DATE (27):

From the beginning of the calendar quarter in which the report is run, up to and including the day the report is run.

THIS_YEAR (6):

The full year in which this report is run. Could include dates in the future.

THIS_YEAR_TO_DATE (28):

From the beginning of the calendar year in which the report is run, to up to and including the day the report is run.

LAST_WEEK (7):

The entire previous calendar week, Monday to Sunday (inclusive), preceding the calendar week the report is run.

LAST_MONTH (8):

The entire previous calendar month preceding the calendar month the report is run.

LAST_QUARTER (9):

The entire previous calendar quarter preceding the calendar quarter the report is run.

LAST_YEAR (10):

The entire previous calendar year preceding the calendar year the report is run.

LAST_7_DAYS (11):

The 7 days preceding the day the report is run.

LAST_30_DAYS (12):

The 30 days preceding the day the report is run.

LAST_60_DAYS (13):

The 60 days preceding the day the report is run.

LAST_90_DAYS (14):

The 90 days preceding the day the report is run.

LAST_180_DAYS (15):

The 180 days preceding the day the report is run.

LAST_360_DAYS (16):

The 360 days preceding the day the report is run.

LAST_365_DAYS (17):

The 365 days preceding the day the report is run.

LAST_3_MONTHS (18):

The entire previous 3 calendar months preceding the calendar month the report is run.

LAST_6_MONTHS (19):

The entire previous 6 calendar months preceding the calendar month the report is run.

LAST_12_MONTHS (20):

The entire previous 6 calendar months preceding the calendar month the report is run.

ALL_AVAILABLE (21):

From 3 years before the report is run, to the day before the report is run, inclusive.

PREVIOUS_PERIOD (22):

Only valid when used in the comparison_date_range field. The complete period preceding the date period provided in date_range.

In the case where date_range is a FixedDateRange of N days, this will be a period of N days where the end date is the date preceding the start date of the date_range.

In the case where date_range is a RelativeDateRange, this will be a period of the same time frame preceding the date_range. In the case where the date_range does not capture the full period because a report is run in the middle of that period, this will still be the full preceding period. For example, if date_range is THIS_WEEK, but the report is run on a Wednesday, THIS_WEEK will be Monday - Wednesday, but PREVIOUS_PERIOD will be Monday - Sunday.

SAME_PERIOD_PREVIOUS_YEAR (24):

Only valid when used in the comparison_date_range field. The period starting 1 year prior to the date period provided in date_range.

In the case where date_range is a FixedDateRange, this will be a date range starting 1 year prior to the date_range start date and ending 1 year prior to the date_range end date.

In the case where date_range is a RelativeDateRange, this will be a period of the same time frame exactly 1 year prior to the date_range. In the case where the date_range does not capture the full period because a report is run in the middle of that period, this will still be the full period 1 year prior. For example, if date range is THIS_WEEK, but the report is run on a Wednesday, THIS_WEEK will be Monday - Wednesday, but SAME_PERIOD_PREVIOUS_YEAR will be Monday - Sunday.

class Dimension(value)[source]¶

Bases: proto.enums.Enum

Reporting dimensions.

Values:

DIMENSION_UNSPECIFIED (0):: Default value. This value is unused.
ADVERTISER_DOMAIN_NAME (242):: The domain name of the advertiser.
ADVERTISER_EXTERNAL_ID (228):: The ID used in an external system for advertiser identification
ADVERTISER_ID (131):: The ID of an advertiser company assigned to an order
ADVERTISER_LABELS (230):: Labels applied to the advertiser can be used for either competitive exclusion or ad exclusion
ADVERTISER_LABEL_IDS (229):: Label ids applied to the advertiser can be used for either competitive exclusion or ad exclusion
ADVERTISER_NAME (132):: The name of an advertiser company assigned to an order
ADVERTISER_PRIMARY_CONTACT (227):: The name of the contact associated with an advertiser company
AD_LOCATION (390):: Shows an ENUM value describing whether a given piece of publisher inventory was above (ATF) or below the fold (BTF) of a page.
AD_LOCATION_NAME (391):: Shows a localized string describing whether a given piece of publisher inventory was above (ATF) or below the fold (BTF) of a page.
AD_UNIT_CODE (64):: The code of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_1 (65):: The code of the first level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_10 (74):: The code of the tenth level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_11 (75):: The code of the eleventh level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_12 (76):: The code of the twelfth level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_13 (77):: The code of the thirteenth level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_14 (78):: The code of the fourteenth level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_15 (79):: The code of the fifteenth level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_16 (80):: The code of the sixteenth level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_2 (66):: The code of the second level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_3 (67):: The code of the third level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_4 (68):: The code of the fourth level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_5 (69):: The code of the fifth level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_6 (70):: The code of the sixth level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_7 (71):: The code of the seventh level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_8 (72):: The code of the eighth level ad unit of the ad unit where the ad was requested.
AD_UNIT_CODE_LEVEL_9 (73):: The code of the ninth level ad unit of the ad unit where the ad was requested.
AD_UNIT_DEPTH (101):: The depth of the ad unit’s hierarchy
AD_UNIT_ID (25):: The ID of the ad unit where the ad was requested.
AD_UNIT_ID_ALL_LEVEL (27):: The full hierarchy of ad unit IDs where the ad was requested, from root to leaf, excluding the root ad unit ID.
AD_UNIT_ID_LEVEL_1 (30):: The first level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_10 (48):: The tenth level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_11 (50):: The eleventh level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_12 (52):: The twelfth level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_13 (54):: The thirteenth level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_14 (56):: The fourteenth level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_15 (58):: The fifteenth level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_16 (60):: The sixteenth level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_2 (32):: The second level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_3 (34):: The third level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_4 (36):: The fourth level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_5 (38):: The fifth level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_6 (40):: The sixth level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_7 (42):: The seventh level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_8 (44):: The eighth level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_LEVEL_9 (46):: The ninth level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_ID_TOP_LEVEL (142):: The top-level ad unit ID of the ad unit where the ad was requested.
AD_UNIT_NAME (26):: The name of the ad unit where the ad was requested.
AD_UNIT_NAME_ALL_LEVEL (29):: The full hierarchy of ad unit names where the ad was requested, from root to leaf, excluding the root ad unit name.
AD_UNIT_NAME_LEVEL_1 (31):: The first level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_10 (49):: The tenth level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_11 (51):: The eleventh level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_12 (53):: The twelfth level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_13 (55):: The thirteenth level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_14 (57):: The fourteenth level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_15 (59):: The fifteenth level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_16 (61):: The sixteenth level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_2 (33):: The second level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_3 (35):: The third level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_4 (37):: The fourth level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_5 (39):: The fifth level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_6 (41):: The sixth level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_7 (43):: The seventh level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_8 (45):: The eighth level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_LEVEL_9 (47):: The ninth level ad unit name of the ad unit where the ad was requested.
AD_UNIT_NAME_TOP_LEVEL (143):: The top-level ad unit name of the ad unit where the ad was requested.
AD_UNIT_REWARD_AMOUNT (63):: The reward amount of the ad unit where the ad was requested.
AD_UNIT_REWARD_TYPE (62):: The reward type of the ad unit where the ad was requested.
AD_UNIT_STATUS (206):: The status of the ad unit
AD_UNIT_STATUS_NAME (207):: The name of the status of the ad unit
APP_VERSION (392):: The app version.
BACKFILL_ADVERTISER_EXTERNAL_ID (349):: The ID used in an external system for advertiser identification
BACKFILL_ADVERTISER_ID (346):: The ID of an advertiser company assigned to a backfill order
BACKFILL_ADVERTISER_LABELS (351):: Labels applied to the advertiser can be used for either competitive exclusion or ad exclusion
BACKFILL_ADVERTISER_LABEL_IDS (350):: Label ids applied to the advertiser can be used for either competitive exclusion or ad exclusion
BACKFILL_ADVERTISER_NAME (347):: The name of an advertiser company assigned to a backfill order
BACKFILL_ADVERTISER_PRIMARY_CONTACT (348):: The name of the contact associated with an advertiser company
BACKFILL_CREATIVE_BILLING_TYPE (378):: Enum value of Backfill creative billing type
BACKFILL_CREATIVE_BILLING_TYPE_NAME (379):: Localized string value of Backfill creative billing type
BACKFILL_CREATIVE_CLICK_THROUGH_URL (376):: Represents the click-through URL of a Backfill creative
BACKFILL_CREATIVE_ID (370):: The ID of a Backfill creative
BACKFILL_CREATIVE_NAME (371):: Backfill creative name
BACKFILL_CREATIVE_THIRD_PARTY_VENDOR (377):: Third party vendor name of a Backfill creative
BACKFILL_CREATIVE_TYPE (374):: Enum value of Backfill creative type
BACKFILL_CREATIVE_TYPE_NAME (375):: Localized string name of Backfill creative type
BACKFILL_LINE_ITEM_ARCHIVED (278):: Whether a Backfill line item is archived.
BACKFILL_LINE_ITEM_COMPANION_DELIVERY_OPTION (258):: Backfill line item comanion delivery option ENUM value.
BACKFILL_LINE_ITEM_COMPANION_DELIVERY_OPTION_NAME (259):: Localized Backfill line item comanion delivery option name.
BACKFILL_LINE_ITEM_COMPUTED_STATUS (296):: The computed status of the BackfillLineItem.
BACKFILL_LINE_ITEM_COMPUTED_STATUS_NAME (297):: The localized name of the computed status of the BackfillLineItem.
BACKFILL_LINE_ITEM_CONTRACTED_QUANTITY (280):: The contracted units bought for the Backfill line item.
BACKFILL_LINE_ITEM_COST_PER_UNIT (272):: The cost per unit of the Backfill line item.
BACKFILL_LINE_ITEM_COST_TYPE (264):: Backfill line item cost type ENUM value.
BACKFILL_LINE_ITEM_COST_TYPE_NAME (265):: Localized Backfill line item cost type name.
BACKFILL_LINE_ITEM_CREATIVE_END_DATE (381):: Represent the end date of a Backfill creative associated with a Backfill line item
BACKFILL_LINE_ITEM_CREATIVE_ROTATION_TYPE (290):: The creative rotation type of the BackfillLineItem.
BACKFILL_LINE_ITEM_CREATIVE_ROTATION_TYPE_NAME (291):: The localized name of the creative rotation type of the BackfillLineItem.
BACKFILL_LINE_ITEM_CREATIVE_START_DATE (380):: Represent the start date of a Backfill creative associated with a Backfill line item
BACKFILL_LINE_ITEM_CURRENCY_CODE (288):: The 3 letter currency code of the Backfill line item
BACKFILL_LINE_ITEM_DELIVERY_INDICATOR (274):: The progress made for the delivery of the Backfill line item.
BACKFILL_LINE_ITEM_DELIVERY_RATE_TYPE (292):: The delivery rate type of the BackfillLineItem.
BACKFILL_LINE_ITEM_DELIVERY_RATE_TYPE_NAME (293):: The localized name of the delivery rate type of the BackfillLineItem.
BACKFILL_LINE_ITEM_DISCOUNT_ABSOLUTE (294):: The discount of the BackfillLineItem in whole units in the BackfillLineItem’s currency code, or if unspecified the Network’s currency code.
BACKFILL_LINE_ITEM_DISCOUNT_PERCENTAGE (295):: The discount of the BackfillLineItem in percentage.
BACKFILL_LINE_ITEM_END_DATE (267):: The end date of the Backfill line item.
BACKFILL_LINE_ITEM_END_DATE_TIME (269):: The end date and time of the Backfill line item.
BACKFILL_LINE_ITEM_ENVIRONMENT_TYPE (302):: The ENUM value of the environment a Backfill line item is targeting.
BACKFILL_LINE_ITEM_ENVIRONMENT_TYPE_NAME (257):: The localized name of the environment a Backfill line item is targeting.
BACKFILL_LINE_ITEM_EXTERNAL_DEAL_ID (285):: The deal ID of the Backfill line item. Set for Programmatic Direct campaigns.
BACKFILL_LINE_ITEM_EXTERNAL_ID (273):: The external ID of the Backfill line item.
BACKFILL_LINE_ITEM_FREQUENCY_CAP (303):: The frequency cap of the Backfill line item (descriptive string).
BACKFILL_LINE_ITEM_ID (298):: Backfill line item ID.
BACKFILL_LINE_ITEM_LAST_MODIFIED_BY_APP (289):: The application that last modified the Backfill line item.
BACKFILL_LINE_ITEM_LIFETIME_CLICKS (283):: The total number of clicks delivered of the lifetime of the Backfill line item.
BACKFILL_LINE_ITEM_LIFETIME_IMPRESSIONS (282):: The total number of impressions delivered over the lifetime of the Backfill line item.
BACKFILL_LINE_ITEM_LIFETIME_VIEWABLE_IMPRESSIONS (284):: The total number of viewable impressions delivered over the lifetime of the Backfill line item.
BACKFILL_LINE_ITEM_MAKEGOOD (276):: Whether or not the Backfill line item is Makegood. Makegood refers to free inventory offered to buyers to compensate for mistakes or under-delivery in the original campaigns.
BACKFILL_LINE_ITEM_NAME (299):: Backfill line item name.
BACKFILL_LINE_ITEM_NON_CPD_BOOKED_REVENUE (286):: The cost of booking for the Backfill line item (non-CPD).
BACKFILL_LINE_ITEM_OPTIMIZABLE (277):: Whether a Backfill line item is eligible for opitimization.
BACKFILL_LINE_ITEM_PRIMARY_GOAL_TYPE (262):: Goal type ENUM value of the primary goal of the Backfill line item.
BACKFILL_LINE_ITEM_PRIMARY_GOAL_TYPE_NAME (263):: Localized goal type name of the primary goal of the Backfill line item.
BACKFILL_LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE (260):: Unit type ENUM value of the primary goal of the Backfill line item.
BACKFILL_LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE_NAME (261):: Localized unit type name of the primary goal of the Backfill line item.
BACKFILL_LINE_ITEM_PRIORITY (266):: The priority of this Backfill line item as a value between 1 and 16. In general, a lower priority means more serving priority for the Backfill line item.
BACKFILL_LINE_ITEM_RESERVATION_STATUS (306):: ENUM value describing the state of inventory reservation for the BackfillLineItem.
BACKFILL_LINE_ITEM_RESERVATION_STATUS_NAME (307):: Localized string describing the state of inventory reservation for the BackfillLineItem.
BACKFILL_LINE_ITEM_START_DATE (268):: The start date of the Backfill line item.
BACKFILL_LINE_ITEM_START_DATE_TIME (270):: The start date and time of the Backfill line item.
BACKFILL_LINE_ITEM_TYPE (300):: Backfill line item type ENUM value.
BACKFILL_LINE_ITEM_TYPE_NAME (301):: Localized Backfill line item type name.
BACKFILL_LINE_ITEM_UNLIMITED_END (271):: Whether the Backfill line item end time and end date is set to effectively never end.
BACKFILL_LINE_ITEM_VALUE_COST_PER_UNIT (275):: The artificial cost per unit used by the Ad server to help rank inventory.
BACKFILL_LINE_ITEM_WEB_PROPERTY_CODE (287):: The web property code used for dynamic allocation Backfill line items.
BACKFILL_MASTER_COMPANION_CREATIVE_ID (372):: The ID of Backfill creative, includes regular creatives, and master and companions in case of creative sets
BACKFILL_MASTER_COMPANION_CREATIVE_NAME (373):: Name of Backfill creative, includes regular creatives, and master and companions in case of creative sets
BACKFILL_ORDER_AGENCY (313):: Backfill order agency.
BACKFILL_ORDER_AGENCY_ID (314):: Backfill order agency ID.
BACKFILL_ORDER_BOOKED_CPC (315):: Backfill order booked CPC.
BACKFILL_ORDER_BOOKED_CPM (316):: Backfill order booked CPM.
BACKFILL_ORDER_DELIVERY_STATUS (340):: Backfill order delivery status ENUM value.
BACKFILL_ORDER_DELIVERY_STATUS_NAME (341):: Backfill order delivery status localized name.
BACKFILL_ORDER_END_DATE (317):: Backfill order end date.
BACKFILL_ORDER_END_DATE_TIME (319):: Backfill order end date and time.
BACKFILL_ORDER_EXTERNAL_ID (320):: Backfill order external ID.
BACKFILL_ORDER_ID (338):: Backfill order id.
BACKFILL_ORDER_LABELS (334):: Backfill order labels.
BACKFILL_ORDER_LABEL_IDS (335):: Backfill order labels IDs.
BACKFILL_ORDER_LIFETIME_CLICKS (322):: Backfill order lifetime clicks.
BACKFILL_ORDER_LIFETIME_IMPRESSIONS (323):: Backfill order lifetime impressions.
BACKFILL_ORDER_NAME (339):: Backfill order name.
BACKFILL_ORDER_PO_NUMBER (324):: Backfill order PO number.
BACKFILL_ORDER_PROGRAMMATIC (321):: Whether the Backfill order is programmatic.
BACKFILL_ORDER_SALESPERSON (325):: Backfill order sales person.
BACKFILL_ORDER_SECONDARY_SALESPEOPLE (329):: Backfill order secondary sales people.
BACKFILL_ORDER_SECONDARY_SALESPEOPLE_ID (328):: Backfill order secondary sales people ID.
BACKFILL_ORDER_SECONDARY_TRAFFICKERS (331):: Backfill order secondary traffickers.
BACKFILL_ORDER_SECONDARY_TRAFFICKERS_ID (330):: Backfill order secondary traffickers ID.
BACKFILL_ORDER_START_DATE (332):: Backfill order start date.
BACKFILL_ORDER_START_DATE_TIME (333):: Backfill order start date and time.
BACKFILL_ORDER_TRAFFICKER (326):: Backfill order trafficker.
BACKFILL_ORDER_TRAFFICKER_ID (327):: Backfill order trafficker ID.
BACKFILL_ORDER_UNLIMITED_END (318):: Whether the Backfill order end time and end date is set to effectively never end.
BACKFILL_PROGRAMMATIC_BUYER_ID (336):: The ID of the buyer on a backfill programmatic proposal.
BACKFILL_PROGRAMMATIC_BUYER_NAME (337):: The name of the buyer on a backfill programmatic proposal.
BRANDING_TYPE (383):: The amount of information about the Publisher’s page sent to the buyer who purchased the impressions.
BRANDING_TYPE_NAME (384):: The localized version of branding type, the amount of information about the Publisher’s page sent to the buyer who purchased the impressions.
BROWSER_CATEGORY (119):: Browser category.
BROWSER_CATEGORY_NAME (120):: Browser category name.
BROWSER_ID (235):: The ID of the browser.
BROWSER_NAME (236):: The name of the browser.
CARRIER_ID (369):: Mobile carrier ID.
CARRIER_NAME (368):: Name of the mobile carrier.
CLASSIFIED_ADVERTISER_ID (133):: The ID of an advertiser, classified by Google, associated with a creative transacted
CLASSIFIED_ADVERTISER_NAME (134):: The name of an advertiser, classified by Google, associated with a creative transacted
CLASSIFIED_BRAND_ID (243):: ID of the brand, as classified by Google,
CLASSIFIED_BRAND_NAME (244):: Name of the brand, as classified by Google,
CONTENT_ID (246):: ID of the video content served.
CONTENT_NAME (247):: Name of the video content served.
COUNTRY_ID (11):: The criteria ID of the country in which the ad served.
COUNTRY_NAME (12):: The name of the country in which the ad served.
CREATIVE_BILLING_TYPE (366):: Enum value of creative billing type
CREATIVE_BILLING_TYPE_NAME (367):: Localized string value of creative billing type
CREATIVE_CLICK_THROUGH_URL (174):: Represents the click-through URL of a creative
CREATIVE_ID (138):: The ID of a creative
CREATIVE_NAME (139):: Creative name
CREATIVE_TECHNOLOGY (148):: Creative technology ENUM
CREATIVE_TECHNOLOGY_NAME (149):: Creative technology locallized name
CREATIVE_THIRD_PARTY_VENDOR (361):: Third party vendor name of a creative
CREATIVE_TYPE (344):: Enum value of creative type
CREATIVE_TYPE_NAME (345):: Localized string name of creative type
DATE (3):: Breaks down reporting data by date.
DAY_OF_WEEK (4):: Breaks down reporting data by day of the week. Monday is 1 and 7 is Sunday.
DEMAND_CHANNEL (9):: Demand channel.
DEMAND_CHANNEL_NAME (10):: Demand channel name.
DEMAND_SUBCHANNEL (22):: Demand subchannel.
DEMAND_SUBCHANNEL_NAME (23):: Demand subchannel name.
DEVICE (226):: The device on which an ad was served.
DEVICE_CATEGORY (15):: The device category to which an ad is being targeted.
DEVICE_CATEGORY_NAME (16):: The name of the category of device (smartphone, feature phone, tablet, or desktop) to which an ad is being targeted.
DEVICE_NAME (225):: The localized name of the device on which an ad was served.
EXCHANGE_THIRD_PARTY_COMPANY_ID (185):: ID of the yield partner as classified by Google
EXCHANGE_THIRD_PARTY_COMPANY_NAME (186):: Name of the yield partner as classified by Google
FIRST_LOOK_PRICING_RULE_ID (248):: The ID of the first look pricing rule.
FIRST_LOOK_PRICING_RULE_NAME (249):: The name of the first look pricing rule.
HOUR (100):: Breaks down reporting data by hour in one day.
INTERACTION_TYPE (223):: The interaction type of an ad.
INTERACTION_TYPE_NAME (224):: The localized name of the interaction type of an ad.
INVENTORY_FORMAT (17):: Inventory format. The format of the ad unit (e.g, banner) where the ad was requested.
INVENTORY_FORMAT_NAME (18):: Inventory format name. The format of the ad unit (e.g, banner) where the ad was requested.
INVENTORY_TYPE (19):: Inventory type. The kind of web page or device where the ad was requested.
INVENTORY_TYPE_NAME (20):: Inventory type name. The kind of web page or device where the ad was requested.
IS_ADX_DIRECT (382):: Whether traffic is Adx Direct.
IS_FIRST_LOOK_DEAL (401):: Whether traffic is First Look.
KEY_VALUES_ID (214):: The Custom Targeting Value ID
KEY_VALUES_NAME (215):: The Custom Targeting Value formatted like <key_name>=<value_name>
LINE_ITEM_ARCHIVED (188):: Whether a Line item is archived.
LINE_ITEM_COMPANION_DELIVERY_OPTION (204):: Line item comanion delivery option ENUM value.
LINE_ITEM_COMPANION_DELIVERY_OPTION_NAME (205):: Localized line item comanion delivery option name.
LINE_ITEM_COMPUTED_STATUS (250):: The computed status of the LineItem.
LINE_ITEM_COMPUTED_STATUS_NAME (251):: The localized name of the computed status of the LineItem.
LINE_ITEM_CONTRACTED_QUANTITY (92):: The contracted units bought for the Line item.
LINE_ITEM_COST_PER_UNIT (85):: The cost per unit of the Line item.
LINE_ITEM_COST_TYPE (212):: Line item cost type ENUM value.
LINE_ITEM_COST_TYPE_NAME (213):: Localized line item cost type name.
LINE_ITEM_CREATIVE_END_DATE (176):: Represent the end date of a creative associated with line item
LINE_ITEM_CREATIVE_ROTATION_TYPE (189):: The creative rotation type of the LineItem.
LINE_ITEM_CREATIVE_ROTATION_TYPE_NAME (190):: The localized name of the creative rotation type of the LineItem.
LINE_ITEM_CREATIVE_START_DATE (175):: Represent the start date of a creative associated with line item
LINE_ITEM_CURRENCY_CODE (180):: The 3 letter currency code of the Line Item
LINE_ITEM_DELIVERY_INDICATOR (87):: The progress made for the delivery of the Line item.
LINE_ITEM_DELIVERY_RATE_TYPE (191):: The delivery rate type of the LineItem.
LINE_ITEM_DELIVERY_RATE_TYPE_NAME (192):: The localized name of the delivery rate type of the LineItem.
LINE_ITEM_DISCOUNT_ABSOLUTE (195):: The discount of the LineItem in whole units in the LineItem’s currency code, or if unspecified the Network’s currency code.
LINE_ITEM_DISCOUNT_PERCENTAGE (196):: The discount of the LineItem in percentage.
LINE_ITEM_END_DATE (81):: The end date of the Line item.
LINE_ITEM_END_DATE_TIME (83):: The end date and time of the Line item.
LINE_ITEM_ENVIRONMENT_TYPE (201):: The ENUM value of the environment a LineItem is targeting.
LINE_ITEM_ENVIRONMENT_TYPE_NAME (202):: The localized name of the environment a LineItem is targeting.
LINE_ITEM_EXTERNAL_DEAL_ID (97):: The deal ID of the Line item. Set for Programmatic Direct campaigns.
LINE_ITEM_EXTERNAL_ID (86):: The external ID of the Line item.
LINE_ITEM_FREQUENCY_CAP (256):: The frequency cap of the Line item (descriptive string).
LINE_ITEM_ID (1):: Line item ID.
LINE_ITEM_LAST_MODIFIED_BY_APP (181):: The application that last modified the Line Item.
LINE_ITEM_LIFETIME_CLICKS (95):: The total number of clicks delivered of the lifetime of the Line item.
LINE_ITEM_LIFETIME_IMPRESSIONS (94):: The total number of impressions delivered over the lifetime of the Line item.
LINE_ITEM_LIFETIME_VIEWABLE_IMPRESSIONS (96):: The total number of viewable impressions delivered over the lifetime of the Line item.
LINE_ITEM_MAKEGOOD (89):: Whether or not the Line item is Makegood. Makegood refers to free inventory offered to buyers to compensate for mistakes or under-delivery in the original campaigns.
LINE_ITEM_NAME (2):: Line item Name.
LINE_ITEM_NON_CPD_BOOKED_REVENUE (98):: The cost of booking for the Line item (non-CPD).
LINE_ITEM_OPTIMIZABLE (90):: Whether a Line item is eligible for opitimization.
LINE_ITEM_PRIMARY_GOAL_TYPE (210):: Goal type ENUM value of the primary goal of the line item.
LINE_ITEM_PRIMARY_GOAL_TYPE_NAME (211):: Localized goal type name of the primary goal of the line item.
LINE_ITEM_PRIMARY_GOAL_UNITS_ABSOLUTE (93):: The total number of impressions or clicks that are reserved for a line item. For line items of type BULK or PRICE_PRIORITY, this represents the number of remaining impressions reserved. If the line item has an impression cap goal, this represents the number of impressions or conversions that the line item will stop serving at if reached.
LINE_ITEM_PRIMARY_GOAL_UNITS_PERCENTAGE (396):: The percentage of impressions or clicks that are reserved for a line item. For line items of type SPONSORSHIP, this represents the percentage of available impressions reserved. For line items of type NETWORK or HOUSE, this represents the percentage of remaining impressions reserved.
LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE (208):: Unit type ENUM value of the primary goal of the line item.
LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE_NAME (209):: Localized unit type name of the primary goal of the line item.
LINE_ITEM_PRIORITY (24):: The priority of this Line item as a value between 1 and 16. In general, a lower priority means more serving priority for the Line item.
LINE_ITEM_RESERVATION_STATUS (304):: ENUM value describing the state of inventory reservation for the LineItem.
LINE_ITEM_RESERVATION_STATUS_NAME (305):: Localized string describing the state of inventory reservation for the LineItem.
LINE_ITEM_START_DATE (82):: The start date of the Line item.
LINE_ITEM_START_DATE_TIME (84):: The start date and time of the Line item.
LINE_ITEM_TYPE (193):: Line item type ENUM value.
LINE_ITEM_TYPE_NAME (194):: Localized line item type name.
LINE_ITEM_UNLIMITED_END (187):: Whether the Line item end time and end date is set to effectively never end.
LINE_ITEM_VALUE_COST_PER_UNIT (88):: The artificial cost per unit used by the Ad server to help rank inventory.
LINE_ITEM_WEB_PROPERTY_CODE (179):: The web property code used for dynamic allocation Line Items.
MASTER_COMPANION_CREATIVE_ID (140):: The ID of creative, includes regular creatives, and master and companions in case of creative sets
MASTER_COMPANION_CREATIVE_NAME (141):: Name of creative, includes regular creatives, and master and companions in case of creative sets
MOBILE_APP_FREE (128):: Whether the mobile app is free.
MOBILE_APP_ICON_URL (129):: URL of app icon for the mobile app.
MOBILE_APP_ID (123):: The ID of the Mobile App.
MOBILE_APP_NAME (127):: The name of the mobile app.
MOBILE_APP_OWNERSHIP_STATUS (311):: Ownership status of the mobile app.
MOBILE_APP_OWNERSHIP_STATUS_NAME (312):: Ownership status of the mobile app.
MOBILE_APP_STORE (125):: The App Store of the mobile app.
MOBILE_APP_STORE_NAME (245):: The localized name of the mobile app store.
MOBILE_INVENTORY_TYPE (99):: Mobile inventory type. Identifies whether a mobile ad came from a regular web page, an AMP web page, or a mobile app. Values match the Inventory type dimension available in the Overview Home dashboard. Note: Video takes precedence over any other value, for example, if there is an in-stream video impression on a desktop device, it will be attributed to in-stream video and not desktop web.
MOBILE_INVENTORY_TYPE_NAME (21):: Mobile inventory type name. Identifies whether a mobile ad came from a regular web page, an AMP web page, or a mobile app.
MOBILE_SDK_VERSION_NAME (130):: SDK version of the mobile device.
MONTH_YEAR (6):: Breaks down reporting data by month and year.
NATIVE_AD_FORMAT_ID (255):: Native ad format ID.
NATIVE_AD_FORMAT_NAME (254):: Native ad format name.
NATIVE_STYLE_ID (253):: Native style ID.
NATIVE_STYLE_NAME (252):: Native style name.
OPERATING_SYSTEM_CATEGORY (117):: Operating system category.
OPERATING_SYSTEM_CATEGORY_NAME (118):: Operating system category name.
OPERATING_SYSTEM_VERSION_ID (238):: ID of the operating system version.
OPERATING_SYSTEM_VERSION_NAME (237):: Details of the operating system, including version.
ORDER_AGENCY (150):: Order agency.
ORDER_AGENCY_ID (151):: Order agency ID.
ORDER_BOOKED_CPC (152):: Order booked CPC.
ORDER_BOOKED_CPM (153):: Order booked CPM.
ORDER_DELIVERY_STATUS (231):: Order delivery status ENUM value.
ORDER_DELIVERY_STATUS_NAME (239):: Order delivery status localized name.
ORDER_END_DATE (154):: Order end date.
ORDER_END_DATE_TIME (155):: Order end date and time.
ORDER_EXTERNAL_ID (156):: Order external ID.
ORDER_ID (7):: Order id.
ORDER_LABELS (170):: Order labels.
ORDER_LABEL_IDS (171):: Order labels IDs.
ORDER_LIFETIME_CLICKS (158):: Order lifetime clicks.
ORDER_LIFETIME_IMPRESSIONS (159):: Order lifetime impressions.
ORDER_NAME (8):: Order name.
ORDER_PO_NUMBER (160):: Order PO number.
ORDER_PROGRAMMATIC (157):: Whether the Order is programmatic.
ORDER_SALESPERSON (161):: Order sales person.
ORDER_SECONDARY_SALESPEOPLE (164):: Order secondary sales people.
ORDER_SECONDARY_SALESPEOPLE_ID (165):: Order secondary sales people ID.
ORDER_SECONDARY_TRAFFICKERS (166):: Order secondary traffickers.
ORDER_SECONDARY_TRAFFICKERS_ID (167):: Order secondary traffickers ID.
ORDER_START_DATE (168):: Order start date.
ORDER_START_DATE_TIME (169):: Order start date and time.
ORDER_TRAFFICKER (162):: Order trafficker.
ORDER_TRAFFICKER_ID (163):: Order trafficker ID.
ORDER_UNLIMITED_END (203):: Whether the Order end time and end date is set to effectively never end.
PLACEMENT_ID (113):: Placement ID
PLACEMENT_ID_ALL (144):: The full list of placement IDs associated with the ad unit.
PLACEMENT_NAME (114):: Placement name
PLACEMENT_NAME_ALL (145):: The full list of placement names associated with the ad unit.
PLACEMENT_STATUS (362):: Placement status ENUM value
PLACEMENT_STATUS_ALL (363):: The full list of placement status ENUM values associated with the ad unit.
PLACEMENT_STATUS_NAME (364):: Localized placement status name.
PLACEMENT_STATUS_NAME_ALL (365):: The full list of localized placement status names associated with the ad unit.
PROGRAMMATIC_BUYER_ID (240):: The ID of the buyer on a programmatic proposal.
PROGRAMMATIC_BUYER_NAME (241):: The name of the buyer on a programmatic proposal.
PROGRAMMATIC_CHANNEL (13):: Programmatic channel. The type of transaction that occurred in Ad Exchange.
PROGRAMMATIC_CHANNEL_NAME (14):: Programmatic channel name. The type of transaction that occurred in Ad Exchange.
RENDERED_CREATIVE_SIZE (343):: The size of a rendered creative, It can differ with the creative’s size if a creative is shown in an ad slot of a different size.
REQUESTED_AD_SIZES (352):: Inventory Requested Ad Sizes dimension
REQUEST_TYPE (146):: Request type ENUM
REQUEST_TYPE_NAME (147):: Request type locallized name
SITE (387):: Information about domain or subdomains.
TARGETING_ID (232):: The ID of the browser, device or other environment into which a line item or creative was served.
TARGETING_NAME (233):: Information about the browser, device and other environments into which a line item or creative was served.
TARGETING_TYPE (385):: The way in which advertisers targeted their ads.
TARGETING_TYPE_NAME (386):: The localized name of the way in which advertisers targeted their ads.
TRAFFIC_SOURCE (388):: Inventory Traffic source dimension
TRAFFIC_SOURCE_NAME (389):: Inventory Traffic source dimension name
UNIFIED_PRICING_RULE_ID (393):: Unified pricing rule ID dimension
UNIFIED_PRICING_RULE_NAME (394):: Unified pricing rule name dimension
VIDEO_PLCMT (172):: The video placement enum as defined by ADCOM 1.0-202303.
VIDEO_PLCMT_NAME (173):: The localized name of the video placement as defined by ADCOM 1.0-202303.
WEEK (5):: Breaks down reporting data by week of the year.
YIELD_GROUP_BUYER_NAME (184):: Name of the company within a yield group
YIELD_GROUP_ID (182):: ID of the group of ad networks or exchanges used for Mediation and Open Bidding
YIELD_GROUP_NAME (183):: Name of the group of ad networks or exchanges used for Mediation and Open Bidding
LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID (10000):: Custom field option ID for Line Item with custom field ID equal to the ID in index 0 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_1_OPTION_ID (10001):: Custom field option ID for Line Item with custom field ID equal to the ID in index 1 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_2_OPTION_ID (10002):: Custom field option ID for Line Item with custom field ID equal to the ID in index 2 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_3_OPTION_ID (10003):: Custom field option ID for Line Item with custom field ID equal to the ID in index 3 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_4_OPTION_ID (10004):: Custom field option ID for Line Item with custom field ID equal to the ID in index 4 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_5_OPTION_ID (10005):: Custom field option ID for Line Item with custom field ID equal to the ID in index 5 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_6_OPTION_ID (10006):: Custom field option ID for Line Item with custom field ID equal to the ID in index 6 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_7_OPTION_ID (10007):: Custom field option ID for Line Item with custom field ID equal to the ID in index 7 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_8_OPTION_ID (10008):: Custom field option ID for Line Item with custom field ID equal to the ID in index 8 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_9_OPTION_ID (10009):: Custom field option ID for Line Item with custom field ID equal to the ID in index 9 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_10_OPTION_ID (10010):: Custom field option ID for Line Item with custom field ID equal to the ID in index 10 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_11_OPTION_ID (10011):: Custom field option ID for Line Item with custom field ID equal to the ID in index 11 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_12_OPTION_ID (10012):: Custom field option ID for Line Item with custom field ID equal to the ID in index 12 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_13_OPTION_ID (10013):: Custom field option ID for Line Item with custom field ID equal to the ID in index 13 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_14_OPTION_ID (10014):: Custom field option ID for Line Item with custom field ID equal to the ID in index 14 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_0_VALUE (11000):: Custom field value for Line Item with custom field ID equal to the ID in index 0 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_1_VALUE (11001):: Custom field value for Line Item with custom field ID equal to the ID in index 1 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_2_VALUE (11002):: Custom field value for Line Item with custom field ID equal to the ID in index 2 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_3_VALUE (11003):: Custom field value for Line Item with custom field ID equal to the ID in index 3 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_4_VALUE (11004):: Custom field value for Line Item with custom field ID equal to the ID in index 4 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_5_VALUE (11005):: Custom field value for Line Item with custom field ID equal to the ID in index 5 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_6_VALUE (11006):: Custom field value for Line Item with custom field ID equal to the ID in index 6 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_7_VALUE (11007):: Custom field value for Line Item with custom field ID equal to the ID in index 7 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_8_VALUE (11008):: Custom field value for Line Item with custom field ID equal to the ID in index 8 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_9_VALUE (11009):: Custom field value for Line Item with custom field ID equal to the ID in index 9 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_10_VALUE (11010):: Custom field value for Line Item with custom field ID equal to the ID in index 10 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_11_VALUE (11011):: Custom field value for Line Item with custom field ID equal to the ID in index 11 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_12_VALUE (11012):: Custom field value for Line Item with custom field ID equal to the ID in index 12 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_13_VALUE (11013):: Custom field value for Line Item with custom field ID equal to the ID in index 13 of ReportDefinition.line_item_custom_field_ids.
LINE_ITEM_CUSTOM_FIELD_14_VALUE (11014):: Custom field value for Line Item with custom field ID equal to the ID in index 14 of ReportDefinition.line_item_custom_field_ids.
ORDER_CUSTOM_FIELD_0_OPTION_ID (12000):: Custom field option ID for Order with custom field ID equal to the ID in index 0 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_1_OPTION_ID (12001):: Custom field option ID for Order with custom field ID equal to the ID in index 1 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_2_OPTION_ID (12002):: Custom field option ID for Order with custom field ID equal to the ID in index 2 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_3_OPTION_ID (12003):: Custom field option ID for Order with custom field ID equal to the ID in index 3 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_4_OPTION_ID (12004):: Custom field option ID for Order with custom field ID equal to the ID in index 4 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_5_OPTION_ID (12005):: Custom field option ID for Order with custom field ID equal to the ID in index 5 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_6_OPTION_ID (12006):: Custom field option ID for Order with custom field ID equal to the ID in index 6 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_7_OPTION_ID (12007):: Custom field option ID for Order with custom field ID equal to the ID in index 7 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_8_OPTION_ID (12008):: Custom field option ID for Order with custom field ID equal to the ID in index 8 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_9_OPTION_ID (12009):: Custom field option ID for Order with custom field ID equal to the ID in index 9 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_10_OPTION_ID (12010):: Custom field option ID for Order with custom field ID equal to the ID in index 10 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_11_OPTION_ID (12011):: Custom field option ID for Order with custom field ID equal to the ID in index 11 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_12_OPTION_ID (12012):: Custom field option ID for Order with custom field ID equal to the ID in index 12 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_13_OPTION_ID (12013):: Custom field option ID for Order with custom field ID equal to the ID in index 13 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_14_OPTION_ID (12014):: Custom field option ID for Order with custom field ID equal to the ID in index 14 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_0_VALUE (13000):: Custom field value for Order with custom field ID equal to the ID in index 0 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_1_VALUE (13001):: Custom field value for Order with custom field ID equal to the ID in index 1 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_2_VALUE (13002):: Custom field value for Order with custom field ID equal to the ID in index 2 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_3_VALUE (13003):: Custom field value for Order with custom field ID equal to the ID in index 3 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_4_VALUE (13004):: Custom field value for Order with custom field ID equal to the ID in index 4 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_5_VALUE (13005):: Custom field value for Order with custom field ID equal to the ID in index 5 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_6_VALUE (13006):: Custom field value for Order with custom field ID equal to the ID in index 6 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_7_VALUE (13007):: Custom field value for Order with custom field ID equal to the ID in index 7 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_8_VALUE (13008):: Custom field value for Order with custom field ID equal to the ID in index 8 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_9_VALUE (13009):: Custom field value for Order with custom field ID equal to the ID in index 9 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_10_VALUE (13010):: Custom field value for Order with custom field ID equal to the ID in index 10 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_11_VALUE (13011):: Custom field value for Order with custom field ID equal to the ID in index 11 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_12_VALUE (13012):: Custom field value for Order with custom field ID equal to the ID in index 12 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_13_VALUE (13013):: Custom field value for Order with custom field ID equal to the ID in index 13 of ReportDefinition.order_custom_field_ids.
ORDER_CUSTOM_FIELD_14_VALUE (13014):: Custom field value for Order with custom field ID equal to the ID in index 14 of ReportDefinition.order_custom_field_ids.
CREATIVE_CUSTOM_FIELD_0_OPTION_ID (14000):: Custom field option ID for Creative with custom field ID equal to the ID in index 0 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_1_OPTION_ID (14001):: Custom field option ID for Creative with custom field ID equal to the ID in index 1 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_2_OPTION_ID (14002):: Custom field option ID for Creative with custom field ID equal to the ID in index 2 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_3_OPTION_ID (14003):: Custom field option ID for Creative with custom field ID equal to the ID in index 3 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_4_OPTION_ID (14004):: Custom field option ID for Creative with custom field ID equal to the ID in index 4 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_5_OPTION_ID (14005):: Custom field option ID for Creative with custom field ID equal to the ID in index 5 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_6_OPTION_ID (14006):: Custom field option ID for Creative with custom field ID equal to the ID in index 6 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_7_OPTION_ID (14007):: Custom field option ID for Creative with custom field ID equal to the ID in index 7 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_8_OPTION_ID (14008):: Custom field option ID for Creative with custom field ID equal to the ID in index 8 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_9_OPTION_ID (14009):: Custom field option ID for Creative with custom field ID equal to the ID in index 9 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_10_OPTION_ID (14010):: Custom field option ID for Creative with custom field ID equal to the ID in index 10 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_11_OPTION_ID (14011):: Custom field option ID for Creative with custom field ID equal to the ID in index 11 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_12_OPTION_ID (14012):: Custom field option ID for Creative with custom field ID equal to the ID in index 12 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_13_OPTION_ID (14013):: Custom field option ID for Creative with custom field ID equal to the ID in index 13 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_14_OPTION_ID (14014):: Custom field option ID for Creative with custom field ID equal to the ID in index 14 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_0_VALUE (15000):: Custom field value for Creative with custom field ID equal to the ID in index 0 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_1_VALUE (15001):: Custom field value for Creative with custom field ID equal to the ID in index 1 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_2_VALUE (15002):: Custom field value for Creative with custom field ID equal to the ID in index 2 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_3_VALUE (15003):: Custom field value for Creative with custom field ID equal to the ID in index 3 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_4_VALUE (15004):: Custom field value for Creative with custom field ID equal to the ID in index 4 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_5_VALUE (15005):: Custom field value for Creative with custom field ID equal to the ID in index 5 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_6_VALUE (15006):: Custom field value for Creative with custom field ID equal to the ID in index 6 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_7_VALUE (15007):: Custom field value for Creative with custom field ID equal to the ID in index 7 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_8_VALUE (15008):: Custom field value for Creative with custom field ID equal to the ID in index 8 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_9_VALUE (15009):: Custom field value for Creative with custom field ID equal to the ID in index 9 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_10_VALUE (15010):: Custom field value for Creative with custom field ID equal to the ID in index 10 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_11_VALUE (15011):: Custom field value for Creative with custom field ID equal to the ID in index 11 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_12_VALUE (15012):: Custom field value for Creative with custom field ID equal to the ID in index 12 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_13_VALUE (15013):: Custom field value for Creative with custom field ID equal to the ID in index 13 of ReportDefinition.creative_custom_field_ids.
CREATIVE_CUSTOM_FIELD_14_VALUE (15014):: Custom field value for Creative with custom field ID equal to the ID in index 14 of ReportDefinition.creative_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID (16000):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 0 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_1_OPTION_ID (16001):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 1 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_2_OPTION_ID (16002):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 2 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_3_OPTION_ID (16003):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 3 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_4_OPTION_ID (16004):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 4 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_5_OPTION_ID (16005):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 5 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_6_OPTION_ID (16006):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 6 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_7_OPTION_ID (16007):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 7 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_8_OPTION_ID (16008):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 8 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_9_OPTION_ID (16009):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 9 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_10_OPTION_ID (16010):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 10 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_11_OPTION_ID (16011):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 11 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_12_OPTION_ID (16012):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 12 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_13_OPTION_ID (16013):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 13 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_14_OPTION_ID (16014):: Custom field option ID for Backfill line item with custom field ID equal to the ID in index 14 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_0_VALUE (17000):: Custom field value for Backfill line item with custom field ID equal to the ID in index 0 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_1_VALUE (17001):: Custom field value for Backfill line item with custom field ID equal to the ID in index 1 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_2_VALUE (17002):: Custom field value for Backfill line item with custom field ID equal to the ID in index 2 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_3_VALUE (17003):: Custom field value for Backfill line item with custom field ID equal to the ID in index 3 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_4_VALUE (17004):: Custom field value for Backfill line item with custom field ID equal to the ID in index 4 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_5_VALUE (17005):: Custom field value for Backfill line item with custom field ID equal to the ID in index 5 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_6_VALUE (17006):: Custom field value for Backfill line item with custom field ID equal to the ID in index 6 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_7_VALUE (17007):: Custom field value for Backfill line item with custom field ID equal to the ID in index 7 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_8_VALUE (17008):: Custom field value for Backfill line item with custom field ID equal to the ID in index 8 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_9_VALUE (17009):: Custom field value for Backfill line item with custom field ID equal to the ID in index 9 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_10_VALUE (17010):: Custom field value for Backfill line item with custom field ID equal to the ID in index 10 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_11_VALUE (17011):: Custom field value for Backfill line item with custom field ID equal to the ID in index 11 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_12_VALUE (17012):: Custom field value for Backfill line item with custom field ID equal to the ID in index 12 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_13_VALUE (17013):: Custom field value for Backfill line item with custom field ID equal to the ID in index 13 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_LINE_ITEM_CUSTOM_FIELD_14_VALUE (17014):: Custom field value for Backfill line item with custom field ID equal to the ID in index 14 of ReportDefinition.line_item_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_0_OPTION_ID (18000):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 0 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_1_OPTION_ID (18001):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 1 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_2_OPTION_ID (18002):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 2 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_3_OPTION_ID (18003):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 3 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_4_OPTION_ID (18004):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 4 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_5_OPTION_ID (18005):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 5 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_6_OPTION_ID (18006):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 6 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_7_OPTION_ID (18007):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 7 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_8_OPTION_ID (18008):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 8 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_9_OPTION_ID (18009):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 9 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_10_OPTION_ID (18010):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 10 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_11_OPTION_ID (18011):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 11 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_12_OPTION_ID (18012):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 12 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_13_OPTION_ID (18013):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 13 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_14_OPTION_ID (18014):: Custom field option ID for Backfill order with custom field ID equal to the ID in index 14 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_0_VALUE (19000):: Custom field value for Backfill order with custom field ID equal to the ID in index 0 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_1_VALUE (19001):: Custom field value for Backfill order with custom field ID equal to the ID in index 1 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_2_VALUE (19002):: Custom field value for Backfill order with custom field ID equal to the ID in index 2 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_3_VALUE (19003):: Custom field value for Backfill order with custom field ID equal to the ID in index 3 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_4_VALUE (19004):: Custom field value for Backfill order with custom field ID equal to the ID in index 4 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_5_VALUE (19005):: Custom field value for Backfill order with custom field ID equal to the ID in index 5 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_6_VALUE (19006):: Custom field value for Backfill order with custom field ID equal to the ID in index 6 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_7_VALUE (19007):: Custom field value for Backfill order with custom field ID equal to the ID in index 7 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_8_VALUE (19008):: Custom field value for Backfill order with custom field ID equal to the ID in index 8 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_9_VALUE (19009):: Custom field value for Backfill order with custom field ID equal to the ID in index 9 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_10_VALUE (19010):: Custom field value for Backfill order with custom field ID equal to the ID in index 10 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_11_VALUE (19011):: Custom field value for Backfill order with custom field ID equal to the ID in index 11 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_12_VALUE (19012):: Custom field value for Backfill order with custom field ID equal to the ID in index 12 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_13_VALUE (19013):: Custom field value for Backfill order with custom field ID equal to the ID in index 13 of ReportDefinition.order_custom_field_ids.
BACKFILL_ORDER_CUSTOM_FIELD_14_VALUE (19014):: Custom field value for Backfill order with custom field ID equal to the ID in index 14 of ReportDefinition.order_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_0_OPTION_ID (20000):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 0 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_1_OPTION_ID (20001):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 1 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_2_OPTION_ID (20002):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 2 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_3_OPTION_ID (20003):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 3 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_4_OPTION_ID (20004):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 4 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_5_OPTION_ID (20005):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 5 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_6_OPTION_ID (20006):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 6 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_7_OPTION_ID (20007):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 7 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_8_OPTION_ID (20008):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 8 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_9_OPTION_ID (20009):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 9 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_10_OPTION_ID (20010):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 10 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_11_OPTION_ID (20011):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 11 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_12_OPTION_ID (20012):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 12 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_13_OPTION_ID (20013):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 13 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_14_OPTION_ID (20014):: Custom field option ID for Backfill creative with custom field ID equal to the ID in index 14 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_0_VALUE (21000):: Custom field value for Backfill creative with custom field ID equal to the ID in index 0 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_1_VALUE (21001):: Custom field value for Backfill creative with custom field ID equal to the ID in index 1 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_2_VALUE (21002):: Custom field value for Backfill creative with custom field ID equal to the ID in index 2 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_3_VALUE (21003):: Custom field value for Backfill creative with custom field ID equal to the ID in index 3 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_4_VALUE (21004):: Custom field value for Backfill creative with custom field ID equal to the ID in index 4 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_5_VALUE (21005):: Custom field value for Backfill creative with custom field ID equal to the ID in index 5 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_6_VALUE (21006):: Custom field value for Backfill creative with custom field ID equal to the ID in index 6 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_7_VALUE (21007):: Custom field value for Backfill creative with custom field ID equal to the ID in index 7 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_8_VALUE (21008):: Custom field value for Backfill creative with custom field ID equal to the ID in index 8 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_9_VALUE (21009):: Custom field value for Backfill creative with custom field ID equal to the ID in index 9 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_10_VALUE (21010):: Custom field value for Backfill creative with custom field ID equal to the ID in index 10 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_11_VALUE (21011):: Custom field value for Backfill creative with custom field ID equal to the ID in index 11 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_12_VALUE (21012):: Custom field value for Backfill creative with custom field ID equal to the ID in index 12 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_13_VALUE (21013):: Custom field value for Backfill creative with custom field ID equal to the ID in index 13 of ReportDefinition.creative_custom_field_ids.
BACKFILL_CREATIVE_CUSTOM_FIELD_14_VALUE (21014):: Custom field value for Backfill creative with custom field ID equal to the ID in index 14 of ReportDefinition.creative_custom_field_ids.
CUSTOM_DIMENSION_0_VALUE_ID (100000):: Custom Dimension Value ID for Custom Dimension with key equal to the key in index 0 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_1_VALUE_ID (100001):: Custom Dimension Value ID for Custom Dimension with key equal to the key in index 1 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_2_VALUE_ID (100002):: Custom Dimension Value ID for Custom Dimension with key equal to the key in index 2 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_3_VALUE_ID (100003):: Custom Dimension Value ID for Custom Dimension with key equal to the key in index 3 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_4_VALUE_ID (100004):: Custom Dimension Value ID for Custom Dimension with key equal to the key in index 4 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_5_VALUE_ID (100005):: Custom Dimension Value ID for Custom Dimension with key equal to the key in index 5 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_6_VALUE_ID (100006):: Custom Dimension Value ID for Custom Dimension with key equal to the key in index 6 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_7_VALUE_ID (100007):: Custom Dimension Value ID for Custom Dimension with key equal to the key in index 9 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_8_VALUE_ID (100008):: Custom Dimension Value ID for Custom Dimension with key equal to the key in index 8 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_9_VALUE_ID (100009):: Custom Dimension Value ID for Custom Dimension with key equal to the key in index 9 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_0_VALUE (101000):: Custom Dimension Value name for Custom Dimension with key equal to the id in index 0 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_1_VALUE (101001):: Custom Dimension Value name for Custom Dimension with key equal to the id in index 1 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_2_VALUE (101002):: Custom Dimension Value name for Custom Dimension with key equal to the id in index 2 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_3_VALUE (101003):: Custom Dimension Value name for Custom Dimension with key equal to the id in index 3 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_4_VALUE (101004):: Custom Dimension Value name for Custom Dimension with key equal to the id in index 4 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_5_VALUE (101005):: Custom Dimension Value name for Custom Dimension with key equal to the id in index 5 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_6_VALUE (101006):: Custom Dimension Value name for Custom Dimension with key equal to the id in index 6 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_7_VALUE (101007):: Custom Dimension Value name for Custom Dimension with key equal to the id in index 7 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_8_VALUE (101008):: Custom Dimension Value name for Custom Dimension with key equal to the id in index 8 of ReportDefinition.custom_dimension_key_ids.
CUSTOM_DIMENSION_9_VALUE (101009):: Custom Dimension Value name for Custom Dimension with key equal to the id in index 9 of ReportDefinition.custom_dimension_key_ids.

class Field(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A dimension or a metric in a report.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

dimension¶

The dimension this field represents.

This field is a member of oneof field.

Type: google.ads.admanager_v1.types.Report.Dimension

metric¶

The metric this field represents.

This field is a member of oneof field.

Type: google.ads.admanager_v1.types.Report.Metric

class Filter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A filter over one or more fields.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

field_filter¶

A filter on a single field.

This field is a member of oneof type.

Type: google.ads.admanager_v1.types.Report.Filter.FieldFilter

not_filter¶

A filter whose result is negated.

This field is a member of oneof type.

Type: google.ads.admanager_v1.types.Report.Filter

and_filter¶

A list of filters whose results are AND-ed.

This field is a member of oneof type.

Type: google.ads.admanager_v1.types.Report.Filter.FilterList

or_filter¶

A list of filters whose results are OR-ed.

This field is a member of oneof type.

Type: google.ads.admanager_v1.types.Report.Filter.FilterList

class FieldFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A filter on a specific field.

field¶

Required. The field to filter on.

Type: google.ads.admanager_v1.types.Report.Field

operation¶

Required. The operation of this filter.

Type: google.ads.admanager_v1.types.Report.Filter.Operation

values¶

Required. Values to filter to.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Value]

slice_¶

Optional. Use to filter on a specific slice of data.

This field is a member of oneof _slice.

Type: google.ads.admanager_v1.types.Report.Slice

time_period_index¶

Optional. When using time period columns, use this to filter on a specific column.

This field is a member of oneof _time_period_index.

Type: int

metric_value_type¶

Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.

This field is a member of oneof _metric_value_type.

Type: google.ads.admanager_v1.types.Report.MetricValueType

class FilterList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A list of filters.

filters¶

Required. A list of filters.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Filter]

class Operation(value)[source]¶

Bases: proto.enums.Enum

Supported filter operations.

Values:

IN (0):

For scalar operands, checks if the operand is in the set of provided filter values.

For list operands, checks if any element in the operand is in the set of provided filter values.

Default value.

NOT_IN (1):

For scalar operands, checks that the operand is not in the set of provided filter values.

For list operands, checks that none of the elements in the operand is in the set of provided filter values.

CONTAINS (2):

For scalar string operands, checks if the operand contains any of the provided filter substrings.

For string list operands, checks if any string in the operand contains any of the provided filter substrings.

NOT_CONTAINS (3):

For scalar string operands, checks that the operand contains none of the provided filter substrings.

For string list operands, checks that none of the strings in the operand contain none of the provided filter substrings.

LESS_THAN (4):

Operand is less than the provided filter value.

LESS_THAN_EQUALS (5):

Operand is less than or equal to provided filter value.

GREATER_THAN (6):

Operand is greater than provided filter value.

GREATER_THAN_EQUALS (7):

Operand is greater than or equal to provided filter value.

BETWEEN (8):

Operand is between provided filter values.

MATCHES (9):

Operand matches against a regex or set of regexes (one must match)

NOT_MATCHES (10):

Operand negative matches against a regex or set of regexes (none must match)

class Flag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A flag for a report. Flags are used show if certain thresholds are met. Result rows that match the filter will have the corresponding [MetricValueGroup.flagValues][MetricValueGroup] index set to true. For more information about flags see: https://support.google.com/admanager/answer/15079975

filters¶

Required. Filters to apply for the flag.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Filter]

name¶

Optional. Name of the flag. The flag names RED, YELLOW, GREEN, BLUE, PURPLE, and GREY correspond to the colored flags that appear in the UI. The UI will not display flags with other names, but they are available for use by API clients.

Type: str

class Metric(value)[source]¶

Bases: proto.enums.Enum

Reporting metrics.

Values:

METRIC_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME (61):

Active View total average time in seconds that specific impressions are reported as being viewable.

ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS (58):

Total number of impressions that were eligible to measure viewability.

ACTIVE_VIEW_MEASURABLE_IMPRESSIONS (57):

The total number of impressions that were sampled and measured by active view.

ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE (60):

The percentage of total impressions that were measurable by active view (out of all the total impressions sampled for active view).

ACTIVE_VIEW_VIEWABLE_IMPRESSIONS (56):

The total number of impressions viewed on the user’s screen.

ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE (59):

The percentage of total impressions viewed on the user’s screen (out of the total impressions measurable by active view).

ADSENSE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME (73):

Active View AdSense average time in seconds that specific impressions are reported as being viewable.

ADSENSE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS (70):

Total number of impressions delivered by AdSense that were eligible to measure viewability.

ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS (69):

The number of impressions delivered by AdSense that were sampled, and measurable by active view.

ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE (72):

The percentage of impressions delivered by AdSense that were measurable by active view (out of all AdSense impressions sampled for active view).

ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS (68):

The number of impressions delivered by AdSense viewed on the user’s screen.

ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE (71):

The percentage of impressions delivered by AdSense viewed on the user’s screen (out of AdSense impressions measurable by active view).

ADSENSE_AVERAGE_ECPM (26):

The average effective cost-per-thousand-impressions earned from the ads delivered by AdSense through line item dynamic allocation.

ADSENSE_CLICKS (23):

Number of clicks delivered by AdSense demand channel.

ADSENSE_CTR (24):

The ratio of impressions served by AdSense that resulted in users clicking on an ad. The clickthrough rate (CTR) is updated nightly. The AdSense CTR is calculated as: (AdSense clicks / AdSense impressions).

ADSENSE_IMPRESSIONS (22):

Total impressions delivered by AdSense.

ADSENSE_PERCENT_CLICKS (28):

Ratio of clicks delivered by AdSense through line item dynamic allocation in relation to the total clicks delivered.

ADSENSE_PERCENT_IMPRESSIONS (27):

Ratio of impressions delivered by AdSense through line item dynamic allocation in relation to the total impressions delivered.

ADSENSE_PERCENT_REVENUE (29):

Ratio of revenue generated by AdSense through line item dynamic allocation in relation to the total revenue.

ADSENSE_PERCENT_REVENUE_WITHOUT_CPD (30):

Ratio of revenue generated by AdSense through line item dynamic allocation in relation to the total revenue (excluding CPD).

ADSENSE_RESPONSES_SERVED (41):

The total number of times that an AdSense ad is delivered.

ADSENSE_REVENUE (25):

Revenue generated from AdSense through line item dynamic allocation, calculated in the network’s currency and time zone.

AD_EXCHANGE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME (79):

Active View AdExchange average time in seconds that specific impressions are reported as being viewable.

AD_EXCHANGE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS (76):

Total number of impressions delivered by Ad Exchange that were eligible to measure viewability.

AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS (75):

The number of impressions delivered by Ad Exchange that were sampled, and measurable by active view.

AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE (78):

The percentage of impressions delivered by Ad Exchange that were measurable by active view (out of all Ad Exchange impressions sampled for active view).

AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS (74):

The number of impressions delivered by Ad Exchange viewed on the user’s screen.

AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE (77):

The percentage of impressions delivered by Ad Exchange viewed on the user’s screen (out of Ad Exchange impressions measurable by active view).

AD_EXCHANGE_AVERAGE_ECPM (18):

The average effective cost-per-thousand-impressions earned from the ads delivered by Ad Exchange through line item dynamic allocation.

AD_EXCHANGE_CLICKS (15):

Number of clicks delivered by the Ad Exchange.

AD_EXCHANGE_CTR (16):

The ratio of impressions served by the Ad Exchange that resulted in users clicking on an ad. The clickthrough rate (CTR) is updated nightly. Ad Exchange CTR is calculated as: (Ad Exchange clicks / Ad Exchange impressions).

AD_EXCHANGE_IMPRESSIONS (14):

Total impressions delivered by the Ad Exchange.

AD_EXCHANGE_PERCENT_CLICKS (20):

Ratio of clicks delivered by Ad Exchange through line item dynamic allocation in relation to the total clicks delivered.

AD_EXCHANGE_PERCENT_IMPRESSIONS (19):

Ratio of impressions delivered by Ad Exchange through line item dynamic allocation in relation to the total impressions delivered.

AD_EXCHANGE_PERCENT_REVENUE (21):

Ratio of revenue generated by Ad Exchange through line item dynamic allocation in relation to the total revenue.

AD_EXCHANGE_PERCENT_REVENUE_WITHOUT_CPD (31):

Ratio of revenue generated by Ad Exchange through line item dynamic allocation in relation to the total revenue (excluding CPD).

AD_EXCHANGE_RESPONSES_SERVED (42):

The total number of times that an Ad Exchange ad is delivered.

AD_EXCHANGE_REVENUE (17):

Revenue generated from the Ad Exchange through line item dynamic allocation, calculated in your network’s currency and time zone.

AD_REQUESTS (38):

The total number of times that an ad request is sent to the ad server including dynamic allocation.

AD_SERVER_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME (67):

Active View ad server average time in seconds that specific impressions are reported as being viewable.

AD_SERVER_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS (64):

Total number of impressions delivered by the ad server that were eligible to measure viewability.

AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS (63):

The number of impressions delivered by the ad server that were sampled, and measurable by active view.

AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE (66):

The percentage of impressions delivered by the ad server that were measurable by active view (out of all the ad server impressions sampled for active view).

AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS (62):

The number of impressions delivered by the ad server viewed on the user’s screen.

AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE (65):

The percentage of impressions delivered by the ad server viewed on the user’s screen (out of the ad server impressions measurable by active view).

AD_SERVER_AVERAGE_ECPM (34):

Average effective cost-per-thousand-impressions earned from the ads delivered by the Google Ad Manager server.

AD_SERVER_AVERAGE_ECPM_WITHOUT_CPD (10):

Average effective cost-per-thousand-impressions earned from the ads delivered by the Google Ad Manager server, excluding CPD value.

AD_SERVER_CLICKS (7):

Total clicks served by the Google Ad Manager server. It usually takes about 30 minutes for new clicks to be recorded and added to the total displayed in reporting.

AD_SERVER_CPD_REVENUE (32):

CPD revenue earned, calculated in your network’s currency, for the ads delivered by the Google Ad Manager server. Sum of all booked revenue.

AD_SERVER_CTR (8):

Ratio of impressions served by the Google Ad Manager server that resulted in users clicking on an ad. The clickthrough rate (CTR) is updated nightly. The ad server CTR is calculated as: (Ad server clicks / Ad server impressions).

AD_SERVER_IMPRESSIONS (6):

Total impressions delivered by the Ad Server.

AD_SERVER_PERCENT_CLICKS (12):

Ratio of clicks delivered by the Google Ad Manager server in relation to the total clicks delivered.

AD_SERVER_PERCENT_IMPRESSIONS (11):

Ratio of impressions delivered by the Google Ad Manager server in relation to the total impressions delivered.

AD_SERVER_PERCENT_REVENUE (35):

Ratio of revenue generated by the Google Ad Manager server in relation to the total revenue.

AD_SERVER_PERCENT_REVENUE_WITHOUT_CPD (13):

Ratio of revenue generated by the Google Ad Manager server (excluding CPD) in relation to the total revenue.

AD_SERVER_RESPONSES_SERVED (40):

The total number of times that an ad is served by the ad server.

AD_SERVER_REVENUE (33):

All CPM, CPC, and CPD revenue earned, calculated in your network’s currency, for the ads delivered by the Google Ad Manager server. Sum of all booked revenue.

AD_SERVER_REVENUE_WITHOUT_CPD (9):

Revenue (excluding CPD) earned, calculated in your network’s currency, for the ads delivered by the Google Ad Manager server. Sum of all booked revenue.

AUCTIONS_WON (80):

Number of winning bids received from Open Bidding buyers, even when the winning bid is placed at the end of a mediation for mobile apps chain.

AVERAGE_ECPM (37):

eCPM averaged across the Google Ad Manager server, AdSense, and Ad Exchange.

AVERAGE_ECPM_WITHOUT_CPD (5):

eCPM averaged across the Google Ad Manager server (excluding CPD), AdSense, and Ad Exchange.

BIDS (81):

Number of bids received from Open Bidding buyers, regardless of whether the returned bid competes in an auction.

BIDS_IN_AUCTION (82):

Number of bids received from Open Bidding buyers that competed in the auction.

CALLOUTS (83):

Number of times a yield partner is asked to return bid to fill a yield group request.

CLICKS (2):

The number of times a user clicked on an ad.

CODE_SERVED_COUNT (44):

The total number of times that the code for an ad is served by the ad server including dynamic allocation.

CTR (3):

For standard ads, your ad clickthrough rate (CTR) is the number of ad clicks divided by the number of individual ad impressions expressed as a fraction. Ad CTR = Clicks / Ad impressions.

GOOGLE_SOLD_AUCTION_COVIEWED_IMPRESSIONS (129):

The number of coviewed impressions sold by Google in partner sales.

GOOGLE_SOLD_AUCTION_IMPRESSIONS (128):

The number of auction impressions sold by Google in partner sales.

GOOGLE_SOLD_COVIEWED_IMPRESSIONS (131):

The number of coviewed impressions sold by Google in partner sales.

GOOGLE_SOLD_IMPRESSIONS (130):

The number of impressions sold by Google in partner sales.

GOOGLE_SOLD_RESERVATION_COVIEWED_IMPRESSIONS (127):

The number of coviewed impressions sold by Google in partner sales.

GOOGLE_SOLD_RESERVATION_IMPRESSIONS (126):

The number of reservation impressions sold by Google in partner sales.

IMPRESSIONS (1):

Total impressions from the Google Ad Manager server, AdSense, Ad Exchange, and yield group partners.

PARTNER_SALES_FILLED_POD_REQUESTS (135):

The number of filled pod requests (filled by partner or Google) in partner sales.

PARTNER_SALES_FILL_RATE (136):

The percent of filled requests to total ad requests in partner sales.

PARTNER_SALES_PARTNER_MATCH_RATE (137):

The percent of partner filled requests to total ad requests in partner sales.

PARTNER_SALES_QUERIES (132):

The number of queries eligible for partner sales.

PARTNER_SALES_UNFILLED_IMPRESSIONS (133):

The number of partner unfilled impressions in partner sales. If a pod request is not filled by partner but filled by Google, this metric will still count 1.

PARTNER_SALES_UNMATCHED_QUERIES (134):

The number of partner unmatched queries in partner sales. If an ad request is not filled by partner but filled by Google, this metric will still count 1.

PARTNER_SOLD_CODE_SERVED (125):

The number of code served sold by partner in partner sales.

PARTNER_SOLD_COVIEWED_IMPRESSIONS (124):

The number of coviewed impressions sold by partner in partner sales.

PARTNER_SOLD_IMPRESSIONS (123):

The number of impressions sold by partner in partner sales.

PROGRAMMATIC_ELIGIBLE_AD_REQUESTS (177):

The total number of ad requests eligible for programmatic inventory, including Programmatic Guaranteed, Preferred Deals, backfill, and open auction.

PROGRAMMATIC_MATCH_RATE (178):

The number of programmatic responses served divided by the number of programmatic eligible ad requests. Includes Ad Exchange, Open Bidding, and Preferred Deals.

PROGRAMMATIC_RESPONSES_SERVED (176):

Total number of ad responses served from programmatic demand sources. Includes Ad Exchange, Open Bidding, and Preferred Deals.

Differs from AD_EXCHANGE_RESPONSES_SERVED, which doesn’t include Open Bidding ad requests.

RESPONSES_SERVED (39):

The total number of times that an ad is served by the ad server including dynamic allocation.

REVENUE (36):

Total amount of CPM, CPC, and CPD revenue based on the number of units served by the Google Ad Manager server, AdSense, Ad Exchange, and third-party Mediation networks.

REVENUE_WITHOUT_CPD (4):

Total amount of revenue (excluding CPD) based on the number of units served by the Google Ad Manager server, AdSense, Ad Exchange, and third-party Mediation networks.

SUCCESSFUL_RESPONSES (84):

Number of times a yield group buyer successfully returned a bid in response to a yield group callout.

UNFILLED_IMPRESSIONS (45):

The total number of missed impressions due to the ad servers’ inability to find ads to serve including dynamic allocation.

UNMATCHED_AD_REQUESTS (43):

The total number of times that an ad is not returned by the ad server.

USER_MESSAGES_OFFERWALL_MESSAGES_SHOWN (121):

Number of times an Offerwall message was shown to users.

USER_MESSAGES_OFFERWALL_SUCCESSFUL_ENGAGEMENTS (122):

The number of messages where the user gained an entitlement.

VIDEO_INTERACTION_AVERAGE_INTERACTION_RATE (92):

The number of user interactions with a video, on average, such as pause, full screen, mute, etc.

VIDEO_INTERACTION_COLLAPSES (93):

The number of times a user collapses a video, either to its original size or to a different size.

VIDEO_INTERACTION_EXPANDS (95):

The number of times a user expands a video.

VIDEO_INTERACTION_FULL_SCREENS (96):

The number of times ad clip played in full screen mode.

VIDEO_INTERACTION_MUTES (97):

The number of times video player was in mute state during play of ad clip.

VIDEO_INTERACTION_PAUSES (98):

The number of times user paused ad clip.

VIDEO_INTERACTION_RESUMES (99):

The number of times the user unpaused the video.

VIDEO_INTERACTION_REWINDS (100):

The number of times a user rewinds the video.

VIDEO_INTERACTION_UNMUTES (101):

The number of times a user unmutes the video.

VIDEO_INTERACTION_VIDEO_SKIPS (102):

The number of times a skippable video is skipped.

VIDEO_REAL_TIME_CREATIVE_SERVES (139):

The number of total creative serves in video realtime reporting.

VIDEO_REAL_TIME_ERROR_100_COUNT (143):

The number of errors of type 100 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_101_COUNT (144):

The number of errors of type 101 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_102_COUNT (145):

The number of errors of type 102 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_200_COUNT (146):

The number of errors of type 200 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_201_COUNT (147):

The number of errors of type 201 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_202_COUNT (148):

The number of errors of type 202 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_203_COUNT (149):

The number of errors of type 203 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_300_COUNT (150):

The number of errors of type 300 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_301_COUNT (151):

The number of errors of type 301 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_302_COUNT (152):

The number of errors of type 302 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_303_COUNT (153):

The number of errors of type 303 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_400_COUNT (154):

The number of errors of type 400 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_401_COUNT (155):

The number of errors of type 401 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_402_COUNT (156):

The number of errors of type 402 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_403_COUNT (157):

The number of errors of type 403 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_405_COUNT (158):

The number of errors of type 405 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_406_COUNT (159):

The number of errors of type 406 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_407_COUNT (160):

The number of errors of type 407 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_408_COUNT (161):

The number of errors of type 408 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_409_COUNT (162):

The number of errors of type 409 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_410_COUNT (163):

The number of errors of type 410 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_500_COUNT (164):

The number of errors of type 500 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_501_COUNT (165):

The number of errors of type 501 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_502_COUNT (166):

The number of errors of type 502 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_503_COUNT (167):

The number of errors of type 503 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_600_COUNT (168):

The number of errors of type 600 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_601_COUNT (169):

The number of errors of type 601 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_602_COUNT (170):

The number of errors of type 602 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_603_COUNT (171):

The number of errors of type 603 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_604_COUNT (172):

The number of errors of type 604 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_900_COUNT (173):

The number of errors of type 900 in video realtime reporting.

VIDEO_REAL_TIME_ERROR_901_COUNT (174):

The number of errors of type 901 in video realtime reporting.

VIDEO_REAL_TIME_IMPRESSIONS (138):

The number of total impressions in video realtime reporting.

VIDEO_REAL_TIME_MATCHED_QUERIES (140):

The number of matched queries in video realtime reporting.

VIDEO_REAL_TIME_TOTAL_ERROR_COUNT (175):

The number of all errors in video realtime reporting.

VIDEO_REAL_TIME_TOTAL_QUERIES (142):

The number of total queries in video realtime reporting.

VIDEO_REAL_TIME_UNMATCHED_QUERIES (141):

The number of unmatched queries in video realtime reporting.

VIDEO_VIEWERSHIP_AUTO_PLAYS (103):

Number of times that the publisher specified a video ad played automatically.

VIDEO_VIEWERSHIP_AVERAGE_VIEW_RATE (104):

Average percentage of the video watched by users.

VIDEO_VIEWERSHIP_AVERAGE_VIEW_TIME (105):

Average time(seconds) users watched the video.

VIDEO_VIEWERSHIP_CLICK_TO_PLAYS (106):

Number of times that the publisher specified a video ad was clicked to play.

VIDEO_VIEWERSHIP_COMPLETES (107):

The number of times the video played to completion.

VIDEO_VIEWERSHIP_COMPLETION_RATE (108):

Percentage of times the video played to the end.

VIDEO_VIEWERSHIP_ENGAGED_VIEWS (109):

The number of engaged views: ad is viewed to completion or for 30s, whichever comes first.

VIDEO_VIEWERSHIP_FIRST_QUARTILES (110):

The number of times the video played to 25% of its length.

VIDEO_VIEWERSHIP_MIDPOINTS (111):

The number of times the video reached its midpoint during play.

VIDEO_VIEWERSHIP_SKIP_BUTTONS_SHOWN (112):

The number of times a skip button is shown in video.

VIDEO_VIEWERSHIP_STARTS (113):

The number of impressions where the video was played.

VIDEO_VIEWERSHIP_THIRD_QUARTILES (114):

The number of times the video played to 75% of its length.

VIDEO_VIEWERSHIP_TOTAL_ERROR_COUNT (115):

The number of times an error occurred, such as a VAST redirect error, a video playback error, or an invalid response error.

VIDEO_VIEWERSHIP_TOTAL_ERROR_RATE (94):

The percentage of video error count.

VIDEO_VIEWERSHIP_VIDEO_LENGTH (116):

Duration of the video creative.

VIDEO_VIEWERSHIP_VIEW_THROUGH_RATE (117):

View-through rate represented as a percentage.

YIELD_GROUP_ESTIMATED_CPM (88):

The estimated net rate for yield groups or individual yield group partners.

YIELD_GROUP_ESTIMATED_REVENUE (87):

Total net revenue earned by a yield group, based upon the yield group estimated CPM and yield group impressions recorded.

YIELD_GROUP_IMPRESSIONS (85):

Number of matched yield group requests where a yield partner delivered their ad to publisher inventory.

YIELD_GROUP_MEDIATION_FILL_RATE (89):

Yield group Mediation fill rate indicating how often a network fills an ad request.

YIELD_GROUP_MEDIATION_MATCHED_QUERIES (86):

Total requests where a Mediation chain was served.

YIELD_GROUP_MEDIATION_PASSBACKS (118):

The number of mediation chain passback across all channels.

YIELD_GROUP_MEDIATION_THIRD_PARTY_ECPM (90):

Revenue per thousand impressions based on data collected by Ad Manager from third-party ad network reports.

class MetricValueType(value)[source]¶

Bases: proto.enums.Enum

Possible metric value types to add.

Values:

PRIMARY (0):: The values for the primary date_range.
PRIMARY_PERCENT_OF_TOTAL (1):: Each metrics’ percent of the total for the primary date_range.
COMPARISON (2):: The values for the comparison_date_range.
COMPARISON_PERCENT_OF_TOTAL (3):: Each metrics’ percent of the total for the comparison_date_range.
ABSOLUTE_CHANGE (4):: The absolute change between the primary and comparison date ranges.
RELATIVE_CHANGE (5):: The relative change between the primary and comparison date ranges.

class ReportType(value)[source]¶

Bases: proto.enums.Enum

Supported report types.

Values:

REPORT_TYPE_UNSPECIFIED (0):: Default value. This value is unused.
HISTORICAL (1):: Historical.

class Slice(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Use to specify a slice of data.

For example, in a report, to focus on just data from the US, specify COUNTRY_NAME for dimension and value: "United States".

dimension¶

Required. The dimension to slice on.

Type: google.ads.admanager_v1.types.Report.Dimension

value¶

Required. The value of the dimension.

Type: google.ads.admanager_v1.types.Report.Value

class Sort(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represents a sorting in a report.

field¶

Required. A field (dimension or metric) to sort by.

Type: google.ads.admanager_v1.types.Report.Field

descending¶

Optional. The sort order. If true the sort will be descending.

Type: bool

slice_¶

Optional. Use to sort on a specific slice of data.

This field is a member of oneof _slice.

Type: google.ads.admanager_v1.types.Report.Slice

time_period_index¶

Optional. When using time period columns, use this to sort on a specific column.

This field is a member of oneof _time_period_index.

Type: int

metric_value_type¶

Optional. Use to specify which metric value type to sort on. Defaults to PRIMARY.

This field is a member of oneof _metric_value_type.

Type: google.ads.admanager_v1.types.Report.MetricValueType

class TimePeriodColumn(value)[source]¶

Bases: proto.enums.Enum

Valid time period columns.

Values:

TIME_PERIOD_COLUMN_UNSPECIFIED (0):: Default value. Report will have no time period column.
TIME_PERIOD_COLUMN_DATE (1):: A column for each date in the report.
TIME_PERIOD_COLUMN_WEEK (2):: A column for each week in the report.
TIME_PERIOD_COLUMN_MONTH (3):: A column for each month in the report.
TIME_PERIOD_COLUMN_QUARTER (4):: A column for each quarter in the report.

class Value(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represents a single value in a report.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

int_value¶

For integer values.

This field is a member of oneof value.

Type: int

double_value¶

For double values.

This field is a member of oneof value.

Type: float

string_value¶

For string values.

This field is a member of oneof value.

Type: str

bool_value¶

For boolean values.

This field is a member of oneof value.

Type: bool

int_list_value¶

For lists of integer values.

This field is a member of oneof value.

Type: google.ads.admanager_v1.types.Report.Value.IntList

string_list_value¶

For lists of string values.

This field is a member of oneof value.

Type: google.ads.admanager_v1.types.Report.Value.StringList

bytes_value¶

For bytes values.

This field is a member of oneof value.

Type: bytes

class IntList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A list of integer values.

values¶

The values

Type: MutableSequence[int]

class StringList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A list of string values.

values¶

The values

Type: MutableSequence[str]

class Visibility(value)[source]¶

Bases: proto.enums.Enum

The visibility of a report.

Values:

HIDDEN (0):: Default value. Reports with hidden visibility will not appear in the Ad Manager UI.
DRAFT (1):: Reports with draft visibility will appear in the Ad Manager UI only if the user has configured the UI to show them.
SAVED (2):: Reports with saved visibility will appear in the Ad Manager UI by default.

class google.ads.admanager_v1.types.ReportDefinition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The definition of how a report should be run.

dimensions¶

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Dimension]

metrics¶

Required. The list of metrics to report on. If empty, the report will have no metrics.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Metric]

filters¶

Optional. The filters for this report.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Filter]

time_zone¶

Optional. The time zone the date range is defined in for this report. Defaults to publisher’s time zone if not specified. Time zone in IANA format. Acceptable values depend on the report type. Publisher time zone is always accepted. Use “America/Los_Angeles” for pacific time, or “Etc/UTC” for UTC.

Type: str

currency_code¶

Optional. The ISO 4217 currency code for this report. Defaults to publisher currency code if not specified.

Type: str

date_range¶

Required. The primary date range of this report.

Type: google.ads.admanager_v1.types.Report.DateRange

comparison_date_range¶

Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.

This field is a member of oneof _comparison_date_range.

Type: google.ads.admanager_v1.types.Report.DateRange

custom_dimension_key_ids¶

Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, custom_dimension_key_ids[0] describes CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE.

Type: MutableSequence[int]

line_item_custom_field_ids¶

Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, line_item_custom_field_ids[0] describes LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE.

Type: MutableSequence[int]

order_custom_field_ids¶

Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, order_custom_field_ids[0] describes ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE.

Type: MutableSequence[int]

creative_custom_field_ids¶

Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, creative_custom_field_ids[0] describes CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE.

Type: MutableSequence[int]

report_type¶

Required. The type of this report.

Type: google.ads.admanager_v1.types.Report.ReportType

time_period_column¶

Optional. Include a time period column to introduce comparison columns in the report for each generated period. For example, set to “QUARTERS” here to have a column for each quarter present in the primary date range. If “PREVIOUS PERIOD” is specified in comparison_date_range, then each quarter column will also include comparison values for its relative previous quarter.

Type: google.ads.admanager_v1.types.Report.TimePeriodColumn

flags¶

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Flag]

sorts¶

Optional. Default sorts to apply to this report.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Sort]

class google.ads.admanager_v1.types.Role(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The Role resource.

name¶

Identifier. The resource name of the Role. Format: networks/{network_code}/roles/{role_id}

Type: str

role_id¶

Output only. Role ID.

Type: int

display_name¶

Required. The display name of the Role.

Type: str

description¶

Optional. The description of the Role.

Type: str

built_in¶

Output only. Whether the Role is a built-in or custom user role.

Type: bool

status¶

Output only. The status of the Role.

Type: google.ads.admanager_v1.types.RoleStatusEnum.RoleStatus

class google.ads.admanager_v1.types.RoleStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [RoleStatus][google.ads.admanager.v1.RoleStatusEnum.RoleStatus]

class RoleStatus(value)[source]¶

Bases: proto.enums.Enum

The status of the role.

Values:

ROLE_STATUS_UNSPECIFIED (0):: No value specified.
ACTIVE (1):: Role is active.
INACTIVE (2):: Role is inactive.

class google.ads.admanager_v1.types.RunReportMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

RunReport operation metadata.

percent_complete¶

An estimate of how close this report is to being completed. Will always be 100 for failed and completed reports.

Type: int

report¶

The result’s parent report.

Type: str

class google.ads.admanager_v1.types.RunReportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for a running a report.

name¶

Required. The report to run. Format: networks/{network_code}/reports/{report_id}

Type: str

class google.ads.admanager_v1.types.RunReportResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for a completed RunReport operation.

report_result¶

The unique name of the generated result. Use with FetchReportResultRows to retrieve data.

Type: str

class google.ads.admanager_v1.types.Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The schedule for the report

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

weekly_schedule¶

Days of week to schedule report run.

This field is a member of oneof frequency_schedule.

Type: google.ads.admanager_v1.types.Schedule.WeeklySchedule

monthly_schedule¶

Days of month to schedule report run.

This field is a member of oneof frequency_schedule.

Type: google.ads.admanager_v1.types.Schedule.MonthlySchedule

start_date¶

Date for the first run of the report.

Type: google.type.date_pb2.Date

end_date¶

Date for the final run of the report.

Type: google.type.date_pb2.Date

frequency¶

Frequency to run report.

Type: google.ads.admanager_v1.types.Schedule.Frequency

start_time¶

Indicates start time for schedule to run Will use the time_zone from ReportDefinition. Defaults to the publisher’s time zone if not specified.

For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this will be the time of day that the first report will run on the first day. For example, if the start time is 2:00 PM, and the frequency is THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, 2:00 PM, 10:00 PM.

Type: google.type.timeofday_pb2.TimeOfDay

class Frequency(value)[source]¶

Bases: proto.enums.Enum

Frequency to run report.

Values:

FREQUENCY_UNSPECIFIED (0):: No Frequency specified.
HOURLY (1):: Schedule report to run every hour.
TWO_TIMES_DAILY (2):: Schedule report to run twice a day (every 12 hours).
THREE_TIMES_DAILY (3):: Schedule report to run three times a day (every 8 hours).
FOUR_TIMES_DAILY (4):: Schedule report to run four times a day (every 6 hours).
DAILY (5):: Schedule report to run on a daily basis.
WEEKLY (6):: Schedule report to run on a weekly basis.
MONTHLY (7):: Schedule report to run on a monthly basis.

class MonthlySchedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Days of Month to schedule report run.

monthly_scheduled_days¶

Specifies days of the month to run report. Range is from 1-31. Will ignore days that are not valid for the given month.

Type: MutableSequence[int]

class WeeklySchedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Days of week to schedule report run.

weekly_scheduled_days¶

Specifies days of the week on which to run report.

Type: MutableSequence[google.type.dayofweek_pb2.DayOfWeek]

class google.ads.admanager_v1.types.ScheduleOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The options for a scheduled report.

schedule¶

Information pertaining to schedule itself.

Type: google.ads.admanager_v1.types.Schedule

delivery_condition¶

Option for when to deliver the scheduled report.

Type: google.ads.admanager_v1.types.ScheduleOptions.DeliveryCondition

flags¶

Optional. The flags evaluated when ReportDeliveryOption.WHEN_FLAG_PRESENT is specified.

Type: MutableSequence[google.ads.admanager_v1.types.Report.Flag]

class DeliveryCondition(value)[source]¶

Bases: proto.enums.Enum

Condition for when to email the scheduled report.

Values:

NEVER (0):: Never deliver report.
ALWAYS (1):: Always deliver report.
WHEN_FLAG_CONDITIONS_MET (2):: Deliver report when flag’s conditions are met.

class google.ads.admanager_v1.types.Size(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represents the dimensions of an AdUnit, LineItem, or Creative.

width¶

Required. The width of the Creative, AdUnit, or LineItem.

Type: int

height¶

Required. The height of the Creative, AdUnit, or LineItem.

Type: int

size_type¶

Required. The SizeType of the Creative, AdUnit, or LineItem.

Type: google.ads.admanager_v1.types.SizeTypeEnum.SizeType

class google.ads.admanager_v1.types.SizeTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [SizeType][google.ads.admanager.v1.SizeTypeEnum.SizeType].

class SizeType(value)[source]¶

Bases: proto.enums.Enum

The different Size types for an ad.

Values:

SIZE_TYPE_UNSPECIFIED (0):: Default value. This value is unused.
PIXEL (1):: Dimension based size, an actual height and width in pixels.
ASPECT_RATIO (2):: Size is expressed as a ratio. For example, 4:1 could be met by a 100 x 25 sized image.
INTERSTITIAL (3):: Out-of-page (Interstitial) size that is not related to the slot it is served. This must be used with 1x1 size.
IGNORED (4):: Size is ignored. This must be used with 1x1 size.
NATIVE (5):: Native size, which is a function of the how the client renders the creative. This must be used with 1x1 size.
FLUID (6):: Fluid size. Automatically sizes the ad by filling the width of the enclosing column and adjusting the height as appropriate. This must be used with 1x1 size.
AUDIO (7):: Audio size. Used with audio ads. This must be used with 1x1 size.

class google.ads.admanager_v1.types.SmartSizeModeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [SmartSizeMode][google.ads.admanager.v1.SmartSizeModeEnum.SmartSizeMode].

class SmartSizeMode(value)[source]¶

Bases: proto.enums.Enum

The smart size mode for this ad unit. This attribute is optional and defaults to SmartSizeMode.NONE for fixed sizes.

Values:

SMART_SIZE_MODE_UNSPECIFIED (0):: Default value. This value is unused.
NONE (1):: Fixed size mode (default).
SMART_BANNER (2):: The height is fixed for the request, the width is a range.
DYNAMIC_SIZE (3):: Height and width are ranges.

class google.ads.admanager_v1.types.TargetWindowEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for [TargetWindow][google.ads.admanager.v1.TargetWindowEnum.TargetWindow].

class TargetWindow(value)[source]¶

Bases: proto.enums.Enum

Corresponds to an HTML link’s target attribute. See http://www.w3.org/TR/html401/present/frames.html#adef-target

Values:

TARGET_WINDOW_UNSPECIFIED (0):: Default value. This value is unused.
TOP (1):: Specifies that the link should open in the full body of the page.
BLANK (2):: Specifies that the link should open in a new window.

class google.ads.admanager_v1.types.TaxonomyCategory(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The TaxonomyCategory resource.

name¶

Identifier. The resource name of the TaxonomyCategory. Format: networks/{network_code}/taxonomyCategories/{taxonomy_category_id}

Type: str

taxonomy_category_id¶

Output only. TaxonomyCategory ID.

Type: int

display_name¶

Output only. Display name of the TaxonomyCategory.

Type: str

grouping_only¶

Output only. Whether this TaxonomyCategory only serves to group its children.

Type: bool

parent_taxonomy_category_id¶

Output only. The ID of the parent category this TaxonomyCategory descends from.

Type: int

taxonomy_type¶

Output only. The taxonomy that this TaxonomyCategory belongs to.

Type: google.ads.admanager_v1.types.TaxonomyTypeEnum.TaxonomyType

ancestor_names¶

Output only. The list of names of the ancestors of this TaxonomyCategory.

Type: MutableSequence[str]

ancestor_taxonomy_category_ids¶

Output only. The list of IDs of the ancestors of this TaxonomyCategory.

Type: MutableSequence[int]

class google.ads.admanager_v1.types.TaxonomyTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper for [TaxonomyType][google.ads.admanager.v1.TaxonomyTypeEnum.TaxonomyType]

class TaxonomyType(value)[source]¶

Bases: proto.enums.Enum

The taxonomy type of the IAB defined taxonomies. Used for Publisher provided signals.

Values:

TAXONOMY_TYPE_UNSPECIFIED (0):: Unspecified/not present
TAXONOMY_IAB_AUDIENCE_1_1 (3):: The IAB Audience Taxonomy v1.1.
TAXONOMY_IAB_CONTENT_2_1 (4):: The IAB Content Taxonomy v2.1.
TAXONOMY_IAB_CONTENT_2_2 (6):: The IAB Content Taxonomy v2.2.
TAXONOMY_IAB_CONTENT_3_0 (5):: The IAB Content Taxonomy v3.0.
TAXONOMY_GOOGLE_STRUCTURED_VIDEO_1_0 (7):: The PPS structured video signals taxonomy.

class google.ads.admanager_v1.types.Team(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A Team defines a grouping of users and what entities they have access to.

name¶

Identifier. The resource name of the Team. Format: networks/{network_code}/teams/{team_id}

Type: str

team_id¶

Output only. The unique ID of the Team. This value is assigned by Google. Teams that are created by Google will have negative IDs.

Type: int

class google.ads.admanager_v1.types.TimeUnitEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Wrapper message for TimeUnit.

class TimeUnit(value)[source]¶

Bases: proto.enums.Enum

Unit of time for the frequency cap.

Values:

TIME_UNIT_UNSPECIFIED (0):: Default value. This value is unused.
MINUTE (1):: Minute
HOUR (2):: Hour
DAY (3):: Day
WEEK (4):: Week
MONTH (5):: Month
LIFETIME (6):: Lifetime
POD (7):: Per pod of ads in a video stream. Only valid for entities in a VIDEO_PLAYER environment.
STREAM (8):: Per video stream. Only valid for entities in a VIDEO_PLAYER environment.

class google.ads.admanager_v1.types.UpdateEntitySignalsMappingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for ‘UpdateEntitySignalsMapping’ method.

entity_signals_mapping¶

Required. The EntitySignalsMapping to update.

The EntitySignalsMapping’s name is used to identify the EntitySignalsMapping to update. Format: networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}

Type: google.ads.admanager_v1.types.EntitySignalsMapping

update_mask¶

Required. The list of fields to update.

Type: google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateReportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request object for UpdateReport method.

report¶

Required. The Report to update.

Type: google.ads.admanager_v1.types.Report

update_mask¶

Required. The list of fields to update.

Type: google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.User(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The User resource.

name¶

Identifier. The resource name of the User. Format: networks/{network_code}/users/{user_id}

Type: str

user_id¶

Output only. User ID.

Type: int

display_name¶

Required. The name of the User. It has a maximum length of 128 characters.

Type: str

email¶

Required. The email or login of the User. In order to create a new user, you must already have a Google Account.

Type: str

role¶

Required. The unique Role ID of the User. Roles that are created by Google will have negative IDs.

Type: str

active¶

Output only. Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations.

Type: bool

external_id¶

Optional. An identifier for the User that is meaningful to the publisher. This attribute has a maximum length of 255 characters.

Type: str

service_account¶

Output only. Whether the user is an OAuth2 service account user. Service account users can only be added through the UI.

Type: bool

orders_ui_local_time_zone¶

Optional. The IANA Time Zone Database time zone, e.g. “America/New_York”, used in the orders and line items UI for this User. If not provided, the UI then defaults to using the Network’s timezone. This setting only affects the UI for this user and does not affect the timezone of any dates and times returned in API responses.

Type: str

Types for Google Ads Admanager v1 API¶

google-ads-admanager

Navigation

Related Topics