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.ActivateCustomTargetingValueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message to activate a CustomTargetingValue.

name

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

Type

str

class google.ads.admanager_v1.types.ActivateDaiEncodingProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ActivateDaiEncodingProfile method.

name

Required. The resource name of the DaiEncodingProfile to activate. Format: networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}

Type

str

class google.ads.admanager_v1.types.AdBreak(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The AdBreak resource.

name

Identifier. The resource name of the AdBreak. This field uses the LiveStreamEvent resource’s asset key in the URI, even if the ad break was created, updated, or queried using the custom asset key.

Format: networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break_id}

Type

str

ad_break_id

Optional. Immutable. AdBreak ID. Must consist only of lowercase letters, digits, and hyphens. Ad break IDs have a maximum length of 63 characters. If not set, an ad break ID is generated as a UUID string.

This field is a member of oneof _ad_break_id.

Type

str

asset_key

Optional. Immutable. The asset key of the LiveStreamEvent that the ad break belongs to. Either an asset key or a custom asset key must be provided for creation.

This field is a member of oneof _asset_key.

Type

str

custom_asset_key

Optional. Immutable. The custom asset key of the LiveStreamEvent that the ad break belongs to. Either an asset key or a custom asset key must be provided for creation.

This field is a member of oneof _custom_asset_key.

Type

str

expected_start_time

Optional. The expected start time of the ad break. When set, the scheduled ad break will be decisioned shortly before the expected start time. If this field is not set, ad decisioning begins immediately. An ad break can be created up to six hours before the expected start time.

This field is a member of oneof _expected_start_time.

Type

google.protobuf.timestamp_pb2.Timestamp

duration

Required. The duration of the AdBreak. An expected duration in seconds with up to nine fractional digits, ending with s, for example, 3.5s. This value will be updated to match the actual duration from the manifest or pod request after the ad break’s state is [COMPLETE][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.COMPLETE].

This field is a member of oneof _duration.

Type

google.protobuf.duration_pb2.Duration

break_state

Output only. The state of the AdBreak.

This field is a member of oneof _break_state.

Type

google.ads.admanager_v1.types.AdBreakStateEnum.AdBreakState

break_sequence

Output only. The sequence id of the AdBreak. The unique sequence number of the created ad break. This value is only set after the AdBreak starts decisioning indicated by the ad break state’s being [DECISIONED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.DECISIONED] .

This field is a member of oneof _break_sequence.

Type

int

pod_template_name

Optional. The pod template name of the AdBreak. This field is the required unique name across all pod templates in the network, not the display name.

This field is a member of oneof _pod_template_name.

Type

str

custom_params

Optional. The key-value pairs to be included on the ad requests for this AdBreak. Key-value pairs to include on ad requests for this break for custom criteria targeting in Google Ad Manager, separated by = and joined by &.

Format:”key1=value&key2=value”.

This field is a member of oneof _custom_params.

Type

str

scte_35_cue_out

Optional. The Base64-encoded SCTE-35 command associated with the AdBreak. This field can include the splice_insert() or time_signal() command.

Examples

• time_signal()

  /DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==
  

• splice_insert()

  /DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=
  

This field is a member of oneof _scte_35_cue_out.

Type

str

class google.ads.admanager_v1.types.AdBreakFillTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [AdBreakFillType][google.ads.admanager.v1.AdBreakFillTypeEnum.AdBreakFillType]

class AdBreakFillType(value)

Bases: proto.enums.Enum

Describes what should be used to fill an empty or underfilled ad break during a live stream.

Values:

AD_BREAK_FILL_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

MINIMIZE_SLATE (1):

Ad break should be filled with mostly underlying content. When ad content can’t be aligned with underlying content during transition, the gap will be bridged with slate to maintain the timeline.

SLATE (2):

Ad break should be filled with slate.

UNDERLYING_CONTENT (3):

Ad break should be filled with underlying content.

class google.ads.admanager_v1.types.AdBreakMarkupTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [AdBreakMarkupType][google.ads.admanager.v1.AdBreakMarkupTypeEnum.AdBreakMarkupType]

class AdBreakMarkupType(value)

Bases: proto.enums.Enum

Describes the SCTE ad break markups for a LiveStreamEvent.

Values:

AD_BREAK_MARKUP_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

HLS_DATERANGE_SPLICE (1):

The DATERANGE ad break marker type. This mark up type is only applicable for HLS live streams.

HLS_EXT_CUE (2):

The CUE-OUT/CUE-IN ad break marker type. This mark up type is only applicable for HLS live streams.

HLS_PRIMETIME_SPLICE (3):

The CUE (Adobe/Azure Prime Time) ad break marker type. This mark up type is only applicable for HLS live streams.

SCTE35_BINARY_BREAK_START_END (4):

The SCTE35 Binary Time Signal: Break Start/End ad break marker type. This mark up type is only applicable for HLS and DASH live streams.

SCTE35_BINARY_PROVIDER_AD_START_END (5):

The SCTE35 Binary Time Signal: Provider Ad Start/End ad break marker type. This mark up type is only applicable for HLS and DASH live streams.

SCTE35_BINARY_PROVIDER_PLACEMENT_OP_START_END (6):

The SCTE35 Binary Time Signal: Provider Placement Opportunity Start/End ad break marker type. This mark up type is only applicable for HLS and DASH live streams.

SCTE35_BINARY_SPLICE_INSERT (7):

The SCTE35 Binary Splice Insert ad break marker type. This mark up type is only applicable for HLS and DASH live streams.

SCTE35_XML_SPLICE_INSERT (11):

The SCTE35 XML Splice In/Out ad break marker type. This markup type is only applicable for DASH live streams.

class google.ads.admanager_v1.types.AdBreakStateEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [AdBreakState][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState]

class AdBreakState(value)

Bases: proto.enums.Enum

Represents the state of an ad break

Values:

AD_BREAK_STATE_UNSPECIFIED (0):

Default value. This value is unused.

DECISIONED (1):

The ad break’s decisioning has finished. You can delete, but not update the ad break.

COMPLETE (2):

The ad break has started serving to users. You cannot delete or update the ad break.

SCHEDULED (3):

The ad break is scheduled and decisioning will start later. You can delete or update the ad break.

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

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.AdMediaDeliveryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Parameters about this CDN config of a CDN used for delivering ad media.

override_default_delivery_settings

Optional. Whether to override the default delivery CDN. If false, deliverySettings must be null.

This field is a member of oneof _override_default_delivery_settings.

Type

bool

delivery_settings

Optional. Config for the delivery location that will override the default. From MediaLocationDto, the URL prefix field represents the hostname of the external CDN and the security policy will be ignored. Null if overrideDefaultDeliverySettings is false.

Type

google.ads.admanager_v1.types.MediaLocation

additional_delivery_settings

Optional. List of additional delivery locations. From MediaLocationDto, the URL prefix field represents the hostname of the external CDN and the security policy will be ignored. In your stream create request, you can set the value of the dai-dlid parameter to the name of the MediaLocation you want to use.

Type

MutableSequence[google.ads.admanager_v1.types.MediaLocation]

class google.ads.admanager_v1.types.AdReviewCenterAd(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents an ad that can be acted on or viewed in the Ad Review Center. [AdReviewCenterAd][google.ads.admanager.v1.AdReviewCenterAd].

name

Identifier. The resource name of the AdReviewCenterAd. Format: networks/{network_code}/webProperties/{web_property_code}/adReviewCenterAds/{ad_review_center_ad_id}

Type

str

ad_review_center_ad_id

Output only. AdReviewCenterAd ID.

Type

str

product_type

Output only. Specifies the ExchangeSyndicationProduct for this AdReviewCenterAd.

Type

google.ads.admanager_v1.types.ExchangeSyndicationProductEnum.ExchangeSyndicationProduct

status

The status of the AdReviewCenterAd.

Type

google.ads.admanager_v1.types.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus

manual_review_statuses

Output only. The manual review status of the AdReviewCenterAd (for web properties in MCR mode). For MCR mode, a single ad could have multiple statuses (for example, pending and serving at the same time, if the ad is affected by a protection in certain inventory only). This field is not set for the standard mode.

Type

MutableSequence[google.ads.admanager_v1.types.ManualAdReviewCenterAdStatusEnum.ManualAdReviewCenterAdStatus]

preview_url

Output only. The preview URL that can be embedded or accessed directly which will present the rendered contents of the ad. (This URL expires 72 hours after being retrieved.).

This field is a member of oneof _preview_url.

Type

str

class google.ads.admanager_v1.types.AdReviewCenterAdStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [AdReviewCenterAdStatus][google.ads.admanager.v1.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus]

class AdReviewCenterAdStatus(value)

Bases: proto.enums.Enum

Specifies the status of an AdReviewCenterAd.

Values:

AD_REVIEW_CENTER_AD_STATUS_UNSPECIFIED (0):

Not specified value

ALLOWED (1):

This ad has been explicitly allowed to serve.

BLOCKED (2):

This ad has been explicitly blocked from serving.

UNREVIEWED (3):

This ad is allowed to serve by default and has not been reviewed.

class google.ads.admanager_v1.types.AdRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An AdRule contains data that the ad server will use to generate a playlist of video ads.

name

Identifier. The resource name of the AdRule. Format: networks/{network_code}/adRules/{ad_rule_id}

Type

str

display_name

Required. The unique name of the AdRule. This attribute is required to create an ad rule and has a maximum length of 255 characters.

This field is a member of oneof _display_name.

Type

str

priority

Optional. The priority of the AdRule. This attribute is required and can range from 1 to 1000, with 1 being the highest possible priority.

Changing an ad rule’s priority can affect the priorities of other ad rules. For example, increasing an ad rule’s priority from 5 to 1 will shift the ad rules that were previously in priority positions 1 through 4 down one.

This field is a member of oneof _priority.

Type

int

start_time

Required. The start time of the AdRule. This attribute is required and must be a date in the future for new ad rules.

This field is a member of oneof _start_time.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Optional. This end time of the AdRule. This attribute is required unless [end_time_unlimited][google.ads.admanager.v1.AdRule.end_time_unlimited] is set to true. If specified, it must be after the [start_time][google.ads.admanager.v1.AdRule.start_time].

This field is a member of oneof _end_time.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time_unlimited

Optional. Specifies whether or not the AdRule has an end time. This attribute is optional and defaults to false.

This field is a member of oneof _end_time_unlimited.

Type

bool

status

Output only. The AdRuleStatus of the AdRule. This attribute is read-only and defaults to [AdRuleStatus.INACTIVE][].

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.AdRuleStatusEnum.AdRuleStatus

frequency_cap_behavior

Optional. The FrequencyCapBehavior of the AdRule. This attribute is optional and defaults to [FrequencyCapBehavior.DEFER][].

This field is a member of oneof _frequency_cap_behavior.

Type

google.ads.admanager_v1.types.AdRuleFrequencyCapBehaviorEnum.AdRuleFrequencyCapBehavior

max_impressions_per_line_item_per_stream

Optional. This AdRule object’s frequency cap for the maximum impressions per stream. This attribute is optional and defaults to 0.

This field is a member of oneof _max_impressions_per_line_item_per_stream.

Type

int

max_impressions_per_line_item_per_pod

Optional. This AdRule object’s frequency cap for the maximum impressions per pod. This attribute is optional and defaults to 0.

This field is a member of oneof _max_impressions_per_line_item_per_pod.

Type

int

preroll

Required. This AdRule object’s pre-roll slot. This attribute is required.

This field is a member of oneof _preroll.

Type

google.ads.admanager_v1.types.AdRuleSlot

midrolls

Required. This AdRule object’s video mid-roll slots. This attribute is required, and there must be at least one mid-roll.

Type

MutableSequence[google.ads.admanager_v1.types.AdRuleSlot]

postroll

Required. This AdRule object’s post-roll slot. This attribute is required.

This field is a member of oneof _postroll.

Type

google.ads.admanager_v1.types.AdRuleSlot

targeting

Required. The targeting of the AdRule.

This field is a member of oneof _targeting.

Type

google.ads.admanager_v1.types.Targeting

class google.ads.admanager_v1.types.AdRuleFrequencyCapBehaviorEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [AdRuleFrequencyCapBehavior][google.ads.admanager.v1.AdRuleFrequencyCapBehaviorEnum.AdRuleFrequencyCapBehavior]

class AdRuleFrequencyCapBehavior(value)

Bases: proto.enums.Enum

Types of behavior for frequency caps within ad rules.

Values:

AD_RULE_FREQUENCY_CAP_BEHAVIOR_UNSPECIFIED (0):

Default value. This value is unused.

DEFER (1):

Defer frequency cap decisions to the next ad rule in priority order.

TURN_OFF (2):

Turn off all frequency caps.

TURN_ON (3):

Turn on at least one of the frequency caps.

class google.ads.admanager_v1.types.AdRuleSlot(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Simple object representing an ad slot within an AdRule. Ad rule slots contain information about the types/number of ads to display, as well as additional information on how the ad server will generate playlists.

slot_behavior

Optional. The AdRuleSlotBehavior for video ads for this slot. This attribute is optional and defaults to [AdRuleSlotBehavior.DEFER][]. Indicates whether video ads are allowed for this slot, or if the decision is deferred to alower-priority ad rule.

This field is a member of oneof _slot_behavior.

Type

google.ads.admanager_v1.types.AdRuleSlotBehaviorEnum.AdRuleSlotBehavior

max_video_ad_duration

Optional. The maximum duration in milliseconds of video ads within this slot. This attribute is optional and defaults to 0.

This field is a member of oneof _max_video_ad_duration.

Type

google.protobuf.duration_pb2.Duration

video_midroll_frequency_type

Optional. The frequency type for video ads in this ad rule slot. This attribute is required for mid-rolls, but if this is not a mid-roll, the value is set to [AdRuleSlotMidrollFrequencyType.NONE][].

This field is a member of oneof _video_midroll_frequency_type.

Type

google.ads.admanager_v1.types.AdRuleSlotMidrollFrequencyTypeEnum.AdRuleSlotMidrollFrequencyType

video_midroll_frequency

Optional. The mid-roll frequency of this ad rule slot for video ads. This attribute is required for mid-rolls, but if MidrollFrequencyType is set to [AdRuleSlotMidrollFrequencyType.NONE][], this value should be ignored. For example, if this slot has a frequency type of [AdRuleSlotMidrollFrequencyType.EVERY_N_SECONDS][] and

seconds.”.

This field is a member of oneof _video_midroll_frequency.

Type

str

bumper

Optional. The AdRuleSlotBumper for this slot. This attribute is optional and defaults to [AdRuleSlotBumper.NONE][].

This field is a member of oneof _bumper.

Type

google.ads.admanager_v1.types.AdRuleSlotBumperEnum.AdRuleSlotBumper

max_bumper_duration

Optional. The maximum duration of bumper ads within this slot. This attribute is optional and defaults to 0.

This field is a member of oneof _max_bumper_duration.

Type

google.protobuf.duration_pb2.Duration

max_pod_duration

Optional. The maximum pod duration for this slot. This attribute is optional and defaults to 0.

This field is a member of oneof _max_pod_duration.

Type

google.protobuf.duration_pb2.Duration

pod_max_ad_count

Optional. The maximum number of ads allowed in a pod in this slot. This attribute is optional and defaults to 0.

This field is a member of oneof _pod_max_ad_count.

Type

int

class google.ads.admanager_v1.types.AdRuleSlotBehaviorEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [AdRuleSlotBehavior][google.ads.admanager.v1.AdRuleSlotBehaviorEnum.AdRuleSlotBehavior]

class AdRuleSlotBehavior(value)

Bases: proto.enums.Enum

The types of behaviors for ads within a BaseAdRuleSlot ad rule slot.

Values:

AD_RULE_SLOT_BEHAVIOR_UNSPECIFIED (0):

Default value. This value is unused.

ALWAYS_SHOW (1):

This ad rule always includes this slot’s ads.

DEFER (2):

Defer to lower priority rules. This ad rule doesn’t specify guidelines for this slot’s ads.

NEVER_SHOW (3):

This ad rule never includes this slot’s ads.

class google.ads.admanager_v1.types.AdRuleSlotBumperEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [AdRuleSlotBumper][google.ads.admanager.v1.AdRuleSlotBumperEnum.AdRuleSlotBumper]

class AdRuleSlotBumper(value)

Bases: proto.enums.Enum

Types of bumper ads on an ad rule slot.

Values:

AD_RULE_SLOT_BUMPER_UNSPECIFIED (0):

Default value. This value is unused.

AFTER (1):

Show a bumper ad after the slot’s other ads.

BEFORE (2):

Show a bumper ad before the slot’s other ads.

BEFORE_AND_AFTER (3):

Show a bumper before and after the slot’s other ads.

NONE (4):

Do not show a bumper ad.

class google.ads.admanager_v1.types.AdRuleSlotMidrollFrequencyTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [AdRuleSlotMidrollFrequencyType][google.ads.admanager.v1.AdRuleSlotMidrollFrequencyTypeEnum.AdRuleSlotMidrollFrequencyType]

class AdRuleSlotMidrollFrequencyType(value)

Bases: proto.enums.Enum

Frequency types for mid-roll BaseAdRuleSlot ad rule slots.

Values:

AD_RULE_SLOT_MIDROLL_FREQUENCY_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

EVERY_N_CUEPOINTS (1):

MidrollFrequency is a cue point interval and is a single integer value, such as “5”, which means “play a mid-roll every 5th cue point”.

EVERY_N_SECONDS (2):

MidrollFrequency is a time interval and mentioned as a single numeric value in seconds. For example, “100” would mean “play a mid-roll every 100 seconds”.

FIXED_CUE_POINTS (3):

Same as FIXED_TIME, except the values represent the ordinal cue points (“1,3,5”, for example).

FIXED_TIME (4):

MidrollFrequency is a comma-delimited list of points in time (in seconds) when an ad should play. For example, “100,300” would mean “play an ad at 100 seconds and 300 seconds”.

NONE (5):

The ad rule slot is not a mid-roll and MidrollFrequency should be ignored.

REVERSE_MIDROLL_INDEX (6):

After all other frequency type is applied and the number of midrolls are settled, this slot setting will override the mid-roll defined by ReverseMidrollIndex.

class google.ads.admanager_v1.types.AdSpot(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An AdSpot is a targetable entity used in the creation of AdRule objects. A ad spot contains a variable number of ads and has constraints (ad duration, reservation type, etc) on the ads that can appear in it.

name

Identifier. The resource name of the AdSpot. Format: networks/{network_code}/adSpots/{ad_spot_id}

Type

str

canonical_display_name

Optional. Name of the AdSpot. The name is case insensitive and can be referenced in ad tags. This value is required if customSpot is true, and cannot be set otherwise. You can use alphanumeric characters and symbols other than the following: “, ‘, =, !, +, #, , ~, ;, ^, (, ), <, >, [, ], the white space character.

This field is a member of oneof _canonical_display_name.

Type

str

display_name

Optional. Descriptive name for the AdSpot.This value is optional if customSpot is true, and cannot be set otherwise.

This field is a member of oneof _display_name.

Type

str

custom_spot

Optional. Whether this ad spot is a custom spot. This field is optional and defaults to false. Custom spots can be reused and targeted in the targeting picker.

This field is a member of oneof _custom_spot.

Type

bool

flexible

Optional. Whether this ad spot is a flexible spot. This field is optional and defaults to false. Flexible spots are allowed to have no max number of ads.

This field is a member of oneof _flexible.

Type

bool

max_duration

Optional. The maximum total duration for this AdSpot. This field is optional, defaults to 0, and supports precision to the nearest second.

This field is a member of oneof _max_duration.

Type

google.protobuf.duration_pb2.Duration

min_ad_duration

Optional. The minimum allowed duration for ads in the AdSpot. This field is optional and defaults to 0.

This field is a member of oneof _min_ad_duration.

Type

google.protobuf.duration_pb2.Duration

max_ad_duration

Required. The maximum allowed duration for ads in the AdSpot. This field is required and must be greater than [min_ad_duration][google.ads.admanager.v1.AdSpot.min_ad_duration].

This field is a member of oneof _max_ad_duration.

Type

google.protobuf.duration_pb2.Duration

max_ads

Optional. The maximum number of ads allowed in the AdSpot. This field is optional and defaults to 0. A value of 0 means that there is no maximum for the number of ads in the ad spot. No max ads is only supported for ad spots that have flexible set to true.

This field is a member of oneof _max_ads.

Type

int

targeting_type

Optional. The AdSpot TargetingType determines how this ad spot can be targeted. This field is required.

This field is a member of oneof _targeting_type.

Type

google.ads.admanager_v1.types.AdSpotTargetingTypeEnum.AdSpotTargetingType

backfill_blocked

Optional. Whether backfill is blocked in this ad spot. This field is optional and defaults to false.

This field is a member of oneof _backfill_blocked.

Type

bool

allowed_line_item_types

Optional. The set of line item types that may appear in the ad spot. This field is optional and defaults to an empty set, which means that all types are allowed. Note, backfill reservation types are controlled by the backfillBlocked field.

Type

MutableSequence[google.ads.admanager_v1.types.LineItemTypeEnum.LineItemType]

inventory_sharing_blocked

Optional. Whether inventory sharing is blocked in this ad spot. This field is optional and defaults to false.

This field is a member of oneof _inventory_sharing_blocked.

Type

bool

class google.ads.admanager_v1.types.AdSpotTargetingTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [AdSpotTargetingType][google.ads.admanager.v1.AdSpotTargetingTypeEnum.AdSpotTargetingType]

class AdSpotTargetingType(value)

Bases: proto.enums.Enum

Defines the targeting behavior of an ad spot.

Values:

AD_SPOT_TARGETING_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

EXPLICITLY_TARGETED (1):

Only line items targeting this ad spots explicitly may serve in it

EXPLICITLY_TARGETED_EXCEPT_HOUSE (2):

If house ads are an allowed reservation type, they may serve in the ad spot regardless of whether they explicitly target it. Ads of other reservation types (whose type is allowed in the ad spot), may serve in the ad spot only if explicitly targeted.

NOT_REQUIRED (3):

Line items not targeting this ad spot explicitly may serve in it.

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

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. Deprecated: 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}”.

This field is a member of oneof _parent_ad_unit.

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.

This field is a member of oneof _display_name.

Type

str

ad_unit_code

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

This field is a member of oneof _ad_unit_code.

Type

str

status

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

This field is a member of oneof _status.

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.

This field is a member of oneof _applied_target_window.

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.

This field is a member of oneof _effective_target_window.

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.

This field is a member of oneof _description.

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.

This field is a member of oneof _explicitly_targeted.

Type

bool

has_children

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

This field is a member of oneof _has_children.

Type

bool

update_time

Output only. The time this AdUnit was last modified.

This field is a member of oneof _update_time.

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.

This field is a member of oneof _external_set_top_box_channel_id.

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.

This field is a member of oneof _refresh_delay.

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 attribute 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. Non-empty default. The smart size mode for this ad unit. This attribute defaults to SmartSizeMode.NONE for fixed sizes.

This field is a member of oneof _smart_size_mode.

Type

google.ads.admanager_v1.types.SmartSizeModeEnum.SmartSizeMode

applied_adsense_enabled

Optional. The value of AdSense enabled directly applied to this ad unit. 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.

This field is a member of oneof _effective_adsense_enabled.

Type

bool

refresh_rate_type

Optional. Non-empty default. Defines the type of refresh rate control for this ad unit. This field defaults to DISABLED.

This field is a member of oneof _refresh_rate_type.

Type

google.ads.admanager_v1.types.RefreshRateTypeEnum.RefreshRateType

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

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}

This field is a member of oneof _parent_ad_unit.

Type

str

display_name

Output only. The display name of the parent AdUnit.

This field is a member of oneof _display_name.

Type

str

ad_unit_code

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

This field is a member of oneof _ad_unit_code.

Type

str

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

Bases: proto.message.Message

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

size

Required. The Size of the AdUnit.

This field is a member of oneof _size.

Type

google.ads.admanager_v1.types.Size

environment_type

Required. The EnvironmentType of the AdUnit

This field is a member of oneof _environment_type.

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)

Bases: proto.message.Message

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

class AdUnitStatus(value)

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.AdUnitTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Specifies an ad unit and (optionally) its descendants.

include_descendants

Whether this ad unit’s children should be targeted/excluded as well.

This field is a member of oneof _include_descendants.

Type

bool

ad_unit

Optional. The resource name of this ad unit.

This field is a member of oneof _ad_unit.

Type

str

class google.ads.admanager_v1.types.Application(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An application that has been added to or “claimed” by the network to be used for targeting purposes. These mobile apps can come from various app stores.

name

Identifier. The resource name of the Application. Format: networks/{network_code}/applications/{application_id}

Type

str

display_name

Required. The display name of the application.

This field is a member of oneof _display_name.

Type

str

app_store_id

Optional. The app store ID of the app to claim.

This field is a member of oneof _app_store_id.

Type

str

app_stores

Optional. The app stores the application belongs to. This attribute is mutable to allow for third party app store linking.

Type

MutableSequence[google.ads.admanager_v1.types.ApplicationStoreEnum.ApplicationStore]

archived

Output only. The archival status of the application.

When true, an application cannot be targeted and will not serve ads, regardless of its status.

This field is a member of oneof _archived.

Type

bool

app_store_display_name

Output only. The name of the application on the app store.

This field is a member of oneof _app_store_display_name.

Type

str

application_code

Output only. The application code used to identify the app in the SDK. Note that the UI refers to this as “App ID”.

This field is a member of oneof _application_code.

Type

str

developer

Output only. The name of the developer of the application.

This field is a member of oneof _developer.

Type

str

platform

Output only. The platform the application runs on.

This field is a member of oneof _platform.

Type

google.ads.admanager_v1.types.ApplicationPlatformEnum.ApplicationPlatform

free

Output only. Whether the application is free on the app store it belongs to.

This field is a member of oneof _free.

Type

bool

download_url

Output only. The download URL of the application on the app store it belongs to.

This field is a member of oneof _download_url.

Type

str

approval_status

Output only. The approval status for the application.

This field is a member of oneof _approval_status.

Type

google.ads.admanager_v1.types.ApplicationApprovalStatusEnum.ApplicationApprovalStatus

webview_claiming_status

Output only. The webview claiming status for the application.

This field is a member of oneof _webview_claiming_status.

Type

google.ads.admanager_v1.types.WebviewClaimingStatusEnum.WebviewClaimingStatus

class google.ads.admanager_v1.types.ApplicationApprovalStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ApplicationApprovalStatus][google.ads.admanager.v1.ApplicationApprovalStatusEnum.ApplicationApprovalStatus]

class ApplicationApprovalStatus(value)

Bases: proto.enums.Enum

The approval status of the application.

Values:

APPLICATION_APPROVAL_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

APPEALING (1):

The application is disapproved but has a pending review status, signaling an appeal.

APPROVED (2):

The application can serve ads.

DISAPPROVED (3):

The application failed approval checks and it cannot serve any ads.

DRAFT (4):

The application is not yet ready for review.

UNCHECKED (5):

The application has not yet been reviewed.

class google.ads.admanager_v1.types.ApplicationPlatformEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ApplicationPlatform][google.ads.admanager.v1.ApplicationPlatformEnum.ApplicationPlatform]

class ApplicationPlatform(value)

Bases: proto.enums.Enum

A platform a Application can run on.

Values:

APPLICATION_PLATFORM_UNSPECIFIED (0):

Default value. This value is unused.

UNSUPPORTED (14):

Platform for apps with platforms we don’t support yet or don’t have a representation for.

AMAZON_TV (6):

Platform for Amazon Fire TV compatible apps.

ANDROID (1):

Platform for Android compatible apps.

IOS (2):

Platform for IOS compatible apps.

LG_TV (12):

Platform for LG TV compatible apps.

PLAYSTATION (7):

Platform for Playstation compatible apps.

ROKU (5):

Platform for Roku compatible apps.

SAMSUNG_TV (10):

Platform for Samsung TV compatible apps.

XBOX (9):

Platform for Xbox compatible apps.

class google.ads.admanager_v1.types.ApplicationStoreEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ApplicationStore][google.ads.admanager.v1.ApplicationStoreEnum.ApplicationStore].

class ApplicationStore(value)

Bases: proto.enums.Enum

The application store that distributes applications.

Values:

APPLICATION_STORE_UNSPECIFIED (0):

Not specified value.

APPLE_APP_STORE (1):

Apple App Store (iTunes).

GOOGLE_PLAY_STORE (2):

Google Play (ex. Google Market).

AMAZON_APP_STORE (14):

Amazon App Store.

OPPO_APP_STORE (15):

Oppo App Market.

SAMSUNG_APP_STORE (16):

Samsung Galaxy Store.

VIVO_APP_STORE (17):

Vivo App Store.

XIAOMI_APP_STORE (18):

Mi GetApps.

AMAZON_FIRETV_STORE (7):

Application store for Amazon Fire TV apps.

LG_TV_STORE (19):

Application store for LG TV apps.

PLAYSTATION_STORE (8):

Application store for Playstation apps.

ROKU_STORE (6):

Application store for Roku apps.

SAMSUNG_TV_STORE (11):

Application store for Samsung TV apps.

XBOX_STORE (10):

Application store for Xbox apps.

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

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.ArchiveDaiEncodingProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ArchiveDaiEncodingProfile method.

name

Required. The resource name of the DaiEncodingProfile to archive. Format: networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}

Type

str

class google.ads.admanager_v1.types.AudienceSegment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The AudienceSegment resource.

name

Identifier. The resource name of the AudienceSegment. Format: networks/{network_code}/audienceSegments/{audience_segment_id} The audience_segment_id may have up to 1 of the following suffixes:

• ~direct for directly licensed third-party segments

• ~global for globally licensed third-party segments

Type

str

display_name

Required. Display name of the AudienceSegment. The attribute has a maximum length of 255 characters.

This field is a member of oneof _display_name.

Type

str

class google.ads.admanager_v1.types.AudienceSegmentTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents targeting for audience segments. The values are combined in a logical OR.

negative

Whether this expression is negatively targeted, meaning it matches ad requests that exclude the below values.

This field is a member of oneof _negative.

Type

bool

audience_segments

Optional. The targeted audience segments.

This is either the resource name of a first-party audience segment or an alias to the effective third-party audience segment. Third-party audience segment resource names containing ~direct or ~global will be normalized by the server. For example, networks/1234/audienceSegments/4567~direct will be normalized to networks/1234/audienceSegments/4567.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.AudioSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Information about the audio settings of an encoding profile.

codec

Required. The RFC6381 codec string of the audio.

This field is a member of oneof _codec.

Type

str

bitrate

Required. The bitrate of the audio, in bits per second. This value must be between 8kbps and 250 Mbps.

This field is a member of oneof _bitrate.

Type

int

channels

Required. The number of audio channels, including low frequency channels. This value has a maximum of 8.

This field is a member of oneof _channels.

Type

int

sample_rate_hertz

Required. The audio sample rate in hertz. Must be between 44kHz and 100kHz.

This field is a member of oneof _sample_rate_hertz.

Type

int

class google.ads.admanager_v1.types.AuxiliaryAdSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Settings for auxiliary ads (e.g. pause ads) on a live stream.

ad_tag_url

Required. The ad tag URL used to request auxiliary ads (such as pause ads). This can be a Google Ad Manager ad tag or a third-party ad tag. Publishers are responsible for ensuring the correctness of the URL.

This field is a member of oneof _ad_tag_url.

Type

str

class google.ads.admanager_v1.types.BandwidthGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a group of bandwidths that are logically organized by some well known generic name such as ‘Cable’ or ‘DSL’.

name

Identifier. The resource name of the BandwidthGroup. Format: networks/{network_code}/bandwidthGroups/{bandwidth_group_id}

This field is a member of oneof _name.

Type

str

display_name

Output only. The localized name of the bandwidth group.

This field is a member of oneof _display_name.

Type

str

class google.ads.admanager_v1.types.BandwidthTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Bandwidth Targeting.

Reach users accessing the internet through various means of connection, such as cable, DSL, or dial-up. Can be useful to target campaigns using low-resolution creatives or text ads for users with low bandwidth.

targeted_bandwidth_groups

Optional. A list of resource names of the bandwidth groups that should be targeted/included.

Type

MutableSequence[str]

excluded_bandwidth_groups

Optional. A list of resource names of the bandwidth groups that should be excluded.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateAdRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchActivateAdRules method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. Resource names for the AdRule. Format: networks/{network_code}/adRules/{ad_rule}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateAdRulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchActivateAdRules method.

class google.ads.admanager_v1.types.BatchActivateAdUnitsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchActivateAdUnits method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the AdUnits to activate. Format: networks/{network_code}/adUnits/{ad_unit_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateAdUnitsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchActivateAdUnits method.

class google.ads.admanager_v1.types.BatchActivateCdnConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message to activate CdnConfig objects.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the CdnConfig objects to activate. Format: networks/{network_code}/cdnConfigs/{cdn_config_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateCdnConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for BatchActivateCdnConfigs method.

class google.ads.admanager_v1.types.BatchActivateCmsMetadataKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchActivateCmsMetadataKeys method.

parent

Required. The parent resource where CmsMetadataKeys will be activated. Format: networks/{network_code}

Type

str

names

Required. The resource names of the CmsMetadataKeys to activate. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateCmsMetadataKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchActivateCmsMetadataKeys method.

class google.ads.admanager_v1.types.BatchActivateCmsMetadataValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchActivateCmsMetadataValues method.

parent

Required. The parent resource where CmsMetadataValues will be activated. Format: networks/{network_code}

Type

str

names

Required. The resource names of the CmsMetadataValues to activate. Format: networks/{network_code}/cmsMetadataValues/{cms_metadata_value_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateCmsMetadataValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchActivateCmsMetadataValues method.

class google.ads.admanager_v1.types.BatchActivateContentBundlesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchActivateContentBundles method.

parent

Required. The parent resource where ContentBundles will be activated. Format: networks/{network_code}

Type

str

names

Required. The resource names of the ContentBundles to activate. Format: networks/{network_code}/contentBundles/{content_bundle_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateContentBundlesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchActivateContentBundles method.

class google.ads.admanager_v1.types.BatchActivateCreativeWrappersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message to activate CreativeWrapper objects.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the CreativeWrapper objects to activate. Format: networks/{network_code}/creativeWrappers/{creative_wrapper_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateCreativeWrappersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for BatchActivateCreativeWrappers method.

class google.ads.admanager_v1.types.BatchActivateCustomFieldsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchActivateCustomFields method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the CustomField objects to activate. Format: networks/{network_code}/customFields/{custom_field_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateCustomFieldsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchActivateCustomFields method.

class google.ads.admanager_v1.types.BatchActivateCustomTargetingKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchActivateCustomTargetingKeys method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the CustomTargetingKeys to activate. Format: networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateCustomTargetingKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchActivateCustomTargetingKeys method.

class google.ads.admanager_v1.types.BatchActivateCustomTargetingValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchActivateCustomTargetingValues method.

parent

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

Type

str

requests

Required. The CustomTargetingValue objects to activate. A maximum of 100 objects can be activated in a batch.

Type

MutableSequence[google.ads.admanager_v1.types.ActivateCustomTargetingValueRequest]

class google.ads.admanager_v1.types.BatchActivateCustomTargetingValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchActivateCustomTargetingValues method.

class google.ads.admanager_v1.types.BatchActivateDaiAuthenticationKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchPerformDaiAuthenticationKeyAction method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. Resource names for the DaiAuthenticationKey. Format: networks/{network_code}/daiAuthenticationKeys/{dai_authentication_key}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateDaiAuthenticationKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchActivateDaiAuthenticationKeys method.

class google.ads.admanager_v1.types.BatchActivateDaiEncodingProfilesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchActivateDaiEncodingProfiles method.

parent

Required. Format: networks/{network_code}

Type

str

requests

Required. The DaiEncodingProfile objects to activate. A maximum of 100 objects can be activated in a batch.

Type

MutableSequence[google.ads.admanager_v1.types.ActivateDaiEncodingProfileRequest]

class google.ads.admanager_v1.types.BatchActivateDaiEncodingProfilesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchActivateDaiEncodingProfiles method.

class google.ads.admanager_v1.types.BatchActivateLabelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchActivateLabels method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. Resource names for the Label. Format: networks/{network_code}/labels/{label_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateLabelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for BatchActivateLabels method.

class google.ads.admanager_v1.types.BatchActivateLiveStreamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchActivateLiveStreams method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the LiveStreams to activate. Format: networks/{network_code}/liveStreams/{live_stream_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateLiveStreamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchActivateLiveStreams method.

class google.ads.admanager_v1.types.BatchActivatePlacementsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchActivatePlacements method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The names of the Placement objects to activate. Format: networks/{network_code}/placements/{placement_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivatePlacementsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchActivatePlacements method.

class google.ads.admanager_v1.types.BatchActivateTeamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchActivateTeams method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the Teams to activate. Format: networks/{network_code}/teams/{team_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchActivateTeamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchActivateTeams method.

class google.ads.admanager_v1.types.BatchAdReviewCenterAdsOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata object for BatchAllowAdReviewCenterAds and BatchBlockAdReviewCenterAds methods.

failed_requests

The status of each failed request, keyed by the index of the corresponding request in the batch request.

Type

MutableMapping[int, google.rpc.status_pb2.Status]

class FailedRequestsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.ads.admanager_v1.types.BatchAllowAdReviewCenterAdsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchAllowAdReviewCenterAds method.

parent

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

Since a network can only have a single web property of each ExchangeSyndicationProduct, you can use the ExchangeSyndicationProduct as an alias for the web property code:

networks/{network_code}/webProperties/display

networks/{network_code}/webProperties/videoAndAudio

networks/{network_code}/webProperties/mobileApp

networks/{network_code}/webProperties/games

Type

str

names

Required. The resource names of the AdReviewCenterAds to allow. Format: networks/{network_code}/webProperties/{web_property_code}/adReviewCenterAds/{ad_review_center_ad_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchAllowAdReviewCenterAdsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchAllowAdReviewCenterAds method.

class google.ads.admanager_v1.types.BatchApproveAndOverbookOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchApproveAndOverbookOrders method.

parent

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

Type

str

names

Required. The resource names of the orders to approve and overbook. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

skip_inventory_check

Optional. Indicates whether the inventory check should be skipped when performing this action.

Type

bool

class google.ads.admanager_v1.types.BatchApproveAndOverbookOrdersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchApproveAndOverbookOrders method.

class google.ads.admanager_v1.types.BatchApproveOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchApproveOrders method.

parent

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

Type

str

names

Required. The resource names of the orders to approve. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

skip_inventory_check

Optional. Indicates whether the inventory check should be skipped when performing this action.

Type

bool

class google.ads.admanager_v1.types.BatchApproveOrdersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchApproveOrders method.

class google.ads.admanager_v1.types.BatchApproveOrdersWithoutReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchApproveOrdersWithoutReservation method.

parent

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

Type

str

names

Required. The resource names of the orders to approve. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchApproveOrdersWithoutReservationResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchApproveOrdersWithoutReservation method.

class google.ads.admanager_v1.types.BatchApproveSuggestedAdUnitsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchApproveSuggestedAdUnits method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. Resource names for the SuggestedAdUnit objects to approve. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchApproveSuggestedAdUnitsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for BatchApproveSuggestedAdUnits method.

created_ad_units

The resource names of the AdUnits that were created as part of the approval. The order of the ad units in the response is not guaranteed to be the same as the order of the suggestions in the request.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchArchiveAdUnitsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchArchiveAdUnits method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the AdUnits to archive. Format: networks/{network_code}/adUnits/{ad_unit_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchArchiveAdUnitsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchArchiveAdUnits method.

class google.ads.admanager_v1.types.BatchArchiveApplicationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchArchiveApplications method.

parent

Required. The parent resource shared by all Applications to archive. Format: networks/{network_code}

Type

str

names

Required. The Application objects to archive.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchArchiveApplicationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchArchiveApplications method.

class google.ads.admanager_v1.types.BatchArchiveCdnConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message to archive CdnConfig objects.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the CdnConfig objects to archive. Format: networks/{network_code}/cdnConfigs/{cdn_config_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchArchiveCdnConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchArchiveCdnConfigs method.

class google.ads.admanager_v1.types.BatchArchiveDaiEncodingProfilesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchArchiveDaiEncodingProfiles method.

parent

Required. Format: networks/{network_code}

Type

str

requests

Required. The DaiEncodingProfile objects to archive. A maximum of 100 objects can be archived in a batch.

Type

MutableSequence[google.ads.admanager_v1.types.ArchiveDaiEncodingProfileRequest]

class google.ads.admanager_v1.types.BatchArchiveDaiEncodingProfilesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchArchiveDaiEncodingProfiles method.

class google.ads.admanager_v1.types.BatchArchiveLiveStreamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchArchiveLiveStreams method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the LiveStreams to archive. Format: networks/{network_code}/liveStreams/{live_stream_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchArchiveLiveStreamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchArchiveLiveStreams method.

class google.ads.admanager_v1.types.BatchArchiveOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchArchiveOrders method.

parent

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

Type

str

names

Required. The resource names of the orders to archive. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchArchiveOrdersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchArchiveOrders method.

class google.ads.admanager_v1.types.BatchArchivePlacementsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchArchivePlacements method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The names of the Placement objects to archive. Format: networks/{network_code}/placements/{placement_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchArchivePlacementsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchArchivePlacements method.

class google.ads.admanager_v1.types.BatchArchiveSlatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchArchiveSlates method.

parent

Required. The parent resource containing the slates. Format: “networks/{network_code}”.

Type

str

names

Required. The resource names of the slates to archive. Format: “networks/{network_code}/slates/{slate_id}”.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchArchiveSlatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for BatchArchiveSlates method.

class google.ads.admanager_v1.types.BatchBlockAdReviewCenterAdsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchBlockAdReviewCenterAds method.

parent

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

Since a network can only have a single web property of each ExchangeSyndicationProduct, you can use the ExchangeSyndicationProduct as an alias for the web property code:

networks/{network_code}/webProperties/display

networks/{network_code}/webProperties/videoAndAudio

networks/{network_code}/webProperties/mobileApp

networks/{network_code}/webProperties/games

Type

str

names

Required. The resource names of the AdReviewCenterAds to block. Format: networks/{network_code}/webProperties/{web_property_code}/adReviewCenterAds/{ad_review_center_ad_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchBlockAdReviewCenterAdsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchBlockAdReviewCenterAds method.

class google.ads.admanager_v1.types.BatchCreateAdRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateAdRules method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateAdRuleRequest]

class google.ads.admanager_v1.types.BatchCreateAdRulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateAdRules method.

ad_rules

The AdRule objects created.

Type

MutableSequence[google.ads.admanager_v1.types.AdRule]

class google.ads.admanager_v1.types.BatchCreateAdSpotsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateAdSpots method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateAdSpotRequest]

class google.ads.admanager_v1.types.BatchCreateAdSpotsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateAdSpots method.

ad_spots

The AdSpot objects created.

Type

MutableSequence[google.ads.admanager_v1.types.AdSpot]

class google.ads.admanager_v1.types.BatchCreateAdUnitsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateAdUnits method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateAdUnitRequest]

class google.ads.admanager_v1.types.BatchCreateAdUnitsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateAdUnits method.

ad_units

The AdUnit objects created.

Type

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

class google.ads.admanager_v1.types.BatchCreateApplicationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateApplications method.

parent

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

Type

str

requests

Required. The Application objects to create.

Type

MutableSequence[google.ads.admanager_v1.types.CreateApplicationRequest]

class google.ads.admanager_v1.types.BatchCreateApplicationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateApplications method.

applications

The Application objects created.

Type

MutableSequence[google.ads.admanager_v1.types.Application]

class google.ads.admanager_v1.types.BatchCreateCdnConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateCdnConfigs method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateCdnConfigRequest]

class google.ads.admanager_v1.types.BatchCreateCdnConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateCdnConfigs method.

cdn_configs

The CdnConfig objects created.

Type

MutableSequence[google.ads.admanager_v1.types.CdnConfig]

class google.ads.admanager_v1.types.BatchCreateChildPublishersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [BatchCreateChildPublishers][] method.

parent

Required. The parent resource where [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s will be created. Format: networks/{network_code} The parent field in the CreateChildPublisherRequest must match this field.

Type

str

requests

Required. The [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects to create. A maximum of 100 objects can be created in a batch.

Type

MutableSequence[google.ads.admanager_v1.types.CreateChildPublisherRequest]

class google.ads.admanager_v1.types.BatchCreateChildPublishersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for [BatchCreateChildPublishers][] method.

child_publishers

The [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects created.

Type

MutableSequence[google.ads.admanager_v1.types.ChildPublisher]

class google.ads.admanager_v1.types.BatchCreateCompaniesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [BatchCreateCompanies][] method.

parent

Required. The parent resource where [Companies][] will be created. Format: networks/{network_code} The parent field in the CreateCompanyRequest must match this field.

Type

str

requests

Required. The [Company][google.ads.admanager.v1.Company] objects to create. A maximum of 100 objects can be created in a batch.

Type

MutableSequence[google.ads.admanager_v1.types.CreateCompanyRequest]

class google.ads.admanager_v1.types.BatchCreateCompaniesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for [BatchCreateCompanies][] method.

companies

The [Company][google.ads.admanager.v1.Company] objects created.

Type

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

class google.ads.admanager_v1.types.BatchCreateContactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateContacts method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateContactRequest]

class google.ads.admanager_v1.types.BatchCreateContactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateContacts method.

contacts

The Contact objects created.

Type

MutableSequence[google.ads.admanager_v1.types.Contact]

class google.ads.admanager_v1.types.BatchCreateCreativeWrappersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateCreativeWrappers method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateCreativeWrapperRequest]

class google.ads.admanager_v1.types.BatchCreateCreativeWrappersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateCreativeWrappers method.

creative_wrappers

The CreativeWrapper objects created.

Type

MutableSequence[google.ads.admanager_v1.types.CreativeWrapper]

class google.ads.admanager_v1.types.BatchCreateCustomFieldsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateCustomFields method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateCustomFieldRequest]

class google.ads.admanager_v1.types.BatchCreateCustomFieldsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateCustomFields method.

custom_fields

The CustomField objects created.

Type

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

class google.ads.admanager_v1.types.BatchCreateCustomTargetingKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateCustomTargetingKeys method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateCustomTargetingKeyRequest]

class google.ads.admanager_v1.types.BatchCreateCustomTargetingKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateCustomTargetingKeys method.

custom_targeting_keys

The CustomTargetingKey objects created.

Type

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

class google.ads.admanager_v1.types.BatchCreateCustomTargetingValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateCustomTargetingValues method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateCustomTargetingValueRequest]

class google.ads.admanager_v1.types.BatchCreateCustomTargetingValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateCustomTargetingValues method.

custom_targeting_values

The CustomTargetingValue objects created.

Type

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

class google.ads.admanager_v1.types.BatchCreateDaiAuthenticationKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateDaiAuthenticationKeys method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateDaiAuthenticationKeyRequest]

class google.ads.admanager_v1.types.BatchCreateDaiAuthenticationKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateDaiAuthenticationKeys method.

dai_authentication_keys

The DaiAuthenticationKey objects created.

Type

MutableSequence[google.ads.admanager_v1.types.DaiAuthenticationKey]

class google.ads.admanager_v1.types.BatchCreateDaiEncodingProfilesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateDaiEncodingProfiles method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateDaiEncodingProfileRequest]

class google.ads.admanager_v1.types.BatchCreateDaiEncodingProfilesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateDaiEncodingProfiles method.

dai_encoding_profiles

The DaiEncodingProfile objects created.

Type

MutableSequence[google.ads.admanager_v1.types.DaiEncodingProfile]

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

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)

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.BatchCreateLabelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateLabels method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateLabelRequest]

class google.ads.admanager_v1.types.BatchCreateLabelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateLabels method.

labels

The Label objects created.

Type

MutableSequence[google.ads.admanager_v1.types.Label]

class google.ads.admanager_v1.types.BatchCreateLiveStreamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateLiveStreams method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateLiveStreamRequest]

class google.ads.admanager_v1.types.BatchCreateLiveStreamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateLiveStreams method.

live_streams

The LiveStream objects created.

Type

MutableSequence[google.ads.admanager_v1.types.LiveStream]

class google.ads.admanager_v1.types.BatchCreateOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateOrders method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateOrderRequest]

class google.ads.admanager_v1.types.BatchCreateOrdersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateOrders method.

orders

The Order objects created.

Type

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

class google.ads.admanager_v1.types.BatchCreatePlacementsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreatePlacements method.

parent

Required. The parent resource where the Placements will be created. Format: networks/{network_code} The parent field in the CreatePlacementRequest messages match this field.

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreatePlacementRequest]

class google.ads.admanager_v1.types.BatchCreatePlacementsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreatePlacements method.

placements

The Placement objects created.

Type

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

class google.ads.admanager_v1.types.BatchCreateSitesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateSites method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateSiteRequest]

class google.ads.admanager_v1.types.BatchCreateSitesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateSites method.

sites

The Site objects created.

Type

MutableSequence[google.ads.admanager_v1.types.Site]

class google.ads.admanager_v1.types.BatchCreateSlatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateSlates method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateSlateRequest]

class google.ads.admanager_v1.types.BatchCreateSlatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateSlates method.

slates

The Slate objects created.

Type

MutableSequence[google.ads.admanager_v1.types.Slate]

class google.ads.admanager_v1.types.BatchCreateTargetingPresetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateTargetingPresets method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateTargetingPresetRequest]

class google.ads.admanager_v1.types.BatchCreateTargetingPresetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateTargetingPresets method.

targeting_presets

The TargetingPreset objects created.

Type

MutableSequence[google.ads.admanager_v1.types.TargetingPreset]

class google.ads.admanager_v1.types.BatchCreateTeamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchCreateTeams method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.CreateTeamRequest]

class google.ads.admanager_v1.types.BatchCreateTeamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchCreateTeams method.

teams

The Team objects created.

Type

MutableSequence[google.ads.admanager_v1.types.Team]

class google.ads.admanager_v1.types.BatchCreateViewabilityProvidersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [BatchCreateViewabilityProviders][] method.

parent

Required. The parent resource where [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]s will be created. Format: networks/{network_code} The parent field in the CreateViewabilityProviderRequest must match this field.

Type

str

requests

Required. The [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] objects to create. A maximum of 100 objects can be created in a batch.

Type

MutableSequence[google.ads.admanager_v1.types.CreateViewabilityProviderRequest]

class google.ads.admanager_v1.types.BatchCreateViewabilityProvidersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for [BatchCreateViewabilityProviders][] method.

viewability_providers

The [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] objects created.

Type

MutableSequence[google.ads.admanager_v1.types.ViewabilityProvider]

class google.ads.admanager_v1.types.BatchDeactivateAdRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchDeactivateAdRules method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. Resource names for the AdRule. Format: networks/{network_code}/adRules/{ad_rule}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeactivateAdRulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeactivateAdRules method.

class google.ads.admanager_v1.types.BatchDeactivateAdUnitsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchDeactivateAdUnits method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the AdUnits to deactivate. Format: networks/{network_code}/adUnits/{ad_unit_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeactivateAdUnitsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeactivateAdUnits method.

class google.ads.admanager_v1.types.BatchDeactivateCmsMetadataKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchDeactivateCmsMetadataKeys method.

parent

Required. The parent resource where CmsMetadataKeys will be deactivated. Format: networks/{network_code}

Type

str

names

Required. The resource names of the CmsMetadataKeys to deactivate. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeactivateCmsMetadataKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeactivateCmsMetadataKeys method.

class google.ads.admanager_v1.types.BatchDeactivateCmsMetadataValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchDeactivateCmsMetadataValues method.

parent

Required. The parent resource where CmsMetadataValues will be deactivated. Format: networks/{network_code}

Type

str

names

Required. The resource names of the CmsMetadataValues to deactivate. Format: networks/{network_code}/cmsMetadataValues/{cms_metadata_value_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeactivateCmsMetadataValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeactivateCmsMetadataValues method.

class google.ads.admanager_v1.types.BatchDeactivateContentBundlesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchDeactivateContentBundles method.

parent

Required. The parent resource where ContentBundles will be deactivated. Format: networks/{network_code}

Type

str

names

Required. The resource names of the ContentBundles to deactivate. Format: networks/{network_code}/contentBundles/{content_bundle_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeactivateContentBundlesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeactivateContentBundles method.

class google.ads.admanager_v1.types.BatchDeactivateCreativeWrappersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message to deactivate CreativeWrapper objects.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the CreativeWrapper objects to deactivate. Format: networks/{network_code}/creativeWrappers/{creative_wrapper_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeactivateCreativeWrappersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeactivateCreativeWrappers method.

class google.ads.admanager_v1.types.BatchDeactivateCustomFieldsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchDeactivateCustomFields method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the CustomField objects to deactivate. Format: networks/{network_code}/customFields/{custom_field_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeactivateCustomFieldsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeactivateCustomFields method.

class google.ads.admanager_v1.types.BatchDeactivateCustomTargetingKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchDeactivateCustomTargetingKeys method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the CustomTargetingKeys to deactivate. Format: networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeactivateCustomTargetingKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeactivateCustomTargetingKeys method.

class google.ads.admanager_v1.types.BatchDeactivateCustomTargetingValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchDeactivateCustomTargetingValues method.

parent

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

Type

str

requests

Required. The CustomTargetingValue objects to deactivate.

Type

MutableSequence[google.ads.admanager_v1.types.DeactivateCustomTargetingValueRequest]

class google.ads.admanager_v1.types.BatchDeactivateCustomTargetingValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeactivateCustomTargetingValues method.

class google.ads.admanager_v1.types.BatchDeactivateDaiAuthenticationKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchPerformDaiAuthenticationKeyAction method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. Resource names for the DaiAuthenticationKey. Format: networks/{network_code}/daiAuthenticationKeys/{dai_authentication_key}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeactivateDaiAuthenticationKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeactivateDaiAuthenticationKeys method.

class google.ads.admanager_v1.types.BatchDeactivateLabelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchDeactivateLabels method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. Resource names for the Label. Format: networks/{network_code}/labels/{label_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeactivateLabelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for BatchDeactivateLabels method.

class google.ads.admanager_v1.types.BatchDeactivatePlacementsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchDeactivatePlacements method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The names of the Placement objects to deactivate. Format: networks/{network_code}/placements/{placement_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeactivatePlacementsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeactivatePlacements method.

class google.ads.admanager_v1.types.BatchDeactivateSitesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchDeactivateSites method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the Site objects to deactivate.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeactivateSitesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeactivateSites method.

class google.ads.admanager_v1.types.BatchDeactivateTargetingPresetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchDeactivateTargetingPresets method.

parent

Required. Format: networks/{network_code}

Type

str

requests

Required. The TargetingPreset objects to deactivate.

Type

MutableSequence[google.ads.admanager_v1.types.DeactivateTargetingPresetRequest]

class google.ads.admanager_v1.types.BatchDeactivateTargetingPresetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for DeactivateTargetingPresets method.

change_count

The number of objects that were deactivated as a result of performing the action.

Type

int

class google.ads.admanager_v1.types.BatchDeactivateTeamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchDeactivateTeams method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the Teams to deactivate. Format: networks/{network_code}/teams/{team_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeactivateTeamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeactivateTeams method.

class google.ads.admanager_v1.types.BatchDeleteAdRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchDeleteAdRules method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. Resource names for the AdRule. Format: networks/{network_code}/adRules/{ad_rule}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeleteOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchDeleteOrders method.

parent

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

Type

str

names

Required. The resource names of the orders to delete. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDeleteOrdersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDeleteOrders method.

class google.ads.admanager_v1.types.BatchDisapproveOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchDisapproveOrders method.

parent

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

Type

str

names

Required. The resource names of the orders to disapprove. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDisapproveOrdersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDisapproveOrders method.

class google.ads.admanager_v1.types.BatchDisapproveOrdersWithoutReservationChangesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchDisapproveOrdersWithoutReservationChanges method.

parent

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

Type

str

names

Required. The resource names of the orders to disapprove without reservation changes. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchDisapproveOrdersWithoutReservationChangesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchDisapproveOrdersWithoutReservationChanges method.

class google.ads.admanager_v1.types.BatchPauseAdsLiveStreamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchPauseAdsLiveStreams method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the LiveStreams to pause ads on. Format: networks/{network_code}/liveStreams/{live_stream_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchPauseAdsLiveStreamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchPauseAdsLiveStreams method.

class google.ads.admanager_v1.types.BatchPauseLiveStreamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchPauseLiveStreams method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the LiveStreams to pause. Format: networks/{network_code}/liveStreams/{live_stream_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchPauseLiveStreamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchPauseLiveStreams method.

class google.ads.admanager_v1.types.BatchPauseOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchPauseOrders method.

parent

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

Type

str

names

Required. The resource names of the orders to pause. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchPauseOrdersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchPauseOrders method.

class google.ads.admanager_v1.types.BatchRefreshMasterPlaylistsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchRefreshMasterPlaylists method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the LiveStreams to refresh master playlists on. Format: networks/{network_code}/liveStreams/{live_stream_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchRefreshMasterPlaylistsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchRefreshMasterPlaylists method.

class google.ads.admanager_v1.types.BatchResumeAndOverbookOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchResumeAndOverbookOrders method.

parent

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

Type

str

names

Required. The resource names of the orders to resume and overbook. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchResumeAndOverbookOrdersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchResumeAndOverbookOrders method.

class google.ads.admanager_v1.types.BatchResumeOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchResumeOrders method.

parent

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

Type

str

names

Required. The resource names of the orders to resume. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

skip_inventory_check

Optional. Indicates whether the inventory check should be skipped when performing this action.

Type

bool

class google.ads.admanager_v1.types.BatchResumeOrdersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchResumeOrders method.

class google.ads.admanager_v1.types.BatchRetractOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchRetractOrders method.

parent

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

Type

str

names

Required. The resource names of the orders to retract. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchRetractOrdersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchRetractOrders method.

class google.ads.admanager_v1.types.BatchRetractOrdersWithoutReservationChangesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchRetractOrdersWithoutReservationChanges method.

parent

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

Type

str

names

Required. The resource names of the orders to retract. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchRetractOrdersWithoutReservationChangesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchRetractOrdersWithoutReservationChanges method.

class google.ads.admanager_v1.types.BatchSubmitOrdersForApprovalAndOverbookRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchSubmitOrdersForApprovalAndOverbook method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the orders to submit for approval and overbook. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchSubmitOrdersForApprovalAndOverbookResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchSubmitOrdersForApprovalAndOverbook method.

class google.ads.admanager_v1.types.BatchSubmitOrdersForApprovalRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchSubmitOrdersForApproval method.

parent

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

Type

str

names

Required. The resource names of the orders to submit for approval. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

skip_inventory_check

Optional. Indicates whether the inventory check should be skipped when performing this action.

Type

bool

class google.ads.admanager_v1.types.BatchSubmitOrdersForApprovalResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchSubmitOrdersForApproval method.

class google.ads.admanager_v1.types.BatchSubmitOrdersForApprovalWithoutReservationChangesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchSubmitOrdersForApprovalWithoutReservationChanges method.

parent

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

Type

str

names

Required. The resource names of the orders to submit for approval. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchSubmitOrdersForApprovalWithoutReservationChangesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchSubmitOrdersForApprovalWithoutReservationChanges method.

class google.ads.admanager_v1.types.BatchSubmitSitesForApprovalRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchSubmitSitesForApproval method.

parent

Required. Format: networks/{network_code}

Type

str

names

Required. The resource names of the Site objects to submit for approval.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchSubmitSitesForApprovalResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchSubmitSitesForApproval method.

class google.ads.admanager_v1.types.BatchUnarchiveApplicationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUnarchiveApplications method.

parent

Required. The parent resource shared by all Applications to Unarchive. Format: networks/{network_code}

Type

str

names

Required. The Application objects to unarchive.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchUnarchiveApplicationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUnarchiveApplications method.

class google.ads.admanager_v1.types.BatchUnarchiveOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchUnarchiveOrders method.

parent

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

Type

str

names

Required. The resource names of the orders to extract. Format: networks/{network_code}/orders/{order_id}

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchUnarchiveOrdersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUnarchiveOrders method.

class google.ads.admanager_v1.types.BatchUnarchiveSlatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for BatchUnarchiveSlates method.

parent

Required. The parent resource containing the slates. Format: “networks/{network_code}”.

Type

str

names

Required. The resource names of the slates to unarchive. Format: “networks/{network_code}/slates/{slate_id}”.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BatchUnarchiveSlatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for BatchUnarchiveSlates method.

class google.ads.admanager_v1.types.BatchUpdateAdRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateAdRules method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateAdRuleRequest]

class google.ads.admanager_v1.types.BatchUpdateAdRulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateAdRules method.

ad_rules

The AdRule objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.AdRule]

class google.ads.admanager_v1.types.BatchUpdateAdSpotsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateAdSpots method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateAdSpotRequest]

class google.ads.admanager_v1.types.BatchUpdateAdSpotsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateAdSpots method.

ad_spots

The AdSpot objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.AdSpot]

class google.ads.admanager_v1.types.BatchUpdateAdUnitsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateAdUnits method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateAdUnitRequest]

class google.ads.admanager_v1.types.BatchUpdateAdUnitsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateAdUnits method.

ad_units

The AdUnit objects updated.

Type

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

class google.ads.admanager_v1.types.BatchUpdateApplicationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateApplications method.

parent

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

Type

str

requests

Required. The Application objects to update.

Type

MutableSequence[google.ads.admanager_v1.types.UpdateApplicationRequest]

class google.ads.admanager_v1.types.BatchUpdateApplicationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateApplications method.

applications

The Application objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.Application]

class google.ads.admanager_v1.types.BatchUpdateCdnConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateCdnConfigs method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateCdnConfigRequest]

class google.ads.admanager_v1.types.BatchUpdateCdnConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateCdnConfigs method.

cdn_configs

The CdnConfig objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.CdnConfig]

class google.ads.admanager_v1.types.BatchUpdateChildPublishersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [BatchUpdateChildPublishers][] method.

parent

Required. The parent resource where [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s will be updated. Format: networks/{network_code} The parent field in the UpdateChildPublisherRequest must match this field.

Type

str

requests

Required. The [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects to update. A maximum of 100 objects can be updated in a batch.

Type

MutableSequence[google.ads.admanager_v1.types.UpdateChildPublisherRequest]

class google.ads.admanager_v1.types.BatchUpdateChildPublishersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for [BatchUpdateChildPublishers][] method.

child_publishers

The [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.ChildPublisher]

class google.ads.admanager_v1.types.BatchUpdateCompaniesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [BatchUpdateCompanies][] method.

parent

Required. The parent resource where [Companies][] will be updated. Format: networks/{network_code} The parent field in the UpdateCompanyRequest must match this field.

Type

str

requests

Required. The [Company][google.ads.admanager.v1.Company] objects to update. A maximum of 100 objects can be updated in a batch.

Type

MutableSequence[google.ads.admanager_v1.types.UpdateCompanyRequest]

class google.ads.admanager_v1.types.BatchUpdateCompaniesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for [BatchUpdateCompanies][] method.

companies

The [Company][google.ads.admanager.v1.Company] objects updated.

Type

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

class google.ads.admanager_v1.types.BatchUpdateContactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateContacts method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateContactRequest]

class google.ads.admanager_v1.types.BatchUpdateContactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateContacts method.

contacts

The Contact objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.Contact]

class google.ads.admanager_v1.types.BatchUpdateCreativeWrappersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateCreativeWrappers method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateCreativeWrapperRequest]

class google.ads.admanager_v1.types.BatchUpdateCreativeWrappersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateCreativeWrappers method.

creative_wrappers

The CreativeWrapper objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.CreativeWrapper]

class google.ads.admanager_v1.types.BatchUpdateCustomFieldsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateCustomFields method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateCustomFieldRequest]

class google.ads.admanager_v1.types.BatchUpdateCustomFieldsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateCustomFields method.

custom_fields

The CustomField objects updated.

Type

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

class google.ads.admanager_v1.types.BatchUpdateCustomTargetingKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateCustomTargetingKeys method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateCustomTargetingKeyRequest]

class google.ads.admanager_v1.types.BatchUpdateCustomTargetingKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateCustomTargetingKeys method.

custom_targeting_keys

The CustomTargetingKey objects updated.

Type

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

class google.ads.admanager_v1.types.BatchUpdateCustomTargetingValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateCustomTargetingValues method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateCustomTargetingValueRequest]

class google.ads.admanager_v1.types.BatchUpdateCustomTargetingValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateCustomTargetingValues method.

custom_targeting_values

The CustomTargetingValue objects updated.

Type

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

class google.ads.admanager_v1.types.BatchUpdateDaiAuthenticationKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateDaiAuthenticationKeys method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateDaiAuthenticationKeyRequest]

class google.ads.admanager_v1.types.BatchUpdateDaiAuthenticationKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateDaiAuthenticationKeys method.

dai_authentication_keys

The DaiAuthenticationKey objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.DaiAuthenticationKey]

class google.ads.admanager_v1.types.BatchUpdateDaiEncodingProfilesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateDaiEncodingProfiles method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateDaiEncodingProfileRequest]

class google.ads.admanager_v1.types.BatchUpdateDaiEncodingProfilesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateDaiEncodingProfiles method.

dai_encoding_profiles

The DaiEncodingProfile objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.DaiEncodingProfile]

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

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)

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.BatchUpdateLabelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateLabels method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateLabelRequest]

class google.ads.admanager_v1.types.BatchUpdateLabelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateLabels method.

labels

The Label objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.Label]

class google.ads.admanager_v1.types.BatchUpdateLiveStreamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateLiveStreams method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateLiveStreamRequest]

class google.ads.admanager_v1.types.BatchUpdateLiveStreamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateLiveStreams method.

live_streams

The LiveStream objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.LiveStream]

class google.ads.admanager_v1.types.BatchUpdateOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateOrders method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateOrderRequest]

class google.ads.admanager_v1.types.BatchUpdateOrdersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateOrders method.

orders

The Order objects updated.

Type

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

class google.ads.admanager_v1.types.BatchUpdatePartnersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [BatchUpdatePartners][] method.

parent

Required. The parent resource where [Partner][google.ads.admanager.v1.Partner]s will be updated. Format: networks/{network_code} The parent field in the [UpdatePartnerRequest][google.ads.admanager.v1.UpdatePartnerRequest] must match this field.

Type

str

requests

Required. The [Partner][google.ads.admanager.v1.Partner] objects to update. A maximum of 100 objects can be updated in a batch.

Type

MutableSequence[google.ads.admanager_v1.types.UpdatePartnerRequest]

class google.ads.admanager_v1.types.BatchUpdatePartnersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for [BatchUpdatePartners][] method.

partners

The [Partner][google.ads.admanager.v1.Partner] objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.Partner]

class google.ads.admanager_v1.types.BatchUpdatePlacementsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdatePlacements method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdatePlacementRequest]

class google.ads.admanager_v1.types.BatchUpdatePlacementsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdatePlacements method.

placements

The Placement objects updated.

Type

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

class google.ads.admanager_v1.types.BatchUpdateSitesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateSites method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateSiteRequest]

class google.ads.admanager_v1.types.BatchUpdateSitesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateSites method.

sites

The Site objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.Site]

class google.ads.admanager_v1.types.BatchUpdateSlatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateSlates method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateSlateRequest]

class google.ads.admanager_v1.types.BatchUpdateSlatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateSlates method.

slates

The Slate objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.Slate]

class google.ads.admanager_v1.types.BatchUpdateTargetingPresetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateTargetingPresets method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateTargetingPresetRequest]

class google.ads.admanager_v1.types.BatchUpdateTargetingPresetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateTargetingPresets method.

targeting_presets

The TargetingPreset objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.TargetingPreset]

class google.ads.admanager_v1.types.BatchUpdateTeamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for BatchUpdateTeams method.

parent

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

Type

str

requests

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

Type

MutableSequence[google.ads.admanager_v1.types.UpdateTeamRequest]

class google.ads.admanager_v1.types.BatchUpdateTeamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for BatchUpdateTeams method.

teams

The Team objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.Team]

class google.ads.admanager_v1.types.BatchUpdateViewabilityProvidersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [BatchUpdateViewabilityProviders][] method.

parent

Required. The parent resource where [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]s will be updated. Format: networks/{network_code} The parent field in the UpdateViewabilityProviderRequest must match this field.

Type

str

requests

Required. The [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] objects to update. A maximum of 100 objects can be updated in a batch.

Type

MutableSequence[google.ads.admanager_v1.types.UpdateViewabilityProviderRequest]

class google.ads.admanager_v1.types.BatchUpdateViewabilityProvidersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for [BatchUpdateViewabilityProviders][] method.

viewability_providers

The [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] objects updated.

Type

MutableSequence[google.ads.admanager_v1.types.ViewabilityProvider]

class google.ads.admanager_v1.types.BrandLiftPartnerEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [BrandLiftPartner][google.ads.admanager.v1.BrandLiftPartnerEnum.BrandLiftPartner]

class BrandLiftPartner(value)

Bases: proto.enums.Enum

Possible options for brand lift.

Values:

BRAND_LIFT_PARTNER_UNSPECIFIED (0):

Default value. This value is unused.

DYNATA (1):

Indicates brand lift partner Dynata.

INTAGE (3):

Indicates brand lift partner Intage.

KANTAR_MILLWARD_BROWN (4):

Indicates brand lift partner Kantar.

MACROMILL (5):

Indicates brand lift partner Macromill.

NONE (7):

Indicates there’s no brand lift partner.

class google.ads.admanager_v1.types.Browser(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a browser, including its version.

name

Identifier. The resource name of the Browser. Format: networks/{network_code}/browsers/{browser}

Type

str

display_name

Output only. The display name of the browser, including version info.

This field is a member of oneof _display_name.

Type

str

major_version

Output only. The major version of the browser.

This field is a member of oneof _major_version.

Type

str

minor_version

Output only. The minor version of the browser.

This field is a member of oneof _minor_version.

Type

str

class google.ads.admanager_v1.types.BrowserLanguage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the language of a browser.

name

Identifier. The resource name of the BrowserLanguage. Format: networks/{network_code}/browserLanguages/{browser_language_id}

Type

str

display_name

Output only. The name of the browser language, localized.

This field is a member of oneof _display_name.

Type

str

class google.ads.admanager_v1.types.BrowserLanguageTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Browser Language Targeting.

For ads targeting mobile apps and their associated WebViews, the language used is based on the language specified by the user in their mobile device settings. If a browser has more than one language assigned to it, each language generates an impression.

targeted_browser_languages

Optional. A list of browser language resource names that should be targeted/included.

Type

MutableSequence[str]

excluded_browser_languages

Optional. A list of browser language resource names that should be excluded.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.BrowserTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Browser Targeting.

Allows publishers to target/exclude a browser type (e.g. Chrome, Firefox, Safari). For more information, see https://support.google.com/admanager/answer/2884033 (Targeting types > Browser).

targeted_browsers

Optional. A list of browser resource names that should be targeted/included.

Type

MutableSequence[str]

excluded_browsers

Optional. A list of browser resource names that should be excluded.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.CdnConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A CdnConfig encapsulates information about where and how to ingest and deliver content enabled for DAI (Dynamic Ad Insertion).

name

Identifier. The resource name of the CdnConfig. Format: networks/{network_code}/cdnConfigs/{cdn_config_id}

Type

str

display_name

Required. The name of the CdnConfig. This value is required to create a CDN config and has a maximum length of 255 characters.

This field is a member of oneof _display_name.

Type

str

cdn_config_type

Required. The type of CDN config represented by this CdnConfig.

This field is a member of oneof _cdn_config_type.

Type

google.ads.admanager_v1.types.CdnConfigTypeEnum.CdnConfigType

source_content_config

Optional. Parameters about this CDN config as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.

Type

google.ads.admanager_v1.types.SourceContentConfig

ad_media_delivery_config

Optional. Config of CDN to deliver ad media.

Type

google.ads.admanager_v1.types.AdMediaDeliveryConfig

cdn_config_status

Output only. The status of the CDN config.

This field is a member of oneof _cdn_config_status.

Type

google.ads.admanager_v1.types.CdnConfigStatusEnum.CdnConfigStatus

class google.ads.admanager_v1.types.CdnConfigStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CdnConfigStatus][google.ads.admanager.v1.CdnConfigStatusEnum.CdnConfigStatus]

class CdnConfigStatus(value)

Bases: proto.enums.Enum

Indicates the status of the CdnConfiguration.

Values:

CDN_CONFIG_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE (1):

The CDN configuration is in use.

ARCHIVED (2):

The CDN configuration is no longer used.

class google.ads.admanager_v1.types.CdnConfigTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CdnConfigType][google.ads.admanager.v1.CdnConfigTypeEnum.CdnConfigType]

class CdnConfigType(value)

Bases: proto.enums.Enum

Indicates the type of CDN configuration for CdnConfiguration.

Values:

CDN_CONFIG_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

AD_MEDIA_DELIVERY (1):

A configuration that specifies a publisher-provided CDN for delivering ad media.

LIVE_STREAM_SOURCE_CONTENT (2):

A configuration that specifies where and how LiveStreamEvent content should be ingested and delivered.

MIDROLL (3):

A configuration that specifies where and how split content should be uploaded and delivered.

VOD_SOURCE_CONTENT (4):

A configuration that specifies where and how video on demand content should be ingested and delivered.

class google.ads.admanager_v1.types.CdnSecurityPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.

security_policy_type

Required. Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.

This field is a member of oneof _security_policy_type.

Type

google.ads.admanager_v1.types.CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType

token_authentication_key

Optional. Shared security key used to generate the Akamai HMAC token for authenticating requests. Only applicable when the value of CdnSecurityPolicyType is equal to CdnSecurityPolicyType.AKAMAI and will be set to null otherwise. Required when the CdnConfig.cdnConfigType is equal to CdnConfigType.LIVE_STREAM_SOURCE_CONTENT and this CdnSecurityPolicy is being configured for SourceContentConfig.ingestSettings.

This field is a member of oneof _token_authentication_key.

Type

str

server_side_url_signing_disabled

Optional. Whether the segment URLs should be signed using the #tokenAuthenticationKey on the server. This is only applicable for delivery media locations that have token authentication enabled.

This field is a member of oneof _server_side_url_signing_disabled.

Type

bool

origin_forwarding_type

Optional. The type of origin forwarding used to support Akamai authentication policies for the parent playlist. Not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to CdnSecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.

This field is a member of oneof _origin_forwarding_type.

Type

google.ads.admanager_v1.types.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding

origin_path_prefix

Optional. The origin path prefix provided by the publisher for the parent playlist. Only applicable for delivery media locations with the value of originForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

This field is a member of oneof _origin_path_prefix.

Type

str

media_playlist_origin_forwarding_type

Optional. The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the CdnSecurityPolicyType set to CdnSecurityPolicyType.AKAMAI. Valid options are CdnSecurityPolicyOriginForwarding.NONE or CdnSecurityPolicyOriginForwarding.ORIGIN_PATH. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT.

This field is a member of oneof _media_playlist_origin_forwarding_type.

Type

google.ads.admanager_v1.types.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding

media_playlist_origin_path_prefix

Optional. The origin path prefix provided by the publisher for the media playlists. Only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

This field is a member of oneof _media_playlist_origin_path_prefix.

Type

str

keyset

Optional. The name of the EdgeCacheKeyset on the Media CDN config that will be used to validate signed requests from DAI to ingest content.

This field is a member of oneof _keyset.

Type

str

signed_request_expiration_ttl

Optional. The duration for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN config.

This field is a member of oneof _signed_request_expiration_ttl.

Type

google.protobuf.duration_pb2.Duration

class google.ads.admanager_v1.types.CdnSecurityPolicyOriginForwardingEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CdnSecurityPolicyOriginForwarding][google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding]

class CdnSecurityPolicyOriginForwarding(value)

Bases: proto.enums.Enum

Indicates the type of origin forwarding used to support Akamai authentication policies for LiveStreamEvent.

Values:

CDN_SECURITY_POLICY_ORIGIN_FORWARDING_UNSPECIFIED (0):

Default value. This value is unused.

CONVENTIONAL (1):

Indicates that conventional origin forwarding is used.

NONE (2):

Indicates that origin forwarding is not being used.

ORIGIN_PATH (3):

Indicates that origin forwarding is set up by passing an origin path query string parameter (necessary for Akamai dynamic packaging to work).

class google.ads.admanager_v1.types.CdnSecurityPolicyTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CdnSecurityPolicy][google.ads.admanager.v1.CdnSecurityPolicy]

class CdnSecurityPolicyType(value)

Bases: proto.enums.Enum

Indicates the type of security policy associated with access to a CDN. Different security policies require different parameters in a SecurityPolicy.

Values:

CDN_SECURITY_POLICY_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

AKAMAI (1):

Security policy for accessing content on the Akamai CDN.

CLOUD_MEDIA (2):

Security policy for access content on Google Cloud Media CDN.

NONE (3):

Indicates that no authentication is necessary.

class google.ads.admanager_v1.types.ChildContentEligibilityEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ChildContentEligibility][google.ads.admanager.v1.ChildContentEligibilityEnum.ChildContentEligibility]

class ChildContentEligibility(value)

Bases: proto.enums.Enum

Child content eligibility designation.

Values:

CHILD_CONTENT_ELIGIBILITY_UNSPECIFIED (0):

Default value. This value is unused.

ALLOWED (1):

This line item is eligible to serve on requests that are child-directed.

DISALLOWED (2):

This line item is not eligible to serve on any requests that are child-directed.

class google.ads.admanager_v1.types.ChildPublisher(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The [ChildPublisher][google.ads.admanager.v1.ChildPublisher] resource.

name

Identifier. The resource name of the [ChildPublisher][google.ads.admanager.v1.ChildPublisher]. Format: networks/{network_code}/childPublishers/{child_publisher_id}

Type

str

display_name

Required. The display name of the [ChildPublisher][google.ads.admanager.v1.ChildPublisher].

This field is a member of oneof _display_name.

Type

str

email

Required. The email for the [ChildPublisher][google.ads.admanager.v1.ChildPublisher].

This field is a member of oneof _email.

Type

str

child_network

Immutable. The resource name of the [ChildPublisher][google.ads.admanager.v1.ChildPublisher]’s Ad Manager network.

Format: networks/{network_code}

This field is a member of oneof _child_network.

Type

str

delegation_type

Required. The type of delegation for the [ChildPublisher][google.ads.admanager.v1.ChildPublisher].

This attribute is immutable while the relationship is active.

This field is a member of oneof _delegation_type.

Type

google.ads.admanager_v1.types.DelegationTypeEnum.DelegationType

parent_revenue_share_millipercent

Optional. The revenue share that the parent publisher will receive in millipercent. For example, 15000 millipercent is 15%.

This attribute is only settable for Manage Account [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s of non-reseller parent publishers. Otherwise, it is read-only and always 100%.

Additionally, this attribute is immutable while the relationship is active.

This field is a member of oneof _parent_revenue_share_millipercent.

Type

int

seller_id

Optional. The seller ID for the [ChildPublisher][google.ads.admanager.v1.ChildPublisher], as specified in the parent publisher’s sellers.json file.

This attribute is only applicable to Manage Inventory [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s.

This field is a member of oneof _seller_id.

Type

str

readiness_status

Output only. The overall onboarding readiness of the [ChildPublisher][google.ads.admanager.v1.ChildPublisher].

This status is correlated with ad serving, but does not include site-level approval information.

This field is a member of oneof _readiness_status.

Type

google.ads.admanager_v1.types.McmReadinessStatusEnum.McmReadinessStatus

invitation_status

Output only. The status of the invitation request to the [ChildPublisher][google.ads.admanager.v1.ChildPublisher].

This field is a member of oneof _invitation_status.

Type

google.ads.admanager_v1.types.DelegationInvitationStatusEnum.DelegationInvitationStatus

approval_status

Output only. The approval status of the [ChildPublisher][google.ads.admanager.v1.ChildPublisher].

This field is a member of oneof _approval_status.

Type

google.ads.admanager_v1.types.DelegationApprovalStatusEnum.DelegationApprovalStatus

identity_verification_status

Output only. The status of the [ChildPublisher][google.ads.admanager.v1.ChildPublisher]’s identity verification.

This field is a member of oneof _identity_verification_status.

Type

google.ads.admanager_v1.types.ChildPublisherIdentityVerificationStatusEnum.ChildPublisherIdentityVerificationStatus

address_verification_status

Output only. The status of the [ChildPublisher][google.ads.admanager.v1.ChildPublisher]’s address verification (i.e., mail PIN).

This field is a member of oneof _address_verification_status.

Type

google.ads.admanager_v1.types.ChildPublisherAddressVerificationStatusEnum.ChildPublisherAddressVerificationStatus

pending_onboarding_tasks

Output only. The pending onboarding tasks that must be completed by the child publisher before Google’s policy compliance (i.e. [DelegationApprovalStatus.PENDING_GOOGLE_APPROVAL][]) can be verified.

Type

MutableSequence[google.ads.admanager_v1.types.ChildPublisherOnboardingTaskEnum.ChildPublisherOnboardingTask]

account_status

Output only. The account status of the [ChildPublisher][google.ads.admanager.v1.ChildPublisher].

This field is a member of oneof _account_status.

Type

google.ads.admanager_v1.types.DelegationAccountStatusEnum.DelegationAccountStatus

approved_manage_account_revenue_share_millipercent

Output only. Provides the approved revenue share that the parent publisher will receive in millipercent. For example, 15000 millipercent is 15%.

This attribute is only set for Manage Account [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s of non-reseller parent publishers.

This field is a member of oneof _approved_manage_account_revenue_share_millipercent.

Type

int

class google.ads.admanager_v1.types.ChildPublisherAddressVerificationStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper for [ChildPublisherAddressVerificationStatus][google.ads.admanager.v1.ChildPublisherAddressVerificationStatusEnum.ChildPublisherAddressVerificationStatus]

class ChildPublisherAddressVerificationStatus(value)

Bases: proto.enums.Enum

The status of the Mcm child address verification.

Values:

CHILD_PUBLISHER_ADDRESS_VERIFICATION_STATUS_UNSPECIFIED (0):

No value specified

EXEMPT (1):

Indicates publisher is exempt from address verification.

EXPIRED (2):

Indicates publisher hasn’t completed address verification before the expiration date.

FAILED (3):

Indicates publisher failed address verification.

PENDING (4):

Indicates publisher’s address pin has been mailed and must be verified.

NOT_ELIGIBLE (5):

Indicates publisher is not eligible for address verification.

VERIFIED (6):

Indicates publisher’s address is verified.

class google.ads.admanager_v1.types.ChildPublisherIdentityVerificationStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper for [ChildPublisherIdentityVerificationStatus][google.ads.admanager.v1.ChildPublisherIdentityVerificationStatusEnum.ChildPublisherIdentityVerificationStatus]

class ChildPublisherIdentityVerificationStatus(value)

Bases: proto.enums.Enum

The status of the Mcm child identity verification.

Values:

CHILD_PUBLISHER_IDENTITY_VERIFICATION_STATUS_UNSPECIFIED (0):

No value specified

EXEMPT (1):

Indicates publisher is exempt from identify verification.

EXPIRED (2):

Indicates publisher hasn’t completed identity verification before the expiration date.

FAILED (3):

Indicates publisher failed identity verification.

PENDING (4):

Indicates publisher is pending identity verification.

NOT_ELIGIBLE (5):

Indicates publisher is not eligible for identity verification.

VERIFIED (6):

Indicates publisher has completed identity verification.

class google.ads.admanager_v1.types.ChildPublisherOnboardingTaskEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper for [ChildPublisherOnboardingTask][google.ads.admanager.v1.ChildPublisherOnboardingTaskEnum.ChildPublisherOnboardingTask]

class ChildPublisherOnboardingTask(value)

Bases: proto.enums.Enum

The pending tasks that must be completed by the child publisher before Google’s policy complicance (i.e., [PENDING_GOOGLE_APPROVAL][google.ads.admanager.v1.DelegationApprovalStatusEnum.DelegationApprovalStatus.PENDING_GOOGLE_APPROVAL]) can be verified.

Values:

CHILD_PUBLISHER_ONBOARDING_TASK_UNSPECIFIED (0):

No value specified

BILLING_PROFILE_CREATION (1):

Indicates the child publisher is required to create a payments billing profile.

PHONE_PIN_VERIFICATION (2):

Indicates the child publisher is required to verify their phone number.

AD_MANAGER_ACCOUNT_SETUP (4):

Indicates the child publisher is required to setup their Ad Manager account.

class google.ads.admanager_v1.types.CmsContent(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains information about the Content from the CMS it was ingested from.

content_source

Output only. The resource name of the [ContentSource][google.ads.admanager.v1.ContentSource] this content was ingested from.

This field is a member of oneof _content_source.

Type

str

content_source_display_name

Output only. The display name of the [ContentSource][google.ads.admanager.v1.ContentSource] this content was ingested from.

This field is a member of oneof _content_source_display_name.

Type

str

cms_content_id

The ID of the Content in the CMS. This ID will be a 3rd party ID, usually the ID of the content in a CMS (Content Management System).

This field is a member of oneof _cms_content_id.

Type

str

class google.ads.admanager_v1.types.CmsMetadataKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Key associated with a piece of content from a publisher’s CMS.

name

Identifier. The resource name of the CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}

Type

str

display_name

Required. The key of a key-value pair.

Type

str

status

Output only. The status of this CMS metadata key.

Type

google.ads.admanager_v1.types.CmsMetadataKeyStatusEnum.CmsMetadataKeyStatus

class google.ads.admanager_v1.types.CmsMetadataKeyStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CmsMetadataKeyStatus][google.ads.admanager.v1.CmsMetadataKeyStatusEnum.CmsMetadataKeyStatus]

class CmsMetadataKeyStatus(value)

Bases: proto.enums.Enum

Status for CmsMetadataKey objects.

Values:

CMS_METADATA_KEY_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE (1):

The key is active.

INACTIVE (2):

The key is not active.

class google.ads.admanager_v1.types.CmsMetadataTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents targeting for CMS metadata. The values are ORed together.

negative

Whether this expression is negatively targeted, meaning it matches ad requests that exclude the below values.

This field is a member of oneof _negative.

Type

bool

cms_metadata_values

Optional. The resource names of the targeted CMS metadata values.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.CmsMetadataValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Key value pair associated with a piece of content from a publisher’s CMS.

name

Identifier. The resource name of the CmsMetadataValue. Format: networks/{network_code}/cmsMetadataValues/{cms_metadata_value_id}

Type

str

display_name

The value of this key-value pair.

Type

str

key

Required. Immutable. The resource name of the CmsMetadataKey. Format: “networks/{network_code}/cmsMetadataKey/{cms_metadata_key_id}”.

Type

str

status

Output only. The status of this CMS metadata value.

Type

google.ads.admanager_v1.types.CmsMetadataValueStatusEnum.CmsMetadataValueStatus

class google.ads.admanager_v1.types.CmsMetadataValueStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CmsMetadataValueStatus][google.ads.admanager.v1.CmsMetadataValueStatusEnum.CmsMetadataValueStatus]

class CmsMetadataValueStatus(value)

Bases: proto.enums.Enum

Status for CmsMetadataValue objects.

Values:

CMS_METADATA_VALUE_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE (1):

The value is active.

ARCHIVED (2):

The value is archived.

INACTIVE (3):

The value is not active.

class google.ads.admanager_v1.types.CompanionDeliveryOptionEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CompanionDeliveryOption][google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption].

class CompanionDeliveryOption(value)

Bases: proto.enums.Enum

Defines the different delivery types of a line item companion.

Values:

COMPANION_DELIVERY_OPTION_UNSPECIFIED (0):

No value specified.

OPTIONAL (1):

Companions are not required to serve a [CreativeSet][google.ads.admanager.v1.CreativeSet]. The creative set can serve to inventory that has zero or more matching companions.

AT_LEAST_ONE (2):

At least one companion must be served in order for the creative set to be used.

ALL (3):

All companions in the set must be served in order for the creative set to be used. This can still serve to inventory that has more companions than can be filled.

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

Bases: proto.message.Message

The [Company][google.ads.admanager.v1.Company] resource.

name

Identifier. The resource name of the [Company][google.ads.admanager.v1.Company]. Format: networks/{network_code}/companies/{company_id}

Type

str

company_id

Output only. Deprecated: [Company][google.ads.admanager.v1.Company] ID.

This field is a member of oneof _company_id.

Type

int

display_name

Required. The display name of the [Company][google.ads.admanager.v1.Company].

This value has a maximum length of 127 characters.

This field is a member of oneof _display_name.

Type

str

type_

Required. The type of the [Company][google.ads.admanager.v1.Company].

This field is a member of oneof _type.

Type

google.ads.admanager_v1.types.CompanyTypeEnum.CompanyType

address

Optional. The address for the [Company][google.ads.admanager.v1.Company].

This value has a maximum length of 1024 characters.

This field is a member of oneof _address.

Type

str

email

Optional. The email for the [Company][google.ads.admanager.v1.Company].

This value has a maximum length of 128 characters.

This field is a member of oneof _email.

Type

str

fax

Optional. The fax number for the [Company][google.ads.admanager.v1.Company].

This value has a maximum length of 63 characters.

This field is a member of oneof _fax.

Type

str

phone

Optional. The phone number for the [Company][google.ads.admanager.v1.Company].

This value has a maximum length of 63 characters.

This field is a member of oneof _phone.

Type

str

external_id

Optional. The external ID for the [Company][google.ads.admanager.v1.Company].

This value has a maximum length of 255 characters.

This field is a member of oneof _external_id.

Type

str

comment

Optional. Comments about the [Company][google.ads.admanager.v1.Company].

This value has a maximum length of 1024 characters.

This field is a member of oneof _comment.

Type

str

credit_status

Optional. The credit status of the [Company][google.ads.admanager.v1.Company].

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

This field is a member of oneof _credit_status.

Type

google.ads.admanager_v1.types.CompanyCreditStatusEnum.CompanyCreditStatus

applied_labels

Optional. The labels that are directly applied to the [Company][google.ads.admanager.v1.Company].

Type

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

primary_contact

Optional. The resource names of primary [Contact][google.ads.admanager.v1.Contact] of the [Company][google.ads.admanager.v1.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][google.ads.admanager.v1.Company]. Format: “networks/{network_code}/teams/{team_id}”.

Type

MutableSequence[str]

third_party_company_id

Optional. The ID of the Google-recognized canonicalized form of the [Company][google.ads.admanager.v1.Company].

This field is a member of oneof _third_party_company_id.

Type

int

update_time

Output only. The time the [Company][google.ads.admanager.v1.Company] was last modified.

This field is a member of oneof _update_time.

Type

google.protobuf.timestamp_pb2.Timestamp

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

Bases: proto.message.Message

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

class CompanyCreditStatus(value)

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)

Bases: proto.message.Message

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

class CompanyType(value)

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)

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

display_name

Required. The name of the contact. This attribute has a maximum length of 127 characters.

This field is a member of oneof _display_name.

Type

str

company

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

This field is a member of oneof _company.

Type

str

status

Output only. The status of the contact. This attribute is assigned by Google.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.ContactStatusEnum.ContactStatus

address

Optional. The address of the contact. This attribute has a maximum length of 1024 characters.

This field is a member of oneof _address.

Type

str

cell_phone

Optional. The cell phone number where the contact can be reached.

This field is a member of oneof _cell_phone.

Type

str

comment

Optional. A free-form text comment for the contact. This attribute has a maximum length of 1024 characters.

This field is a member of oneof _comment.

Type

str

email

Optional. The e-mail address where the contact can be reached. This attribute has a maximum length of 128 characters.

This field is a member of oneof _email.

Type

str

fax

Optional. The fax number where the contact can be reached. This attribute has a maximum length of 1024 characters.

This field is a member of oneof _fax.

Type

str

title

Optional. The job title of the contact. This attribute has a maximum length of 1024 characters.

This field is a member of oneof _title.

Type

str

work_phone

Optional. The work phone number where the contact can be reached. This attribute has a maximum length of 1024 characters.

This field is a member of oneof _work_phone.

Type

str

class google.ads.admanager_v1.types.ContactStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ContactStatus][google.ads.admanager.v1.ContactStatusEnum.ContactStatus]

class ContactStatus(value)

Bases: proto.enums.Enum

Describes the contact statuses.

Values:

CONTACT_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

INVITE_CANCELED (1):

The contact was invited to see their orders, but the invitation was cancelled.

INVITE_EXPIRED (2):

The contact has been invited to see their orders, but the invitation has already expired.

INVITE_PENDING (3):

The contact has been invited to see their orders, but has not yet accepted the invitation.

UNINVITED (4):

The contact has not been invited to see their orders.

USER_ACTIVE (5):

The contact has access to login and view their orders.

USER_DISABLED (6):

The contact accepted an invitation to see their orders, but their access was later revoked.

class google.ads.admanager_v1.types.ContainerTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ContainerType][google.ads.admanager.v1.ContainerTypeEnum.ContainerType]

class ContainerType(value)

Bases: proto.enums.Enum

The container type of the DaiEncodingProfile.

Values:

CONTAINER_TYPE_UNSPECIFIED (0):

Not specified value.

TS (1):

Transport stream (TS) container.

FMP4 (2):

Fragmented MPEG-4 (fMP4) output container.

HLS_AUDIO (3):

HTTP live streaming (HLS) packed audio container.

class google.ads.admanager_v1.types.Content(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A piece of Content from a Publisher’s CMS.

name

Identifier. The resource name of the Content. Format: networks/{network_code}/content/{content_id}

Type

str

display_name

Output only. The name of the Content.

This field is a member of oneof _display_name.

Type

str

status

Output only. The status of this Content.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.ContentStatusEnum.ContentStatus

content_status_source

Output only. Whether the content status was defined by the user, or by the source CMS from which the Content was ingested.

This field is a member of oneof _content_status_source.

Type

google.ads.admanager_v1.types.ContentStatusSourceEnum.ContentStatusSource

hls_ingest_status

Output only. The current DAI ingest status of the HLS media for the Content. This attribute is unset if the Content is not eligible for dynamic ad insertion or if the Content does not have HLS media.

This field is a member of oneof _hls_ingest_status.

Type

google.ads.admanager_v1.types.DaiIngestStatusEnum.DaiIngestStatus

hls_ingest_errors

Output only. The list of any errors that occurred during the most recent DAI ingestion process of the HLS media. This attribute will be empty if the hlsIngestStatus is [DaiIngestStatus.SUCCESS][] or if the Content is not eligible for dynamic ad insertion or if the Content does not have HLS media.

Type

MutableSequence[google.ads.admanager_v1.types.DaiIngestError]

last_hls_ingest_time

Output only. The timestamp at which this Content’s HLS media was last ingested for DAI. This attribute will be unset if the Content is not eligible for dynamic ad insertion or if the Content does not have HLS media.

This field is a member of oneof _last_hls_ingest_time.

Type

google.protobuf.timestamp_pb2.Timestamp

dash_ingest_status

Output only. The current DAI ingest status of the DASH media for the Content. This attribute is unset if the Content is not eligible for dynamic ad insertion or if the Content does not have DASH media.

This field is a member of oneof _dash_ingest_status.

Type

google.ads.admanager_v1.types.DaiIngestStatusEnum.DaiIngestStatus

dash_ingest_errors

Output only. The list of any errors that occurred during the most recent DAI ingestion process of the DASH media. This attribute will be empty if the hlsIngestStatus is [DaiIngestStatus.SUCCESS][] or if the Content is not eligible for dynamic ad insertion or if the Content does not have DASH media.

Type

MutableSequence[google.ads.admanager_v1.types.DaiIngestError]

last_dash_ingest_time

Output only. The timestamp at which this Content’s DASH media was last ingested for DAI. This attribute will be unset if the Content is not eligible for dynamic ad insertion or if the Content does not have DASH media.

This field is a member of oneof _last_dash_ingest_time.

Type

google.protobuf.timestamp_pb2.Timestamp

import_time

Output only. The timestamp at which this Content was published.

This field is a member of oneof _import_time.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The timestamp at which this Content was last modified. The last modified date time will always be updated when a [ContentBundle][google.ads.admanager.v1.ContentBundle] association is changed, but will not always be updated when a [CmsMetadataValue][google.ads.admanager.v1.CmsMetadataValue] value is changed.

This field is a member of oneof _update_time.

Type

google.protobuf.timestamp_pb2.Timestamp

cms_sources

Output only. Information about the Content from the CMS it was ingested from.

Type

MutableSequence[google.ads.admanager_v1.types.CmsContent]

content_bundles

Output only. The resource names of the [ContentBundles][google.ads.admanager.v1.ContentBundle] of which this Content is a member.

Type

MutableSequence[str]

cms_metadata_values

Output only. The resource names of the [CmsMetadataValues] [google.ads.admanager.v1.CmsMetadataValue] that are associated with this Content.

Type

MutableSequence[str]

duration

Output only. The duration of the Content.

This field is a member of oneof _duration.

Type

google.protobuf.duration_pb2.Duration

class google.ads.admanager_v1.types.ContentBundle(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A [ContentBundle][google.ads.admanager.v1.ContentBundle] is a grouping of individual [Content][google.ads.admanager.v1.Content]. A [ContentBundle][google.ads.admanager.v1.ContentBundle] is defined as including the [Content][google.ads.admanager.v1.Content] that match certain filter rules along with the option to explicitly include or exclude certain Content IDs.

name

Identifier. The resource name of the [ContentBundle][google.ads.admanager.v1.ContentBundle]. Format: networks/{network_code}/contentBundles/{content_bundle_id}

Type

str

display_name

Required. The name of the [ContentBundle][google.ads.admanager.v1.ContentBundle]. This attribute is required and has a maximum length of 255 characters.

Type

str

status

Output only. The ContentBundleStatus of the [ContentBundle][google.ads.admanager.v1.ContentBundle]. This attribute is read-only and defaults to [ContentBundleStatus.INACTIVE][].

Type

google.ads.admanager_v1.types.ContentBundleStatusEnum.ContentBundleStatus

update_time

Output only. The time the ContentBundle was last modified.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.ads.admanager_v1.types.ContentBundleStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ContentBundleStatus][google.ads.admanager.v1.ContentBundleStatusEnum.ContentBundleStatus]

class ContentBundleStatus(value)

Bases: proto.enums.Enum

Status for ContentBundle objects.

Values:

CONTENT_BUNDLE_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE (1):

The object is active and stats are collected.

ARCHIVED (2):

The object has been archived.

INACTIVE (3):

The object is no longer active and no stats collected.

class google.ads.admanager_v1.types.ContentLabel(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A content label.

name

Identifier. The resource name of the ContentLabel. Format: networks/{network_code}/contentLabels/{content_label_id}

Type

str

display_name

Optional. The display name of the ContentLabel.

Type

str

class google.ads.admanager_v1.types.ContentStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ContentStatus][google.ads.admanager.v1.ContentStatusEnum.ContentStatus]

class ContentStatus(value)

Bases: proto.enums.Enum

Describes the status of a [Content][google.ads.admanager.v1.Content] object.

Values:

CONTENT_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE (1):

Indicates the Content has been created and is eligible to have ads served against it.

INACTIVE (2):

Indicates the Content has been deactivated and cannot have ads served against it.

ARCHIVED (3):

Indicates the Content has been archived; user-visible.

DELETED (4):

Indicates the Content has been removed from an external CMS.

DUPLICATED (5):

Indicates the Content is a duplicate of another piece of content.

class google.ads.admanager_v1.types.ContentStatusSourceEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ContentStatusSource][google.ads.admanager.v1.ContentStatusSourceEnum.ContentStatusSource]

class ContentStatusSource(value)

Bases: proto.enums.Enum

Describes who defined the status of the [Content][google.ads.admanager.v1.Content] object.

Values:

CONTENT_STATUS_SOURCE_UNSPECIFIED (0):

Default value. This value is unused.

CMS (1):

Indicates that the status of the Content is defined by the CMS.

USER (2):

Indicates that the status of the Content is defined by the user.

class google.ads.admanager_v1.types.ContentTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Content Targeting

Targeted/excluded content entities and bundles.

targeted_content

Optional. The resource names of the [Content][google.ads.admanager.v1.Content] that should be targeted/included.

Type

MutableSequence[str]

excluded_content

Optional. The resource names of the [Content][google.ads.admanager.v1.Content] that should be excluded.

Type

MutableSequence[str]

targeted_content_bundles

Optional. The resource names of the [ContentBundles][google.ads.admanager.v1.ContentBundle] that should be targeted/included.

Type

MutableSequence[str]

excluded_content_bundles

Optional. The resource names of the [ContentBundles][google.ads.admanager.v1.ContentBundle] that should be excluded.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.ConversionEventEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ConversionEvent][google.ads.admanager.v1.ConversionEventEnum.ConversionEvent]

class ConversionEvent(value)

Bases: proto.enums.Enum

All possible tracking event types. Not all events are supported by every kind of creative.

Values:

CONVERSION_EVENT_UNSPECIFIED (0):

Default value. This value is unused.

ACCEPT_INVITATION (1):

Corresponds to the acceptInvitation tracking event.

CLICK_TRACKING (2):

Corresponds to the Linear.VideoClicks.ClickTracking node.

CLOSE (3):

Corresponds to the close tracking event.

COLLAPSE (4):

Corresponds to the collapse tracking event.

COMPLETE (5):

Corresponds to the complete tracking event.

CREATIVE_VIEW (6):

Corresponds to the creativeView tracking event.

CUSTOM_CLICK (7):

Corresponds to the Linear.VideoClicks.CustomClick node.

ENGAGED_VIEW (8):

An event that is fired after 30 seconds of viewing the video or when the video finished (if the video duration is less than 30 seconds). This event does not correspond to any VAST element and is implemented using an extension.

EXPAND (9):

Corresponds to the expand tracking event.

FIRST_QUARTILE (10):

Corresponds to the firstQuartile tracking event.

FULLSCREEN (11):

Corresponds to the fullscreen tracking event.

FULLY_VIEWABLE_AUDIBLE_HALF_DURATION_IMPRESSION (12):

Corresponds to the fullyViewableAudibleHalfDurationImpression tracking event.

MEASURABLE_IMPRESSION (13):

Corresponds to the measurableImpression tracking event.

MIDPOINT (14):

Corresponds to the midpoint tracking event.

MUTE (15):

Corresponds to the mute tracking event.

PAUSE (16):

Corresponds to the pause tracking event.

RESUME (17):

Corresponds to the resume tracking event.

REWIND (18):

Corresponds to the rewind tracking event.

SKIPPED (19):

An event that is fired when a video was skipped. This event does not correspond to any VAST element and is implemented using an extension.

SKIP_SHOWN (20):

An event that is fired when a video skip button is shown, usually after 5 seconds of viewing the video. This event does not correspond to any VAST element and is implemented using an extension.

START (21):

Corresponds to the start tracking event.

SURVEY (22):

Corresponds to the InLine.Survey node.

THIRD_QUARTILE (23):

Corresponds to the thirdQuartile tracking event.

UNMUTE (24):

Corresponds to the unmute tracking event.

VIDEO_ABANDON (25):

Corresponds to the abandon tracking event.

VIEWABLE_IMPRESSION (26):

Corresponds to the viewableImpression tracking event.

class google.ads.admanager_v1.types.CreateAdBreakRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateAdBreak method.

parent

Required. The parent resource where this AdBreak will be created identified by an asset key or custom asset key.

Formats: networks/{network_code}/liveStreamEventsByAssetKey/{asset_key} networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}

Type

str

ad_break

Required. The AdBreak to create.

Type

google.ads.admanager_v1.types.AdBreak

class google.ads.admanager_v1.types.CreateAdRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateAdRule method.

parent

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

Type

str

ad_rule

Required. The AdRule to create.

Type

google.ads.admanager_v1.types.AdRule

class google.ads.admanager_v1.types.CreateAdSpotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateAdSpot method.

parent

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

Type

str

ad_spot

Required. The AdSpot to create.

Type

google.ads.admanager_v1.types.AdSpot

class google.ads.admanager_v1.types.CreateAdUnitRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateAdUnit method.

parent

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

Type

str

ad_unit

Required. The AdUnit to create.

Type

google.ads.admanager_v1.types.AdUnit

class google.ads.admanager_v1.types.CreateApplicationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateApplication method.

parent

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

Type

str

application

Required. The Application to create.

Type

google.ads.admanager_v1.types.Application

class google.ads.admanager_v1.types.CreateCdnConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateCdnConfig method.

parent

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

Type

str

cdn_config

Required. The CdnConfig to create.

Type

google.ads.admanager_v1.types.CdnConfig

class google.ads.admanager_v1.types.CreateChildPublisherRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [CreateChildPublisher][] method.

parent

Required. The parent resource where this [ChildPublisher][google.ads.admanager.v1.ChildPublisher] will be created. Format: networks/{network_code}

Type

str

child_publisher

Required. The [ChildPublisher][google.ads.admanager.v1.ChildPublisher] to create.

Type

google.ads.admanager_v1.types.ChildPublisher

class google.ads.admanager_v1.types.CreateCompanyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [CreateCompany][] method.

parent

Required. The parent resource where this [Company][google.ads.admanager.v1.Company] will be created. Format: networks/{network_code}

Type

str

company

Required. The [Company][google.ads.admanager.v1.Company] to create.

Type

google.ads.admanager_v1.types.Company

class google.ads.admanager_v1.types.CreateContactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateContact method.

parent

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

Type

str

contact

Required. The Contact to create.

Type

google.ads.admanager_v1.types.Contact

class google.ads.admanager_v1.types.CreateCreativeSetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateCreativeSet method.

parent

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

Type

str

creative_set

Required. The CreativeSet to create.

Type

google.ads.admanager_v1.types.CreativeSet

class google.ads.admanager_v1.types.CreateCreativeWrapperRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateCreativeWrapper method.

parent

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

Type

str

creative_wrapper

Required. The CreativeWrapper to create.

Type

google.ads.admanager_v1.types.CreativeWrapper

class google.ads.admanager_v1.types.CreateCustomFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateCustomField method.

parent

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

Type

str

custom_field

Required. The CustomField to create.

Type

google.ads.admanager_v1.types.CustomField

class google.ads.admanager_v1.types.CreateCustomTargetingKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateCustomTargetingKey method.

parent

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

Type

str

custom_targeting_key

Required. The CustomTargetingKey to create.

Type

google.ads.admanager_v1.types.CustomTargetingKey

class google.ads.admanager_v1.types.CreateCustomTargetingValueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateCustomTargetingValue method.

parent

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

Type

str

custom_targeting_value

Required. The CustomTargetingValue to create.

Type

google.ads.admanager_v1.types.CustomTargetingValue

class google.ads.admanager_v1.types.CreateDaiAuthenticationKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateDaiAuthenticationKey method.

parent

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

Type

str

dai_authentication_key

Required. The DaiAuthenticationKey to create.

Type

google.ads.admanager_v1.types.DaiAuthenticationKey

class google.ads.admanager_v1.types.CreateDaiEncodingProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateDaiEncodingProfile method.

parent

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

Type

str

dai_encoding_profile

Required. The DaiEncodingProfile to create.

Type

google.ads.admanager_v1.types.DaiEncodingProfile

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

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.CreateLabelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateLabel method.

parent

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

Type

str

label

Required. The Label to create.

Type

google.ads.admanager_v1.types.Label

class google.ads.admanager_v1.types.CreateLiveStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateLiveStream method.

parent

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

Type

str

live_stream

Required. The LiveStream to create.

Type

google.ads.admanager_v1.types.LiveStream

class google.ads.admanager_v1.types.CreateOrderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateOrder method.

parent

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

Type

str

order

Required. The Order to create.

Type

google.ads.admanager_v1.types.Order

class google.ads.admanager_v1.types.CreatePlacementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreatePlacement method.

parent

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

Type

str

placement

Required. The Placement to create.

Type

google.ads.admanager_v1.types.Placement

class google.ads.admanager_v1.types.CreatePrivateAuctionDealRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreatePrivateAuctionDeal method.

parent

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

Type

str

private_auction_deal

Required. The PrivateAuctionDeal to create.

Type

google.ads.admanager_v1.types.PrivateAuctionDeal

class google.ads.admanager_v1.types.CreatePrivateAuctionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreatePrivateAuction method.

parent

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

Type

str

private_auction

Required. The PrivateAuction to create.

Type

google.ads.admanager_v1.types.PrivateAuction

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

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.CreateSiteRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateSite method.

parent

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

Type

str

site

Required. The Site to create.

Type

google.ads.admanager_v1.types.Site

class google.ads.admanager_v1.types.CreateSlateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateSlate method.

parent

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

Type

str

slate

Required. The Slate to create.

Type

google.ads.admanager_v1.types.Slate

class google.ads.admanager_v1.types.CreateTargetingPresetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateTargetingPreset method.

parent

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

Type

str

targeting_preset

Required. The TargetingPreset to create.

Type

google.ads.admanager_v1.types.TargetingPreset

class google.ads.admanager_v1.types.CreateTeamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for CreateTeam method.

parent

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

Type

str

team

Required. The Team to create.

Type

google.ads.admanager_v1.types.Team

class google.ads.admanager_v1.types.CreateViewabilityProviderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [CreateViewabilityProvider][] method.

parent

Required. The parent resource where this [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] will be created. Format: networks/{network_code}

Type

str

viewability_provider

Required. The [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] to create.

Type

google.ads.admanager_v1.types.ViewabilityProvider

class google.ads.admanager_v1.types.Creative(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The Creative resource.

name

Identifier. The resource name of the Creative. Format: networks/{network_code}/creatives/{creative_id}

Type

str

display_name

Required. Display name of the Creative. This attribute has a maximum length of 255 characters.

This field is a member of oneof _display_name.

Type

str

class google.ads.admanager_v1.types.CreativePlaceholder(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describes a slot that a creative is expected to fill. This is used in forecasting and to validate that the correct creatives are associated with the line item.

size

Required. The size that the creative is expected to have.

Type

google.ads.admanager_v1.types.Size

companions

Optional. The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has an [EnvironmentType][google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType] of VIDEO_PLAYER or [roadblocking_type][google.ads.admanager.v1.LineItem.roadblocking_type] of CREATIVE_SET.

Type

MutableSequence[google.ads.admanager_v1.types.CreativePlaceholderCompanion]

expected_creative_count

Optional. Non-empty default. Expected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served. By default, the expected creative count is set to 1.

This field is a member of oneof _expected_creative_count.

Type

int

applied_labels

Optional. Set of labels applied directly to this CreativePlaceholder.

Type

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

amp_only

Optional. Non-empty default. Indicates if the expected creative of this placeholder has an AMP only variant. This is used to improve the accuracy of forecasting and has no effect on serving. By default, the value is false.

This field is a member of oneof _amp_only.

Type

bool

creative_targeting_display_name

Optional. The display name of the creative targeting that this CreativePlaceholder represents.

This field is a member of oneof _creative_targeting_display_name.

Type

str

class google.ads.admanager_v1.types.CreativePlaceholderCompanion(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An individual companion to a [CreativePlaceholder][google.ads.admanager.v1.CreativePlaceholder].

size

Required. The size of the companion to a [CreativePlaceholder][google.ads.admanager.v1.CreativePlaceholder].

This field is a member of oneof _size.

Type

google.ads.admanager_v1.types.Size

class google.ads.admanager_v1.types.CreativeRotationTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CreativeRotationType][google.ads.admanager.v1.CreativeRotationTypeEnum.CreativeRotationType].

class CreativeRotationType(value)

Bases: proto.enums.Enum

The strategy to use for displaying multiple creatives that are associated with a line item.

Values:

CREATIVE_ROTATION_TYPE_UNSPECIFIED (0):

No value specified.

EVENLY (1):

Creatives are displayed approximately the same number of times over the duration of the line item.

OPTIMIZED (2):

Creatives are served approximately proportionally to their performance.

SEQUENTIAL (4):

Creatives are served exactly in sequential order, aka Storyboarding. Set on the LineItemCreativeAssociation.

WEIGHTED (3):

Creatives are served approximately proportionally to their weights, set on the LineItemCreativeAssociation.

class google.ads.admanager_v1.types.CreativeSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A CreativeSet is comprised of a master Creative and its companion Creatives.

name

Identifier. The resource name of the CreativeSet. Format: networks/{network_code}/creativeSets/{creative_set_id}

Type

str

display_name

Required. The name of the CreativeSet. This attribute has a maximum length of 255 characters.

This field is a member of oneof _display_name.

Type

str

master_creative

Required. Immutable. The master Creative to which the CreativeSet is associated.

This field is a member of oneof _master_creative.

Type

str

companion_creatives

Required. The resource names of the companion Creatives associated with this CreativeSet. Format: networks/{network_code}/creatives/{creative}

Type

MutableSequence[str]

update_time

Output only. The time this CreativeSet was last modified.

This field is a member of oneof _update_time.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.ads.admanager_v1.types.CreativeTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the creative targeting criteria for a LineItem.

creative_targeting_display_name

Required. The name of this creative targeting. This attribute is required.

This field is a member of oneof _creative_targeting_display_name.

Type

str

targeting

Required. The Targeting criteria of this creative targeting. This attribute is required.

This field is a member of oneof _targeting.

Type

google.ads.admanager_v1.types.Targeting

class google.ads.admanager_v1.types.CreativeTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A template that can be used to create a [TemplateCreative][].

name

Identifier. The resource name of the creative template. Format: networks/{network_code}/creativeTemplates/{creative_template_id}

Type

str

display_name

Required. The display name of the creative template. This has a maximum length of 255 characters.

This field is a member of oneof _display_name.

Type

str

description

Optional. The description of the creative template.

This field is a member of oneof _description.

Type

str

snippet

Required. The code snippet of the creative template, with placeholders for the associated variables.

This field is a member of oneof _snippet.

Type

str

status

Output only. The status of the creative template. This attribute is assigned by Google.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.CreativeTemplateStatusEnum.CreativeTemplateStatus

type_

Optional. The type of the creative template. Users can only create or update CreativeTemplateType.CUSTOM templates.

This field is a member of oneof _type.

Type

google.ads.admanager_v1.types.CreativeTemplateTypeEnum.CreativeTemplateType

interstitial

Optional. True if this creative template produces out-of-page creatives. Creative templates with this setting enabled must include the viewed impression macro.

This field is a member of oneof _interstitial.

Type

bool

native_eligible

Optional. True if this creative template produces native-eligible creatives.

This field is a member of oneof _native_eligible.

Type

bool

native_video_eligible

Optional. True if this creative template produces native video-eligible creatives.

This field is a member of oneof _native_video_eligible.

Type

bool

safe_frame_compatible

Optional. Whether the Creative produced is compatible for SafeFrame rendering. This attribute defaults to True.

This field is a member of oneof _safe_frame_compatible.

Type

bool

variables

Required. The list of creative template variables.

Type

MutableSequence[google.ads.admanager_v1.types.CreativeTemplateVariable]

class google.ads.admanager_v1.types.CreativeTemplateStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CreativeTemplateStatus][google.ads.admanager.v1.CreativeTemplateStatusEnum.CreativeTemplateStatus]

class CreativeTemplateStatus(value)

Bases: proto.enums.Enum

Describes status of the creative template

Values:

CREATIVE_TEMPLATE_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE (1):

The CreativeTemplate is active

DELETED (2):

The CreativeTemplate is deleted. Creatives created from this CreativeTemplate can no longer serve.

INACTIVE (3):

The CreativeTemplate is inactive. Users cannot create new creatives from this template, but existing ones can be edited and continue to serve

class google.ads.admanager_v1.types.CreativeTemplateTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CreativeTemplateType][google.ads.admanager.v1.CreativeTemplateTypeEnum.CreativeTemplateType]

class CreativeTemplateType(value)

Bases: proto.enums.Enum

Describes type of the creative template.

Values:

CREATIVE_TEMPLATE_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

STANDARD (1):

Creative templates that are included in Ad Manager by default.

CUSTOM (2):

Creative templates created by an administrator or other user in the network.

class google.ads.admanager_v1.types.CreativeTemplateVariable(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a variable defined in a creative template.

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.

asset_variable

Optional. Represents a file asset variable defined in a creative template.

This field is a member of oneof SubType.

Type

google.ads.admanager_v1.types.CreativeTemplateVariable.AssetCreativeTemplateVariable

list_string_variable

Optional. Represents a list variable defined in a creative template.

This field is a member of oneof SubType.

Type

google.ads.admanager_v1.types.CreativeTemplateVariable.ListStringCreativeTemplateVariable

long_variable

Optional. Represents a long variable defined in a creative template.

This field is a member of oneof SubType.

Type

google.ads.admanager_v1.types.CreativeTemplateVariable.LongCreativeTemplateVariable

string_variable

Optional. Represents a string variable defined in a creative template.

This field is a member of oneof SubType.

Type

google.ads.admanager_v1.types.CreativeTemplateVariable.StringCreativeTemplateVariable

url_variable

Optional. Represents a url variable defined in a creative template.

This field is a member of oneof SubType.

Type

google.ads.admanager_v1.types.CreativeTemplateVariable.UrlCreativeTemplateVariable

label

Required. Label that is displayed to users when creating from the creative template. This has a maximum length of 127 characters.

This field is a member of oneof _label.

Type

str

unique_display_name

Output only. Unique name used to identify the variable. This attribute is assigned by Google when a creative template variable is created.

This field is a member of oneof _unique_display_name.

Type

str

description

Required. A descriptive help text that is displayed to users along with the label. This attribute has a maximum length of 255 characters.

This field is a member of oneof _description.

Type

str

required

Optional. True if this variable is required to be filled in by users when creating a creative from the creative template.

This field is a member of oneof _required.

Type

bool

class AssetCreativeTemplateVariable(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a file asset variable defined in a creative template.

Use [AssetCreativeTemplateVariableValue][] to specify the value for this variable when creating a [TemplateCreative][] from a [CreativeTemplate][google.ads.admanager.v1.CreativeTemplate].

mime_types

Optional. The set of allowed MIME types. If unspecified, all MIME types are allowed.

Type

MutableSequence[google.ads.admanager_v1.types.CreativeTemplateVariable.AssetCreativeTemplateVariable.MimeType]

class MimeType(value)

Bases: proto.enums.Enum

Different MIME types that the asset variable supports.

Values:

MIME_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

JPG (1):

The image/jpeg MIME type.

PNG (2):

The image/png MIME type.

GIF (3):

The image/gif MIME type.

class ListStringCreativeTemplateVariable(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a list variable defined in a creative template. This is similar to [StringCreativeTemplateVariable][google.ads.admanager.v1.CreativeTemplateVariable.StringCreativeTemplateVariable], except that there are possible choices to choose from.

Use [StringCreativeTemplateVariableValue][] to specify the value for this variable when creating a [TemplateCreative][] from a [CreativeTemplate][google.ads.admanager.v1.CreativeTemplate].

default_value

Optional. Default value to be filled in when creating creatives from the creative template.

This field is a member of oneof _default_value.

Type

str

sample_value

Optional. Sample value that is used when previewing the template in the UI.

This field is a member of oneof _sample_value.

Type

str

choices

Optional. The selectable values that the user can choose from.

Type

MutableSequence[google.ads.admanager_v1.types.CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice]

allow_other_choice

Optional. True if a user can specify an ‘other’ value. For example, if a variable called backgroundColor is defined as a list with values: red, green, blue, this boolean can be set to allow a user to enter a value not on the list such as purple.

This field is a member of oneof _allow_other_choice.

Type

bool

class VariableChoice(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Stores variable choices selectable by users.

label

Required. A label is displayed to users when creating a [TemplateCreative][]. This attribute is intended to be more descriptive than value. This attribute has a maximum length of 255 characters.

This field is a member of oneof _label.

Type

str

value

Required. When creating a [TemplateCreative][], the value in [StringCreativeTemplateVariableValue][] should match this value, if you intend to select this value. This attribute has a maximum length of 255 characters.

This field is a member of oneof _value.

Type

str

class LongCreativeTemplateVariable(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a long variable defined in a creative template.

Use [LongCreativeTemplateVariableValue][] to specify the value for this variable when creating [TemplateCreative][] from a [CreativeTemplate][google.ads.admanager.v1.CreativeTemplate].

default_value

Optional. Default value to be filled in when creating creatives from the creative template.

This field is a member of oneof _default_value.

Type

int

sample_value

Optional. Sample value that is used when previewing the template in the UI.

This field is a member of oneof _sample_value.

Type

int

class StringCreativeTemplateVariable(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a string variable defined in a creative template.

Use [StringCreativeTemplateVariableValue][] to specify the value for this variable when creating [TemplateCreative][] from a [CreativeTemplate][google.ads.admanager.v1.CreativeTemplate].

default_value

Optional. Default value to be filled in when creating creatives from the creative template.

This field is a member of oneof _default_value.

Type

str

sample_value

Optional. Sample value that is used when previewing the template in the UI.

This field is a member of oneof _sample_value.

Type

str

class UrlCreativeTemplateVariable(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a url variable defined in a creative template.

Use [UrlCreativeTemplateVariableValue][] to specify the value for this variable when creating a [TemplateCreative][] from a [CreativeTemplate][google.ads.admanager.v1.CreativeTemplate].

default_value

Optional. Default value to be filled in when creating creatives from the creative template.

This field is a member of oneof _default_value.

Type

str

sample_value

Optional. Sample value that is used when previewing the template in the UI.

This field is a member of oneof _sample_value.

Type

str

url_type

Optional. The type of URL that this variable represents. Different types of URLs may be handled differently at rendering time.

This field is a member of oneof _url_type.

Type

google.ads.admanager_v1.types.CreativeTemplateVariableUrlTypeEnum.CreativeTemplateVariableUrlType

class google.ads.admanager_v1.types.CreativeTemplateVariableUrlTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CreativeTemplateVariableUrlType][google.ads.admanager.v1.CreativeTemplateVariableUrlTypeEnum.CreativeTemplateVariableUrlType]

class CreativeTemplateVariableUrlType(value)

Bases: proto.enums.Enum

Types of URLs that a UrlCreativeTemplateVariable can represent.

Values:

CREATIVE_TEMPLATE_VARIABLE_URL_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

CLICK_TRACKER (1):

Click tracking URL.

DEEPLINK (2):

Deep-link URL.

IMPRESSION_TRACKER (3):

Impression tracking URL.

STANDARD_HTTP (4):

Standard HTTP URL.

class google.ads.admanager_v1.types.CreativeWrapper(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A CreativeWrapper allows the wrapping of HTML snippets to be served along with Creative objects.

CreativeWrapper must be associated with a [LabelType.CREATIVE_WRAPPER][google.ads.admanager.v1.LabelTypeEnum.LabelType.CREATIVE_WRAPPER] label and applied to ad units by [AdUnit.appliedLabels][google.ads.admanager.v1.AdUnit.applied_labels].

name

Identifier. The resource name of the CreativeWrapper. Format: networks/{network_code}/creativeWrappers/{creative_wrapper_id}

Type

str

label

Required. Immutable. The resource name of the [Label][google.ads.admanager.v1.Label]. Format:networks/{network_code}/label/{label_id}

Type

str

creative_wrapper_type

Required. The creative_wrapper_type. If the creative_wrapper_type is [CreativeWrapperType.VIDEO_TRACKING_URL][google.ads.admanager.v1.CreativeWrapperTypeEnum.CreativeWrapperType.VIDEO_TRACKING_URL], the video_tracking_urls field must be set. If the creative_wrapper_type is [CreativeWrapperType.HTML][google.ads.admanager.v1.CreativeWrapperTypeEnum.CreativeWrapperType.HTML], either the header or footer field must be set.

This field is a member of oneof _creative_wrapper_type.

Type

google.ads.admanager_v1.types.CreativeWrapperTypeEnum.CreativeWrapperType

header_creative

Output only. The resource name of the [Creative][google.ads.admanager.v1.Creative]. Format: networks/{network_code}/creative/{creative_id}

This field is a member of oneof _header_creative.

Type

str

footer_creative

Output only. The resource name of the [Creative][google.ads.admanager.v1.Creative]. Format: networks/{network_code}/creative/{creative_id}

This field is a member of oneof _footer_creative.

Type

str

html_header

Optional. The header HTML snippet that this CreativeWrapper delivers.

This field is a member of oneof _html_header.

Type

str

html_footer

Optional. The footer HTML snippet that this CreativeWrapper delivers.

This field is a member of oneof _html_footer.

Type

str

amp_header

Optional. The header AMP snippet that this CreativeWrapper delivers.

This field is a member of oneof _amp_header.

Type

str

amp_footer

Optional. The footer AMP snippet that this CreativeWrapper delivers.

This field is a member of oneof _amp_footer.

Type

str

video_tracking_urls

Optional. The video tracking URLs that this CreativeWrapper delivers. This field is required if the creative_wrapper_type is [CreativeWrapperType.VIDEO_TRACKING_URL][google.ads.admanager.v1.CreativeWrapperTypeEnum.CreativeWrapperType.VIDEO_TRACKING_URL] and ignored otherwise.

Type

MutableSequence[google.ads.admanager_v1.types.VideoTrackingUrl]

third_party_data_declaration

Optional. The ThirdPartyDataDeclaration for this creative wrapper.

The third party companies that are associated with this CreativeWrapper and are present in the html_header or html_footer. This field is only applicable when the creative_wrapper_type is [CreativeWrapperType.HTML][google.ads.admanager.v1.CreativeWrapperTypeEnum.CreativeWrapperType.HTML].

This field is a member of oneof _third_party_data_declaration.

Type

google.ads.admanager_v1.types.ThirdPartyDataDeclaration

ordering

Optional. If there are multiple wrappers for a [Creative][google.ads.admanager.v1.Creative], then ordering defines the order in which the HTML snippets are rendered.

This field is a member of oneof _ordering.

Type

google.ads.admanager_v1.types.CreativeWrapperOrderingEnum.CreativeWrapperOrdering

status

Output only. The status of the CreativeWrapper.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.CreativeWrapperStatusEnum.CreativeWrapperStatus

class google.ads.admanager_v1.types.CreativeWrapperOrderingEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CreativeWrapperOrdering][google.ads.admanager.v1.CreativeWrapperOrderingEnum.CreativeWrapperOrdering]

class CreativeWrapperOrdering(value)

Bases: proto.enums.Enum

Defines the order in which the header and footer HTML snippets will be wrapped around the served creative. INNER snippets will be wrapped first, followed by NO_PREFERENCE and finally OUTER. If the creative needs to be wrapped with more than one snippet with the same CreativeWrapperOrdering, then the order is unspecified.

Values:

CREATIVE_WRAPPER_ORDERING_UNSPECIFIED (0):

Default value. This value is unused.

INNER (1):

Wrapping occurs as early as possible.

NO_PREFERENCE (2):

Wrapping occurs after INNER but before OUTER

OUTER (3):

Wrapping occurs after both NO_PREFERENCE and INNER

class google.ads.admanager_v1.types.CreativeWrapperStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CreativeWrapperStatus][google.ads.admanager.v1.CreativeWrapperStatusEnum.CreativeWrapperStatus]

class CreativeWrapperStatus(value)

Bases: proto.enums.Enum

Indicates whether the CreativeWrapper is active. HTML snippets are served to Creatives only when the CreativeWrapper is active.

Values:

CREATIVE_WRAPPER_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE (1):

The CreativeWrapper will be applied to served creatives.

INACTIVE (2):

The CreativeWrapper will not be applied to served creatives.

class google.ads.admanager_v1.types.CreativeWrapperTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CreativeWrapperType][google.ads.admanager.v1.CreativeWrapperTypeEnum.CreativeWrapperType]

class CreativeWrapperType(value)

Bases: proto.enums.Enum

The type of a CreativeWrapper which is specified on the CreativeWrapper.

Values:

CREATIVE_WRAPPER_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

HTML (1):

HTML CreativeWrappers that include header/footer HTML snippets.

VIDEO_TRACKING_URL (2):

Video Tracking URL CreativeWrappers that include tracking URIs.

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

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}

Type

str

custom_field_id

Output only. Deprecated: Unique ID of the CustomField.

This field is a member of oneof _custom_field_id.

Type

int

display_name

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

This field is a member of oneof _display_name.

Type

str

description

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

This field is a member of oneof _description.

Type

str

status

Output only. The status of the CustomField.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.CustomFieldStatusEnum.CustomFieldStatus

entity_type

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

This field is a member of oneof _entity_type.

Type

google.ads.admanager_v1.types.CustomFieldEntityTypeEnum.CustomFieldEntityType

data_type

Required. The data type of the CustomField.

This field is a member of oneof _data_type.

Type

google.ads.admanager_v1.types.CustomFieldDataTypeEnum.CustomFieldDataType

visibility

Required. The visibility of the CustomField.

This field is a member of oneof _visibility.

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)

Bases: proto.message.Message

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

class CustomFieldDataType(value)

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)

Bases: proto.message.Message

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

class CustomFieldEntityType(value)

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)

Bases: proto.message.Message

An option for a drop-down CustomField.

custom_field_option_id

Optional. Non-empty default. 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)

Bases: proto.message.Message

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

class CustomFieldStatus(value)

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)

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)

Bases: proto.message.Message

Represent custom field value type.

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)

Bases: proto.message.Message

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

class CustomFieldVisibility(value)

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.CustomPacingCurve(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A curve consisting of CustomPacingGoal objects that is used to pace line item delivery.

custom_pacing_goal_unit

Required. The unit of the [CustomPacingGoal.amount][google.ads.admanager.v1.CustomPacingGoal.amount] values.

This field is a member of oneof _custom_pacing_goal_unit.

Type

google.ads.admanager_v1.types.CustomPacingGoalUnitEnum.CustomPacingGoalUnit

custom_pacing_goals

Required. The list of goals that make up the custom pacing curve.

Type

MutableSequence[google.ads.admanager_v1.types.CustomPacingGoal]

class google.ads.admanager_v1.types.CustomPacingGoal(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An interval of a CustomPacingCurve. A custom pacing goal contains a start time and an amount. The goal will apply until either the next custom pacing goal’s getStartTime or the line item’s end time if it is the last goal.

start_time

Optional. The start date and time of the goal. This field is required unless [use_line_item_start_time][google.ads.admanager.v1.CustomPacingGoal.use_line_item_start_time] is true.

This field is a member of oneof _start_time.

Type

google.protobuf.timestamp_pb2.Timestamp

use_line_item_start_time

Optional. Input only. Whether the [LineItem.start_time] should be used for the start date and time of this goal. This field is not persisted and if it is set to true, the [start_time] field will be populated by the line item’s start time.

This field is a member of oneof _use_line_item_start_time.

Type

bool

amount

Optional. The amount associated with the goal. This field is required.

This field is a member of oneof _amount.

Type

int

class google.ads.admanager_v1.types.CustomPacingGoalUnitEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [CustomPacingGoalUnit][google.ads.admanager.v1.CustomPacingGoalUnitEnum.CustomPacingGoalUnit]

class CustomPacingGoalUnit(value)

Bases: proto.enums.Enum

Options for the unit of the custom pacing goal amounts.

Values:

CUSTOM_PACING_GOAL_UNIT_UNSPECIFIED (0):

Default value. This value is unused.

ABSOLUTE (1):

The custom pacing goal amounts represent absolute numbers corresponding to the line item’s [Goal.unitType][].

MILLI_PERCENT (2):

The custom pacing goal amounts represent a millipercent. For example, 15000 millipercent equals 15%.

class google.ads.admanager_v1.types.CustomTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the top level targeting expression for custom key/values, audience segments, and/or CMS metadata.

custom_targeting_clauses

Optional. These clauses are all ORed together.

Type

MutableSequence[google.ads.admanager_v1.types.CustomTargetingClause]

class google.ads.admanager_v1.types.CustomTargetingClause(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a logical AND of individual custom targeting expressions.

custom_targeting_literals

Optional. Leaf targeting expressions for custom key/values.

Type

MutableSequence[google.ads.admanager_v1.types.CustomTargetingLiteral]

audience_segment_targetings

Optional. Leaf targeting expressions for audience segments.

Type

MutableSequence[google.ads.admanager_v1.types.AudienceSegmentTargeting]

cms_metadata_targetings

Optional. Leaf targeting expressions for cms metadata.

Type

MutableSequence[google.ads.admanager_v1.types.CmsMetadataTargeting]

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

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. Deprecated: CustomTargetingKey ID.

This field is a member of oneof _custom_targeting_key_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.

This field is a member of oneof _ad_tag_name.

Type

str

display_name

Optional. Descriptive name for the CustomTargetingKey.

This field is a member of oneof _display_name.

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.

This field is a member of oneof _type.

Type

google.ads.admanager_v1.types.CustomTargetingKeyTypeEnum.CustomTargetingKeyType

status

Output only. Status of the CustomTargetingKey.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus

reportable_type

Required. Reportable state of the CustomTargetingKey.

This field is a member of oneof _reportable_type.

Type

google.ads.admanager_v1.types.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType

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

Bases: proto.message.Message

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

class CustomTargetingKeyReportableType(value)

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)

Bases: proto.message.Message

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

class CustomTargetingKeyStatus(value)

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)

Bases: proto.message.Message

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

class CustomTargetingKeyType(value)

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.CustomTargetingLiteral(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents targeting for custom key/values. The values are ORed together.

negative

Whether this expression is negatively targeted, meaning it matches ad requests that exclude the below values.

This field is a member of oneof _negative.

Type

bool

custom_targeting_key

Optional. The resource name of the targeted CustomKey.

This field is a member of oneof _custom_targeting_key.

Type

str

custom_targeting_values

Optional. The resource names of the targeted CustomValues.

Type

MutableSequence[str]

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

Bases: proto.message.Message

The CustomTargetingValue resource.

name

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

Type

str

custom_targeting_key

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

This field is a member of oneof _custom_targeting_key.

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

This field is a member of oneof _ad_tag_name.

Type

str

display_name

Optional. Descriptive name for the CustomTargetingValue.

This field is a member of oneof _display_name.

Type

str

match_type

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

This field is a member of oneof _match_type.

Type

google.ads.admanager_v1.types.CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchType

status

Output only. Status of the CustomTargetingValue.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.CustomTargetingValueStatusEnum.CustomTargetingValueStatus

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

Bases: proto.message.Message

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

class CustomTargetingValueMatchType(value)

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)

Bases: proto.message.Message

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

class CustomTargetingValueStatus(value)

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.DaiAuthenticationKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A DaiAuthenticationKey is used to authenticate stream requests to the IMA SDK API.

name

Identifier. The resource name of the DaiAuthenticationKey. Format: networks/{network_code}/daiAuthenticationKeys/{dai_authentication_key}

Type

str

status

Output only. The status of this DaiAuthenticationKey.

DAI authentication keys are created in the [ACTIVE][google.ads.admanager.v1.DaiAuthenticationKeyStatusEnum.DaiAuthenticationKeyStatus.ACTIVE] state.

Only active keys will be accepted by the IMA SDK API as valid.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.DaiAuthenticationKeyStatusEnum.DaiAuthenticationKeyStatus

display_name

Required. The name for this DaiAuthenticationKey.

This field is a member of oneof _display_name.

Type

str

key_type

Optional. The type of this key, which determines how it should be used on stream create requests.

This field is a member of oneof _key_type.

Type

google.ads.admanager_v1.types.DaiAuthenticationKeyTypeEnum.DaiAuthenticationKeyType

class google.ads.admanager_v1.types.DaiAuthenticationKeyStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [DaiAuthenticationKeyStatus][google.ads.admanager.v1.DaiAuthenticationKeyStatusEnum.DaiAuthenticationKeyStatus]

class DaiAuthenticationKeyStatus(value)

Bases: proto.enums.Enum

Statuses associated with DaiAuthenticationKey objects.

Values:

DAI_AUTHENTICATION_KEY_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE (1):

Indicates that the API key is actively in use and that the IMA SDK API should accept it as a valid key in requests.

INACTIVE (2):

Indicates that the API key is no longer is use and that the IMA SDK API should not accept it as a valid key in requests.

class google.ads.admanager_v1.types.DaiAuthenticationKeyTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [DaiAuthenticationKeyType][google.ads.admanager.v1.DaiAuthenticationKeyTypeEnum.DaiAuthenticationKeyType]

class DaiAuthenticationKeyType(value)

Bases: proto.enums.Enum

Key types associated with DaiAuthenticationKey objects.

Values:

DAI_AUTHENTICATION_KEY_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

API (1):

Indicates that the key is a standard API key and should be used with the api-key SDK parameter when authenticating stream create requests.

HMAC (2):

Indicates that the key is an HMAC key and should be used to generate a signature for the stream create request with the auth-token SDK parameter.

class google.ads.admanager_v1.types.DaiEncodingProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A DaiEncodingProfile contains data about a publisher’s encoding profiles. Ad Manager Dynamic Ad Insertion (DAI) uses the profile information about the content to select an appropriate ad transcode to play for the particular video.

name

Identifier. The resource name of the DaiEncodingProfile. Format: networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}

Type

str

display_name

Required. The name of the DaiEncodingProfile. It may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: “, ‘, =, !, +, #, , ~, ;, ^, (, ), <, >, [, ], the white space character.

This field is a member of oneof _display_name.

Type

str

status

Output only. The status of this DaiEncodingProfile.

DAI encoding profiles are created in the [DaiEncodingProfileStatus.ACTIVE][] state by default.

Only active profiles will be allowed to be associated with live streams.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.DaiEncodingProfileStatusEnum.DaiEncodingProfileStatus

variant_type

Required. The variant playlist type that this DaiEncodingProfile represents.

This field is a member of oneof _variant_type.

Type

google.ads.admanager_v1.types.DaiEncodingProfileVariantTypeEnum.DaiEncodingProfileVariantType

container_type

Required. The digital container type of the underlying media. This is required for MEDIA and IFRAME variant types.

This field is a member of oneof _container_type.

Type

google.ads.admanager_v1.types.ContainerTypeEnum.ContainerType

video_settings

Optional. Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type.

Type

google.ads.admanager_v1.types.VideoSettings

audio_settings

Optional. Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio.

Type

google.ads.admanager_v1.types.AudioSettings

class google.ads.admanager_v1.types.DaiEncodingProfileStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [DaiEncodingProfileStatus][google.ads.admanager.v1.DaiEncodingProfileStatusEnum.DaiEncodingProfileStatus]

class DaiEncodingProfileStatus(value)

Bases: proto.enums.Enum

The status of the DaiEncodingProfile.

Values:

DAI_ENCODING_PROFILE_STATUS_UNSPECIFIED (0):

Not specified value.

ACTIVE (1):

Indicates the DaiEncodingProfile has been created and is eligible for streaming.

ARCHIVED (2):

Indicates the DaiEncodingProfile has been archived.

class google.ads.admanager_v1.types.DaiEncodingProfileVariantTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [DaiEncodingProfileVariantType][google.ads.admanager.v1.DaiEncodingProfileVariantTypeEnum.DaiEncodingProfileVariantType]

class DaiEncodingProfileVariantType(value)

Bases: proto.enums.Enum

The variant type of the DaiEncodingProfile.

Values:

DAI_ENCODING_PROFILE_VARIANT_TYPE_UNSPECIFIED (0):

Not specified value.

MEDIA (1):

Media variant playlist type. Media playlists may: contain audio only video only, or audio and video.

IFRAME (2):

iFrame variant playlist type. iFrame playlists may: contain video or contain audio and video (i.e. video must be present).

SUBTITLES (3):

Subtitles variant playlist type.

class google.ads.admanager_v1.types.DaiIngestError(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents an error associated with a Dynamic Ad Insertion (DAI) Content’s status.

reason

The error associated with the content.

This field is a member of oneof _reason.

Type

google.ads.admanager_v1.types.DaiIngestErrorReasonEnum.DaiIngestErrorReason

trigger

Output only. The field, if any, that triggered the error.

This field is a member of oneof _trigger.

Type

str

class google.ads.admanager_v1.types.DaiIngestErrorReasonEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [DaiIngestErrorReason][google.ads.admanager.v1.DaiIngestErrorReasonEnum.DaiIngestErrorReason]

class DaiIngestErrorReason(value)

Bases: proto.enums.Enum

Represents an error associated with a Dynamic Ad Insertion (DAI) [Content’s][google.ads.admanager.v1.Content] status.

Values:

DAI_INGEST_ERROR_REASON_UNSPECIFIED (0):

Default value. This value is unused.

INVALID_INGEST_URL (1):

The ingest URL provided in the publisher’s Content source feed is invalid. The trigger for this error is the ingest URL specified in the publisher’s feed.

INVALID_CLOSED_CAPTION_URL (2):

The closed caption URL provided in the publisher’s Content source feed is invalid.

MISSING_CLOSED_CAPTION_URL (3):

There is no closed caption URL for a Content in the publisher’s Content source feed. There is no trigger for this error.

COULD_NOT_FETCH_HLS (4):

There was an error while trying to fetch the HLS from the specified ingest URL. The trigger for this error is the ingest URL specified in the publisher’s feed.

COULD_NOT_FETCH_SUBTITLES (5):

There was an error while trying to fetch the subtitles from the specified closed caption url. The trigger for this error is the closed caption URL specified in the publisher’s feed.

MISSING_SUBTITLE_LANGUAGE (6):

One of the subtitles from the closed caption URL is missing a language. The trigger for this error is the closed caption URL that does not have a language associated with it.

COULD_NOT_FETCH_MEDIA (7):

Error fetching the media files from the URLs specified in the master HLS playlist. The trigger for this error is a media playlist URL within the publisher’s HLS playlist that could not be fetched.

MALFORMED_MEDIA_BYTES (8):

The media from the publisher’s CDN is malformed and cannot be conditioned. The trigger for this error is a media playlist URL within the publisher’s HLS playlist that is malformed.

CHAPTER_TIME_OUT_OF_BOUNDS (9):

A chapter time for the Content is outside of the range of the Content’s duration. The trigger for this error is the chapter time (a parsable long representing the time in ms) that is out of bounds.

INTERNAL_ERROR (10):

An internal error occurred. There is no trigger for this error.

CONTENT_HAS_CHAPTER_TIMES_BUT_NO_MIDROLL_SETTINGS (11):

The Content has chapter times but the Content’s source has no CDN settings for midrolls. There is no trigger for this error.

MALFORMED_MEDIA_PLAYLIST (12):

There is bad/missing/malformed data in a media playlist. The trigger for this error is the URL that points to the malformed media playlist.

MIXED_AD_BREAK_TAGS (13):

Multiple ways of denoting ad breaks were detected in a media playlist (e.g. placement opportunity tags, cue markers, etc.)

AD_BREAK_TAGS_INCONSISTENT_ACROSS_VARIANTS (14):

The ad break tags in the preconditioned Content are not in the same locations across all variant playlists.

MALFORMED_SUBTITLES (15):

There is bad/missing/malformed data in a subtitles file. The trigger for this error is the URL that points to the malformed subtitles.

SUBTITLES_TOO_LARGE (16):

The subtitles sent to DAI are too large. The trigger for this error is the URL that points to the master playlist.

PLAYLIST_ITEM_URL_DOES_NOT_MATCH_INGEST_COMMON_PATH (17):

A playlist item has a URL that does not begin with the ingest common path provided in the DAI settings. The trigger for this error is the playlist item URL.

COULD_NOT_UPLOAD_SPLIT_MEDIA_AUTHENTICATION_FAILED (18):

Uploading split media segments failed due to an authentication error.

COULD_NOT_UPLOAD_SPLIT_MEDIA_CONNECTION_FAILED (19):

Uploading spit media segments failed due to a connection error.

COULD_NOT_UPLOAD_SPLIT_MEDIA_WRITE_FAILED (20):

Uploading split media segments failed due to a write error.

PLAYLISTS_HAVE_DIFFERENT_NUMBER_OF_DISCONTINUITIES (21):

Variants in a playlist do not have the same number of discontinuities. The trigger for this error is the master playlist URI.

PLAYLIST_HAS_NO_STARTING_PTS_VALUE (22):

The playlist does not have a starting PTS value. The trigger for this error is the master playlist URI.

PLAYLIST_DISCONTINUITY_PTS_VALUES_DIFFER_TOO_MUCH (23):

The PTS at a discontinuity varies too much between the different variants. The trigger for this error is the master playlist URI.

SEGMENT_HAS_NO_PTS (24):

A media segment has no PTS. The trigger for this error is the segment data URI.

SUBTITLE_LANGUAGE_DOES_NOT_MATCH_LANGUAGE_IN_FEED (25):

The language in the subtitles file does not match the language specified in the feed. The trigger for this error is the feed language and the parsed language separated by a semi-colon, e.g. “en;sp”.

CANNOT_DETERMINE_CORRECT_SUBTITLES_FOR_LANGUAGE (26):

There are multiple subtitles files at the closed caption URI, and none of them match the language defined in the feed.

NO_CDN_CONFIG_FOUND (27):

No CDN configuration found for the Content. The trigger for this error is the Content’s master playlist URI.

CONTENT_HAS_MIDROLLS_BUT_NO_SPLIT_CONTENT_CONFIG (28):

The Content has midrolls but there was no split Content config on the CDN configuration for that Content so the Content was not conditioned. There is no trigger for this error.

CONTENT_HAS_MIDROLLS_BUT_SOURCE_HAS_MIDROLLS_DISABLED (29):

The Content has midrolls but the source the Content was ingested from has mid-rolls disabled, so the Content was not conditioned. There is no trigger for this error.

ADTS_PARSE_ERROR (30):

Error parsing ADTS while splitting the Content. The trigger for this error is the variant URL and the cue-point separated by a semi-colon, e.g. “www.variant2.com;5000”.

AAC_SPLIT_ERROR (31):

Error splitting an AAC segment. The trigger for this error is the variant URL and the cue-point separated by a semi-colon, e.g. “www.variant2.com;5000”.

AAC_PARSE_ERROR (32):

Error parsing an AAC file while splitting the Content. The trigger for this error is the variant URL and the cue-point separated by a semi-colon, e.g. “www.variant2.com;5000”.

TS_PARSE_ERROR (33):

Error parsing a TS file while splitting the Content. The trigger for this error is the variant URL and the cue-point separated by a semi-colon, e.g. “www.variant2.com;5000”.

TS_SPLIT_ERROR (34):

Error splitting a TS file while splitting the Content. The trigger for this error is the variant URL and the cue-point separated by a semi-colon, e.g. “www.variant2.com;5000”.

UNSUPPORTED_CONTAINER_FORMAT (35):

Encountered an unsupported container format while splitting the Content. The trigger for this error is the variant URL and the cue-point separated by a semi-colon, e.g. “www.variant2.com;5000”.

MULTIPLE_ELEMENTARY_STREAMS_OF_SAME_MEDIA_TYPE_IN_TS (36):

Encountered multiple elementary streams of the same media type (audio, video) within a transport stream. The trigger for this error is the variant URL and the cue-point separated by a semi-colon, e.g. “www.variant2.com;5000”.

UNSUPPORTED_TS_MEDIA_FORMAT (37):

Encountered an unsupported TS media format while splitting the Content. The trigger for this error is the variant URL and the cue-point separated by a semi-colon, e.g. “www.variant2.com;5000”.

NO_IFRAMES_NEAR_CUE_POINT (38):

Error splitting because there were no i-frames near the target split point. The trigger for this error is the variant URL and the cue-point separated by a semi-colon, e.g. “www.variant2.com;5000”.

AC3_SPLIT_ERROR (39):

Error splitting an AC-3 segment. The trigger for this error is the variant URL and the cue-point separated by a semi-colon, e.g. “www.variant2.com;5000”.

AC3_PARSE_ERROR (40):

Error parsing an AC-3 file while splitting the Content. The trigger for this error is the variant URL and the cue-point separated by a semi-colon, e.g. “www.variant2.com;5000”.

EAC3_SPLIT_ERROR (41):

Error splitting an E-AC-3 segment. The trigger for this error is the variant URL and the cue-point separated by a semi-colon, e.g. “www.variant2.com;5000”.

INVALID_ENCRYPTION_KEY (42):

Error caused by an invalid encryption key. The trigger for this error is a media playlist URL within the publisher’s HLS playlist that has the invalid encryption key.

EAC3_PARSE_ERROR (43):

Error parsing an E-AC-3 file while splitting the Content. The trigger for this error is the variant URL and the cue-point separated by a semi-colon, e.g. “www.variant2.com;5000”.

CUE_POINT_COUNT_DOES_NOT_MATCH_PTS_COUNT (44):

Error caused by the number of PTS being a different value than the number of cue points + 1.

DISCONTINUITY_COUNT_DOES_NOT_MATCH_PTS_COUNT (45):

Error caused by the number of PTS being a different value than the number of discontinuity tags + 1.

DASH_CUE_POINT_EVENT_MISMATCH (46):

The DASH Content has cue points but they do not match the Event durations from the DASH manifest EventStream, if present.

DASH_MANIFEST_CONDITIONING_FAILED (47):

The DASH manifest cannot be conditioned for midrolls.

DASH_MANIFEST_CONDITIONING_SEGMENT_BOUNDARY_ERROR (48):

The DASH manifest cannot be conditioned for midrolls because one or more of the cue points do not lie on a media segment boundary.

CLOSED_CAPTION_LANGUAGE_VALUE_INVALID (49):

The subtitle language code should not contain “$$$$$”.

CLOSED_CAPTION_NAME_VALUE_INVALID (50):

The subtitle name should not contain “$$$$$”.

CLOSED_CAPTION_CHARACTERISTICS_VALUE_UNEXPECTED (51):

The common subtitle characteristics values listed in the HLS spec are: 1)”public.accessibility.transcribes-spoken-dialog”, 2)”public.accessibility.describes-music-and-sound”, 3)”public.easy-to-read”;

CLOSED_CAPTIONS_WITH_DUPLICATE_KEYS (52):

Closed captions for a Content should be unique by ‘language + name’.

SUBTITLES_PRESENT_IN_FEED_AND_MANIFEST (53):

Subtitles are defined in the Content source feed as well as inside the stream manifest. Only feed subtitles will be ingested.

INVALID_MEDIA_PROFILE (54):

The media profile is invalid due to missing data.

CHAPTER_PTS_MISMATCH (55):

Error caused when the PTS values do not align across chapters.

CHAPTER_RENDITION_ERROR (56):

Error occurred while chaptering renditions in the Content.

INVALID_TRANSCODING_REQUEST (57):

Error during notification processing: invalid transcoding request.

TRANSCODE_FAILED (58):

Error during notification processing: transcode failed.

PLAYLIST_GENERATION_FAILED (59):

Error during playlist generation.

COULD_NOT_FETCH_DASH (60):

Error during DASH ingest: could not fetch DASH manifest.

MALFORMED_DASH (61):

Error during DASH ingest: malformed DASH manifest.

DASH_CONDITIONING_NOT_SUPPORTED (62):

Error during DASH ingest: DASH conditioning not supported.

class google.ads.admanager_v1.types.DaiIngestStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [DaiIngestStatus][google.ads.admanager.v1.DaiIngestStatusEnum.DaiIngestStatus]

class DaiIngestStatus(value)

Bases: proto.enums.Enum

The status of the Dynamic Ad Insertion (DAI) ingestion process. Only [Content][google.ads.admanager.v1.Content] with a status of SUCCESS will be available for DAI.

Values:

DAI_INGEST_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

SUCCESS (1):

The Content was successfully ingested for DAI.

WARNING (2):

There was a non-fatal issue during the DAI ingestion process.

INGESTED (3):

The preconditioned Content was successfully ingested for DAI.

INGESTED_WITH_WARNINGS (4):

There was a non-fatal issue during the DAI ingestion process on preconditioned Content.

CONDITIONED (5):

The unconditioned Content was successfully conditioned for DAI.

CONDITIONED_WITH_WARNINGS (6):

There was a non-fatal issue during the DAI conditioning process on originally unconditioned Content.

FAILURE (7):

There was a non-fatal issue during the DAI ingestion process and the Content is not available for dynamic ad insertion.

class google.ads.admanager_v1.types.DashBridge(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A DashBridge is used to decide when to apply DASH Bridge single-period to multi-period MPD conditioning. This should always be enabled when the DASH manifest type is single-period.

enabled

Optional. Specifies whether to apply DASH Bridge single-period to multi-period MPD conditioning.

This field is a member of oneof _enabled.

Type

bool

class google.ads.admanager_v1.types.DataSegmentTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Data Segment Targeting

has_data_segment_targeting

Output only. Whether any data segments are currently targeted.

Type

bool

class google.ads.admanager_v1.types.DeactivateCustomTargetingValueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message to deactivate a CustomTargetingValue.

name

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

Type

str

class google.ads.admanager_v1.types.DeactivateTargetingPresetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for DeactivateTargetingPreset method.

name

Required. Resource name for the TargetingPreset. Format: networks/{network_code}/targetingPreset/{targeting_preset_id}

Type

str

targeting_preset_id

Required. TargetingPreset ID to deactivate.

Type

int

class google.ads.admanager_v1.types.DealBuyerPermissionTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [DealBuyerPermissionType][google.ads.admanager.v1.DealBuyerPermissionTypeEnum.DealBuyerPermissionType].

class DealBuyerPermissionType(value)

Bases: proto.enums.Enum

Defines how a deal would transact among all buyers under the same bidder.

Values:

DEAL_BUYER_PERMISSION_TYPE_UNSPECIFIED (0):

No value specified.

NEGOTIATOR_ONLY (1):

The deal only transacts with the buyer specified.

BIDDER (2):

The deal transacts with all buyers under the same bidder.

class google.ads.admanager_v1.types.DealPriorityTierEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [DealPriorityTier][google.ads.admanager.v1.DealPriorityTierEnum.DealPriorityTier].

class DealPriorityTier(value)

Bases: proto.enums.Enum

Priority tier of non guaranteed deal products.

Values:

DEAL_PRIORITY_TIER_UNSPECIFIED (0):

No value specified.

TIER1 (1):

Tier 1

TIER2 (2):

Tier 2

TIER3 (3):

Tier 3

TIER4 (4):

Tier 4

TIER5 (5):

Tier 5

TIER6 (6):

Tier 6

TIER7 (7):

Tier 7

TIER8 (8):

Tier 8

TIER9 (9):

Tier 9

OPTIMIZED (1000):

Open Auction optimized tier

class google.ads.admanager_v1.types.DelegationAccountStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper for [DelegationAccountStatus][google.ads.admanager.v1.DelegationAccountStatusEnum.DelegationAccountStatus]

class DelegationAccountStatus(value)

Bases: proto.enums.Enum

Status of the MCM child publisher’s Ad Manager account with respect to delegated serving. In order for the child network to be served ads for MCM, it must have accepted the invite from the parent network, and must have passed Google’s policy compliance verifications.

Values:

DELEGATION_ACCOUNT_STATUS_UNSPECIFIED (0):

No value specified

INVITED (1):

Indicates the child publisher has not acted on the invite from the parent.

DECLINED (2):

Indicates the child publisher has declined the invite.

APPROVED (3):

Indicates the child publisher accepted the invite, and Google found it to be compliant with its policies, i.e. no policy violations were found, and the child publisher can be served ads.

CLOSED_BY_PUBLISHER (4):

Indicates the child publisher has closed their own account.

CLOSED_INVALID_ACTIVITY (5):

Indicates the child publisher accepted the invite, but was disapproved by Google for invalid activity.

CLOSED_POLICY_VIOLATION (6):

Indicates the child publisher accepted the invite, but was disapproved by Google for violating its policies.

DEACTIVATED_BY_AD_MANAGER (7):

Indicates the child publisher accepted the invite, but was disapproved by a Googler.

DISAPPROVED_DUPLICATE_ACCOUNT (8):

Indicates the child publisher accepted the invite, but was disapproved by Google for being a duplicate of another account.

DISAPPROVED_INELIGIBLE (9):

Indicates the child publisher accepted the invite, but was disapproved as ineligible by Google.

PENDING_GOOGLE_APPROVAL (10):

Indicates the child publisher has accepted the invite, and is awaiting Google’s policy compliance verifications.

EXPIRED (11):

Indicates the invite was sent to the child publisher more than 90 days ago, due to which it has been deactivated.

INACTIVE (12):

Indicates either the child publisher disconnected from the parent network, or the parent network withdrew the invite.

class google.ads.admanager_v1.types.DelegationApprovalStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper for [DelegationApprovalStatus][google.ads.admanager.v1.DelegationApprovalStatusEnum.DelegationApprovalStatus]

class DelegationApprovalStatus(value)

Bases: proto.enums.Enum

Status of the MCM child publisher’s Ad Manager network with respect to delegated serving. It is only valid when the invitation is accepted by the child network. If the child has not yet accepted the parent’s invite, this will be null.

Values:

DELEGATION_APPROVAL_STATUS_UNSPECIFIED (0):

No value specified

APPROVED (1):

Indicates the child publisher accepted the invite, and Google found it to be compliant with its policies, i.e. no policy violations were found, and the child publisher can be served ads.

CLOSED_BY_PUBLISHER (2):

Indicates the child publisher has closed their own account.

CLOSED_INVALID_ACTIVITY (3):

Indicates the child publisher accepted the invite, but was disapproved by Google for invalid activity.

CLOSED_POLICY_VIOLATION (4):

Indicates the child publisher accepted the invite, but was disapproved by Google for violating its policies.

DEACTIVATED_BY_AD_MANAGER (5):

Indicates the child publisher accepted the invite, but was disapproved by a Googler.

DISAPPROVED_DUPLICATE_ACCOUNT (6):

Indicates the child publisher accepted the invite, but was disapproved by Google for being a duplicate of another account.

DISAPPROVED_INELIGIBLE (7):

Indicates the child publisher accepted the invite, but was disapproved as ineligible by Google.

PENDING_GOOGLE_APPROVAL (8):

Indicates the child publisher has accepted the invite, and is awaiting Google’s policy compliance verifications.

class google.ads.admanager_v1.types.DelegationInvitationStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper for [DelegationInvitationStatus][google.ads.admanager.v1.DelegationInvitationStatusEnum.DelegationInvitationStatus]

class DelegationInvitationStatus(value)

Bases: proto.enums.Enum

Status of the association between networks. When a parent network requests access, it is marked as pending. Once the child network accepts the agreement, it is marked as accepted.

Values:

DELEGATION_INVITATION_STATUS_UNSPECIFIED (0):

No value specified

ACCEPTED (1):

Indicates the association request from the parent network is accepted by the child network.

EXPIRED (2):

Indicates the invite was sent to the child publisher more than 90 days ago, due to which it has been deactivated.

PENDING (3):

Indicates the child publisher has not acted on the invite from the parent.

REJECTED (4):

Indicates the child publisher has declined the invite.

WITHDRAWN (5):

Indicates the parent network withdrew the invite.

DEACTIVATED_BY_AD_MANAGER (6):

Indicates the invitation was disapproved by Google.

class google.ads.admanager_v1.types.DelegationTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper for [DelegationType][google.ads.admanager.v1.DelegationTypeEnum.DelegationType]

class DelegationType(value)

Bases: proto.enums.Enum

The delegation type of the MCM child publisher.

Values:

DELEGATION_TYPE_UNSPECIFIED (0):

No value specified

MANAGE_ACCOUNT (1):

Indicates the parent network gets complete access to the child network’s account.

MANAGE_INVENTORY (2):

Indicates a subset of the ad requests from the child are delegated to the parent, determined by the tag on the child network’s web pages. The parent network does not have access to the child network, as a subset of the inventory could be owned and operated by the child network.

class google.ads.admanager_v1.types.DeleteAdBreakRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for DeleteAdBreak method.

name

Required. The name of the ad break to delete.

Format: networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}

Type

str

class google.ads.admanager_v1.types.DeliveryIndicator(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Indicates the delivery performance of the LineItem.

expected_delivery_percentage

Output only. The expected delivery percentage of the LineItem.

This field is a member of oneof _expected_delivery_percentage.

Type

float

actual_delivery_percentage

Output only. The actual delivery percentage of the LineItem.

This field is a member of oneof _actual_delivery_percentage.

Type

float

class google.ads.admanager_v1.types.DeviceCapability(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a device capability.

name

Identifier. The resource name of the DeviceCapability. Format: networks/{network_code}/deviceCapabilities/{device_capability_id}

Type

str

display_name

Output only. The localized name of the device capability.

This field is a member of oneof _display_name.

Type

str

class google.ads.admanager_v1.types.DeviceCapabilityTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Device Capability Targeting.

Can be used to target/exclude users using mobile apps, ad requests resulting from apps built on the MRAID standard, or users on devices that are able to make phone calls versus devices that aren’t able to make phone calls, such as tablets.

targeted_capabilities

Optional. A list of device capability resource names that should be targeted/included.

Type

MutableSequence[str]

excluded_capabilities

Optional. A list of device capability resource names that should be excluded.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.DeviceCategory(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the category of a device. For example, “smartphone” or “desktop”.

name

Identifier. The resource name of the DeviceCategory. Format: networks/{network_code}/deviceCategories/{device_category}

Type

str

display_name

Output only. The display name of the device category.

This field is a member of oneof _display_name.

Type

str

class google.ads.admanager_v1.types.DeviceCategoryTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a list of targeted and excluded device categories.

targeted_categories

Optional. A list of device category resource names that should be targeted/included.

Type

MutableSequence[str]

excluded_categories

Optional. A list of device category resource names that should be excluded.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.DeviceManufacturer(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a device manufacturer.

name

Identifier. The resource name of the DeviceManufacturer. Format: networks/{network_code}/deviceManufacturers/{device_manufacturer}

Type

str

display_name

Output only. The localized name of the device manufacturer.

This field is a member of oneof _display_name.

Type

str

class google.ads.admanager_v1.types.DeviceManufacturerTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Device Manufacturer Targeting.

Can be used to target/exclude users on devices made by specific brands or companies, such as Apple, Google, Samsung and others. For more information, see https://support.google.com/admanager/answer/2884033 (“Targeting types > Device manufacturer”).

targeted_device_manufacturers

Optional. A list of device manufacturer resource names that should be targeted/included.

Type

MutableSequence[str]

excluded_device_manufacturers

Optional. A list of device manufacturer resource names that should be excluded.

Type

MutableSequence[str]

targeted_mobile_devices

Optional. A list of mobile device resource names that should be targeted/included.

Type

MutableSequence[str]

excluded_mobile_devices

Optional. A list of mobile device resource names that should be excluded.

Type

MutableSequence[str]

targeted_mobile_device_submodels

Optional. A list of mobile device submodel resource names that should be targeted/included.

Type

MutableSequence[str]

excluded_mobile_device_submodels

Optional. A list of mobile device submodel resource names that should be excluded.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.DisapprovalReason(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the reason for which Google disapproved the Site.

type_

Output only. The type of policy violation found for the Site.

This field is a member of oneof _type.

Type

google.ads.admanager_v1.types.SiteDisapprovalReasonEnum.SiteDisapprovalReason

details

Output only. Additional details for the disapproval of the Site.

This field is a member of oneof _details.

Type

str

class google.ads.admanager_v1.types.DiscountTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [DiscountType][google.ads.admanager.v1.DiscountTypeEnum.DiscountType].

class DiscountType(value)

Bases: proto.enums.Enum

Describes the possible discount types on the cost of booking a line item.

Values:

DISCOUNT_TYPE_UNSPECIFIED (0):

No value specified

ABSOLUTE_VALUE (1):

An absolute value will be discounted from the line item’s cost.

PERCENTAGE (2):

A percentage of the cost will be discounted for booking the line item.

class google.ads.admanager_v1.types.DynamicAdInsertionTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [DynamicAdInsertionType][google.ads.admanager.v1.DynamicAdInsertionTypeEnum.DynamicAdInsertionType]

class DynamicAdInsertionType(value)

Bases: proto.enums.Enum

Describes how the live stream will have ads dynamically inserted into playlists.

Values:

DYNAMIC_AD_INSERTION_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

LINEAR (1):

Content manifest is served by Google DAI. Content and ads are stitched together into a unique video manifest per user.

POD_SERVING_MANIFEST (2):

Ads manifest is served by Google DAI, containing unique ad pod segments for the video player to switch to from the content stream, or for the partner to stitch directly into the user content manifest.

POD_SERVING_REDIRECT (3):

Content manifest is served by the partner, embedding Google DAI ad segment URLs which redirect to unique Google DAI ad segments per user.

class google.ads.admanager_v1.types.EarningsProductBreakdown(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The product type breakdown of earnings for a given month between a parent and child publisher in MCM.

product_type

The syndication product type of the child’s earnings in MCM.

This field is a member of oneof _product_type.

Type

google.ads.admanager_v1.types.McmEarningsProductTypeEnum.McmEarningsProductType

total_earnings

The total earnings for the specified product type for the month.

This field is a member of oneof _total_earnings.

Type

google.type.money_pb2.Money

parent_payment

The portion of the total earnings for the specified product type paid to the parent publisher.

This field is a member of oneof _parent_payment.

Type

google.type.money_pb2.Money

child_payment

The portion of the total earnings for the specified product type paid to the child publisher.

This field is a member of oneof _child_payment.

Type

google.type.money_pb2.Money

deductions

The deductions for the specified product type for the month due to spam.

This field is a member of oneof _deductions.

Type

google.type.money_pb2.Money

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

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. Deprecated: EntitySignalsMapping ID.

This field is a member of oneof _entity_signals_mapping_id.

Type

int

taxonomy_category_ids

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

Bases: proto.message.Message

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

class EnvironmentType(value)

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.ExchangeSyndicationProductEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ExchangeSyndicationProduct][google.ads.admanager.v1.ExchangeSyndicationProductEnum.ExchangeSyndicationProduct]

class ExchangeSyndicationProduct(value)

Bases: proto.enums.Enum

Ad Exchange syndication product.

Values:

EXCHANGE_SYNDICATION_PRODUCT_UNSPECIFIED (0):

No value specified

DISPLAY (1):

Property serves in-browser.

MOBILE_APP (2):

Property serves on mobile applications (includes JS and SDK).

VIDEO_AND_AUDIO (3):

Property serves video (includes audio).

GAMES (4):

Property serves for games.

class google.ads.admanager_v1.types.ExclusionScopeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ExclusionScope][google.ads.admanager.v1.ExclusionScopeEnum.ExclusionScope].

class ExclusionScope(value)

Bases: proto.enums.Enum

The scope to which the exclusion label applies.

Values:

EXCLUSION_SCOPE_UNSPECIFIED (0):

No value specified.

PAGE (1):

The exclusion label applies to the entire page.

STREAM (2):

The exclusion label applies to the entire stream of content.

POD (3):

The exclusion label applies to the entire pod (or group).

class google.ads.admanager_v1.types.FetchMcmEarningsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for FetchMcmEarnings method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to FetchMcmEarnings 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

month

Required. The month to fetch earnings for. The date will be specified as the first of the month.

Type

google.type.date_pb2.Date

class google.ads.admanager_v1.types.FetchMcmEarningsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for FetchMcmEarningsRequest containing matching McmEarnings objects.

mcm_earnings

The McmEarnings objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.McmEarnings]

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 McmEarnings objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.FetchReportResultRowsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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 greater than 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)

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.ReportDataTable.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.ReportDefinition.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.ReportDefinition.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.FirstPartyMobileApplicationTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

First-party mobile application targeting.

targeted_applications

Optional. The resource names of the first-party applications that should be targeted.

Type

MutableSequence[str]

excluded_applications

Optional. The resource names of the first-party applications that should be excluded.

Type

MutableSequence[str]

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

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.GeoTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a location in the world, for targeting.

name

Identifier. The resource name of the GeoTarget. Format: networks/{network_code}/geoTargets/{geo_target_id}

Type

str

display_name

Output only. The display name of the GeoTarget.

This field is a member of oneof _display_name.

Type

str

canonical_parent

Output only. The name of the direct parent that defines the canonical name of the geo target. For example, if the current geo target is “San Francisco”, its canonical name would be “San Francisco, California, United States” thus the canonical_parent would be the name of California and the canonical_parent of California would be the name of United states Format: networks/{network_code}/geoTargets/{geo_target}

This field is a member of oneof _canonical_parent.

Type

str

parent_names

Output only. All parents of the geo target ordered by ascending size.

Type

MutableSequence[str]

region_code

Output only. The Unicode CLDR region code of the geo target.

This field is a member of oneof _region_code.

Type

str

type_

Output only. The location type (unlocalized) for this geographical entity.

This field is a member of oneof _type.

Type

str

targetable

Output only. Whether the geo target is targetable.

This field is a member of oneof _targetable.

Type

bool

class google.ads.admanager_v1.types.GeoTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a list of targeted and excluded geos.

targeted_geos

Optional. A list of geo resource names that should be targeted/included.

Type

MutableSequence[str]

excluded_geos

Optional. A list of geo resource names that should be excluded.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.GetAdBreakRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetAdBreak method.

name

Required. The resource name of the AdBreak using the asset key or custom asset key.

Format: networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break_id} networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}/adBreaks/{ad_break_id}

Type

str

class google.ads.admanager_v1.types.GetAdRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetAdRule method.

name

Required. The resource name of the AdRule. Format: networks/{network_code}/adRules/{ad_rule_id}

Type

str

class google.ads.admanager_v1.types.GetAdSpotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetAdSpot method.

name

Required. The resource name of the AdSpot. Format: networks/{network_code}/adSpots/{ad_spot_id}

Type

str

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

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.GetApplicationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetApplication method.

name

Required. The resource name of the Application. Format: networks/{network_code}/applications/{application_id}

Type

str

class google.ads.admanager_v1.types.GetAudienceSegmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetAudienceSegment method.

name

Required. The resource name of the AudienceSegment. Format: networks/{network_code}/audienceSegments/{audience_segment_id}

Type

str

class google.ads.admanager_v1.types.GetBandwidthGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetBandwidthGroup method.

name

Required. The resource name of the BandwidthGroup. Format: networks/{network_code}/bandwidthGroups/{bandwidth_group_id}

Type

str

class google.ads.admanager_v1.types.GetBrowserLanguageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetBrowserLanguage method.

name

Required. The resource name of the BrowserLanguage. Format: networks/{network_code}/browserLanguages/{browser_language_id}

Type

str

class google.ads.admanager_v1.types.GetBrowserRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetBrowser method.

name

Required. The resource name of the Browser. Format: networks/{network_code}/browsers/{browser_id}

Type

str

class google.ads.admanager_v1.types.GetCdnConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetCdnConfig method.

name

Required. The resource name of the CdnConfig. Format: networks/{network_code}/cdnConfigs/{cdn_config_id}

Type

str

class google.ads.admanager_v1.types.GetChildPublisherRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [GetChildPublisher][] method.

name

Required. The resource name of the [ChildPublisher][google.ads.admanager.v1.ChildPublisher]. Format: networks/{network_code}/childPublishers/{child_publisher_id}

Type

str

class google.ads.admanager_v1.types.GetCmsMetadataKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetCmsMetadataKey method.

name

Required. The resource name of the CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}

Type

str

class google.ads.admanager_v1.types.GetCmsMetadataValueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetCmsMetadataValue method.

name

Required. The resource name of the CmsMetadataValue. Format: networks/{network_code}/cmsMetadataValues/{cms_metadata_value_id}

Type

str

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

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.GetContactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetContact method.

name

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

Type

str

class google.ads.admanager_v1.types.GetContentBundleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetContentBundle method.

name

Required. The resource name of the ContentBundle. Format: networks/{network_code}/contentBundles/{content_bundle_id}

Type

str

class google.ads.admanager_v1.types.GetContentLabelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetContentLabel method.

name

Required. The resource name of the ContentLabel. Format: networks/{network_code}/contentLabels/{content_label_id}

Type

str

class google.ads.admanager_v1.types.GetContentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetContent method.

name

Required. The resource name of the Content. Format: networks/{network_code}/content/{content_id}

Type

str

class google.ads.admanager_v1.types.GetCreativeSetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetCreativeSet method.

name

Required. The resource name of the CreativeSet. Format: networks/{network_code}/creativeSets/{creative_set_id}

Type

str

class google.ads.admanager_v1.types.GetCreativeTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetCreativeTemplate method.

name

Required. The resource name of the CreativeTemplate. Format: networks/{network_code}/creativeTemplates/{creative_template_id}

Type

str

class google.ads.admanager_v1.types.GetCreativeWrapperRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetCreativeWrapper method.

name

Required. The resource name of the CreativeWrapper. Format: networks/{network_code}/creativeWrappers/{creative_wrapper_id}

Type

str

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

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)

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)

Bases: proto.message.Message

Request object for GetCustomTargetingValue method.

name

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

Type

str

class google.ads.admanager_v1.types.GetDaiAuthenticationKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetDaiAuthenticationKey method.

name

Required. The resource name of the DaiAuthenticationKey. Format: networks/{network_code}/daiAuthenticationKeys/{dai_authentication_key_id}

Type

str

class google.ads.admanager_v1.types.GetDaiEncodingProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetDaiEncodingProfile method.

name

Required. The resource name of the DaiEncodingProfile. Format: networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}

Type

str

class google.ads.admanager_v1.types.GetDeviceCapabilityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetDeviceCapability method.

name

Required. The resource name of the DeviceCapability. Format: networks/{network_code}/deviceCapabilities/{device_capability_id}

Type

str

class google.ads.admanager_v1.types.GetDeviceCategoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetDeviceCategory method.

name

Required. The resource name of the DeviceCategory. Format: networks/{network_code}/deviceCategories/{device_category_id}

Type

str

class google.ads.admanager_v1.types.GetDeviceManufacturerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetDeviceManufacturer method.

name

Required. The resource name of the DeviceManufacturer. Format: networks/{network_code}/deviceManufacturers/{device_manufacturer_id}

Type

str

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

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.GetGeoTargetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetGeoTarget method.

name

Required. The resource name of the GeoTarget. Format: networks/{network_code}/geoTargets/{geo_target_id}

Type

str

class google.ads.admanager_v1.types.GetLabelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetLabel method.

name

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

Type

str

class google.ads.admanager_v1.types.GetLineItemRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetLineItem method.

name

Required. The resource name of the LineItem. Format: networks/{network_code}/lineItems/{line_item_id}

Type

str

class google.ads.admanager_v1.types.GetLinkedDeviceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetLinkedDevice method.

name

Required. The resource name of the LinkedDevice. Format: networks/{network_code}/linkedDevices/{linked_device_id}

Type

str

class google.ads.admanager_v1.types.GetLiveStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetLiveStream method.

name

Required. The resource name of the LiveStream. Format: networks/{network_code}/liveStreams/{live_stream_id}

Type

str

class google.ads.admanager_v1.types.GetMobileCarrierRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetMobileCarrier method.

name

Required. The resource name of the MobileCarrier. Format: networks/{network_code}/mobileCarriers/{mobile_carrier_id}

Type

str

class google.ads.admanager_v1.types.GetMobileDeviceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetMobileDevice method.

name

Required. The resource name of the MobileDevice. Format: networks/{network_code}/mobileDevices/{mobile_device_id}

Type

str

class google.ads.admanager_v1.types.GetMobileDeviceSubmodelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetMobileDeviceSubmodel method.

name

Required. The resource name of the MobileDeviceSubmodel. Format: networks/{network_code}/mobileDeviceSubmodels/{mobile_device_submodel_id}

Type

str

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

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.GetOperatingSystemRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetOperatingSystem method.

name

Required. The resource name of the OperatingSystem. Format: networks/{network_code}/operatingSystems/{operating_system_id}

Type

str

class google.ads.admanager_v1.types.GetOperatingSystemVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetOperatingSystemVersion method.

name

Required. The resource name of the OperatingSystemVersion. Format: networks/{network_code}/operatingSystemVersions/{operating_system_version_id}

Type

str

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

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.GetPartnerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [GetPartner][] method.

name

Required. The resource name of the [Partner][google.ads.admanager.v1.Partner]. Format: networks/{network_code}/partners/{partner_id}

Type

str

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

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.GetPrivateAuctionDealRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetPrivateAuctionDeal method.

name

Required. The resource name of the PrivateAuctionDeal. Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}

Type

str

class google.ads.admanager_v1.types.GetPrivateAuctionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetPrivateAuction method.

name

Required. The resource name of the PrivateAuction. Format: networks/{network_code}/privateAuctions/{private_auction_id}

Type

str

class google.ads.admanager_v1.types.GetProgrammaticBuyerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetProgrammaticBuyer method.

name

Required. The resource name of the ProgrammaticBuyer. Format: networks/{network_code}/programmaticBuyers/{buyer_account_id}

Type

str

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

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.GetRichMediaAdsCompanyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetRichMediaAdsCompany method.

name

Required. The resource name of the RichMediaAdsCompany. Format: networks/{network_code}/richMediaAdsCompanies/{rich_media_ads_company_id}

Type

str

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

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.GetSiteRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetSite method.

name

Required. The resource name of the Site. Format: networks/{network_code}/sites/{site_id}

Type

str

class google.ads.admanager_v1.types.GetSlateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for GetSlate method.

name

Required. The resource name of the Slate to retrieve. Format: networks/{network_code}/slates/{slate_id}

Type

str

class google.ads.admanager_v1.types.GetSuggestedAdUnitRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetSuggestedAdUnit method.

name

Required. The resource name of the SuggestedAdUnit. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

Type

str

class google.ads.admanager_v1.types.GetTargetingPresetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetTargetingPreset method.

name

Required. The resource name of the TargetingPreset. Format: networks/{network_code}/targetingPresets/{targeting_preset_id}

Type

str

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

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.GetTeamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetTeam method.

name

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

Type

str

class google.ads.admanager_v1.types.GetThirdPartyCompanyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for GetThirdPartyCompany method.

name

Required. The resource name of the ThirdPartyCompany. Format: networks/{network_code}/thirdPartyCompanies/{third_party_company_id}

Type

str

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

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.GetViewabilityProviderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [GetViewabilityProvider][] method.

name

Required. The resource name of the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]. Format: networks/{network_code}/viewabilityProviders/{viewability_provider}

Type

str

class google.ads.admanager_v1.types.Goal(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Defines the criteria a [LineItem][google.ads.admanager.v1.LineItem] needs to satisfy to meet its delivery goal.

goal_type

The type of the goal for the LineItem. It defines the period over which the goal should be reached.

This field is a member of oneof _goal_type.

Type

google.ads.admanager_v1.types.GoalTypeEnum.GoalType

unit_type

The type of the goal unit for the LineItem.

This field is a member of oneof _unit_type.

Type

google.ads.admanager_v1.types.UnitTypeEnum.UnitType

units

If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved. If the line item is of type [LineItemTypeEnum.LineItemType.SPONSORSHIP][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.SPONSORSHIP], it represents the percentage of available impressions reserved. If the line item is of type [LineItemTypeEnum.LineItemType.BULK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.BULK] or [LineItemTypeEnum.LineItemType.PRICE_PRIORITY][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.PRICE_PRIORITY], it represents the number of remaining impressions reserved. If the line item is of type [LineItemTypeEnum.LineItemType.NETWORK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.NETWORK] or [LineItemTypeEnum.LineItemType.HOUSE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.HOUSE], it represents the percentage of remaining impressions reserved. If this is an impression cap goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see [LineItem.impressions_cap][].

This field is a member of oneof _units.

Type

int

class google.ads.admanager_v1.types.GoalTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [GoalType][google.ads.admanager.v1.GoalTypeEnum.GoalType].

class GoalType(value)

Bases: proto.enums.Enum

Specifies the type of the goal for a LineItem.

Values:

GOAL_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

NONE (1):

No goal is specified for the number of ads delivered. The line item [type][google.ads.admanager.v1.LineItem.line_item_type] must be one of:

• [LineItemTypeEnum.LineItemType.PRICE_PRIORITY][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.PRICE_PRIORITY]

• [LineItemTypeEnum.LineItemType.AD_EXCHANGE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.AD_EXCHANGE]

• [LineItemTypeEnum.LineItemType.CLICK_TRACKING][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.CLICK_TRACKING]

LIFETIME (2):

There is a goal on the number of ads delivered for this line item during its entire lifetime. The line item [type][google.ads.admanager.v1.LineItem.line_item_type] must be one of:

• [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD]

• [LineItemTypeEnum.LineItemType.BULK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.BULK]

• [LineItemTypeEnum.LineItemType.PRICE_PRIORITY][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.PRICE_PRIORITY]

• [LineItemTypeEnum.LineItemType.ADSENSE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.ADSENSE]

• [LineItemTypeEnum.LineItemType.AD_EXCHANGE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.AD_EXCHANGE]

• [LineItemTypeEnum.LineItemType.ADMOB][]

• [LineItemTypeEnum.LineItemType.CLICK_TRACKING][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.CLICK_TRACKING]

DAILY (3):

There is a daily goal on the number of ads delivered for this line item. The line item [type][google.ads.admanager.v1.LineItem.line_item_type] must be one of:

• [LineItemTypeEnum.LineItemType.SPONSORSHIP][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.SPONSORSHIP]

• [LineItemTypeEnum.LineItemType.NETWORK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.NETWORK]

• [LineItemTypeEnum.LineItemType.PRICE_PRIORITY][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.PRICE_PRIORITY]

• [LineItemTypeEnum.LineItemType.HOUSE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.HOUSE]

• [LineItemTypeEnum.LineItemType.ADSENSE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.ADSENSE]

• [LineItemTypeEnum.LineItemType.AD_EXCHANGE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.AD_EXCHANGE]

• [LineItemTypeEnum.LineItemType.ADMOB][]

• [LineItemTypeEnum.LineItemType.BUMPER][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.BUMPER]

class google.ads.admanager_v1.types.GrpProviderEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [GrpProvider][google.ads.admanager.v1.GrpProviderEnum.GrpProvider]

class GrpProvider(value)

Bases: proto.enums.Enum

Represents available GRP providers that a line item will have its target demographic measured by.

Values:

GRP_PROVIDER_UNSPECIFIED (0):

Default value. This value is unused.

GOOGLE (1):

Google’s GRP provider.

NIELSEN (2):

Nielsen’s GRP provider.

class google.ads.admanager_v1.types.GrpSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

GrpSettings contains information for a line item that will have a target demographic when serving. This information will be used to set up tracking and enable reporting on the demographic information.

min_target_age

Optional. Specifies the minimum target age (in years) of the LineItem. This field is only applicable if [provider][google.ads.admanager.v1.GrpSettings.provider] is not null.

This field is a member of oneof _min_target_age.

Type

int

max_target_age

Optional. Specifies the maximum target age (in years) of the LineItem. This field is only applicable if [provider][google.ads.admanager.v1.GrpSettings.provider] is not null.

This field is a member of oneof _max_target_age.

Type

int

target_gender

Optional. Specifies the target gender of the LineItem. This field is only applicable if [provider][google.ads.admanager.v1.GrpSettings.provider] is not null.

This field is a member of oneof _target_gender.

Type

google.ads.admanager_v1.types.GrpTargetGenderEnum.GrpTargetGender

provider

Optional. Specifies the GRP provider of the LineItem.

This field is a member of oneof _provider.

Type

google.ads.admanager_v1.types.GrpProviderEnum.GrpProvider

in_target_ratio_estimate_milli_percent

Optional. Estimate for the in-target ratio given the line item’s audience targeting. This field is only applicable if [provider][google.ads.admanager.v1.GrpSettings.provider] is Nielsen, [LineItem.primary_goal.unit_type][] is in-target impressions, and [LineItemCostType] is in-target CPM. This field determines the in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is available. Represented as a milli percent, so 55.7% becomes 55700.

This field is a member of oneof _in_target_ratio_estimate_milli_percent.

Type

int

nielsen_ctv_pacing_type

Optional. Specifies which pacing computation to apply in pacing to impressions from connected devices.

This field is a member of oneof _nielsen_ctv_pacing_type.

Type

google.ads.admanager_v1.types.NielsenCtvPacingEnum.NielsenCtvPacing

pacing_device_categorization_type

Optional. Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.

This field is a member of oneof _pacing_device_categorization_type.

Type

google.ads.admanager_v1.types.PacingDeviceCategorizationEnum.PacingDeviceCategorization

apply_true_coview

Optional. Specifies whether to apply true coviewing in Nielsen Line Item auto pacing. This field can only be true if [nielsen_ctv_pacing_type][google.ads.admanager.v1.GrpSettings.nielsen_ctv_pacing_type] is not NONE.

This field is a member of oneof _apply_true_coview.

Type

bool

class google.ads.admanager_v1.types.GrpTargetGenderEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [GrpTargetGender][google.ads.admanager.v1.GrpTargetGenderEnum.GrpTargetGender]

class GrpTargetGender(value)

Bases: proto.enums.Enum

Represents the target gender for a GRP demographic targeted line item.

Values:

GRP_TARGET_GENDER_UNSPECIFIED (0):

Default value. This value is unused.

BOTH (1):

Indicates that the GRP target gender is both male and female.

FEMALE (2):

Indicates that the GRP target gender is Female.

MALE (3):

Indicates that the GRP target gender is Male.

class google.ads.admanager_v1.types.HlsMasterPlaylistRefreshTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [HlsMasterPlaylistRefreshType][google.ads.admanager.v1.HlsMasterPlaylistRefreshTypeEnum.HlsMasterPlaylistRefreshType]

class HlsMasterPlaylistRefreshType(value)

Bases: proto.enums.Enum

Enumerates the different ways an HLS master playlist on a live stream will can be refreshed.

Values:

HLS_MASTER_PLAYLIST_REFRESH_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

AUTOMATIC (1):

The master playlist will automatically be refreshed.

MANUAL (2):

The master playlist will only be refreshed when requested.

class google.ads.admanager_v1.types.HlsSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

LiveStream settings that are specific to the HTTP live streaming (HLS) protocol.

playlist_type

Immutable. Indicates the type of the playlist associated with this live stream. The playlist type is analogous to the EXT-X-PLAYLIST-TYPE HLS tag. Will default to [LIVE][google.ads.admanager.v1.HlsSettingsPlaylistTypeEnum.HlsSettingsPlaylistType.LIVE].

This field is a member of oneof _playlist_type.

Type

google.ads.admanager_v1.types.HlsSettingsPlaylistTypeEnum.HlsSettingsPlaylistType

master_playlist_settings

Optional. The settings for the master playlist. If it is not set will default to a MasterPlaylistSettings with a refresh type of [AUTOMATIC][google.ads.admanager.v1.HlsMasterPlaylistRefreshTypeEnum.HlsMasterPlaylistRefreshType.AUTOMATIC].

Type

google.ads.admanager_v1.types.MasterPlaylistSettings

class google.ads.admanager_v1.types.HlsSettingsPlaylistTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [HlsSettingsPlaylistType][google.ads.admanager.v1.HlsSettingsPlaylistTypeEnum.HlsSettingsPlaylistType]

class HlsSettingsPlaylistType(value)

Bases: proto.enums.Enum

Describes the type of the playlist associated with this live stream. This is analogous to the EXT-X-PLAYLIST-TYPE HLS tag. Use HlsSettingsPlaylistType.EVENT for streams with the value “#EXT-X-PLAYLIST-TYPE:EVENT” and use HlsSettingsPlaylistType.LIVE for streams without the tag.

Values:

HLS_SETTINGS_PLAYLIST_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

EVENT (1):

The playlist is an event, which means that media segments can only be added to the end of the playlist. This allows viewers to scrub back to the beginning of the playlist.

LIVE (2):

The playlist is a live stream and there are no restrictions on whether media segments can be removed from the beginning of the playlist.

class google.ads.admanager_v1.types.InventoryTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Targeted ad units and AU placements are applied with logical OR. Example:

(au:1 OR au:2 OR au_placement:5) AND (NOT (au:3))

targeted_ad_units

Optional. A list of ad units that should be targeted/included.

Type

MutableSequence[google.ads.admanager_v1.types.AdUnitTargeting]

excluded_ad_units

Optional. A list of ad units that should be excluded. Excluded AUs take precedence over targeted AUs. In fact an AU can be excluded only if one of its ancestors is targeted. Subsequently child AUs of an excluded AU can not be targeted (except through a Placement).

Type

MutableSequence[google.ads.admanager_v1.types.AdUnitTargeting]

targeted_placements

Optional. The resource names of the placements that should be targeted/included.

Type

MutableSequence[str]

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

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

display_name

Required. Display name of the Label. This attribute has a maximum length of 127 characters.

This field is a member of oneof _display_name.

Type

str

description

Optional. A description of the label. This attribute has a maximum length of 255 characters.

This field is a member of oneof _description.

Type

str

active

Output only. Specifies whether or not the label is active.

This field is a member of oneof _active.

Type

bool

types

Required. Unordered list. The types of the Label.

Type

MutableSequence[google.ads.admanager_v1.types.LabelTypeEnum.LabelType]

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

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}”.

This field is a member of oneof _label.

Type

str

frequency_cap

The frequency cap.

This field is a member of oneof _frequency_cap.

Type

google.ads.admanager_v1.types.FrequencyCap

class google.ads.admanager_v1.types.LabelTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [LabelType][google.ads.admanager.v1.LabelTypeEnum.LabelType]

class LabelType(value)

Bases: proto.enums.Enum

Represents the types of labels supported.

Values:

LABEL_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

AD_EXCLUSION (1):

Allows for the creation of labels to exclude ads from showing against a tag that specifies the label as an exclusion.

AD_UNIT_FREQUENCY_CAP (2):

Allows for the creation of limits on the frequency that a user sees a particular type of creative over a portion of the inventory.

CANONICAL_CATEGORY (3):

Allows for the creation of labels mapped to a Google canonical ad category, which can be used for competitive exclusions and blocking across Google systems.

COMPETITIVE_EXCLUSION (4):

Allows for the creation of labels to exclude competing ads from showing on the same page.

CREATIVE_WRAPPER (5):

Allows for the creation of labels that can be used to force the wrapping of a delivering creative with header/footer creatives.

class google.ads.admanager_v1.types.LineItem(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A LineItem contains information about how specific ad creatives are intended to serve to your website or app along with pricing and other delivery details.

name

Identifier. The resource name of the LineItem. Format: networks/{network_code}/lineItems/{line_item_id}

Type

str

order

Required. Immutable. The ID of the Order to which the LineItem belongs. Format: networks/{network_code}/orders/{order}

This field is a member of oneof _order.

Type

str

display_name

Required. The name of the line item. This attribute has a maximum length of 255 characters.

This field is a member of oneof _display_name.

Type

str

external_line_item_id

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

This field is a member of oneof _external_line_item_id.

Type

str

order_display_name

Output only. The name of the Order.

This field is a member of oneof _order_display_name.

Type

str

start_time

Required. The date and time on which the LineItem is enabled to begin serving. This attribute is required and must be in the future.

This field is a member of oneof _start_time.

Type

google.protobuf.timestamp_pb2.Timestamp

target_end_time

Optional. The target end time of the line item. This attribute is required unless [end_time_unlimited][google.ads.admanager.v1.LineItem.end_time_unlimited] is set to true. If specified, it must be after the [start_time][google.ads.admanager.v1.LineItem.start_time]. This does not include auto extension days.

This field is a member of oneof _target_end_time.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. The timestamp when the LineItem will stop serving. This attribute includes auto extension days.

This field is a member of oneof _end_time.

Type

google.protobuf.timestamp_pb2.Timestamp

auto_extension_days

Optional. The number of days to allow a line item to deliver past its [target_end_time][google.ads.admanager.v1.LineItem.target_end_time]. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts.

This field is a member of oneof _auto_extension_days.

Type

int

end_time_unlimited

Optional. Non-empty default. Specifies whether or not the LineItem has an end time. This attribute defaults to false. It can be be set to true for only line items of type SPONSORSHIP, NETWORK, PRICE_PRIORITY and HOUSE.

This field is a member of oneof _end_time_unlimited.

Type

bool

creative_rotation_type

Required. The strategy used for displaying multiple Creative objects that are associated with the LineItem.

This field is a member of oneof _creative_rotation_type.

Type

google.ads.admanager_v1.types.CreativeRotationTypeEnum.CreativeRotationType

delivery_rate_type

Optional. Non-empty default. The strategy for delivering ads over the course of the line item’s duration. This attribute defaults to EVENLY or FRONTLOADED depending on the network’s configuration.

This field is a member of oneof _delivery_rate_type.

Type

google.ads.admanager_v1.types.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType

delivery_forecast_source

Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.

This field is a member of oneof _delivery_forecast_source.

Type

google.ads.admanager_v1.types.LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource

custom_pacing_curve

Optional. The curve that is used to pace the line item’s delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.

This field is a member of oneof _custom_pacing_curve.

Type

google.ads.admanager_v1.types.CustomPacingCurve

roadblocking_type

Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.

This field is a member of oneof _roadblocking_type.

Type

google.ads.admanager_v1.types.RoadblockingTypeEnum.RoadblockingType

skippable_ad_type

Optional. Non-empty default. The nature of the line item’s creatives’ skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.

This field is a member of oneof _skippable_ad_type.

Type

google.ads.admanager_v1.types.SkippableAdTypeEnum.SkippableAdType

frequency_caps

Optional. The set of frequency capping units for this LineItem.

Type

MutableSequence[google.ads.admanager_v1.types.FrequencyCap]

line_item_type

Required. Indicates the line item type of a LineItem. The line item type determines the default priority of the line item. More information can be found at https://support.google.com/admanager/answer/177279.

This field is a member of oneof _line_item_type.

Type

google.ads.admanager_v1.types.LineItemTypeEnum.LineItemType

priority

Optional. Non-empty default. The priority for the line item. Valid values range from 1 to 16. This field defaults to the default priority of the LineItemType. The following list shows the default, minimum, and maximum priority values are for each line item type:

• LineItemType: default priority (minimum priority, maximum priority)

• SPONSORSHIP: 4 (2, 5)

• STANDARD: 8 (6, 10)

• NETWORK: 12 (11, 14)

• BULK: 12 (11, 14)

• PRICE_PRIORITY: 12 (11, 14)

• HOUSE: 16 (15, 16)

• CLICK_TRACKING: 16 (1, 16)

• AD_EXCHANGE: 12 (1, 16)

• ADSENSE: 12 (1, 16)

• BUMPER: 16 (15, 16)

• ADMOB: 21 (1, 16)

• PREFERRED_DEAL: 12 (12, 12) This field can only be edited by certain networks, otherwise a PermissionError will occur.

This field is a member of oneof _priority.

Type

int

rate

Required. The amount of money to spend per impression or click.

This field is a member of oneof _rate.

Type

google.type.money_pb2.Money

value_cpm

Optional. Non-empty default. An amount to help the adserver rank inventory. [value_cpm][google.ads.admanager.v1.LineItem.value_cpm] artificially raises the value of inventory over the [rate][google.ads.admanager.v1.LineItem.rate] but avoids raising the actual [rate][google.ads.admanager.v1.LineItem.rate]. This attribute defaults to a Money object in the local currency with units and nanos set to 0.

This field is a member of oneof _value_cpm.

Type

google.type.money_pb2.Money

cost_type

Required. The method used for billing this LineItem.

This field is a member of oneof _cost_type.

Type

google.ads.admanager_v1.types.LineItemCostTypeEnum.LineItemCostType

discount

Optional. Discount information for the line item.

This field is a member of oneof _discount.

Type

google.ads.admanager_v1.types.LineItemDiscount

contracted_units_bought

Optional. This attribute is only applicable for certain line item types and acts as an “FYI” or note, which does not impact adserving or other backend systems. For SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a “FYI” for traffickers to manually intervene with the LineItem when needed. This attribute is only available for STANDARD line items if you have this feature enabled on your network.

This field is a member of oneof _contracted_units_bought.

Type

int

creative_placeholders

Required. Details about the creatives that are expected to serve through this LineItem.

Type

MutableSequence[google.ads.admanager_v1.types.CreativePlaceholder]

environment_type

Optional. Non-empty default. The environment that the LineItem is targeting. The default value is BROWSER. If this value is VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.

This field is a member of oneof _environment_type.

Type

google.ads.admanager_v1.types.EnvironmentTypeEnum.EnvironmentType

companion_delivery_option

Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met:

• The “Guaranteed roadblocks” feature is enabled on your network.

• One of the following is true (both cannot be true, these are mutually exclusive).

  • The environmentType is VIDEO_PLAYER.

  • The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.

This field is a member of oneof _companion_delivery_option.

Type

google.ads.admanager_v1.types.CompanionDeliveryOptionEnum.CompanionDeliveryOption

allow_overbook

Input only. The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types SPONSORSHIP and STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field won’t persist on the line item itself, and the value will only affect the current request.

This field is a member of oneof _allow_overbook.

Type

bool

skip_inventory_check

Input only. The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false. Note: this field won’t persist on the line item itself, and the value will only affect the current request.

This field is a member of oneof _skip_inventory_check.

Type

bool

skip_cross_selling_rule_warning_checks

Input only. True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false. Note:

this field won’t persist on the line item itself, and the value will only affect the current request.

This field is a member of oneof _skip_cross_selling_rule_warning_checks.

Type

bool

reserve_on_creation

Input only. The flag indicates whether inventory should be reserved when creating a line item of types SPONSORSHIP and STANDARD in an unapproved Order. The default value is false.

This field is a member of oneof _reserve_on_creation.

Type

bool

stats

Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.

This field is a member of oneof _stats.

Type

google.ads.admanager_v1.types.LineItemStats

delivery_indicator

Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:

• The line item is not delivering.

• The line item has an unlimited goal or cap.

• The line item has a percentage based goal or

cap.

This field is a member of oneof _delivery_indicator.

Type

google.ads.admanager_v1.types.DeliveryIndicator

budget

Output only. The amount of money allocated to the LineItem. This attribute is readonly and is populated by Google. The currency code is readonly.

This field is a member of oneof _budget.

Type

google.type.money_pb2.Money

status

Output only. The status of the LineItem.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.LineItemComputedStatusEnum.LineItemComputedStatus

reservation_status

Output only. Describes whether or not inventory has been reserved for the LineItem.

This field is a member of oneof _reservation_status.

Type

google.ads.admanager_v1.types.LineItemReservationStatusEnum.LineItemReservationStatus

archived

Output only. The archival status of the LineItem.

This field is a member of oneof _archived.

Type

bool

web_property_code

Optional. The web property code used for dynamic allocation line items. This web property is only required with line item types AD_EXCHANGE and ADSENSE.

This field is a member of oneof _web_property_code.

Type

str

applied_labels

Optional. The set of labels applied directly to this line item.

Type

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

effective_applied_labels

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

Type

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

same_advertiser_exception_enabled

Optional. If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.

This field is a member of oneof _same_advertiser_exception_enabled.

Type

bool

update_source

Output only. The application that last modified this line item.

This field is a member of oneof _update_source.

Type

str

notes

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

This field is a member of oneof _notes.

Type

str

competitive_constraint_scope

Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.

This field is a member of oneof _competitive_constraint_scope.

Type

google.ads.admanager_v1.types.ExclusionScopeEnum.ExclusionScope

update_time

Output only. The time this line item was last modified.

This field is a member of oneof _update_time.

Type

google.protobuf.timestamp_pb2.Timestamp

create_time

Output only. The time this line item was created.

This field is a member of oneof _create_time.

Type

google.protobuf.timestamp_pb2.Timestamp

custom_field_values

Optional. The values of the custom fields associated with this line item.

Type

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

missing_creatives

Output only. Indicates if a LineItem is missing any Creative creatives for the creativePlaceholders specified. Creative Creatives can be considered missing for several reasons including:

• Not enough Creative creatives of a certain size have been uploaded, as determined by [expected_creative_count][google.ads.admanager.v1.CreativePlaceholder.expected_creative_count]. For example a LineItem specifies 750x350, 400x200 but only a 750x350 was uploaded. Or LineItem specifies 750x350 with an expected count of 2, but only one was uploaded.

• The [Creative.applied_labels][] of an associated Creative don’t match the [CreativePlaceholder.applied_labels][google.ads.admanager.v1.CreativePlaceholder.applied_labels] of the LineItem. For example LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative without a AppliedLabel was uploaded.

This field is a member of oneof _missing_creatives.

Type

bool

third_party_measurement_settings

Optional. Third party auto-pixeling settings for cross-sell Partners.

This field is a member of oneof _third_party_measurement_settings.

Type

google.ads.admanager_v1.types.ThirdPartyMeasurementSettings

youtube_kids_restricted

Optional. Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the help center article for more information:

https://support.google.com/yt-partner-sales/answer/10015534.

This field is a member of oneof _youtube_kids_restricted.

Type

bool

max_video_creative_duration

Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.

This field is a member of oneof _max_video_creative_duration.

Type

google.protobuf.duration_pb2.Duration

goal

Optional. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.

This field is a member of oneof _goal.

Type

google.ads.admanager_v1.types.Goal

secondary_goals

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the [line_item_type][google.ads.admanager.v1.LineItem.line_item_type] is SPONSORSHIP and [cost_type][google.ads.admanager.v1.LineItem.cost_type] is CPM.

Type

MutableSequence[google.ads.admanager_v1.types.Goal]

grp_settings

Optional. Contains the information for a line item which has a target GRP demographic.

This field is a member of oneof _grp_settings.

Type

google.ads.admanager_v1.types.GrpSettings

deal_info

Optional. The deal information associated with this line item, if it is programmatic.

This field is a member of oneof _deal_info.

Type

google.ads.admanager_v1.types.LineItemDealInfo

viewability_provider_companies

Optional. Optional IDs of the Company that provide ad verification for this line item.

Type

MutableSequence[str]

child_content_eligibility

Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.

This field is a member of oneof _child_content_eligibility.

Type

google.ads.admanager_v1.types.ChildContentEligibilityEnum.ChildContentEligibility

custom_vast_extension

Optional. Custom XML to be rendered in a custom VAST response at serving time.

This field is a member of oneof _custom_vast_extension.

Type

str

sponsorship_exclusivity_enabled

Optional. Whether the line item is enabled for sponsorship exclusivity. If true, only exclusive sponsorships can be served on inventory targeted by this LineItem. This control should only be available for 100% video sponsorships.

This field is a member of oneof _sponsorship_exclusivity_enabled.

Type

bool

repeated_creative_serving_enabled

Optional. Indicates whether repeated creative serving is enabled for this line item.

This field is a member of oneof _repeated_creative_serving_enabled.

Type

bool

targeting

Required. Contains the targeting criteria for the ad campaign.

This field is a member of oneof _targeting.

Type

google.ads.admanager_v1.types.Targeting

creative_targetings

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a [CreativePlaceholder.creative_targeting_display_name][google.ads.admanager.v1.CreativePlaceholder.creative_targeting_display_name] field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

Type

MutableSequence[google.ads.admanager_v1.types.CreativeTargeting]

allowed_formats

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

Type

MutableSequence[google.ads.admanager_v1.types.LineItemAllowedFormatEnum.LineItemAllowedFormat]

class google.ads.admanager_v1.types.LineItemAllowedFormatEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [LineItemAllowedFormat][google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat]

class LineItemAllowedFormat(value)

Bases: proto.enums.Enum

The formats that a publisher allows on their programmatic video LineItem or ProposalLineItem.

Values:

LINE_ITEM_ALLOWED_FORMAT_UNSPECIFIED (0):

Default value. This value is unused.

AUDIO (1):

Audio format.

VIDEO (2):

Video format.

DISPLAY (3):

Display format.

class google.ads.admanager_v1.types.LineItemComputedStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [LineItemComputedStatus][google.ads.admanager.v1.LineItemComputedStatusEnum.LineItemComputedStatus].

class LineItemComputedStatus(value)

Bases: proto.enums.Enum

Describes the computed LineItem status that is derived from the current state of the LineItem.

Values:

LINE_ITEM_COMPUTED_STATUS_UNSPECIFIED (0):

No value specified.

CANCELED (1):

The LineItem has been canceled and is no longer eligible to serve. This is a legacy status.

COMPLETED (2):

The LineItem has completed its run.

DELIVERING (3):

The LineItem has begun serving.

DELIVERY_EXTENDED (4):

The LineItem has past its endDateTime with an auto extension, but hasn’t met its goal.

DISAPPROVED (5):

The LineItem has been disapproved and is not eligible to serve.

DRAFT (6):

The LineItem is still being drafted.

INACTIVE (7):

The LineItem is inactive. It is either caused by missing creatives or the network disabling auto-activation.

PAUSED (8):

The LineItem has been paused from serving.

PAUSED_INVENTORY_RELEASED (9):

The LineItem has been paused and its reserved inventory has been released. The LineItem will not serve.

PENDING_APPROVAL (10):

The LineItem has been submitted for approval.

READY (11):

The LineItem has been activated and is ready to serve.

class google.ads.admanager_v1.types.LineItemCostTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [LineItemCostType][google.ads.admanager.v1.LineItemCostTypeEnum.LineItemCostType].

class LineItemCostType(value)

Bases: proto.enums.Enum

Describes the LineItem actions that are billable.

Values:

LINE_ITEM_COST_TYPE_UNSPECIFIED (0):

Not specified value.

CPA (1):

Starting February 22, 2024 the CPA LineItemCostType will only be read as part of Spotlight deprecation, learn more at: https://support.google.com/admanager/answer/7519021#spotlight

Cost per action. The line item [type][google.ads.admanager.v1.LineItem.line_item_type] must be one of:

• [LineItemTypeEnum.LineItemType.SPONSORSHIP][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.SPONSORSHIP]

• [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD]

• [LineItemTypeEnum.LineItemType.BULK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.BULK]

• [LineItemTypeEnum.LineItemType.NETWORK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.NETWORK]

CPC (2):

Cost per click. The line item [type][google.ads.admanager.v1.LineItem.line_item_type] must be one of:

• [LineItemTypeEnum.LineItemType.SPONSORSHIP][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.SPONSORSHIP]

• [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD]

• [LineItemTypeEnum.LineItemType.BULK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.BULK]

• [LineItemTypeEnum.LineItemType.NETWORK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.NETWORK]

• [LineItemTypeEnum.LineItemType.PRICE_PRIORITY][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.PRICE_PRIORITY]

• [LineItemTypeEnum.LineItemType.HOUSE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.HOUSE]

CPD (3):

Cost per day. The line item [type][google.ads.admanager.v1.LineItem.line_item_type] must be one of:

• [LineItemTypeEnum.LineItemType.SPONSORSHIP][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.SPONSORSHIP]

• [LineItemTypeEnum.LineItemType.NETWORK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.NETWORK]

CPM (4):

Cost per mille (thousand) impressions. The line item [type][google.ads.admanager.v1.LineItem.line_item_type] must be one of:

• [LineItemTypeEnum.LineItemType.SPONSORSHIP][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.SPONSORSHIP]

• [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD]

• [LineItemTypeEnum.LineItemType.BULK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.BULK]

• [LineItemTypeEnum.LineItemType.NETWORK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.NETWORK]

• [LineItemTypeEnum.LineItemType.PRICE_PRIORITY][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.PRICE_PRIORITY]

• [LineItemTypeEnum.LineItemType.HOUSE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.HOUSE]

VCPM (5):

Cost per mille (thousand) Active View viewable impressions. The line item [type][google.ads.admanager.v1.LineItem.line_item_type] must be one of:

• [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD]

CPM_IN_TARGET (6):

Cost per millie (thousand) in-target impressions. The line item [type][google.ads.admanager.v1.LineItem.line_item_type] must be one of:

• [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD]

CPF (7):

Cost for the entire flight of the deal. The line item [type][google.ads.admanager.v1.LineItem.line_item_type] must be must be one of:

• [LineItemTypeEnum.LineItemType.SPONSORSHIP][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.SPONSORSHIP]

CPCV (8):

Cost per completed view. The line item [type][google.ads.admanager.v1.LineItem.line_item_type] must be one of:

• [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD].

class google.ads.admanager_v1.types.LineItemDealInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Data transfer object for the exchange deal info of a line item.

external_deal_id

Optional. The external deal ID shared between seller and buyer. This field is only present if the deal has been finalized.

This field is a member of oneof _external_deal_id.

Type

int

class google.ads.admanager_v1.types.LineItemDeliveryForecastSourceEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [LineItemDeliveryForecastSource][google.ads.admanager.v1.LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource]

class LineItemDeliveryForecastSource(value)

Bases: proto.enums.Enum

Strategies for choosing forecasted traffic shapes to pace line items.

Values:

LINE_ITEM_DELIVERY_FORECAST_SOURCE_UNSPECIFIED (0):

Default value. This value is unused.

CUSTOM_PACING_CURVE (1):

A user specified custom pacing curve will be used to pace line item delivery.

FORECASTING (2):

The line item’s projected future traffic will be used to pace line item delivery.

HISTORICAL (3):

The line item’s historical traffic shape will be used to pace line item delivery.

class google.ads.admanager_v1.types.LineItemDeliveryRateTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [LineItemDeliveryRateType][google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType].

class LineItemDeliveryRateType(value)

Bases: proto.enums.Enum

Possible delivery rates for a [LineItem][google.ads.admanager.v1.LineItem]. It dictates the manner in which the LineItem is served.

Values:

LINE_ITEM_DELIVERY_RATE_TYPE_UNSPECIFIED (0):

No value specified.

AS_FAST_AS_POSSIBLE (3):

The booked impressions may delivered well before the end time. Other lower-priority or lower-value LineItems will be stopped from delivering until the LineItem meets the number of impressions or clicks it is booked for.

EVENLY (1):

LineItems are served as evenly as possible across the number of days specified in a LineItem’s duration.

FRONTLOADED (2):

LineItems are served more aggressively in the beginning of the flight date.

class google.ads.admanager_v1.types.LineItemDiscount(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Discount information for a LineItem.

discount_type

Optional. The type of discount being applied to a LineItem, either percentage based or absolute. This attribute is optional and defaults to PERCENTAGE.

This field is a member of oneof _discount_type.

Type

google.ads.admanager_v1.types.DiscountTypeEnum.DiscountType

discount

Optional. The number here is either a percentage or an absolute value depending on the DiscountType. If the DiscountType is PERCENTAGE, then only non-fractional values are supported.

This field is a member of oneof _discount.

Type

float

class google.ads.admanager_v1.types.LineItemReservationStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [LineItemReservationStatus][google.ads.admanager.v1.LineItemReservationStatusEnum.LineItemReservationStatus].

class LineItemReservationStatus(value)

Bases: proto.enums.Enum

Defines the different reservation statuses of a line item.

Values:

LINE_ITEM_RESERVATION_STATUS_UNSPECIFIED (0):

No value specified

RESERVED (1):

Indicates that inventory has been reserved for the line item.

UNRESERVED (2):

Indicates that inventory has not been reserved for the line item.

class google.ads.admanager_v1.types.LineItemStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains trafficking statistics for LineItem.

impressions_delivered

Output only. The number of impressions delivered.

This field is a member of oneof _impressions_delivered.

Type

int

clicks_delivered

Output only. The number of clicks delivered

This field is a member of oneof _clicks_delivered.

Type

int

video_completions_delivered

Output only. The number of video completions delivered.

This field is a member of oneof _video_completions_delivered.

Type

int

video_starts_delivered

Output only. The number of video starts delivered.

This field is a member of oneof _video_starts_delivered.

Type

int

viewable_impressions_delivered

Output only. The number of viewable impressions delivered.

This field is a member of oneof _viewable_impressions_delivered.

Type

int

delivery_data

Output only. Clicks or impressions delivered for each of the last 7 days. Values are in chronological order (oldest to newest).

Type

MutableSequence[int]

class google.ads.admanager_v1.types.LineItemTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [LineItemType][google.ads.admanager.v1.LineItemTypeEnum.LineItemType].

class LineItemType(value)

Bases: proto.enums.Enum

Indicates the priority of a LineItem, determined by the way in which impressions are reserved to be served for it.

Values:

LINE_ITEM_TYPE_UNSPECIFIED (0):

Not specified value.

SPONSORSHIP (12):

The type of LineItem for which a percentage of all the impressions that are being sold are reserved.

STANDARD (13):

The type of LineItem for which a fixed quantity of impressions or clicks are reserved.

NETWORK (9):

The type of LineItem most commonly used to fill a site’s unsold inventory if not contractually obligated to deliver a requested number of impressions. Uses daily percentage of unsold impressions or clicks.

BULK (4):

The type of LineItem for which a fixed quantity of impressions or clicks will be delivered at a priority lower than the STANDARD type.

PRICE_PRIORITY (11):

The type of LineItem most commonly used to fill a site’s unsold inventory if not contractually obligated to deliver a requested number of impressions. Uses fixed quantity percentage of unsold impressions or clicks.

HOUSE (7):

The type of LineItem typically used for ads that promote products and services chosen by the publisher.

CLICK_TRACKING (6):

The type of LineItem used for ads that track ads being served externally of Ad Manager.

ADSENSE (2):

Targets the LineItem to specific inventory available to AdSense buyers.

AD_EXCHANGE (3):

Targets the LineItem to specific inventory available to Authorized Buyers and the Open Auction.

BUMPER (5):

Represents a non-monetizable video LineItem that targets one or more bumper positions, which are short house video messages used by publishers to separate content from ad breaks.

PREFERRED_DEAL (10):

The type of LineItem for which there are no impressions reserved, and will serve for a second price bid.

AUDIENCE_EXTENSION (14):

The type of LineItem used for configuring audience extension campaigns.

class google.ads.admanager_v1.types.LinkedDevice(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A test mobile device that is linked to the network. Can be used to preview a creative within a mobile application.

name

Identifier. The resource name of the LinkedDevice. Format: networks/{network_code}/linkedDevices/{linked_device_id}

Type

str

display_name

Required. The display name of the LinkedDevice.

This field is a member of oneof _display_name.

Type

str

owner

Output only. The user who owns this device linking. Format: networks/{network_code}/users/{user}

This field is a member of oneof _owner.

Type

str

visibility

Optional. The visibility of the device.

This field is a member of oneof _visibility.

Type

google.ads.admanager_v1.types.LinkedDeviceVisibilityEnum.LinkedDeviceVisibility

class google.ads.admanager_v1.types.LinkedDeviceVisibilityEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [LinkedDeviceVisibility][google.ads.admanager.v1.LinkedDeviceVisibilityEnum.LinkedDeviceVisibility]

class LinkedDeviceVisibility(value)

Bases: proto.enums.Enum

Represents the visibility of a LinkedDevice.

Values:

LINKED_DEVICE_VISIBILITY_UNSPECIFIED (0):

Default value. This value is unused.

PRIVATE (2):

The linked device can only be used by the user who owns the device linking.

PUBLIC (3):

The linked device can be used by anyone on the network.

class google.ads.admanager_v1.types.ListAdBreaksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListAdBreaks method.

parent

Required. The parent, which owns this collection of AdBreaks.

Formats: networks/{network_code}/liveStreamEventsByAssetKey/{asset_key} networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}

Type

str

page_size

Optional. The maximum number of AdBreaks to return. The service might return fewer than this value. If unspecified, at most 10 ad breaks are returned. The maximum value is 100. Values above 100 are coerced to 100.

Type

int

page_token

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

When paginating, all other parameters provided to ListAdBreaks 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.ListAdBreaksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListAdBreaksRequest containing matching AdBreak objects.

ad_breaks

The AdBreak objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.AdBreak]

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. This field expires after five minutes.

Type

str

total_size

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

total_size won’t 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.ListAdRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListAdRules method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListAdRules 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

Filterable fields:

• displayName

• name

• priority

• status

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.ListAdRulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListAdRulesRequest containing matching AdRule objects.

ad_rules

The AdRule objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.AdRule]

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 AdRule objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListAdSpotsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListAdSpots method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListAdSpots 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

Filterable fields:

• canonicalDisplayName

• customSpot

• displayName

• flexible

• name

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.ListAdSpotsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListAdSpotsRequest containing matching AdSpot objects.

ad_spots

The AdSpot objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.AdSpot]

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 AdSpot objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListAdUnitSizesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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 greater than 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)

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 won’t 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)

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 greater than 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

Filterable fields:

• adUnitCode

• adUnitSizes.canonicalName

• displayName

• effectiveAdsenseEnabled

• explicitlyTargeted

• externalSetTopBoxChannelId

• hasChildren

• name

• parentAdUnit

• status

• teams

• updateTime

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)

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 won’t 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.ListApplicationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListApplications method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListApplications 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

Filterable fields:

• appStoreId

• appStores

• applicationCode

• approvalStatus

• archived

• displayName

• name

• platform

• webviewClaimingStatus

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.ListApplicationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListApplicationsRequest containing matching Application objects.

applications

The Application objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.Application]

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 Application objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListAudienceSegmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListAudienceSegments method.

parent

Required. The parent publisher network associated with these audience segments. Format: networks/{network_code}

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListAudienceSegments 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

Filterable fields:

• displayName

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.ListAudienceSegmentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListAudienceSegmentsRequest containing matching AudienceSegment objects.

audience_segments

The AudienceSegment objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.AudienceSegment]

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 AudienceSegment objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListBandwidthGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListBandwidthGroups method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListBandwidthGroups 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

Filterable fields:

• displayName

• name

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.ListBandwidthGroupsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListBandwidthGroupsRequest containing matching BandwidthGroup objects.

bandwidth_groups

The BandwidthGroup objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.BandwidthGroup]

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 BandwidthGroup objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListBrowserLanguagesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListBrowserLanguages method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListBrowserLanguages 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

Filterable fields:

• displayName

• name

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.ListBrowserLanguagesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListBrowserLanguagesRequest containing matching BrowserLanguage objects.

browser_languages

The BrowserLanguage objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.BrowserLanguage]

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 BrowserLanguage objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListBrowsersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListBrowsers method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListBrowsers 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

Filterable fields:

• displayName

• majorVersion

• minorVersion

• name

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.ListBrowsersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListBrowsersRequest containing matching Browser objects.

browsers

The Browser objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.Browser]

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 Browser objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListCdnConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListCdnConfigs method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListCdnConfigs 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

Filterable fields:

• cdnConfigStatus

• cdnConfigType

• displayName

• name

• sourceContentConfig.ingestSettings.urlPrefix

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.ListCdnConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListCdnConfigsRequest containing matching CdnConfig objects.

cdn_configs

The CdnConfig objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.CdnConfig]

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 CdnConfig objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListChildPublishersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [ListChildPublishers][] method.

parent

Required. The parent, which owns this collection of [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s. Format: networks/{network_code}

Type

str

page_size

Optional. The maximum number of [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s to return. The service may return fewer than this value. If unspecified, at most 50 [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.

Type

int

page_token

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

When paginating, all other parameters provided to [ListChildPublishers][] 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

Filterable fields:

• accountStatus

• addressVerificationStatus

• approvalStatus

• approvedManageAccountRevenueShareMillipercent

• childNetwork

• delegationType

• displayName

• email

• identityVerificationStatus

• invitationStatus

• name

• parentRevenueShareMillipercent

• pendingOnboardingTasks

• readinessStatus

• sellerId

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.ListChildPublishersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for [ListChildPublishers][] containing matching [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects.

child_publishers

The [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.ChildPublisher]

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 [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListCmsMetadataKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListCmsMetadataKeys method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListCmsMetadataKeys 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

Filterable fields:

• displayName

• name

• status

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.ListCmsMetadataKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListCmsMetadataKeysRequest containing matching CmsMetadataKey objects.

cms_metadata_keys

The CmsMetadataKey objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.CmsMetadataKey]

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 CmsMetadataKey objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListCmsMetadataValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListCmsMetadataValues method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListCmsMetadataValues 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

Filterable fields:

• displayName

• key

• name

• status

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.ListCmsMetadataValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListCmsMetadataValuesRequest containing matching CmsMetadataValue objects.

cms_metadata_values

The CmsMetadataValue objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.CmsMetadataValue]

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 CmsMetadataValue objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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)

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 greater than 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

Filterable fields:

• address

• comment

• companyId

• creditStatus

• displayName

• email

• externalId

• fax

• name

• phone

• thirdPartyCompanyId

• type

• updateTime

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)

Bases: proto.message.Message

Response object for [ListCompaniesRequest][google.ads.admanager.v1.ListCompaniesRequest] containing matching [Company][google.ads.admanager.v1.Company] objects.

companies

The [Company][google.ads.admanager.v1.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][google.ads.admanager.v1.Company] objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListContactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListContacts method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListContacts 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

Filterable fields:

• address

• cellPhone

• comment

• company

• displayName

• email

• fax

• name

• status

• title

• workPhone

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.ListContactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListContactsRequest containing matching Contact objects.

contacts

The Contact objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.Contact]

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 Contact objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListContentBundlesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListContentBundles method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListContentBundles 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

Filterable fields:

• displayName

• name

• status

• updateTime

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.ListContentBundlesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListContentBundlesRequest containing matching ContentBundle objects.

content_bundles

The ContentBundle objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.ContentBundle]

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 ContentBundle objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListContentLabelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListContentLabels method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListContentLabels 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

Filterable fields:

• displayName

• name

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.ListContentLabelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListContentLabelsRequest containing matching ContentLabel objects.

content_labels

The ContentLabel objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.ContentLabel]

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 ContentLabel objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListContentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListContent method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListContent 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

Filterable fields:

• cmsMetadataValues

• cmsSources.contentSource

• cmsSources.contentSourceDisplayName

• contentBundles

• contentStatusSource

• dashIngestStatus

• displayName

• duration

• hlsIngestStatus

• importTime

• lastDashIngestTime

• lastHlsIngestTime

• name

• status

• updateTime

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.ListContentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListContentRequest containing matching Content objects.

content

The Content objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.Content]

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 Content objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListCreativeSetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListCreativeSets method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListCreativeSets 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

Filterable fields:

• companionCreatives

• displayName

• masterCreative

• name

• updateTime

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.ListCreativeSetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListCreativeSetsRequest containing matching CreativeSet objects.

creative_sets

The CreativeSet objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.CreativeSet]

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 CreativeSet objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListCreativeTemplatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListCreativeTemplates method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListCreativeTemplates 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

Filterable fields:

• description

• displayName

• interstitial

• name

• nativeEligible

• nativeVideoEligible

• safeFrameCompatible

• status

• type

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.ListCreativeTemplatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListCreativeTemplatesRequest containing matching CreativeTemplate objects.

creative_templates

The CreativeTemplate objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.CreativeTemplate]

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 CreativeTemplate objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListCreativeWrappersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListCreativeWrappers method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListCreativeWrappers 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

Filterable fields:

• creativeWrapperType

• label

• name

• ordering

• status

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.ListCreativeWrappersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListCreativeWrappersRequest containing matching CreativeWrapper objects.

creative_wrappers

The CreativeWrapper objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.CreativeWrapper]

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 CreativeWrapper objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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)

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 greater than 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

Filterable fields:

• dataType

• description

• displayName

• entityType

• name

• options.customFieldOptionId

• options.displayName

• status

• visibility

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)

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 won’t 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)

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

Filterable fields:

• adTagName

• displayName

• name

• reportableType

• status

• type

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)

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 won’t 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)

Bases: proto.message.Message

Request object for ListCustomTargetingValues method.

parent

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

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

Filterable fields:

• adTagName

• customTargetingKey

• displayName

• matchType

• name

• status

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)

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 won’t 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.ListDaiAuthenticationKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListDaiAuthenticationKeys method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListDaiAuthenticationKeys 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

Filterable fields:

• displayName

• name

• status

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.ListDaiAuthenticationKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListDaiAuthenticationKeysRequest containing matching DaiAuthenticationKey objects.

dai_authentication_keys

The DaiAuthenticationKey objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.DaiAuthenticationKey]

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 DaiAuthenticationKey objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListDaiEncodingProfilesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListDaiEncodingProfiles method.

parent

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

Type

str

page_size

Optional. The maximum number of DaiEncodingProfiles to return. The service may return fewer than this value. If unspecified, at most 50 DaiEncodingProfiles 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 ListDaiEncodingProfiles call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDaiEncodingProfiles 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

Filterable fields:

• containerType

• displayName

• name

• status

• variantType

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.ListDaiEncodingProfilesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListDaiEncodingProfilesRequest containing matching DaiEncodingProfile objects.

dai_encoding_profiles

The DaiEncodingProfile objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.DaiEncodingProfile]

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 DaiEncodingProfile 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.ListDeviceCapabilitiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListDeviceCapabilities method.

parent

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

Type

str

page_size

Optional. The maximum number of DeviceCapabilities to return. The service may return fewer than this value. If unspecified, at most 50 DeviceCapabilities 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 ListDeviceCapabilities call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDeviceCapabilities 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

Filterable fields:

• displayName

• name

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.ListDeviceCapabilitiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListDeviceCapabilitiesRequest containing matching DeviceCapability objects.

device_capabilities

The DeviceCapability objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.DeviceCapability]

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 DeviceCapability objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListDeviceCategoriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListDeviceCategories method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListDeviceCategories 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

Filterable fields:

• displayName

• name

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.ListDeviceCategoriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListDeviceCategoriesRequest containing matching DeviceCategory objects.

device_categories

The DeviceCategory objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.DeviceCategory]

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 DeviceCategory objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListDeviceManufacturersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListDeviceManufacturers method.

parent

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

Type

str

page_size

Optional. The maximum number of DeviceManufacturers to return. The service may return fewer than this value. If unspecified, at most 50 DeviceManufacturers 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 ListDeviceManufacturers call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDeviceManufacturers 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

Filterable fields:

• displayName

• name

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.ListDeviceManufacturersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListDeviceManufacturersRequest containing matching DeviceManufacturer objects.

device_manufacturers

The DeviceManufacturer objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.DeviceManufacturer]

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 DeviceManufacturer objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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)

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)

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 won’t 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.ListGeoTargetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListGeoTargets method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListGeoTargets 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

Filterable fields:

• canonicalParent

• displayName

• name

• regionCode

• type

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.ListGeoTargetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListGeoTargetsRequest containing matching GeoTarget objects.

geo_targets

The GeoTarget objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.GeoTarget]

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 GeoTarget objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListLabelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListLabels method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListLabels 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

Filterable fields:

• active

• description

• displayName

• name

• types

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.ListLabelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListLabelsRequest containing matching Label objects.

labels

The Label objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.Label]

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 Label objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListLineItemsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListLineItems method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListLineItems 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

Filterable fields:

• archived

• contractedUnitsBought

• costType

• createTime

• creativePlaceholders.size.canonicalName

• dealInfo.externalDealId

• deliveryRateType

• displayName

• endTime

• environmentType

• externalLineItemId

• goal.units

• grpSettings.growbirdNielsenEnabled

• grpSettings.inTargetRatioEstimateMilliPercent

• lineItemType

• missingCreatives

• name

• notes

• order

• orderDisplayName

• priority

• roadblockingType

• startTime

• stats.clickThroughRate

• stats.clicksDelivered

• stats.impressionsDelivered

• stats.viewableImpressionsDelivered

• status

• targeting.inventoryTargeting.targetedAdUnits.adUnit

• targeting.inventoryTargeting.targetedPlacements

• targeting.mobileApplicationTargeting.firstPartyTargeting.targetedApplications

• updateSource

• updateTime

• webPropertyCode

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.ListLineItemsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListLineItemsRequest containing matching LineItem objects.

line_items

The LineItem objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.LineItem]

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 LineItem objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListLinkedDevicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListLinkedDevices method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListLinkedDevices 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

Filterable fields:

• displayName

• name

• owner

• visibility

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.ListLinkedDevicesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListLinkedDevicesRequest containing matching LinkedDevice objects.

linked_devices

The LinkedDevice objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.LinkedDevice]

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 LinkedDevice objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListLiveStreamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListLiveStreams method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListLiveStreams 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

Filterable fields:

• assetKey

• createTime

• customAssetKey

• daiAuthenticationKeys

• daiEncodingProfiles

• displayName

• dynamicAdInsertionType

• effectiveAssetKey

• endTime

• segmentUrlAuthenticationKeys

• slate

• sourceContentConfigurations

• startTime

• status

• streamingFormat

• updateTime

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.ListLiveStreamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListLiveStreamsRequest containing matching LiveStream objects.

live_streams

The LiveStream objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.LiveStream]

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 LiveStream objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListMobileCarriersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListMobileCarriers method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListMobileCarriers 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

Filterable fields:

• displayName

• name

• regionCode

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.ListMobileCarriersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListMobileCarriersRequest containing matching MobileCarrier objects.

mobile_carriers

The MobileCarrier objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.MobileCarrier]

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 MobileCarrier objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListMobileDeviceSubmodelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListMobileDeviceSubmodels method.

parent

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

Type

str

page_size

Optional. The maximum number of MobileDeviceSubmodels to return. The service may return fewer than this value. If unspecified, at most 50 MobileDeviceSubmodels 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 ListMobileDeviceSubmodels call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListMobileDeviceSubmodels 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

Filterable fields:

• displayName

• mobileDevice

• name

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.ListMobileDeviceSubmodelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListMobileDeviceSubmodelsRequest containing matching MobileDeviceSubmodel objects.

mobile_device_submodels

The MobileDeviceSubmodel objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.MobileDeviceSubmodel]

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 MobileDeviceSubmodel objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListMobileDevicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListMobileDevices method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListMobileDevices 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

Filterable fields:

• displayName

• manufacturer

• name

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.ListMobileDevicesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListMobileDevicesRequest containing matching MobileDevice objects.

mobile_devices

The MobileDevice objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.MobileDevice]

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 MobileDevice objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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)

Bases: proto.message.Message

Request object for ListNetworks method.

page_size

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

Type

int

page_token

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

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

Type

str

skip

Optional. Number of individual resources to skip while paginating.

Type

int

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

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]

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

total_size won’t 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.ListOperatingSystemVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListOperatingSystemVersions method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListOperatingSystemVersions 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

Filterable fields:

• majorVersion

• microVersion

• minorVersion

• name

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.ListOperatingSystemVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListOperatingSystemVersionsRequest containing matching OperatingSystemVersion objects.

operating_system_versions

The OperatingSystemVersion objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.OperatingSystemVersion]

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 OperatingSystemVersion objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListOperatingSystemsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListOperatingSystems method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListOperatingSystems 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

Filterable fields:

• displayName

• name

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.ListOperatingSystemsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListOperatingSystemsRequest containing matching OperatingSystem objects.

operating_systems

The OperatingSystem objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.OperatingSystem]

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 OperatingSystem objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListOrdersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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 greater than 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

Filterable fields:

• advertiser

• agency

• appliedTeams

• archived

• creator

• displayName

• endTime

• externalOrderId

• impressionsDelivered

• name

• orderId

• poNumber

• programmatic

• salesperson

• secondarySalespeople

• secondaryTraffickers

• startTime

• status

• totalClicksDelivered

• totalViewableImpressionsDelivered

• trafficker

• updateTime

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)

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 won’t 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.ListPartnersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [ListPartners][] method.

parent

Required. The parent, which owns this collection of [Partner][google.ads.admanager.v1.Partner]s. Format: networks/{network_code}

Type

str

page_size

Optional. The maximum number of [Partner][google.ads.admanager.v1.Partner]s to return. The service may return fewer than this value. If unspecified, at most 50 [Partner][google.ads.admanager.v1.Partner]s will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.

Type

int

page_token

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

When paginating, all other parameters provided to [ListPartners][] 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

Filterable fields:

• address

• comment

• creditStatus

• displayName

• email

• externalId

• fax

• name

• phone

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.ListPartnersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for [ListPartnersRequest][google.ads.admanager.v1.ListPartnersRequest] containing matching [Partner][google.ads.admanager.v1.Partner] objects.

partners

The [Partner][google.ads.admanager.v1.Partner] objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.Partner]

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 [Partner][google.ads.admanager.v1.Partner] objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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)

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 greater than 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

Filterable fields:

• description

• displayName

• name

• placementCode

• status

• targetedAdUnits

• updateTime

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)

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 won’t 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.ListPrivateAuctionDealsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListPrivateAuctionDeals method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListPrivateAuctionDeals 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

Filterable fields:

• auctionPriorityEnabled

• blockOverrideEnabled

• buyerAccountId

• buyerPermissionType

• endTime

• externalDealId

• floorPrice

• name

• privateAuctionDealId

• privateAuctionDisplayName

• privateAuctionId

• status

• updateTime

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.ListPrivateAuctionDealsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListPrivateAuctionDealsRequest containing matching PrivateAuctionDeal objects.

private_auction_deals

The PrivateAuctionDeal objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.PrivateAuctionDeal]

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 PrivateAuctionDeal objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListPrivateAuctionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListPrivateAuctions method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListPrivateAuctions 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.ListPrivateAuctionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListPrivateAuctionsRequest containing matching PrivateAuction objects.

private_auctions

The PrivateAuction objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.PrivateAuction]

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 PrivateAuction objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListProgrammaticBuyersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListProgrammaticBuyers method.

parent

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

Type

str

page_size

Optional. The maximum number of ProgrammaticBuyers to return. The service may return fewer than this value. If unspecified, at most 50 ProgrammaticBuyers 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 ListProgrammaticBuyers call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListProgrammaticBuyers 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

Filterable fields:

• agency

• buyerAccountId

• displayName

• name

• parentAccountId

• partnerClientId

• preferredDealsEnabled

• programmaticGuaranteedEnabled

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.ListProgrammaticBuyersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListProgrammaticBuyersRequest containing matching ProgrammaticBuyer objects.

programmatic_buyers

The ProgrammaticBuyer objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.ProgrammaticBuyer]

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 ProgrammaticBuyer objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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)

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 greater than 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)

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 won’t 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.ListRichMediaAdsCompaniesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListRichMediaAdsCompanies method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListRichMediaAdsCompanies 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

Filterable fields:

• companyGvlId

• displayName

• gdprStatus

• name

• policyUrl

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.ListRichMediaAdsCompaniesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListRichMediaAdsCompaniesRequest containing matching RichMediaAdsCompany objects.

rich_media_ads_companies

The RichMediaAdsCompany objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.RichMediaAdsCompany]

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 RichMediaAdsCompany objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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)

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 greater than 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

Filterable fields:

• builtIn

• description

• displayName

• name

• status

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)

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 won’t 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.ListSitesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListSites method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListSites 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

Filterable fields:

• approvalStatus

• approvalStatusUpdateTime

• childNetworkCode

• name

• url

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.ListSitesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListSitesRequest containing matching Site objects.

sites

The Site objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.Site]

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 Site objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListSlatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for ListSlates method.

parent

Required. The parent resource containing the Slates. Format: networks/{network_code}

Type

str

page_size

Optional. The maximum number of Slates to return. The service may return fewer than this value. If unspecified, at most 50 Slates 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 ListSlates call. Provide this to retrieve the subsequent page.

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

Type

str

filter

Optional. Expression to filter the response. See syntax details at https://google.aip.dev/160

Filterable fields:

• displayName

• name

• status

Type

str

order_by

Optional. Expression to specify sorting order. See syntax details at https://google.aip.dev/132#ordering

Type

str

skip

Optional. Number of individual resources to skip while paginating.

Type

int

class google.ads.admanager_v1.types.ListSlatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for ListSlates method.

slates

The Slate objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.Slate]

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

total_size

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

total_size will not be returned if skip is nonzero.

Type

int

class google.ads.admanager_v1.types.ListSuggestedAdUnitsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListSuggestedAdUnits method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListSuggestedAdUnits 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

Filterable fields:

• name

• newCodePath

• weeklyRequestCount

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.ListSuggestedAdUnitsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListSuggestedAdUnitsRequest containing matching SuggestedAdUnit objects.

suggested_ad_units

The SuggestedAdUnit objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.SuggestedAdUnit]

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 SuggestedAdUnit objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListTargetingPresetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListTargetingPresets method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListTargetingPresets 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

Filterable fields:

• displayName

• name

• status

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.ListTargetingPresetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListTargetingPresetsRequest containing matching TargetingPreset objects.

targeting_presets

The TargetingPreset objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.TargetingPreset]

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 TargetingPreset objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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)

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)

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 won’t 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.ListTeamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListTeams method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListTeams 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

Filterable fields:

• accessType

• allCompaniesAccess

• allInventoryAccess

• description

• displayName

• name

• status

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.ListTeamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListTeamsRequest containing matching Team objects.

teams

The Team objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.Team]

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 Team objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListThirdPartyCompaniesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for ListThirdPartyCompanies method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

When paginating, all other parameters provided to ListThirdPartyCompanies 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

Filterable fields:

• displayName

• name

• status

• type

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.ListThirdPartyCompaniesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for ListThirdPartyCompaniesRequest containing matching ThirdPartyCompany objects.

third_party_companies

The ThirdPartyCompany objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.ThirdPartyCompany]

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 ThirdPartyCompany objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.ListViewabilityProvidersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [ListViewabilityProviders][] method.

parent

Required. The parent, which owns this collection of [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]s. Format: networks/{network_code}

Type

str

page_size

Optional. The maximum number of [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]s to return. The service may return fewer than this value. If unspecified, at most 50 [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]s 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 [ListViewabilityProviders][] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [ListViewabilityProviders][] 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

Filterable fields:

• address

• comment

• displayName

• email

• externalId

• fax

• name

• phone

• primaryContact

• rejectionTrackerUrl

• vendorKey

• verificationScriptUrl

• verificationScriptUrlParameters

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.ListViewabilityProvidersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for [ListViewabilityProviders][] containing matching [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] objects.

viewability_providers

The [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] objects from the specified network.

Type

MutableSequence[google.ads.admanager_v1.types.ViewabilityProvider]

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 [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size won’t 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.LiveStream(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A LiveStream encapsulates all the information necessary to enable DAI (Dynamic Ad Insertion) into a live video stream. This includes information such as the start and expected end time of the live stream, the URL of the actual content for Ad Manager to pull and insert ads into, as well as the metadata necessary to generate ad requests during the live stream.

name

Identifier. The resource name of the LiveStream. Format: networks/{network_code}/liveStreams/{live_stream_id}

Type

str

display_name

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

This field is a member of oneof _display_name.

Type

str

status

Output only. The status of this LiveStream. Live stream events are created in the [PAUSED][google.ads.admanager.v1.LiveStreamEventStatusEnum.LiveStreamEventStatus.PAUSED] state.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.LiveStreamEventStatusEnum.LiveStreamEventStatus

create_time

Output only. The date and time this LiveStream was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The date and time this LiveStream was last modified.

Type

google.protobuf.timestamp_pb2.Timestamp

start_time

Optional. The start date and time of this LiveStream. Modifying this attribute for an active live stream can impact traffic.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Optional. The scheduled end date and time of this LiveStream. This attribute is required if unlimitedEndDateTime is false and ignored if unlimitedEndDateTime is true. Modifying this attribute for an active live stream can impact traffic.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time_unlimited

Optional. Whether the LiveStream has an end time. Defaults to false. If this field is true, endDateTime is ignored.

This field is a member of oneof _end_time_unlimited.

Type

bool

content_urls

Required. The list of URLs pointing to the live stream content in Content Delivery Network. Can be modified when the live stream is in a [PAUSED][google.ads.admanager.v1.LiveStreamEventStatusEnum.LiveStreamEventStatus.PAUSED] state.

Type

MutableSequence[str]

ad_tags

Required. The list of Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream. Currently, the list includes only one element: the master ad tag.

Type

MutableSequence[str]

asset_key

Output only. The code used in constructing a live stream master playlist URL.

This field is a member of oneof _asset_key.

Type

str

slate

Optional. The slate to use for this live stream. If not set, network default slate will be used. Format: “networks/{network_code}/slates/{slate_id}”.

This field is a member of oneof _slate.

Type

str

dvr_window_duration

Optional. The duration of the DVR window. If unset the default window as provided by the input encoder will be used. Modifying this value for an active live stream can impact traffic.

This field is a member of oneof _dvr_window_duration.

Type

google.protobuf.duration_pb2.Duration

enable_dai_authentication_keys

Optional. Whether the live stream’s requests to the IMA SDK API will be authenticated using the DAI authentication keys.

This field is a member of oneof _enable_dai_authentication_keys.

Type

bool

ad_break_fill_type

Optional. The type of content that should be used to fill an empty ad break. Defaults to [SLATE][google.ads.admanager.v1.AdBreakFillTypeEnum.AdBreakFillType.SLATE].

This field is a member of oneof _ad_break_fill_type.

Type

google.ads.admanager_v1.types.AdBreakFillTypeEnum.AdBreakFillType

underfill_ad_break_fill_type

Optional. The type of content that should be used to fill the time remaining in the ad break when there are not enough ads to fill the entire break. Defaults to [SLATE][google.ads.admanager.v1.AdBreakFillTypeEnum.AdBreakFillType.SLATE]. To set this field a network needs to have the “Live stream ad break underfill type” feature enabled.

This field is a member of oneof _underfill_ad_break_fill_type.

Type

google.ads.admanager_v1.types.AdBreakFillTypeEnum.AdBreakFillType

ad_holiday_duration

Optional. The duration, starting from the time the user enters the DAI stream, for which mid-roll decisioning will be skipped. This field is only applicable when an ad holiday is requested in the stream create request. Defaults to 0.

This field is a member of oneof _ad_holiday_duration.

Type

google.protobuf.duration_pb2.Duration

enable_max_filler_duration

Optional. Whether there will be max filler duration in this live stream. If true, maxFillerDuration should be specified. Defaults to false.

This field is a member of oneof _enable_max_filler_duration.

Type

bool

max_filler_duration

Optional. The maximum duration that can be used to fill this ad pod, either with a slate or underlying content, depending on your settings. If more time needs to be filled, the ad pod will instead be dropped and the underlying content will be served.

This field is a member of oneof _max_filler_duration.

Type

google.protobuf.duration_pb2.Duration

pod_serving_segment_duration

Optional. The duration that can be used when stitching ads for each livestream event. This attribute is only available for Pod Serving HLS Segment Redirect and Pod Serving Dash Segment Redirect.

This field is a member of oneof _pod_serving_segment_duration.

Type

google.protobuf.duration_pb2.Duration

enable_durationless_ad_breaks

Optional. Whether there will be durationless ad breaks in this live stream. If true, defaultAdBreakDuration should be specified. Defaults to false.

This field is a member of oneof _enable_durationless_ad_breaks.

Type

bool

default_ad_break_duration

Optional. The default ad pod duration that will be requested when an ad break cue-out does not specify a duration. Defaults to 0.

This field is a member of oneof _default_ad_break_duration.

Type

google.protobuf.duration_pb2.Duration

dai_authentication_keys

Optional. The list of DaiAuthenticationKey objects used to authenticate stream create requests for this live stream. Modifying settings for an active live stream may break the stream for some users. Exercise caution. Format: “networks/{network_code}/daiAuthenticationKeys/{dai_authentication_key_id}”.

Type

MutableSequence[str]

source_content_configurations

Optional. The list of CdnConfigurations that provide settings for ingesting and delivering the videos associated with this source. Modifying settings for an active live stream may break the stream for some users. Exercise caution. Format: “networks/{network_code}/cdnConfigs/{cdn_config_id}”.

Type

MutableSequence[str]

ad_media_delivery_config

Optional. The CdnConfiguration that provide settings for delivering ad media associated with this source. Format: “networks/{network_code}/cdnConfigs/{cdn_config_id}”.

This field is a member of oneof _ad_media_delivery_config.

Type

str

preroll_settings

Optional. The settings specific to Preroll ad breaks. If null, this livestream does not have prerolls enabled.

Type

google.ads.admanager_v1.types.PrerollSettings

hls_settings

Optional. The settings that are specific to HTTPS live streaming (HLS) protocol. If it is not set will use the default HLS settings.

Type

google.ads.admanager_v1.types.HlsSettings

allowlisted_ips_enabled

Optional. Whether specific allowlisted IP addresses should be used to access this live stream. Will default to false. To set this field a network needs to have the “Video live allowlisted IPS enabled” feature enabled. Modifying this field for an active live stream can impact traffic.

This field is a member of oneof _allowlisted_ips_enabled.

Type

bool

dynamic_ad_insertion_type

Immutable. The method of dynamic ad insertion that is used to insert ads into this live stream. Defaults to DynamicAdInsertionType.LINEAR.

This field is a member of oneof _dynamic_ad_insertion_type.

Type

google.ads.admanager_v1.types.DynamicAdInsertionTypeEnum.DynamicAdInsertionType

relative_playlist_delivery_enabled

Optional. Whether the served playlists can include relative URLs. Defaults to false. To set this field a network needs to have the “Video live stream relative playlist URLs” feature enabled. This field can be modified when the live stream is in a LiveStreamEventStatus#PAUSED state.

This field is a member of oneof _relative_playlist_delivery_enabled.

Type

bool

streaming_format

Immutable. The streaming format of the LiveStream media.

This field is a member of oneof _streaming_format.

Type

google.ads.admanager_v1.types.LiveStreamEventStreamingFormatEnum.LiveStreamEventStreamingFormat

prefetch_enabled

Optional. Indicates whether the option to prefetch ad requests is enabled.

This field is a member of oneof _prefetch_enabled.

Type

bool

prefetch_settings

Optional. The information needed to prefetch ad requests for an ad break.

Type

google.ads.admanager_v1.types.PrefetchSettings

forced_cue_in_enabled

Optional. Whether live stream placement opportunities without #EXT-CUE-IN markers should be force closed. Defaults to false. To set this field a network needs to have the “Video live stream forced cue in” feature enabled.

This field is a member of oneof _forced_cue_in_enabled.

Type

bool

short_segment_dropping_enabled

Optional. Whether segments shorter than 1 second at the end of an ad pod should be dropped. Defaults to false. To set this field a network needs to have the “Video live stream short segment dropping” feature enabled.

This field is a member of oneof _short_segment_dropping_enabled.

Type

bool

custom_asset_key

Immutable. An additional code that can be used in constructing live stream event URLs. Can only be set for pod serving live streams. The custom asset key may be at most 64 characters and can contain alphanumeric characters and symbols other than the following: “, ‘, =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.

This field is a member of oneof _custom_asset_key.

Type

str

dai_encoding_profiles

Optional. The list of DaiEncodingProfiles that will be used for this live stream event. Format: “networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}”.

Type

MutableSequence[str]

segment_url_authentication_keys

Optional. The list of DaiAuthenticationKeys used to authenticate ad segment url requests for this live stream. Format: “networks/{network_code}/daiAuthenticationKeys/{dai_authentication_key_id}”.

Type

MutableSequence[str]

ad_break_markups

Optional. The formats that will be recognized as ad break start/end markers. This field is ignored if adBreakMarkupTypesEnabled is false.

Type

MutableSequence[google.ads.admanager_v1.types.AdBreakMarkupTypeEnum.AdBreakMarkupType]

ad_break_markup_types_enabled

Optional. Whether this LiveStream is specifying a subset of supported adBreakMarkups. If this field is false, all supported formats will be treated as ad break start/end markers.

This field is a member of oneof _ad_break_markup_types_enabled.

Type

bool

live_stream_conditioning

Optional. The conditioning to apply to this LiveStream.

Type

google.ads.admanager_v1.types.LiveStreamConditioning

early_break_notification_multi_break_scheduling_enabled

Optional. Indicates whether multi-break scheduling via Early Break Notification (EBN) is enabled for this LiveStream.

This field is a member of oneof _early_break_notification_multi_break_scheduling_enabled.

Type

bool

ad_pod_trim_tolerance

Optional. The maximum amount of time by which a stitched ad pod is allowed to be trimmed before whole ads are dropped instead.

Type

google.protobuf.duration_pb2.Duration

effective_asset_key

Output only. The effective asset key of the live stream. This is the user-defined custom_asset_key if specified; otherwise, it falls back to the autogenerated asset_key.

This field is a member of oneof _effective_asset_key.

Type

str

auxiliary_ad_settings

Optional. The auxiliary ad tag settings for this live stream.

Type

google.ads.admanager_v1.types.AuxiliaryAdSettings

class google.ads.admanager_v1.types.LiveStreamConditioning(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Settings to specify all types of conditioning to apply to the associated LiveStream.

dash_bridge

Optional. Specifies DASH Bridge single-period to multi-period MPD conditioning.

Type

google.ads.admanager_v1.types.DashBridge

class google.ads.admanager_v1.types.LiveStreamEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A LiveStreamEvent encapsulates all the information necessary to enable DAI (Dynamic Ad Insertion) into a live video stream. This includes information such as the start and expected end time of the LiveStreamEvent, the URL of the actual content for Ad Manager to pull and insert ads into, as well as the metadata necessary to generate ad requests during the live stream.

name

Identifier. The resource name of the LiveStreamEvent. Format: networks/{network_code}/liveStreamEvents/{live_stream_event_id}

Type

str

class google.ads.admanager_v1.types.LiveStreamEventStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [LiveStreamEventStatus][google.ads.admanager.v1.LiveStreamEventStatusEnum.LiveStreamEventStatus]

class LiveStreamEventStatus(value)

Bases: proto.enums.Enum

Describes the status of a LiveStreamEvent object.

Values:

LIVE_STREAM_EVENT_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE (1):

Indicates the LiveStreamEvent has been created and is eligible for streaming.

ADS_PAUSED (2):

Indicates that the stream is still being served, but ad insertion should be paused temporarily.

ARCHIVED (3):

Indicates the LiveStreamEvent has been archived.

PAUSED (4):

Indicates the LiveStreamEvent has been paused. This can be made #ACTIVE at later time.

class google.ads.admanager_v1.types.LiveStreamEventStreamingFormatEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [LiveStreamEventStreamingFormat][google.ads.admanager.v1.LiveStreamEventStreamingFormatEnum.LiveStreamEventStreamingFormat]

class LiveStreamEventStreamingFormat(value)

Bases: proto.enums.Enum

The LiveStreamEvent streaming format.

Values:

LIVE_STREAM_EVENT_STREAMING_FORMAT_UNSPECIFIED (0):

Default value. This value is unused.

DASH (1):

The format of the live stream media is MPEG-DASH.

HLS (2):

The format of the live stream media is HTTP Live Streaming.

class google.ads.admanager_v1.types.ManualAdReviewCenterAdStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ManualAdReviewCenterAdStatus][google.ads.admanager.v1.ManualAdReviewCenterAdStatusEnum.ManualAdReviewCenterAdStatus]

class ManualAdReviewCenterAdStatus(value)

Bases: proto.enums.Enum

Specifies the manual review status of a AdReviewCenterAd.

Values:

MANUAL_AD_REVIEW_CENTER_AD_STATUS_UNSPECIFIED (0):

Not specified value.

ALLOWED (1):

This ad has been explicitly allowed to serve.

BLOCKED (2):

This ad has been explicitly blocked from serving.

ARCHIVED (3):

This ad is implicitly blocked and has been reviewed.

PENDING (4):

This ad is implicitly blocked and has not been reviewed.

SERVING (5):

This ad is allowed to serve by default and has not been reviewed.

class google.ads.admanager_v1.types.MasterPlaylistSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Settings for the HLS (HTTP Live Streaming) master playlist.

refresh_type

Optional. Indicates how the master playlist gets refreshed. Defaults to [AUTOMATIC][google.ads.admanager.v1.HlsMasterPlaylistRefreshTypeEnum.HlsMasterPlaylistRefreshType.AUTOMATIC]. This field can only be modified when the live stream is in a [PAUSED][google.ads.admanager.v1.LiveStreamEventStatusEnum.LiveStreamEventStatus.PAUSED] state.

This field is a member of oneof _refresh_type.

Type

google.ads.admanager_v1.types.HlsMasterPlaylistRefreshTypeEnum.HlsMasterPlaylistRefreshType

class google.ads.admanager_v1.types.McmEarnings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The earnings for a given month between a parent and child publisher in MCM

month

Output only. The year and month that the MCM earnings data applies to. The date will be specified as the first of the month.

This field is a member of oneof _month.

Type

google.type.date_pb2.Date

delegation_type

Output only. The current type of MCM delegation between the parent and child publisher.

This field is a member of oneof _delegation_type.

Type

google.ads.admanager_v1.types.DelegationTypeEnum.DelegationType

parent

Output only. The parent publisher in the MCM relationship. Format: networks/{network_code}

Type

str

parent_display_name

Output only. The name of the parent publisher.

This field is a member of oneof _parent_display_name.

Type

str

child

Output only. The resource name of the ChildPublisher’s Ad Manager network in the MCM relationship. Format: networks/{network_code}

Type

str

child_publisher

Output only. The resource name of the child publisher in the MCM relationship. Format: “networks/{network_code}/childPublishers/{child_publisher_id}”.

This field is a member of oneof _child_publisher.

Type

str

child_display_name

Output only. The name of the child publisher in the MCM relationship.

This field is a member of oneof _child_display_name.

Type

str

total_earnings

Output only. The total earnings for the month.

This field is a member of oneof _total_earnings.

Type

google.type.money_pb2.Money

parent_payment

Output only. The portion of the total earnings paid to the parent publisher.

This field is a member of oneof _parent_payment.

Type

google.type.money_pb2.Money

child_payment

Output only. The portion of the total earnings paid to the child publisher.

This field is a member of oneof _child_payment.

Type

google.type.money_pb2.Money

deductions

Output only. The deductions for the month due to spam in micro units. Null for earnings prior to August 2020.

This field is a member of oneof _deductions.

Type

google.type.money_pb2.Money

earnings_product_breakdown

Output only. The product type breakdown of earnings for a given month between a parent and child publisher in MCM.

Type

MutableSequence[google.ads.admanager_v1.types.EarningsProductBreakdown]

class google.ads.admanager_v1.types.McmEarningsProductTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper for [McmEarningsProductType][google.ads.admanager.v1.McmEarningsProductTypeEnum.McmEarningsProductType]

class McmEarningsProductType(value)

Bases: proto.enums.Enum

The syndication product type of the child’s earnings in MCM.

Values:

MCM_EARNINGS_PRODUCT_TYPE_UNSPECIFIED (0):

No value specified

AD_EXCHANGE_CONTENT (1):

Indicates the child network’s earnings from Google Ad Exchange Content.

AD_EXCHANGE_CONTENT_HOST (2):

Indicates the child network’s earnings from Google Ad Exchange Content made by a host.

AD_EXCHANGE_GAMES (3):

Indicates the child network’s earnings from Google Ad Exchange Games.

AD_EXCHANGE_GAMES_HOST (4):

Indicates the child network’s earnings from Google Ad Exchange Games made by a host.

AD_EXCHANGE_MOBILE_CONTENT_APP (5):

Indicates the child network’s earnings from Google Ad Exchange Content Applications.

AD_EXCHANGE_MOBILE_CONTENT_APP_HOST (6):

Indicates the child network’s earnings from Google Ad Exchange Content Applications made by a host.

AD_EXCHANGE_VIDEO (7):

Indicates the child network’s earnings from Google Ad Exchange Video.

AD_EXCHANGE_VIDEO_HOST (8):

Indicates the child network’s earnings from Google Ad Exchange Video made by a host.

AD_EXCHANGE_RESERVATIONS (9):

Indicates the child network’s earnings from Ad Exchange Reservations deals (known externally as Programmatic Reservations).

AD_EXCHANGE_PREFERRED_DEALS (10):

Indicates the child network’s earnings from Ad Exchange Preferred deals.

OFFERWALL (11):

Indicates the child network’s earnings from Monteverdi Offerwall.

BUYER_DIRECT (12):

Indicates the child network’s earnings from Agency Direct.

class google.ads.admanager_v1.types.McmReadinessStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper for [McmReadinessStatus][google.ads.admanager.v1.McmReadinessStatusEnum.McmReadinessStatus]

class McmReadinessStatus(value)

Bases: proto.enums.Enum

Status of the MCM child publisher’s Ad Manager network onboarding readiness status

Values:

MCM_READINESS_STATUS_UNSPECIFIED (0):

No value specified

INACTIVE (1):

Indicates the invitation to the child is declined or withdrawn.

NOT_READY (2):

Indicates the MCM setup has not yet completed. It could be child not yet accepted the invitation, Google found noncompliance settings or child has not yet completed identity or address verifications.

READY (3):

Indicates MCM setup has completed. Including the child publisher accepted the invite, Google found it to be compliant with its policies, i.e. no policy violations were found, related verifications have completed and the child publisher can be served ads.

class google.ads.admanager_v1.types.MediaLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Config that associates a media location with a security policy and the authentication credentials needed to access the content.

display_name

Output only. The name of the media location. This value is read-only and is assigned by Google.

This field is a member of oneof _display_name.

Type

str

url_prefix

Required. The URL prefix of the media location. This value is required for a valid media location.

This field is a member of oneof _url_prefix.

Type

str

security_policy

Optional. The security policy and authentication credentials needed to access the content in this media location. Optional; if omitted, no security policy will be applied (indicating a public/unprotected location). Must NOT be configured for ad media delivery locations (doing so will trigger a validation error).

Type

google.ads.admanager_v1.types.CdnSecurityPolicy

class google.ads.admanager_v1.types.MobileApplicationTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Mobile Application Targeting

first_party_targeting

Optional. The targeted/excluded first-party mobile applications.

This field is a member of oneof targeting.

Type

google.ads.admanager_v1.types.FirstPartyMobileApplicationTargeting

class google.ads.admanager_v1.types.MobileCarrier(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a mobile carrier.

name

Identifier. The resource name of the MobileCarrier. Format: networks/{network_code}/mobileCarriers/{mobile_carrier}

Type

str

display_name

Output only. The localized name of the mobile carrier.

This field is a member of oneof _display_name.

Type

str

region_code

Output only. The region code of the mobile carrier.

This field is a member of oneof _region_code.

Type

str

class google.ads.admanager_v1.types.MobileCarrierTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Mobile Carrier Targeting.

Used to target or exclude mobile carriers.

targeted_mobile_carriers

Optional. A list of mobile carrier resource names that should be targeted/included.

Type

MutableSequence[str]

excluded_mobile_carriers

Optional. A list of mobile carrier resource names that should be excluded.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.MobileDevice(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a mobile device.

name

Identifier. The resource name of the MobileDevice. Format: networks/{network_code}/mobileDevices/{mobile_device}

Type

str

display_name

Output only. The localized name of the mobile device.

This field is a member of oneof _display_name.

Type

str

manufacturer

Output only. The manufacturer associated with the mobile device. Format: networks/{network_code}/deviceManufacturers/{device_manufacturer}

This field is a member of oneof _manufacturer.

Type

str

class google.ads.admanager_v1.types.MobileDeviceSubmodel(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a mobile device submodel.

name

Identifier. The resource name of the MobileDeviceSubmodel. Format: networks/{network_code}/mobileDeviceSubmodels/{mobile_device_submodel}

Type

str

display_name

Output only. The display name of the mobile device submodel.

This field is a member of oneof _display_name.

Type

str

mobile_device

Output only. The mobile device associated with the submodel. Format: networks/{network_code}/mobileDevices/{mobile_device}

This field is a member of oneof _mobile_device.

Type

str

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

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.

This field is a member of oneof _display_name.

Type

str

network_code

Output only. Network Code.

This field is a member of oneof _network_code.

Type

str

property_code

Output only. Property code.

This field is a member of oneof _property_code.

Type

str

time_zone

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

This field is a member of oneof _time_zone.

Type

str

currency_code

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

This field is a member of oneof _currency_code.

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}/adUnits/{ad_unit}

This field is a member of oneof _effective_root_ad_unit.

Type

str

test_network

Output only. Whether this is a test network.

This field is a member of oneof _test_network.

Type

bool

network_id

Output only. Network ID.

This field is a member of oneof _network_id.

Type

int

class google.ads.admanager_v1.types.NielsenCtvPacingEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [NielsenCtvPacing][google.ads.admanager.v1.NielsenCtvPacingEnum.NielsenCtvPacing]

class NielsenCtvPacing(value)

Bases: proto.enums.Enum

Represents the pacing computation method for impressions on connected devices for a Nielsen measured line item. This only applies when Nielsen measurement is enabled for connected devices.

Values:

NIELSEN_CTV_PACING_UNSPECIFIED (0):

Default value. This value is unused.

COVIEW (1):

Indicates that Nielsen impressions on connected devices are included, and we apply coviewing in pacing.

NONE (2):

The value returned if Nielsen measurement is disabled for connected devices.

STRICT_COVIEW (3):

Indicates that Nielsen impressions on connected devices are included, and we apply strict coviewing in pacing.

class google.ads.admanager_v1.types.NonGuaranteedDealPriority(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the priority settings to apply to non-guaranteed deals, independently of their types.

priority_tier

Required. Enables publishers to favor certain deals, even if their default priorities are lower. For example, allowing a PA deal to beat a PD deal.

This field is a member of oneof _priority_tier.

Type

google.ads.admanager_v1.types.DealPriorityTierEnum.DealPriorityTier

class google.ads.admanager_v1.types.OperatingSystem(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a device’s operating system.

name

Identifier. The resource name of the OperatingSystem. Format: networks/{network_code}/operatingSystems/{operating_system_id}

Type

str

display_name

Output only. The name of the operating system.

This field is a member of oneof _display_name.

Type

str

class google.ads.admanager_v1.types.OperatingSystemTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Operating System Targeting

targeted_operating_systems

Optional. A list of operating system resource names that should be targeted/included.

Type

MutableSequence[str]

excluded_operating_systems

Optional. A list of operating system resource names that should be excluded.

Type

MutableSequence[str]

targeted_operating_system_versions

Optional. A list of operating system version resource names that should be targeted/included.

Type

MutableSequence[str]

excluded_operating_system_versions

Optional. A list of operating system version resource names that should be excluded.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.OperatingSystemVersion(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a specific version of an operating system.

name

Identifier. The resource name of the OperatingSystemVersion. Format: networks/{network_code}/operatingSystemVersions/{operating_system_version_id}

Type

str

major_version

Output only. The major version of the operating system.

This field is a member of oneof _major_version.

Type

int

minor_version

Output only. The minor version of the operating system.

This field is a member of oneof _minor_version.

Type

int

micro_version

Output only. The micro version of the operating system.

This field is a member of oneof _micro_version.

Type

int

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

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. Deprecated: Order ID.

This field is a member of oneof _order_id.

Type

int

display_name

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

This field is a member of oneof _display_name.

Type

str

programmatic

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

This field is a member of oneof _programmatic.

Type

bool

trafficker

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

This field is a member of oneof _trafficker.

Type

str

advertiser_contacts

Optional. Unordered list. 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}”.

This field is a member of oneof _advertiser.

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}”.

This field is a member of oneof _agency.

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. Format: “networks/{network_code}/users/{user_id}”.

This field is a member of oneof _creator.

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.

This field is a member of oneof _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.

This field is a member of oneof _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.

This field is a member of oneof _end_time.

Type

google.protobuf.timestamp_pb2.Timestamp

unlimited_end_time

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

This field is a member of oneof _unlimited_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.

This field is a member of oneof _external_order_id.

Type

int

archived

Output only. The archival status of the Order.

This field is a member of oneof _archived.

Type

bool

last_modified_by_app

Output only. The application which modified this order.

This field is a member of oneof _last_modified_by_app.

Type

str

update_time

Output only. The instant this Order was last modified.

This field is a member of oneof _update_time.

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.

This field is a member of oneof _notes.

Type

str

po_number

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

This field is a member of oneof _po_number.

Type

str

status

Output only. The status of the Order.

This field is a member of oneof _status.

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}”.

This field is a member of oneof _salesperson.

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]

impressions_delivered

Output only. The total number of impressions delivered for Line items in this order.

This field is a member of oneof _impressions_delivered.

Type

int

total_clicks_delivered

Output only. Total clicks delivered for all Line items of this Order. This value is calculated from the associated LineItem values.

This field is a member of oneof _total_clicks_delivered.

Type

int

total_viewable_impressions_delivered

Output only. Total viewable impressions delivered for all Line items of this Order. This value is calculated from the associated LineItem values.

This field is a member of oneof _total_viewable_impressions_delivered.

Type

int

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

Bases: proto.message.Message

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

class OrderStatus(value)

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.PacingDeviceCategorizationEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [PacingDeviceCategorization][google.ads.admanager.v1.PacingDeviceCategorizationEnum.PacingDeviceCategorization]

class PacingDeviceCategorization(value)

Bases: proto.enums.Enum

Represents whose device categorization to use on Nielsen measured line item with auto-pacing enabled.

Values:

PACING_DEVICE_CATEGORIZATION_UNSPECIFIED (0):

Default value. This value is unused.

GOOGLE (1):

Use Google’s device categorization in auto-pacing.

NIELSEN (2):

Use Nielsen device categorization in auto-pacing

class google.ads.admanager_v1.types.Partner(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The [Partner][google.ads.admanager.v1.Partner] resource.

Represents a publishing partner with established agreements to share inventory and revenue based on assignments.

For more information, see [Add publishing partner assignments] (https://support.google.com/admanager/answer/7032752).

name

Identifier. The resource name of the [Partner][google.ads.admanager.v1.Partner]. Format: networks/{network_code}/partners/{partner_id}

Type

str

display_name

Required. The display name of the [Partner][google.ads.admanager.v1.Partner].

This field is a member of oneof _display_name.

Type

str

address

Optional. The address for the [Partner][google.ads.admanager.v1.Partner].

This value has a maximum length of 1024 characters.

This field is a member of oneof _address.

Type

str

email

Optional. The email for the [Partner][google.ads.admanager.v1.Partner].

This value has a maximum length of 128 characters.

This field is a member of oneof _email.

Type

str

fax

Optional. The fax number for the [Partner][google.ads.admanager.v1.Partner].

This value has a maximum length of 63 characters.

This field is a member of oneof _fax.

Type

str

phone

Optional. The phone number for the [Partner][google.ads.admanager.v1.Partner].

This value has a maximum length of 63 characters.

This field is a member of oneof _phone.

Type

str

external_id

Optional. The external ID for the [Partner][google.ads.admanager.v1.Partner].

This value has a maximum length of 255 characters.

This field is a member of oneof _external_id.

Type

str

comment

Optional. Comments about the [Partner][google.ads.admanager.v1.Partner].

This value has a maximum length of 1024 characters.

This field is a member of oneof _comment.

Type

str

applied_labels

Optional. The labels that are directly applied to the [Partner][google.ads.admanager.v1.Partner].

Type

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

primary_contact

Optional. The resource names of primary Contact of the [Partner][google.ads.admanager.v1.Partner]. 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 [Partner][google.ads.admanager.v1.Partner]. Format: “networks/{network_code}/teams/{team_id}”.

Type

MutableSequence[str]

update_time

Output only. The time the [Partner][google.ads.admanager.v1.Partner] was last updated.

Type

google.protobuf.timestamp_pb2.Timestamp

credit_status

Optional. The credit status of the [Partner][google.ads.admanager.v1.Partner].

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

This field is a member of oneof _credit_status.

Type

google.ads.admanager_v1.types.CompanyCreditStatusEnum.CompanyCreditStatus

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

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. Deprecated: Placement ID.

Type

int

display_name

Required. The display name of the placement. This attribute has a maximum length of 255 characters.

This field is a member of oneof _display_name.

Type

str

description

Optional. A description of the Placement. This attribute has a maximum length of 65,535 characters.

This field is a member of oneof _description.

Type

str

placement_code

Output only. A string used to uniquely identify the Placement for purposes of serving the ad. This attribute is assigned by Google.

This field is a member of oneof _placement_code.

Type

str

status

Output only. The status of the Placement.

This field is a member of oneof _status.

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}”.

Type

MutableSequence[str]

update_time

Output only. The instant this Placement was last modified.

This field is a member of oneof _update_time.

Type

google.protobuf.timestamp_pb2.Timestamp

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

Bases: proto.message.Message

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

class PlacementStatus(value)

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.PrefetchSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The information needed to prefetch ad requests for an ad break.

stage_one_ad_request_duration

Optional. The duration of the part of the break to be prefetched.

This field is a member of oneof _stage_one_ad_request_duration.

Type

google.protobuf.duration_pb2.Duration

class google.ads.admanager_v1.types.PrerollSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Settings for ad breaks on a livestream that are specific to preroll.

ad_tag

Required. The Ad Manager ad tag URL generated by the Ad Manager trafficking workflow that is associated with this live stream.

This field is a member of oneof _ad_tag.

Type

str

max_ad_pod_duration

Required. The maximum duration for an ad break.

This field is a member of oneof _max_ad_pod_duration.

Type

google.protobuf.duration_pb2.Duration

class google.ads.admanager_v1.types.PrivateAuction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The PrivateAuction resource.

name

Identifier. The resource name of the PrivateAuction. Format: networks/{network_code}/privateAuctions/{private_auction_id}

Type

str

private_auction_id

Output only. Deprecated: PrivateAuction ID.

This field is a member of oneof _private_auction_id.

Type

int

display_name

Required. Display name of the PrivateAuction. This attribute has a maximum length of 255 bytes.

This field is a member of oneof _display_name.

Type

str

description

Optional. Description of the PrivateAuction. This attribute has a maximum length of 4096 bytes.

This field is a member of oneof _description.

Type

str

seller_contact_users

Optional. The resource names of the seller contact users associated with this PrivateAuction. Format: networks/{network_code}/users/{user_id}

Type

MutableSequence[str]

archived

Output only. Whether the PrivateAuction is archived.

This field is a member of oneof _archived.

Type

bool

create_time

Output only. The instant at which the PrivateAuction was created.

This field is a member of oneof _create_time.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The instant at which the PrivateAuction was last updated.

This field is a member of oneof _update_time.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.ads.admanager_v1.types.PrivateAuctionDeal(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The PrivateAuctionDeal resource.

name

Identifier. The resource name of the PrivateAuctionDeal. Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}

Type

str

private_auction_deal_id

Output only. Deprecated: PrivateAuctionDeal ID.

This field is a member of oneof _private_auction_deal_id.

Type

int

private_auction_id

Immutable. The ID of the PrivateAuction.

This field is a member of oneof _private_auction_id.

Type

int

private_auction_display_name

Output only. The display name of the PrivateAuction.

This field is a member of oneof _private_auction_display_name.

Type

str

buyer_account_id

Immutable. The account ID of the buyer of the PrivateAuctionDeal.

This field is a member of oneof _buyer_account_id.

Type

int

external_deal_id

Output only. The external ID of the PrivateAuctionDeal.

This field is a member of oneof _external_deal_id.

Type

int

targeting

Optional. The targeting of the PrivateAuctionDeal.

This field is a member of oneof _targeting.

Type

google.ads.admanager_v1.types.Targeting

end_time

Optional. The end time of the PrivateAuctionDeal.

This field is a member of oneof _end_time.

Type

google.protobuf.timestamp_pb2.Timestamp

floor_price

Required. The floor price of the PrivateAuctionDeal.

This field is a member of oneof _floor_price.

Type

google.type.money_pb2.Money

creative_sizes

Optional. The expected creative sizes of the PrivateAuctionDeal.

Type

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

status

Output only. The status of the PrivateAuctionDeal.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.PrivateMarketplaceDealStatusEnum.PrivateMarketplaceDealStatus

auction_priority_enabled

Optional. Whether the deal is enabled with priority over open auction.

This field is a member of oneof _auction_priority_enabled.

Type

bool

block_override_enabled

Optional. Whether the deal has block override enabled.

This field is a member of oneof _block_override_enabled.

Type

bool

buyer_permission_type

Optional. The buyer permission model defining how the deal would transact among all buyers under the same bidder.

This field is a member of oneof _buyer_permission_type.

Type

google.ads.admanager_v1.types.DealBuyerPermissionTypeEnum.DealBuyerPermissionType

buyer_data

Optional. The buyer data required by the Marketplace API.

This field is a member of oneof _buyer_data.

Type

google.ads.admanager_v1.types.PrivateAuctionDeal.BuyerData

deal_priority

Optional. The priority of the deal across all non-guaranteed deals.

This field is a member of oneof _deal_priority.

Type

google.ads.admanager_v1.types.NonGuaranteedDealPriority

create_time

Output only. The instant at which the PrivateAuctionDeal was created.

This field is a member of oneof _create_time.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The instant at which the PrivateAuctionDeal was last updated.

This field is a member of oneof _update_time.

Type

google.protobuf.timestamp_pb2.Timestamp

class BuyerData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains buyer data. This data is required by the Marketplace API.

buyer_emails

Optional. The email contacts of the buyer of the PrivateAuctionDeal.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.PrivateMarketplaceDealStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [PrivateMarketplaceDealStatus][google.ads.admanager.v1.PrivateMarketplaceDealStatusEnum.PrivateMarketplaceDealStatus].

class PrivateMarketplaceDealStatus(value)

Bases: proto.enums.Enum

Describes the status of a private marketplace deal.

Values:

PRIVATE_MARKETPLACE_DEAL_STATUS_UNSPECIFIED (0):

No value specified.

PENDING (1):

The deal is pending.

ACTIVE (2):

The deal is active.

CANCELED (3):

The deal is canceled.

SELLER_PAUSED (4):

The deal is paused by the seller.

BUYER_PAUSED (5):

The deal is paused by the buyer.

COMPLETED (6):

The deal is past its end date.

class google.ads.admanager_v1.types.ProgrammaticBuyer(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a programmatic buyer.

name

Identifier. The resource name of the ProgrammaticBuyer. Format: networks/{network_code}/programmaticBuyers/{buyer_account_id}

Type

str

buyer_account_id

Output only. The buyer account ID of the buyer.

This field is a member of oneof _buyer_account_id.

Type

int

display_name

Output only. The display name of the buyer.

This field is a member of oneof _display_name.

Type

str

parent_account_id

Output only. The ID of the programmatic buyer’s sponsor. If the buyer has no sponsor, this field will be -1.

This field is a member of oneof _parent_account_id.

Type

int

partner_client_id

Output only. ID of the Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID.

This field is a member of oneof _partner_client_id.

Type

str

agency

Output only. Whether the buyer is an advertising agency.

This field is a member of oneof _agency.

Type

bool

preferred_deals_enabled

Output only. Whether the buyer is enabled for preferred deals.

This field is a member of oneof _preferred_deals_enabled.

Type

bool

programmatic_guaranteed_enabled

Output only. Whether the buyer is enabled for programmatic guaranteed deals.

This field is a member of oneof _programmatic_guaranteed_enabled.

Type

bool

class google.ads.admanager_v1.types.ReachPartnerEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ReachPartner][google.ads.admanager.v1.ReachPartnerEnum.ReachPartner]

class ReachPartner(value)

Bases: proto.enums.Enum

Possible options for third-party reach integration.

Values:

REACH_PARTNER_UNSPECIFIED (0):

Default value. This value is unused.

AUDIENCE_PROJECT (1):

Indicates third-party reach integration partner Audience Project

COMSCORE (2):

Indicates third-party reach integration partner Comscore.

GEMIUS (3):

Indicates third-party reach integration partner Gemius.

ISPOT_TV (5):

Indicates third-party reach integration partner iSpot.TV

KANTAR_MILLWARD_BROWN (6):

Indicates third-party reach integration partner Kantar.

NIELSEN (7):

Indicates third-party reach integration partner Nielsen.

NONE (8):

Indicates there’s no third-party reach integration partner.

VIDEO_AMP (9):

Indicates third-party reach integration partner VideoAmp

VIDEO_RESEARCH (10):

Indicates third-party reach integration partner Video Research.

class google.ads.admanager_v1.types.RefreshRateTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [RefreshRateType][google.ads.admanager.v1.RefreshRateTypeEnum.RefreshRateType]

class RefreshRateType(value)

Bases: proto.enums.Enum

Represents the refresh rate control type for an ad unit. New values may be added in the future.

Values:

REFRESH_RATE_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

DISABLED (1):

Indicates refresh is disabled.

OPTIMIZED (2):

Represents the Google optimized refresh rate.

FIXED_INTERVAL (3):

Represents a fixed interval refresh rate.

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

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.ReportVisibilityEnum.ReportVisibility

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’t be modified.

Type

str

schedule_options

Optional. The schedule options of this report.

Type

google.ads.admanager_v1.types.ScheduleOptions

class google.ads.admanager_v1.types.ReportDataTable(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A table containing report data including dimension and metric values.

class MetricValueGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.ReportValue]

primary_percent_of_total_values

Data for the PRIMARY_PERCENT_OF_TOTAL MetricValueType.

Type

MutableSequence[google.ads.admanager_v1.types.ReportValue]

comparison_values

Data for the COMPARISON MetricValueType.

Type

MutableSequence[google.ads.admanager_v1.types.ReportValue]

comparison_percent_of_total_values

Data for the COMPARISON_PERCENT_OF_TOTAL MetricValueType.

Type

MutableSequence[google.ads.admanager_v1.types.ReportValue]

absolute_change_values

Data for the ABSOLUTE_CHANGE MetricValueType.

Type

MutableSequence[google.ads.admanager_v1.types.ReportValue]

relative_change_values

Data for the RELATIVE_CHANGE MetricValueType.

Type

MutableSequence[google.ads.admanager_v1.types.ReportValue]

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)

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.ReportValue]

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.ReportDataTable.MetricValueGroup]

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

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.ReportDefinition.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.ReportDefinition.Metric]

filters

Optional. The filters for this report.

Type

MutableSequence[google.ads.admanager_v1.types.ReportDefinition.Filter]

time_zone_source

Optional. Where to get the time zone for this report. Defaults to using the network time zone setting (PUBLISHER). If source is PROVIDED, the time_zone field in the report definition must also set a time zone.

Type

google.ads.admanager_v1.types.ReportDefinition.TimeZoneSource

time_zone

Optional. If time_zone_source is PROVIDED, this is the time zone to use for this report. Leave empty for any other time zone source. Time zone in IANA format. For example, “America/New_York”.

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.ReportDefinition.DateRange

comparison_date_range

Optional. The comparison date range of this report. If unspecified, the report won’t have any comparison metrics.

This field is a member of oneof _comparison_date_range.

Type

google.ads.admanager_v1.types.ReportDefinition.DateRange

cms_metadata_dimension_key_ids

Optional. CMS Metadata Dimension keys that represent CMS_METADATA_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, cms_metadata_dimension_key_ids[0] describes CMS_METADATA_DIMENSION_0_VALUE_ID and CMS_METADATA_DIMENSION_0_VALUE.

Type

MutableSequence[int]

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]

ekv_dimension_key_ids

Optional. Enhanced Key-values Dimension keys that represent EKV_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, ekv_dimension_key_ids[0] describes EKV_DIMENSION_0_VALUE_ID and EKV_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.ReportDefinition.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.ReportDefinition.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.ReportDefinition.Flag]

sorts

Optional. Default sorts to apply to this report.

Type

MutableSequence[google.ads.admanager_v1.types.ReportDefinition.Sort]

expanded_compatibility

Optional. Whether to use expanded compatibility for this report. If true, this setting enables certain combinations of dimensions and metrics for this report that would otherwise be incompatible. Enabling this will collapse reservation data into a single row even if the report’s dimensions would normally result in multiple rows for reservation data. This impacts dimensions related to line items, orders, creatives, and advertisers.

This is equivalent to the “Access more dimension and metric combinations” setting in the Interactive Reports UI. For more details, see:

https://support.google.com/admanager/answer/16865393#combinations

Type

bool

class DateRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.ReportDefinition.DateRange.FixedDateRange

relative

A relative date range.

This field is a member of oneof date_range_type.

Type

google.ads.admanager_v1.types.ReportDefinition.DateRange.RelativeDateRange

class FixedDateRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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 in which the up to and including the day the report is run.

THIS_WEEK_TO_YESTERDAY (40):

From the beginning of the calendar week in which the report is run, up to and including the day before 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_MONTH_TO_YESTERDAY (41):

From the beginning of the calendar month in which the report is run, up to and including the day before 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_QUARTER_TO_YESTERDAY (42):

From the beginning of the calendar quarter in which the report is run, up to and including the day before 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.

THIS_YEAR_TO_YESTERDAY (43):

From the beginning of the calendar year in which the report is run, to up to and including the day before 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_WEEK_STARTING_SUNDAY (39):

The entire previous calendar week, Sunday to Saturday (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_93_DAYS (38):

The 93 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.

TOMORROW (30):

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

NEXT_90_DAYS (31):

The 90 days following the day the report is run.

NEXT_MONTH (32):

The entire calendar month following the calendar month the report is run.

NEXT_3_MONTHS (33):

The entire 3 calendar months following the calendar month the report is run.

NEXT_12_MONTHS (34):

The entire 12 calendar months following the calendar month the report is run.

NEXT_WEEK (35):

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

NEXT_QUARTER (36):

The entire calendar quarter following the calendar quarter the report is run.

TO_END_OF_NEXT_MONTH (37):

From the date a day after the date that the report is run, to the end of the calendar month following the calendar month the report is run.

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

Bases: proto.enums.Enum

Reporting dimensions.

Values:

DIMENSION_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE_VIEW_MEASUREMENT_SOURCE (575):

The measurement source of a video ad.

Corresponds to “Active View measurement source value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

ACTIVE_VIEW_MEASUREMENT_SOURCE_NAME (576):

Active View measurement source localized name.

Corresponds to “Active View measurement source” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

ADVERTISER_CREDIT_STATUS (475):

Advertiser credit status ENUM

Corresponds to “Advertiser credit status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: ENUM

ADVERTISER_CREDIT_STATUS_NAME (476):

Advertiser credit status localized name

Corresponds to “Advertiser credit status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: STRING

ADVERTISER_DOMAIN_NAME (242):

The domain name of the advertiser.

Corresponds to “Landing page domain” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

ADVERTISER_EXTERNAL_ID (228):

The ID used in an external system for advertiser identification

Corresponds to “Advertiser external ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

ADVERTISER_ID (131):

The ID of an advertiser company assigned to an order

Corresponds to “Advertiser ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: IDENTIFIER

ADVERTISER_LABELS (230):

Labels applied to the advertiser can be used for either competitive exclusion or ad exclusion

Corresponds to “Advertiser labels” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING_LIST

ADVERTISER_LABEL_IDS (229):

Label ids applied to the advertiser can be used for either competitive exclusion or ad exclusion

Corresponds to “Advertiser label IDs” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: IDENTIFIER_LIST

ADVERTISER_NAME (132):

The name of an advertiser company assigned to an order

Corresponds to “Advertiser” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: STRING

ADVERTISER_PRIMARY_CONTACT (227):

The name of the contact associated with an advertiser company

Corresponds to “Advertiser primary contact” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

ADVERTISER_STATUS (471):

Advertiser status ENUM

Corresponds to “Advertiser status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

ADVERTISER_STATUS_NAME (472):

Advertiser status localized name

Corresponds to “Advertiser status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

ADVERTISER_TYPE (473):

Advertiser type ENUM

Corresponds to “Advertiser type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: ENUM

ADVERTISER_TYPE_NAME (474):

Advertiser type localized name

Corresponds to “Advertiser type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: STRING

ADVERTISER_VERTICAL (580):

The category of an advertiser, such as Arts & Entertainment or Travel & Tourism.

Corresponds to “Advertiser vertical” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

ADX_PRODUCT (499):

Classification of different Ad Exchange products.

Corresponds to “Ad Exchange product value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REVENUE_VERIFICATION

Data format: ENUM

ADX_PRODUCT_NAME (500):

Localized name of the classification of different Ad Exchange products.

Corresponds to “Ad Exchange product” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REVENUE_VERIFICATION

Data format: STRING

AD_EXPERIENCES_TYPE (641):

Ad experiences type.

Corresponds to “Ad experiences value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

AD_EXPERIENCES_TYPE_NAME (642):

Localized name of the Ad experiences type.

Corresponds to “Ad experiences” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

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.

Corresponds to “Ad location value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

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.

Corresponds to “Ad location” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

AD_REQUEST_SIZES (541):

Multi-size inventory in an ad request.

Corresponds to “Ad request sizes” in the Ad Manager UI.

Compatible with the following report types: FUTURE_SELL_THROUGH

Data format: STRING_LIST

AD_TECHNOLOGY_PROVIDER_DOMAIN (620):

The domain of the ad technology provider associated with the bid.

Corresponds to “Ad technology provider domain” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

AD_TECHNOLOGY_PROVIDER_ID (621):

The ID of the ad technology provider associated with the bid.

Corresponds to “Ad technology provider ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

AD_TECHNOLOGY_PROVIDER_NAME (622):

The name of the ad technology provider associated with the bid.

Corresponds to “Ad technology provider” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

AD_TYPE (497):

Segmentation of ad types.

Corresponds to “Ad type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

AD_TYPE_NAME (498):

Localized name of the ad type.

Corresponds to “Ad type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

AD_UNIT_CODE (64):

The code of the ad unit where the ad was requested.

Corresponds to “Ad unit code” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO, REACH

Data format: STRING

AD_UNIT_CODE_LEVEL_1 (65):

The code of the first level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 1” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_10 (74):

The code of the tenth level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 10” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_11 (75):

The code of the eleventh level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 11” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_12 (76):

The code of the twelfth level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 12” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_13 (77):

The code of the thirteenth level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 13” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_14 (78):

The code of the fourteenth level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 14” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_15 (79):

The code of the fifteenth level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 15” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_16 (80):

The code of the sixteenth level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 16” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_2 (66):

The code of the second level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 2” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_3 (67):

The code of the third level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 3” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_4 (68):

The code of the fourth level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 4” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_5 (69):

The code of the fifth level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 5” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_6 (70):

The code of the sixth level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 6” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_7 (71):

The code of the seventh level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 7” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_8 (72):

The code of the eighth level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 8” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_CODE_LEVEL_9 (73):

The code of the ninth level ad unit of the ad unit where the ad was requested.

Corresponds to “Ad unit code level 9” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_ID (25):

The ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO, REACH, ADS_TRAFFIC_NAVIGATOR, ON_PLATFORM_MULTICALL

Data format: IDENTIFIER

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.

Corresponds to “Ad unit ID (all levels)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO, REACH, ADS_TRAFFIC_NAVIGATOR, ON_PLATFORM_MULTICALL

Data format: IDENTIFIER_LIST

AD_UNIT_ID_LEVEL_1 (30):

The first level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 1” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_10 (48):

The tenth level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 10” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_11 (50):

The eleventh level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 11” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_12 (52):

The twelfth level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 12” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_13 (54):

The thirteenth level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 13” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_14 (56):

The fourteenth level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 14” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_15 (58):

The fifteenth level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 15” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_16 (60):

The sixteenth level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 16” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_2 (32):

The second level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 2” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_3 (34):

The third level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 3” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_4 (36):

The fourth level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 4” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_5 (38):

The fifth level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 5” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_6 (40):

The sixth level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 6” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_7 (42):

The seventh level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 7” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_8 (44):

The eighth level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 8” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_LEVEL_9 (46):

The ninth level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID level 9” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: IDENTIFIER

AD_UNIT_ID_TOP_LEVEL (142):

The top-level ad unit ID of the ad unit where the ad was requested.

Corresponds to “Ad unit ID (top level)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO, ADS_TRAFFIC_NAVIGATOR, ON_PLATFORM_MULTICALL

Data format: IDENTIFIER

AD_UNIT_NAME (26):

The name of the ad unit where the ad was requested.

Corresponds to “Ad unit” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO, REACH, ADS_TRAFFIC_NAVIGATOR, ON_PLATFORM_MULTICALL

Data format: STRING

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.

Corresponds to “Ad unit (all levels)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO, REACH, ADS_TRAFFIC_NAVIGATOR, ON_PLATFORM_MULTICALL

Data format: STRING_LIST

AD_UNIT_NAME_LEVEL_1 (31):

The first level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 1” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_10 (49):

The tenth level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 10” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_11 (51):

The eleventh level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 11” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_12 (53):

The twelfth level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 12” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_13 (55):

The thirteenth level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 13” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_14 (57):

The fourteenth level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 14” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_15 (59):

The fifteenth level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 15” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_16 (61):

The sixteenth level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 16” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_2 (33):

The second level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 2” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_3 (35):

The third level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 3” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_4 (37):

The fourth level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 4” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_5 (39):

The fifth level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 5” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_6 (41):

The sixth level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 6” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_7 (43):

The seventh level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 7” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_8 (45):

The eighth level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 8” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_LEVEL_9 (47):

The ninth level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit level 9” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AD_UNIT_NAME_TOP_LEVEL (143):

The top-level ad unit name of the ad unit where the ad was requested.

Corresponds to “Ad unit (top level)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO, ADS_TRAFFIC_NAVIGATOR, ON_PLATFORM_MULTICALL

Data format: STRING

AD_UNIT_REWARD_AMOUNT (63):

The reward amount of the ad unit where the ad was requested.

Corresponds to “Ad unit reward amount” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED, REACH

Data format: INTEGER

AD_UNIT_REWARD_TYPE (62):

The reward type of the ad unit where the ad was requested.

Corresponds to “Ad unit reward type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED, REACH

Data format: STRING

AD_UNIT_STATUS (206):

The status of the ad unit

Corresponds to “Ad unit status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: ENUM

Values: [AdUnitStatus][google.ads.admanager.v1.AdUnitStatusEnum.AdUnitStatus]

AD_UNIT_STATUS_NAME (207):

The name of the status of the ad unit

Corresponds to “Ad unit status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

AGENCY_LEVEL_1_ID (565):

The ID of an agency at level 1 of agency hierarchy.

Corresponds to “Agency ID (Level 1)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

AGENCY_LEVEL_1_NAME (566):

The name of an agency at level 1 of agency hierarchy.

Corresponds to “Agency (Level 1)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

AGENCY_LEVEL_2_ID (567):

The ID of an agency at level 2 of agency hierarchy.

Corresponds to “Agency ID (Level 2)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

AGENCY_LEVEL_2_NAME (568):

The name of an agency at level 2 of agency hierarchy.

Corresponds to “Agency (Level 2)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

AGENCY_LEVEL_3_ID (569):

The ID of an agency at level 3 of agency hierarchy.

Corresponds to “Agency ID (Level 3)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

AGENCY_LEVEL_3_NAME (570):

The name of an agency at level 3 of agency hierarchy.

Corresponds to “Agency (Level 3)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

AGE_BRACKET (508):

User age bracket enum.

Corresponds to “Age bracket value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

AGE_BRACKET_NAME (582):

Localized user age bracket returned from Google Analytics. For example, “18-24”, “25-34”, “35-44”, “45-54”, “55-64”, “65+”.

Corresponds to “Age bracket” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

ANALYTICS_PROPERTY_ID (733):

Property ID in Google Analytics

Corresponds to “Analytics property ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

ANALYTICS_PROPERTY_NAME (767):

Property name in Google Analytics

Corresponds to “Analytics property” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

APP_TRACKING_TRANSPARENCY_CONSENT_STATUS (442):

Enum value for App Tracking Transparency consent status.

Corresponds to “App Tracking Transparency consent status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

APP_TRACKING_TRANSPARENCY_CONSENT_STATUS_NAME (443):

Localized string value for App Tracking Transparency consent status.

Corresponds to “App Tracking Transparency consent status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

APP_VERSION (392):

The app version.

Corresponds to “App version” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

AUCTION_PACKAGE_DEAL (579):

The name of Auction Package deal

Corresponds to “Auction package deal” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

AUCTION_PACKAGE_DEAL_ID (571):

The ID of Auction Package deal

Corresponds to “Auction package deal ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

AUDIENCE_SEGMENT_BILLABLE (594):

Name of billable audience segment.

Corresponds to “Audience segment (billable)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

AUDIENCE_SEGMENT_DATA_PROVIDER_ID (613):

ID of the data provider for the audience segment.

Corresponds to “Audience segment data provider ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

AUDIENCE_SEGMENT_DATA_PROVIDER_NAME (614):

Name of the data provider for the audience segment.

Corresponds to “Audience segment data provider” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

AUDIENCE_SEGMENT_ID_BILLABLE (595):

ID of billable audience segment.

Corresponds to “Audience segment ID (billable)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

AUDIENCE_SEGMENT_ID_TARGETED (584):

ID of targeted audience segment, including all first-party and third-party segments that matched the user on the winning line item.

Corresponds to “Audience segment ID (targeted)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: IDENTIFIER

AUDIENCE_SEGMENT_TARGETED (585):

Name of targeted audience segment, including all first-party and third-party segments that matched the user on the winning line item.

Corresponds to “Audience segment (targeted)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: STRING

AUDIENCE_SEGMENT_TARGETED_AD_ID_USER_SIZE (605):

Number of AdID identifiers in the audience segment.

Corresponds to “Audience segment (targeted) AdID size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

AUDIENCE_SEGMENT_TARGETED_AMAZON_FIRE_USER_SIZE (606):

Number of Amazon Fire identifiers in the audience segment.

Corresponds to “Audience segment (targeted) Amazon Fire size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

AUDIENCE_SEGMENT_TARGETED_ANDROID_TV_USER_SIZE (607):

Number of Android TV identifiers in the audience segment.

Corresponds to “Audience segment (targeted) Android TV size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

AUDIENCE_SEGMENT_TARGETED_APPLE_TV_USER_SIZE (608):

Number of Apple TV identifiers in the audience segment.

Corresponds to “Audience segment (targeted) Apple TV size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

AUDIENCE_SEGMENT_TARGETED_IDFA_USER_SIZE (609):

Number of IDFA identifiers in the audience segment.

Corresponds to “Audience segment (targeted) IDFA size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

AUDIENCE_SEGMENT_TARGETED_MOBILE_WEB_USER_SIZE (610):

Number of mobile web identifiers in the audience segment.

Corresponds to “Audience segment (targeted) mobile web size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

AUDIENCE_SEGMENT_TARGETED_PLAYSTATION_USER_SIZE (611):

Number of PlayStation identifiers in the audience segment.

Corresponds to “Audience segment (targeted) PlayStation size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

AUDIENCE_SEGMENT_TARGETED_PPID_USER_SIZE (612):

Number of PPID identifiers in the audience segment.

Corresponds to “Audience segment (targeted) PPID size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

AUDIENCE_SEGMENT_TARGETED_ROKU_USER_SIZE (615):

Number of Roku identifiers in the audience segment.

Corresponds to “Audience segment (targeted) Roku size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

AUDIENCE_SEGMENT_TARGETED_SAMSUNG_TV_USER_SIZE (616):

Number of Samsung TV identifiers in the audience segment.

Corresponds to “Audience segment (targeted) Samsung TV size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

AUDIENCE_SEGMENT_TARGETED_SIZE (618):

Number of identifiers in the audience segment.

Corresponds to “Audience segment (targeted) size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

AUDIENCE_SEGMENT_TARGETED_STATUS (628):

Status of the audience segment.

Corresponds to “Audience segment (targeted) status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: ENUM

AUDIENCE_SEGMENT_TARGETED_STATUS_NAME (617):

Name of the status of the audience segment.

Corresponds to “Audience segment (targeted) status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: STRING

AUDIENCE_SEGMENT_TARGETED_XBOX_USER_SIZE (619):

Number of Xbox identifiers in the audience segment.

Corresponds to “Audience segment (targeted) Xbox size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

AUTO_REFRESHED_TRAFFIC (421):

Enum value of Auto refreshed traffic.

Corresponds to “Auto refreshed traffic value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

AUTO_REFRESHED_TRAFFIC_NAME (422):

Indicates if the traffic is from auto-refreshed ad requests.

Corresponds to “Auto refreshed traffic” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

BIDDER_ENCRYPTED_ID (493):

The encrypted version of BIDDER_ID.

Corresponds to “Bidder encrypted ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REVENUE_VERIFICATION, ADS_TRAFFIC_NAVIGATOR

Data format: STRING

BIDDER_NAME (494):

The name of the bidder.

Corresponds to “Bidder” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REVENUE_VERIFICATION, ADS_TRAFFIC_NAVIGATOR

Data format: STRING

BID_RANGE (679):

The cpm range within which a bid falls.

Corresponds to “Bid Range” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: BID_RANGE

BID_REJECTION_REASON (599):

The reason a bid was rejected.

Corresponds to “Bid rejection reason value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

BID_REJECTION_REASON_NAME (600):

The localized name of the reason a bid was rejected.

Corresponds to “Bid rejection reason” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

BRANDING_TYPE (383):

The amount of information about the Publisher’s page sent to the buyer who purchased the impressions.

Corresponds to “Branding type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

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.

Corresponds to “Branding type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

BROWSER_CATEGORY (119):

Browser category.

Corresponds to “Browser category value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REACH, OFF_PROPERTY_CAMPAIGNS, ON_PLATFORM_MULTICALL

Data format: ENUM

BROWSER_CATEGORY_NAME (120):

Browser category name.

Corresponds to “Browser category” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH, OFF_PROPERTY_CAMPAIGNS, ON_PLATFORM_MULTICALL

Data format: STRING

BROWSER_ID (235):

The ID of the browser.

Corresponds to “Browser ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS, ON_PLATFORM_MULTICALL

Data format: IDENTIFIER

BROWSER_NAME (236):

The name of the browser.

Corresponds to “Browser” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS, ON_PLATFORM_MULTICALL

Data format: STRING

BUYER_NETWORK_ID (448):

The ID of the buyer network.

Corresponds to “Buyer network ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

BUYER_NETWORK_NAME (449):

The name of the buyer network.

Corresponds to “Buyer network” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CALLOUT_STATUS_CATEGORY_NAME (589):

The callout status category name in the Ads traffic navigator report.

Corresponds to “Callout status category” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: STRING

CARRIER_ID (369):

Mobile carrier ID.

Corresponds to “Carrier ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

CARRIER_NAME (368):

Name of the mobile carrier.

Corresponds to “Carrier” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CHANNEL (501):

Inventory segmentation by channel.

Corresponds to “Channel” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CHILD_NETWORK_CODE (542):

Child Publisher Network Code

Corresponds to “Child network code” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CHILD_NETWORK_ID (544):

Child Publisher Network ID

Corresponds to “Child network ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

CHILD_PARTNER_NAME (543):

Child Partner Network Name

Corresponds to “Child network” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CITY_ID (459):

The criteria ID of the city in which the ad served.

Corresponds to “City ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED, OFF_PROPERTY_CAMPAIGNS

Data format: IDENTIFIER

CITY_NAME (452):

The name of the city in which the ad served.

Corresponds to “City” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED

Data format: STRING

CLASSIFIED_ADVERTISER_ID (133):

The ID of an advertiser, classified by Google, associated with a creative transacted

Corresponds to “Advertiser ID (classified)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED, REACH

Data format: IDENTIFIER

CLASSIFIED_ADVERTISER_NAME (134):

The name of an advertiser, classified by Google, associated with a creative transacted

Corresponds to “Advertiser (classified)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED, REACH

Data format: STRING

CLASSIFIED_BRAND_ID (243):

ID of the brand, as classified by Google,

Corresponds to “Brand ID (classified)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED

Data format: IDENTIFIER

CLASSIFIED_BRAND_NAME (244):

Name of the brand, as classified by Google,

Corresponds to “Brand (classified)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED

Data format: STRING

CONTENT_BUNDLE_ID (460):

ID of the video content bundle served.

Corresponds to “Content bundle ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, YOUTUBE_CONSOLIDATED

Data format: IDENTIFIER

CONTENT_BUNDLE_NAME (461):

Name of the video content bundle served.

Corresponds to “Content bundle” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, YOUTUBE_CONSOLIDATED

Data format: STRING

CONTENT_CMS_METADATA_KV_NAMESPACE_ID (462):

ID of the video content metadata namespace served.

Corresponds to “CMS metadata key ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, YOUTUBE_CONSOLIDATED

Data format: IDENTIFIER

CONTENT_CMS_METADATA_KV_NAMESPACE_NAME (463):

Name of the video content metadata namespace served.

Corresponds to “CMS metadata key” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, YOUTUBE_CONSOLIDATED

Data format: STRING

CONTENT_CMS_NAME (643):

The display name of the CMS content.

Corresponds to “Content source name” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, YOUTUBE_CONSOLIDATED

Data format: STRING

CONTENT_CMS_VIDEO_ID (644):

The CMS content ID of the video content.

Corresponds to “ID of the video in the content source” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, YOUTUBE_CONSOLIDATED

Data format: STRING

CONTENT_ID (246):

ID of the video content served.

Corresponds to “Content ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, YOUTUBE_CONSOLIDATED

Data format: IDENTIFIER

CONTENT_MAPPING_PRESENCE (731):

Content mapping presence ENUM value

Corresponds to “Content mapping presence value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

CONTENT_MAPPING_PRESENCE_NAME (732):

Content mapping presence name

Corresponds to “Content mapping presence” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CONTENT_NAME (247):

Name of the video content served.

Corresponds to “Content” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, YOUTUBE_CONSOLIDATED

Data format: STRING

CONTINENT (469):

The continent in which the ad served (derived from country).

Corresponds to “Continent value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

CONTINENT_NAME (470):

The name of the continent in which the ad served (derived from country).

Corresponds to “Continent” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

COUNTRY_CODE (466):

The ISO code of the country in which the ad served.

Corresponds to “Country code” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, PRIVACY_AND_MESSAGING, AD_SPEED, YOUTUBE_CONSOLIDATED, ON_PLATFORM_MULTICALL

Data format: STRING

COUNTRY_ID (11):

The criteria ID of the country in which the ad served.

Corresponds to “Country ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, PRIVACY_AND_MESSAGING, AD_SPEED, YOUTUBE_CONSOLIDATED, OFF_PROPERTY_CAMPAIGNS, ADS_TRAFFIC_NAVIGATOR, ON_PLATFORM_MULTICALL

Data format: IDENTIFIER

COUNTRY_NAME (12):

The name of the country in which the ad served.

Corresponds to “Country” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, PRIVACY_AND_MESSAGING, AD_SPEED, YOUTUBE_CONSOLIDATED, OFF_PROPERTY_CAMPAIGNS, ADS_TRAFFIC_NAVIGATOR, ON_PLATFORM_MULTICALL

Data format: STRING

CREATIVE_BILLING_TYPE (366):

Enum value of creative billing type

Corresponds to “Creative billing type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

CREATIVE_BILLING_TYPE_NAME (367):

Localized string value of creative billing type

Corresponds to “Creative billing type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CREATIVE_CLICK_THROUGH_URL (174):

Represents the click-through URL of a creative

Corresponds to “Creative click through url” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CREATIVE_ID (138):

The ID of a creative

Corresponds to “Creative ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED, REAL_TIME_VIDEO, OFF_PROPERTY_CAMPAIGNS

Data format: IDENTIFIER

CREATIVE_NAME (139):

Creative name

Corresponds to “Creative” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED, REAL_TIME_VIDEO, OFF_PROPERTY_CAMPAIGNS

Data format: STRING

CREATIVE_OR_CREATIVE_SET (682):

ENUM describing whether the creative is part of a creative set or a normal creative.

Corresponds to “Creative or creative set value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REAL_TIME_VIDEO

Data format: ENUM

CREATIVE_OR_CREATIVE_SET_NAME (683):

Localized string name of whether the creative is part of a creative set or a normal creative.

Corresponds to “Creative or creative set” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REAL_TIME_VIDEO

Data format: STRING

CREATIVE_POLICIES_FILTERING (711):

Creative Policies filtering.

Corresponds to “Creative policies filtering value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

CREATIVE_POLICIES_FILTERING_NAME (712):

Localized name of the Creative Policies filtering.

Corresponds to “Creative policies filtering” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CREATIVE_PROTECTIONS_FILTERING (704):

Creative Protections filtering.

Corresponds to “Creative protections filtering value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

CREATIVE_PROTECTIONS_FILTERING_NAME (705):

Localized name of the Creative Protections filtering.

Corresponds to “Creative protections filtering” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CREATIVE_SET_ROLE_TYPE (686):

ENUM describing whether the creative is part of a creative set and if so, what its role in the creative set is.

Corresponds to “Creative set role type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

CREATIVE_SET_ROLE_TYPE_NAME (687):

Localized name describing whether the creative is part of a creative set and if so, what its role in the creative set is.

Corresponds to “Creative set role type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CREATIVE_SSL_COMPLIANCE_OVERRIDE (784):

Whether the creative has an SSL compliance override, and how the override has been set.

Corresponds to “Creative SSL compliance override value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

CREATIVE_SSL_COMPLIANCE_OVERRIDE_NAME (786):

Localized name of the creative SSL compliance override.

Corresponds to “Creative SSL compliance override” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CREATIVE_SSL_SCAN_RESULT (785):

The result of an Ad Manager scan of the creative.

Corresponds to “Creative SSL scan result value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

CREATIVE_SSL_SCAN_RESULT_NAME (787):

Localized name of the creative SSL scan result.

Corresponds to “Creative SSL scan result” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CREATIVE_TARGET_AD_UNIT_SIZE (770):

The size of the ad unit that the creative is intended to occupy, such as “468 x 60”.

Corresponds to “Creative target ad unit size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED, REAL_TIME_VIDEO, OFF_PROPERTY_CAMPAIGNS

Data format: STRING

CREATIVE_TECHNOLOGY (148):

Creative technology ENUM

Corresponds to “Creative technology value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

CREATIVE_TECHNOLOGY_NAME (149):

Creative technology localized name

Corresponds to “Creative technology” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CREATIVE_THIRD_PARTY_VENDOR (361):

Third party vendor name of a creative

Corresponds to “Creative third party vendor” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CREATIVE_TYPE (344):

Enum value of creative type

Corresponds to “Creative type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, AD_SPEED

Data format: ENUM

CREATIVE_TYPE_NAME (345):

Localized string name of creative type

Corresponds to “Creative type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED

Data format: STRING

CREATIVE_VENDOR_ID (706):

Creative vendor ID.

Corresponds to “Creative vendor ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

CREATIVE_VENDOR_NAME (707):

Name of the Creative vendor.

Corresponds to “Creative vendor” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CREATIVE_VIDEO_REDIRECT_THIRD_PARTY (562):

The third party where Google Ad Manager was redirected for the creative, based on the domain.

Corresponds to “Creative video redirect third party” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CURATOR_ID (572):

The ID of a Curation partner

Corresponds to “Curation partner ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

CURATOR_NAME (573):

The name of a Curation partner

Corresponds to “Curation partner” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CUSTOM_EVENT_ID (737):

Custom event ID

Corresponds to “Custom event id” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

CUSTOM_EVENT_NAME (735):

Custom event name

Corresponds to “Custom event” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CUSTOM_EVENT_TYPE (736):

Custom event type

Corresponds to “Custom event type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

CUSTOM_EVENT_TYPE_NAME (738):

Localized name of the custom event type

Corresponds to “Custom event type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

CUSTOM_SPOT_ID (423):

The ID of an ad spot. An ad spot can be added to an ad break template, as well as directly targeted by a video line item.

Corresponds to “Custom spot ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

CUSTOM_SPOT_NAME (424):

The name of an ad spot. An ad spot can be added to an ad break template, as well as directly targeted by a video line item.

Corresponds to “Custom spot” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

DATE (3):

Breaks down reporting data by date.

Corresponds to “Date” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, PRIVACY_AND_MESSAGING, REVENUE_VERIFICATION, AD_SPEED, REAL_TIME_VIDEO, YOUTUBE_CONSOLIDATED, OFF_PROPERTY_CAMPAIGNS, ADS_TRAFFIC_NAVIGATOR, ON_PLATFORM_MULTICALL

Data format: DATE

DAY_OF_WEEK (4):

Breaks down reporting data by day of the week. Monday is 1 and 7 is Sunday.

Corresponds to “Day of week” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, PRIVACY_AND_MESSAGING, YOUTUBE_CONSOLIDATED, OFF_PROPERTY_CAMPAIGNS, ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

DEAL_BUYER_ID (240):

The ID of the buyer of a deal.

Corresponds to “Deal buyer ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

DEAL_BUYER_NAME (241):

The name of the buyer of a deal.

Corresponds to “Deal buyer” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

DEAL_ID (436):

Deal ID

Corresponds to “Deal ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, ADS_TRAFFIC_NAVIGATOR

Data format: STRING

DEAL_ID_ALL (781):

List of deal IDs found in a callout.

Corresponds to “Deal ID (all)” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: STRING_LIST

DEAL_NAME (437):

Deal name

Corresponds to “Deal” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, ADS_TRAFFIC_NAVIGATOR

Data format: STRING

DECLARED_ADVERTISER_DOMAIN (796):

The declared domain of the advertiser.

Corresponds to “Declared advertiser domain” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

DELIVERED_SECURE_SIGNAL_ID (309):

The ID of the secure signals that were sent to the bidder who won the impression.

Corresponds to “Secure signal ID (delivered)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

DELIVERED_SECURE_SIGNAL_NAME (310):

The name of the secure signals that were sent to the bidder who won the impression.

Corresponds to “Secure signal name (delivered)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

DEMAND_CHANNEL (9):

Demand channel.

Corresponds to “Demand channel value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REACH, REVENUE_VERIFICATION, AD_SPEED, ON_PLATFORM_MULTICALL

Data format: ENUM

DEMAND_CHANNEL_NAME (10):

Demand channel name.

Corresponds to “Demand channel” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH, REVENUE_VERIFICATION, AD_SPEED, ON_PLATFORM_MULTICALL

Data format: STRING

DEMAND_SOURCE (592):

Demand source.

Corresponds to “Demand source value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: ENUM

DEMAND_SOURCE_ALL (782):

List of demand sources found in a callout.

Corresponds to “Demand source (all)” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: STRING_LIST

DEMAND_SOURCE_NAME (593):

Demand source name.

Corresponds to “Demand source” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: STRING

DEMAND_SUBCHANNEL (22):

Demand subchannel.

Corresponds to “Demand subchannel value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

DEMAND_SUBCHANNEL_NAME (23):

Demand subchannel name.

Corresponds to “Demand subchannel” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

DEVICE (226):

The device on which an ad was served.

Corresponds to “Device value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

DEVICE_CATEGORY (15):

The device category to which an ad is being targeted.

Corresponds to “Device category value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, PRIVACY_AND_MESSAGING, AD_SPEED, REAL_TIME_VIDEO, OFF_PROPERTY_CAMPAIGNS, ON_PLATFORM_MULTICALL

Data format: ENUM

DEVICE_CATEGORY_NAME (16):

The name of the category of device (smartphone, feature phone, tablet, or desktop) to which an ad is being targeted.

Corresponds to “Device category” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, PRIVACY_AND_MESSAGING, AD_SPEED, REAL_TIME_VIDEO, OFF_PROPERTY_CAMPAIGNS, ON_PLATFORM_MULTICALL

Data format: STRING

DEVICE_MANUFACTURER_ID (525):

Device manufacturer ID

Corresponds to “Device manufacturer ID” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

DEVICE_MANUFACTURER_NAME (526):

Device manufacturer name

Corresponds to “Device manufacturer” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

DEVICE_MODEL_ID (527):

Device model ID

Corresponds to “Device model ID” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

DEVICE_MODEL_NAME (528):

Device model name

Corresponds to “Device model” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

DEVICE_NAME (225):

The localized name of the device on which an ad was served.

Corresponds to “Device” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

DSP_SEAT_ID (564):

The ID of DSP Seat

Corresponds to “DSP seat ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

DYNAMIC_ALLOCATION_TYPE (502):

Categorization of inventory sources based on AdX dynamic allocation backfill type.

Corresponds to “Dynamic allocation value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

DYNAMIC_ALLOCATION_TYPE_NAME (503):

Localized name of the dynamic allocation type.

Corresponds to “Dynamic allocation” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

ESP_DELIVERY (623):

Status of Encrypted Signals for Publishers delivery.

Corresponds to “Secure signal delivery value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

ESP_DELIVERY_NAME (624):

Localized name of the ESP delivery status.

Corresponds to “Secure signal delivery” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

ESP_PRESENCE (625):

Whether Encrypted Signals for Publishers are present on the ad request.

Corresponds to “Secure signal presence value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

ESP_PRESENCE_NAME (626):

Localized name of the ESP presence status.

Corresponds to “Secure signal presence” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

EXCHANGE_BIDDING_DEAL_ID (715):

Exchange bidding deal ID.

Corresponds to “Exchange bidding deal id” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

EXCHANGE_BIDDING_DEAL_TYPE (714):

Exchange bidding deal type.

Corresponds to “Exchange bidding deal type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

EXCHANGE_BIDDING_DEAL_TYPE_NAME (723):

Localized name of the exchange bidding deal type.

Corresponds to “Exchange bidding deal type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

EXCHANGE_THIRD_PARTY_COMPANY_ID (185):

ID of the yield partner as classified by Google

Corresponds to “Yield partner ID (classified)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

EXCHANGE_THIRD_PARTY_COMPANY_NAME (186):

Name of the yield partner as classified by Google

Corresponds to “Yield partner (classified)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

FIRST_LOOK_PRICING_RULE_ID (248):

The ID of the first look pricing rule.

Corresponds to “First look pricing rule ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

FIRST_LOOK_PRICING_RULE_NAME (249):

The name of the first look pricing rule.

Corresponds to “First look pricing rule” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

FIRST_PARTY_ID_STATUS (404):

Whether a first-party user identifier was present on a given ad-request.

Corresponds to “First-party ID status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

FIRST_PARTY_ID_STATUS_NAME (405):

The localized name of whether a first-party user identifier was present on a given ad-request.

Corresponds to “First-party ID status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

GENDER (509):

User gender enum value returned from Google Analytics.

Corresponds to “Gender value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

GENDER_NAME (583):

Localized user gender returned from Google Analytics. For example, “male”, “female”.

Corresponds to “Gender” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

GOOGLE_ANALYTICS_STREAM_ID (519):

The ID of a Google Analytics stream. For example, web site or mobile app

Corresponds to “Google Analytics stream ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

GOOGLE_ANALYTICS_STREAM_NAME (520):

The name of a Google Analytics stream. For example, web site or mobile app.

Corresponds to “Google Analytics stream” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

HBT_YIELD_PARTNER_ID (659):

The ID of the header bidding trafficking yield partner.

Corresponds to “Yield partner ID (header bidding trafficking)” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: IDENTIFIER

HBT_YIELD_PARTNER_NAME (660):

The name of the header bidding trafficking yield partner.

Corresponds to “Yield partner (header bidding trafficking)” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: STRING

HEADER_BIDDER_INTEGRATION_TYPE (718):

Header Bidder integration type.

Corresponds to “Header bidder integration type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

HEADER_BIDDER_INTEGRATION_TYPE_NAME (719):

Localized name of the Header Bidder integration type.

Corresponds to “Header bidder integration type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

HOUR (100):

Breaks down reporting data by hour in one day.

Corresponds to “Hour” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REAL_TIME_VIDEO, OFF_PROPERTY_CAMPAIGNS, ADS_TRAFFIC_NAVIGATOR, ON_PLATFORM_MULTICALL

Data format: INTEGER

IMPRESSION_COUNTING_METHOD (577):

Impression Counting Method ENUM.

Corresponds to “Impression counting method value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

IMPRESSION_COUNTING_METHOD_NAME (578):

Localized impression counting method name.

Corresponds to “Impression counting method” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

INTERACTION_TYPE (223):

The interaction type of an ad.

Corresponds to “Interaction type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

INTERACTION_TYPE_NAME (224):

The localized name of the interaction type of an ad.

Corresponds to “Interaction type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

INTEREST (510):

User interest returned from Google Analytics.

Corresponds to “Interests” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

INVENTORY_FORMAT (17):

Inventory format. The format of the ad unit (e.g, banner) where the ad was requested.

Corresponds to “Inventory format value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

INVENTORY_FORMAT_NAME (18):

Inventory format name. The format of the ad unit (e.g, banner) where the ad was requested.

Corresponds to “Inventory format” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

INVENTORY_SHARE_ASSIGNMENT_ID (648):

The ID of the inventory share assignment.

Corresponds to “Inventory share assignment ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

INVENTORY_SHARE_ASSIGNMENT_NAME (649):

The name of the inventory share assignment.

Corresponds to “Inventory share assignment” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

INVENTORY_SHARE_OUTCOME (603):

The result of an inventory share.

Corresponds to “Inventory share outcome value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

INVENTORY_SHARE_OUTCOME_NAME (604):

The localized name of the result of an inventory share.

Corresponds to “Inventory share outcome” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

INVENTORY_SHARE_PARTNER_AD_SERVER (652):

The partner ad server of the inventory share.

Corresponds to “Inventory share partner ad server value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

INVENTORY_SHARE_PARTNER_AD_SERVER_NAME (653):

The localized name of the partner ad server.

Corresponds to “Inventory share partner ad server” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

INVENTORY_SHARE_TARGET_SHARE_PERCENT (654):

The target share percent of the inventory share assignment

Corresponds to “Partner target share percent” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

INVENTORY_SHARE_TYPE (650):

The type of the inventory share.

Corresponds to “Inventory share type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

INVENTORY_SHARE_TYPE_NAME (651):

The localized name of the inventory share type.

Corresponds to “Inventory share type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

INVENTORY_TYPE (19):

Inventory type. The kind of web page or device where the ad was requested.

Corresponds to “Inventory type (expanded) value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS, ADS_TRAFFIC_NAVIGATOR

Data format: ENUM

INVENTORY_TYPE_NAME (20):

Inventory type name. The kind of web page or device where the ad was requested.

Corresponds to “Inventory type (expanded)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS, ADS_TRAFFIC_NAVIGATOR

Data format: STRING

IS_ADX_DIRECT (382):

Whether traffic is Adx Direct.

Corresponds to “Is AdX Direct” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: BOOLEAN

IS_CURATION_TARGETED (574):

If curation was targeted by the buyer when buying the impression

Corresponds to “Is curation targeted” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: BOOLEAN

IS_DROPPED (464):

Whether the query was dropped.

Corresponds to “Is Dropped” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: BOOLEAN

IS_FIRST_LOOK_DEAL (401):

Whether traffic is First Look.

Corresponds to “Is First Look” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: BOOLEAN

KEY_VALUES_ID (214):

The Custom Targeting Value ID

Corresponds to “Key-values ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH

Data format: IDENTIFIER

KEY_VALUES_NAME (215):

The Custom Targeting Value formatted like {keyName}={valueName}

Corresponds to “Key-values” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH

Data format: STRING

KEY_VALUES_SET (713):

The custom criteria key-values specified in ad requests.

Corresponds to “Key-values” in the Ad Manager UI.

Compatible with the following report types:

Data format: STRING_LIST

LANDING_PAGE_DOMAIN (242):

The landing page domain name of the advertiser. This will eventually replace ADVERTISER_DOMAIN_NAME.

LINE_ITEM_AGENCY (663):

The agency of the order associated with the line item.

Corresponds to “Line item agency” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

LINE_ITEM_ARCHIVED (188):

Whether a Line item is archived.

Corresponds to “Line item is archived” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: BOOLEAN

LINE_ITEM_AVERAGE_NUMBER_OF_VIEWERS (694):

The average number of viewers for the line item.

Corresponds to “Nielsen average number of viewers” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: DOUBLE

LINE_ITEM_COMPANION_DELIVERY_OPTION (204):

Line item companion delivery option ENUM value.

Corresponds to “Line item companion delivery option value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REACH

Data format: ENUM

Values: [LineItemCompanionDeliveryType][google.ads.admanager.v1.LineItemCompanionDeliveryTypeEnum.LineItemCompanionDeliveryType]

LINE_ITEM_COMPANION_DELIVERY_OPTION_NAME (205):

Localized line item companion delivery option name.

Corresponds to “Line item companion delivery option” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

LINE_ITEM_COMPUTED_STATUS (250):

The computed status of the LineItem.

Corresponds to “Line item computed status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: ENUM

Values: [LineItemComputedStatus][google.ads.admanager.v1.LineItemComputedStatusEnum.LineItemComputedStatus]

LINE_ITEM_COMPUTED_STATUS_NAME (251):

The localized name of the computed status of the LineItem.

Corresponds to “Line item computed status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

LINE_ITEM_CONTRACTED_QUANTITY (92):

The contracted units bought for the Line item.

Corresponds to “Line item contracted quantity” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: INTEGER

LINE_ITEM_COST_PER_UNIT (85):

The cost per unit of the Line item.

Corresponds to “Line item rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: MONEY

LINE_ITEM_COST_TYPE (212):

Line item cost type ENUM value.

Corresponds to “Line item cost type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: ENUM

Values: [LineItemCostType][google.ads.admanager.v1.LineItemCostTypeEnum.LineItemCostType]

LINE_ITEM_COST_TYPE_NAME (213):

Localized line item cost type name.

Corresponds to “Line item cost type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

LINE_ITEM_CREATIVE_END_DATE (176):

Represent the end date of a creative associated with line item

Corresponds to “Line item creative end date” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DATE

LINE_ITEM_CREATIVE_ROTATION_TYPE (189):

The creative rotation type of the LineItem.

Corresponds to “Line item creative rotation type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REACH

Data format: ENUM

Values: [CreativeRotationType][google.ads.admanager.v1.CreativeRotationTypeEnum.CreativeRotationType]

LINE_ITEM_CREATIVE_ROTATION_TYPE_NAME (190):

The localized name of the creative rotation type of the LineItem.

Corresponds to “Line item creative rotation type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

LINE_ITEM_CREATIVE_START_DATE (175):

Represent the start date of a creative associated with line item

Corresponds to “Line item creative start date” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DATE

LINE_ITEM_CURRENCY_CODE (180):

The 3 letter currency code of the Line Item

Corresponds to “Line item currency code” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

LINE_ITEM_DELIVERY_INDICATOR (87):

The progress made for the delivery of the Line item.

Corresponds to “Line item delivery indicator” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH, REAL_TIME_VIDEO

Data format: PERCENT

LINE_ITEM_DELIVERY_RATE_TYPE (191):

The delivery rate type of the LineItem.

Corresponds to “Line item delivery rate type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: ENUM

Values: [LineItemDeliveryRateType][google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType]

LINE_ITEM_DELIVERY_RATE_TYPE_NAME (192):

The localized name of the delivery rate type of the LineItem.

Corresponds to “Line item delivery rate type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

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.

Corresponds to “Line item discount (absolute)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: MONEY

LINE_ITEM_DISCOUNT_PERCENTAGE (196):

The discount of the LineItem in percentage.

Corresponds to “Line item discount (percentage)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: WHOLE_PERCENT

LINE_ITEM_END_DATE (81):

The end date of the Line item.

Corresponds to “Line item end date” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: DATE

LINE_ITEM_END_DATE_TIME (83):

The end date and time of the Line item.

Corresponds to “Line item end time” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: TIMESTAMP

LINE_ITEM_ENVIRONMENT_TYPE (201):

The ENUM value of the environment a LineItem is targeting.

Corresponds to “Line item environment type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REACH

Data format: ENUM

Values: [EnvironmentType][google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType]

LINE_ITEM_ENVIRONMENT_TYPE_NAME (202):

The localized name of the environment a LineItem is targeting.

Corresponds to “Line item environment type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

LINE_ITEM_EXTERNAL_DEAL_ID (97):

The deal ID of the Line item. Set for Programmatic Direct campaigns.

Corresponds to “Line item deal ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: IDENTIFIER

LINE_ITEM_EXTERNAL_ID (86):

The external ID of the Line item.

Corresponds to “Line item external ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

LINE_ITEM_FREQUENCY_CAP (256):

The frequency cap of the Line item (descriptive string).

Corresponds to “Line item frequency cap” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

LINE_ITEM_ID (1):

Line item ID.

Corresponds to “Line item ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO, OFF_PROPERTY_CAMPAIGNS, ADS_TRAFFIC_NAVIGATOR

Data format: IDENTIFIER

LINE_ITEM_LABELS (667):

Line item labels.

Corresponds to “Line item labels” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING_LIST

LINE_ITEM_LABEL_IDS (665):

Line item label IDs.

Corresponds to “Line item label IDs” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: IDENTIFIER_LIST

LINE_ITEM_LAST_MODIFIED_BY_APP (181):

The application that last modified the Line Item.

Corresponds to “Line item last modified by app” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

LINE_ITEM_LIFETIME_CLICKS (95):

The total number of clicks delivered of the lifetime of the Line item.

Corresponds to “Line item lifetime clicks” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: INTEGER

LINE_ITEM_LIFETIME_IMPRESSIONS (94):

The total number of impressions delivered over the lifetime of the Line item.

Corresponds to “Line item lifetime impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: INTEGER

LINE_ITEM_LIFETIME_VIEWABLE_IMPRESSIONS (96):

The total number of viewable impressions delivered over the lifetime of the Line item.

Corresponds to “Line item lifetime viewable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: INTEGER

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.

Corresponds to “Line item is makegood” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: BOOLEAN

LINE_ITEM_NAME (2):

Line item Name.

Corresponds to “Line item” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO, OFF_PROPERTY_CAMPAIGNS, ADS_TRAFFIC_NAVIGATOR

Data format: STRING

LINE_ITEM_NON_CPD_BOOKED_REVENUE (98):

The cost of booking for the Line item (non-CPD).

Corresponds to “Line item booked revenue (exclude CPD)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: MONEY

LINE_ITEM_OPTIMIZABLE (90):

Whether a Line item is eligible for optimization.

Corresponds to “Line item is optimizable” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: BOOLEAN

LINE_ITEM_PO_NUMBER (669):

The PO number of the order associated with the line item.

Corresponds to “Line item PO number” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

LINE_ITEM_PRIMARY_GOAL_TYPE (210):

Goal type ENUM value of the primary goal of the line item.

Corresponds to “Line item primary goal type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REACH

Data format: ENUM

Values: [GoalType][google.ads.admanager.v1.GoalTypeEnum.GoalType]

LINE_ITEM_PRIMARY_GOAL_TYPE_NAME (211):

Localized goal type name of the primary goal of the line item.

Corresponds to “Line item primary goal type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

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.

Corresponds to “Line item primary goal units (absolute)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: INTEGER

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.

Corresponds to “Line item primary goal units (percentage)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: WHOLE_PERCENT

LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE (208):

Unit type ENUM value of the primary goal of the line item.

Corresponds to “Line item primary goal unit type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REACH

Data format: ENUM

Values: [UnitType][google.ads.admanager.v1.UnitTypeEnum.UnitType]

LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE_NAME (209):

Localized unit type name of the primary goal of the line item.

Corresponds to “Line item primary goal unit type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

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.

Corresponds to “Line item priority” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: INTEGER

LINE_ITEM_RESERVATION_STATUS (304):

ENUM value describing the state of inventory reservation for the LineItem.

Corresponds to “Line item reservation status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REACH

Data format: ENUM

Values: [LineItemReservationStatus][google.ads.admanager.v1.LineItemReservationStatusEnum.LineItemReservationStatus]

LINE_ITEM_RESERVATION_STATUS_NAME (305):

Localized string describing the state of inventory reservation for the LineItem.

Corresponds to “Line item reservation status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

LINE_ITEM_SALESPERSON (671):

The sales person of the order associated with the line item.

Corresponds to “Line item salesperson” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

LINE_ITEM_SECONDARY_SALESPEOPLE (673):

The secondary sales people of the order associated with the line item.

Corresponds to “Line item secondary salespeople” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING_LIST

LINE_ITEM_SECONDARY_TRAFFICKERS (675):

The secondary traffickers of the order associated with the line item.

Corresponds to “Line item secondary traffickers” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING_LIST

LINE_ITEM_START_DATE (82):

The start date of the Line item.

Corresponds to “Line item start date” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: DATE

LINE_ITEM_START_DATE_TIME (84):

The start date and time of the Line item.

Corresponds to “Line item start time” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: TIMESTAMP

LINE_ITEM_TRAFFICKER (677):

The trafficker of the order associated with the line item.

Corresponds to “Line item trafficker” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

LINE_ITEM_TYPE (193):

Line item type ENUM value.

Corresponds to “Line item type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: ENUM

Values: [LineItemType][google.ads.admanager.v1.LineItemTypeEnum.LineItemType]

LINE_ITEM_TYPE_NAME (194):

Localized line item type name.

Corresponds to “Line item type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: STRING

LINE_ITEM_UNLIMITED_END (187):

Whether the Line item end time and end date is set to effectively never end.

Corresponds to “Line item is unlimited end time” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, REAL_TIME_VIDEO

Data format: BOOLEAN

LINE_ITEM_VALUE_COST_PER_UNIT (88):

The artificial cost per unit used by the Ad server to help rank inventory.

Corresponds to “Line item value cost per unit” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: MONEY

LINE_ITEM_WEB_PROPERTY_CODE (179):

The web property code used for dynamic allocation Line Items.

Corresponds to “Line item web property code” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

MASTER_COMPANION_CREATIVE_ID (140):

The ID of creative, includes regular creatives, and master and companions in case of creative sets

Corresponds to “Master and Companion creative ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

MASTER_COMPANION_CREATIVE_NAME (141):

Name of creative, includes regular creatives, and master and companions in case of creative sets

Corresponds to “Master and Companion creative” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

MEDIATION_TYPE (701):

Mediation type.

Corresponds to “Mediation type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

MEDIATION_TYPE_NAME (754):

Localized mediation type name.

Corresponds to “Mediation type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

MEDIATION_YIELD_PARTNER_ID (661):

The ID of the yield partner for Mediation.

Corresponds to “Yield partner ID (mediation)” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: IDENTIFIER

MEDIATION_YIELD_PARTNER_NAME (662):

The name of the yield partner for Mediation.

Corresponds to “Yield partner (mediation)” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: STRING

METRO_ID (453):

The criteria ID of the metro area in which the ad served.

Corresponds to “Metro ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED, OFF_PROPERTY_CAMPAIGNS

Data format: IDENTIFIER

METRO_NAME (454):

The name of the metro area in which the ad served.

Corresponds to “Metro” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED

Data format: STRING

MOBILE_APP_FREE (128):

Whether the mobile app is free.

Corresponds to “App is free” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: BOOLEAN

MOBILE_APP_ICON_URL (129):

URL of app icon for the mobile app.

Corresponds to “App icon URL” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: STRING

MOBILE_APP_ID (123):

The ID of the Mobile App.

Corresponds to “App ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, PRIVACY_AND_MESSAGING, OFF_PROPERTY_CAMPAIGNS

Data format: STRING

MOBILE_APP_NAME (127):

The name of the mobile app.

Corresponds to “App” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, PRIVACY_AND_MESSAGING, OFF_PROPERTY_CAMPAIGNS

Data format: STRING

MOBILE_APP_OWNERSHIP_STATUS (311):

Ownership status of the mobile app.

Corresponds to “App ownership status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

MOBILE_APP_OWNERSHIP_STATUS_NAME (312):

Ownership status of the mobile app.

Corresponds to “App ownership status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

MOBILE_APP_STORE (125):

The App Store of the mobile app.

Corresponds to “App store value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

MOBILE_APP_STORE_NAME (245):

The localized name of the mobile app store.

Corresponds to “App store” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

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.

Corresponds to “Inventory type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, PRIVACY_AND_MESSAGING, AD_SPEED, OFF_PROPERTY_CAMPAIGNS

Data format: ENUM

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.

Corresponds to “Inventory type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, PRIVACY_AND_MESSAGING, AD_SPEED, OFF_PROPERTY_CAMPAIGNS

Data format: STRING

MOBILE_RENDERING_SDK (646):

Mobile rendering SDK.

Corresponds to “Rendering SDK value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REVENUE_VERIFICATION

Data format: ENUM

MOBILE_RENDERING_SDK_NAME (647):

Localized name of the Mobile rendering SDK.

Corresponds to “Rendering SDK” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REVENUE_VERIFICATION

Data format: STRING

MOBILE_SDK_MAJOR_VERSION (692):

The major version of the mobile SDK.

Corresponds to “App SDK major version” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

MOBILE_SDK_MINOR_VERSION (693):

The minor version of the mobile SDK.

Corresponds to “App SDK minor version” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

MOBILE_SDK_VERSION_NAME (130):

SDK version of the mobile device.

Corresponds to “App SDK version” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

MONTH_YEAR (6):

Breaks down reporting data by month and year.

Corresponds to “Month and year” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, PRIVACY_AND_MESSAGING, REVENUE_VERIFICATION, PARTNER_FINANCE, YOUTUBE_CONSOLIDATED, OFF_PROPERTY_CAMPAIGNS, ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

NATIVE_AD_FORMAT_ID (255):

Native ad format ID.

Corresponds to “Native ad format ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

NATIVE_AD_FORMAT_NAME (254):

Native ad format name.

Corresponds to “Native ad format” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

NATIVE_STYLE_ID (253):

Native style ID.

Corresponds to “Native style ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

NATIVE_STYLE_NAME (252):

Native style name.

Corresponds to “Native style” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

NIELSEN_DEMOGRAPHICS (695):

Nielsen demographics (gender and age group).

Corresponds to “Nielsen Digital Ad Ratings demographics value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: REACH

Data format: ENUM

NIELSEN_DEMOGRAPHICS_NAME (768):

Name of the Nielsen demographics (gender and age group).

Corresponds to “Nielsen Digital Ad Ratings demographics” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: STRING

NIELSEN_DEVICE (696):

Nielsen device.

Corresponds to “Nielsen Digital Ad Ratings device value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: REACH

Data format: ENUM

NIELSEN_DEVICE_NAME (697):

Name of the Nielsen device.

Corresponds to “Nielsen Digital Ad Ratings device” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: STRING

NIELSEN_IN_TARGET (769):

Nielsen in target

Corresponds to “Nielsen in-target” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: BOOLEAN

NIELSEN_RESTATEMENT_DATE (698):

Data restatement date of Nielsen Digital Ad Ratings data.

Corresponds to “Nielsen Digital Ad Ratings restatement date” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: DATE

NIELSEN_SEGMENT (699):

Campaign date segment of Nielsen Digital Ad Ratings reporting.

Corresponds to “Nielsen Digital Ad Ratings segment” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: DATE_RANGE

NIELSEN_SITE_URL (700):

Site URL of Nielsen Digital Ad Ratings data.

Corresponds to “Nielsen Site URL” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: STRING

NO_FILL_REASON_CATEGORY_NAME (587):

No fill reason category name in the Ads traffic navigator report.

Corresponds to “No fill reason category” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: STRING

NUM_ADS_IN_POD (804):

Number of ads served in a pod response.

Corresponds to “Number of ads in pod” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

OPERATING_SYSTEM_CATEGORY (117):

Operating system category.

Corresponds to “Operating system category value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REACH

Data format: ENUM

OPERATING_SYSTEM_CATEGORY_NAME (118):

Operating system category name.

Corresponds to “Operating system category” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

OPERATING_SYSTEM_VERSION_ID (238):

ID of the operating system version.

Corresponds to “Operating system ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

OPERATING_SYSTEM_VERSION_NAME (237):

Details of the operating system, including version.

Corresponds to “Operating system” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

OPTIMIZATION_TYPE (639):

Enum value of the optimization type.

Corresponds to “Optimization type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

OPTIMIZATION_TYPE_NAME (640):

Localized name of the optimization type.

Corresponds to “Optimization type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

ORDER_AGENCY (150):

Order agency.

Corresponds to “Order agency” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

ORDER_AGENCY_ID (151):

Order agency ID.

Corresponds to “Order agency ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: IDENTIFIER

ORDER_BOOKED_CPC (152):

Order booked CPC.

Corresponds to “Order booked CPC” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: INTEGER

ORDER_BOOKED_CPM (153):

Order booked CPM.

Corresponds to “Order booked CPM” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: INTEGER

ORDER_DELIVERY_STATUS (231):

Order delivery status ENUM value.

Corresponds to “Order delivery status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

Values: [OrderDeliveryStatus][google.ads.admanager.v1.OrderDeliveryStatusEnum.OrderDeliveryStatus]

ORDER_DELIVERY_STATUS_NAME (239):

Order delivery status localized name.

Corresponds to “Order delivery status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

ORDER_END_DATE (154):

Order end date.

Corresponds to “Order end date” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: DATE

ORDER_END_DATE_TIME (155):

Order end date and time.

Corresponds to “Order end time” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: TIMESTAMP

ORDER_EXTERNAL_ID (156):

Order external ID.

Corresponds to “Order external ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: IDENTIFIER

ORDER_ID (7):

Order ID.

Corresponds to “Order ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, OFF_PROPERTY_CAMPAIGNS

Data format: IDENTIFIER

ORDER_LABELS (170):

Order labels.

Corresponds to “Order labels” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING_LIST

ORDER_LABEL_IDS (171):

Order labels IDs.

Corresponds to “Order label IDs” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: IDENTIFIER_LIST

ORDER_LIFETIME_CLICKS (158):

Order lifetime clicks.

Corresponds to “Order lifetime clicks” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: INTEGER

ORDER_LIFETIME_IMPRESSIONS (159):

Order lifetime impressions.

Corresponds to “Order lifetime impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: INTEGER

ORDER_NAME (8):

Order name.

Corresponds to “Order” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED, OFF_PROPERTY_CAMPAIGNS

Data format: STRING

ORDER_PO_NUMBER (160):

Order PO number.

Corresponds to “Order PO number” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: STRING

ORDER_PROGRAMMATIC (157):

Whether the Order is programmatic.

Corresponds to “Order is programmatic” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: BOOLEAN

ORDER_SALESPERSON (161):

Order sales person.

Corresponds to “Order salesperson” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH

Data format: STRING

ORDER_SALESPERSON_ID (629):

Order sales person ID.

Corresponds to “Order salesperson ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH

Data format: IDENTIFIER

ORDER_SECONDARY_SALESPEOPLE (164):

Order secondary sales people.

Corresponds to “Order secondary salespeople” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING_LIST

ORDER_SECONDARY_SALESPEOPLE_ID (165):

Order secondary sales people ID.

Corresponds to “Order secondary salespeople ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: IDENTIFIER_LIST

ORDER_SECONDARY_TRAFFICKERS (166):

Order secondary traffickers.

Corresponds to “Order secondary traffickers” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING_LIST

ORDER_SECONDARY_TRAFFICKERS_ID (167):

Order secondary traffickers ID.

Corresponds to “Order secondary trafficker IDs” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: IDENTIFIER_LIST

ORDER_START_DATE (168):

Order start date.

Corresponds to “Order start date” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: DATE

ORDER_START_DATE_TIME (169):

Order start date and time.

Corresponds to “Order start time” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: TIMESTAMP

ORDER_TRAFFICKER (162):

Order trafficker.

Corresponds to “Order trafficker” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: STRING

ORDER_TRAFFICKER_ID (163):

Order trafficker ID.

Corresponds to “Order trafficker ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH

Data format: IDENTIFIER

ORDER_UNLIMITED_END (203):

Whether the Order end time and end date is set to effectively never end.

Corresponds to “Order is unlimited end time” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, AD_SPEED

Data format: BOOLEAN

PAGE_PATH (511):

Page path is the part of a page URL that comes after the domain but before the query strings from Google Analytics.

Corresponds to “Page path” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PAGE_TITLE_AND_SCREEN_CLASS (512):

Page title (web) and screen class (mobile) returned from Google Analytics.

Corresponds to “Page title and screen class” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PAGE_TITLE_AND_SCREEN_NAME (513):

Page title (web) and screen name (mobile) returned from Google Analytics.

Corresponds to “Page title and screen name” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PARTNER_MANAGEMENT_ASSIGNMENT_ID (657):

The ID of a partner management assignment.

Corresponds to “Partner management assignment ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, PARTNER_FINANCE

Data format: INTEGER

PARTNER_MANAGEMENT_ASSIGNMENT_NAME (658):

The name of a partner management assignment.

Corresponds to “Partner management assignment” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, PARTNER_FINANCE

Data format: STRING

PARTNER_MANAGEMENT_PARTNER_ID (655):

The ID of a partner in a partner management assignment.

Corresponds to “Partner management partner ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, PARTNER_FINANCE

Data format: INTEGER

PARTNER_MANAGEMENT_PARTNER_NAME (656):

The name of a partner in a partner management assignment.

Corresponds to “Partner management partner” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, PARTNER_FINANCE

Data format: STRING

PLACEMENT_ID (113):

Placement ID

Corresponds to “Placement ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, ADS_TRAFFIC_NAVIGATOR

Data format: IDENTIFIER

PLACEMENT_ID_ALL (144):

The full list of placement IDs associated with the ad unit.

Corresponds to “Placement ID (all)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, ADS_TRAFFIC_NAVIGATOR

Data format: IDENTIFIER_LIST

PLACEMENT_NAME (114):

Placement name

Corresponds to “Placement” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, ADS_TRAFFIC_NAVIGATOR

Data format: STRING

PLACEMENT_NAME_ALL (145):

The full list of placement names associated with the ad unit.

Corresponds to “Placement (all)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, ADS_TRAFFIC_NAVIGATOR

Data format: STRING_LIST

PLACEMENT_STATUS (362):

Placement status ENUM value

Corresponds to “Placement status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH

Data format: ENUM

Values: [PlacementStatus][google.ads.admanager.v1.PlacementStatusEnum.PlacementStatus]

PLACEMENT_STATUS_NAME (364):

Localized placement status name.

Corresponds to “Placement status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH

Data format: STRING

PLACEMENT_STATUS_NAME_ALL (365):

The full list of localized placement status names associated with the ad unit.

Corresponds to “Placement status (all)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH

Data format: STRING_LIST

POSTAL_CODE_ID (455):

The criteria ID of the postal code in which the ad served.

Corresponds to “Postal code ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED

Data format: IDENTIFIER

POSTAL_CODE_NAME (456):

The name of the postal code in which the ad served.

Corresponds to “Postal code” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED

Data format: STRING

PPID_STATUS (406):

Indicates the valid PPID (Publisher provided identifier) status on a given ad request.

Corresponds to “PPID status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

PPID_STATUS_NAME (407):

The localized name of that indicates the valid PPID (Publisher provided identifier) status on a given ad request.

Corresponds to “PPID status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PREDICTED_VIEWABILITY_BUCKET (633):

Predicted viewability score bucket.

Corresponds to “Predicted viewability bucket value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

PREDICTED_VIEWABILITY_BUCKET_NAME (634):

The localized name of the predicted viewability score bucket.

Corresponds to “Predicted viewability bucket” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PRESENTED_SECURE_SIGNAL_ID (495):

The ID of the secure signals sent in the ad request.

Corresponds to “Secure signal ID (presented)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

PRESENTED_SECURE_SIGNAL_NAME (496):

The name of the secure signals sent in the ad request.

Corresponds to “Secure signal name (presented)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PRICING_RULE_ID (393):

Pricing rule ID dimension

Corresponds to “Pricing rule ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

PRICING_RULE_NAME (394):

Pricing rule name dimension

Corresponds to “Pricing rule” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PRIMARY_PERSONALIZATION_ID_TYPE (408):

The ID type selected for personalization.

Corresponds to “Primary personalization ID type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

PRIMARY_PERSONALIZATION_ID_TYPE_NAME (409):

The localized name of the ID type selected for personalization.

Corresponds to “Primary personalization ID type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PROGRAMMATIC_CHANNEL (13):

Programmatic channel. The type of transaction that occurred in Ad Exchange.

Corresponds to “Programmatic channel value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REVENUE_VERIFICATION

Data format: ENUM

PROGRAMMATIC_CHANNEL_NAME (14):

Programmatic channel name. The type of transaction that occurred in Ad Exchange.

Corresponds to “Programmatic channel” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REACH, REVENUE_VERIFICATION

Data format: STRING

PUBLISHER_PROVIDED_SIGNALS_ALL_LEVELS_EXTERNAL_CODE (410):

External code ID of a publisher provided signal (all levels).

Corresponds to “Publisher provided signals external code (all levels)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PUBLISHER_PROVIDED_SIGNALS_ALL_LEVELS_IDS (546):

The ancestor chain of IDs of a publisher provided signal (all levels).

Corresponds to “Publisher provided signals ID (all levels)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER_LIST

PUBLISHER_PROVIDED_SIGNALS_ALL_LEVELS_NAME (412):

The ancestor chain of names of a publisher provided signal (all levels).

Corresponds to “Publisher provided signals (all levels)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING_LIST

PUBLISHER_PROVIDED_SIGNALS_ALL_LEVELS_TIER (413):

Tier of a publisher provided signal (all levels).

Corresponds to “Publisher provided signals tier (all levels)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

PUBLISHER_PROVIDED_SIGNALS_ALL_LEVELS_TYPE (414):

Type of a publisher provided signal (all levels).

Corresponds to “Publisher provided signals type (all levels)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PUBLISHER_PROVIDED_SIGNALS_DELIVERED_EXTERNAL_CODE (425):

External code ID of a publisher provided signal (delivered).

Corresponds to “Publisher provided signals external code (delivered)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PUBLISHER_PROVIDED_SIGNALS_DELIVERED_IDS (545):

The ancestor chain of IDs of a publisher provided signal (delivered).

Corresponds to “Publisher provided signals ID (delivered)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER_LIST

PUBLISHER_PROVIDED_SIGNALS_DELIVERED_NAME (427):

The ancestor chain of names of a publisher provided signal (delivered).

Corresponds to “Publisher provided signals (delivered)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING_LIST

PUBLISHER_PROVIDED_SIGNALS_DELIVERED_TIER (428):

Tier of a publisher provided signal (delivered).

Corresponds to “Publisher provided signals tier (delivered)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

PUBLISHER_PROVIDED_SIGNALS_DELIVERED_TYPE (429):

Type of a publisher provided signal (delivered).

Corresponds to “Publisher provided signals type (delivered)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PUBLISHER_PROVIDED_SIGNALS_TOP_LEVEL_EXTERNAL_CODE (415):

External code ID of a publisher provided signal (top level).

Corresponds to “Publisher provided signals external code (top level)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PUBLISHER_PROVIDED_SIGNALS_TOP_LEVEL_ID (416):

ID of a publisher provided signal (top level).

Corresponds to “Publisher provided signals ID (top level)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

PUBLISHER_PROVIDED_SIGNALS_TOP_LEVEL_NAME (417):

Name of a publisher provided signal (top level).

Corresponds to “Publisher provided signals (top level)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING_LIST

PUBLISHER_PROVIDED_SIGNALS_TOP_LEVEL_TIER (418):

Tier of a publisher provided signal (top level).

Corresponds to “Publisher provided signals tier (top level)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

PUBLISHER_PROVIDED_SIGNALS_TOP_LEVEL_TYPE (419):

Type of a publisher provided signal (top level).

Corresponds to “Publisher provided signals type (top level)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

PUBLISHER_PROVIDED_SIGNAL_DATA_PROVIDER_ID (136):

Data provider ID associated with a publisher provided signal.

Corresponds to “Publisher provided signals (data provider ID)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

PUBLISHER_PROVIDED_SIGNAL_DATA_PROVIDER_NAME (137):

Data provider name associated with a publisher provided signal.

Corresponds to “Publisher provided signals (data provider)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

REGION_ID (457):

The criteria ID of the region (for example, US state) in which the ad served.

Corresponds to “Region ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, PRIVACY_AND_MESSAGING, AD_SPEED

Data format: IDENTIFIER

REGION_NAME (458):

The name of the region (for example, US state) in which the ad served.

Corresponds to “Region” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, PRIVACY_AND_MESSAGING, AD_SPEED

Data format: STRING

REJECTION_CLASS_CATEGORY_NAME (591):

The rejection class category name in the Ads traffic navigator report.

Corresponds to “Rejection class category” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: STRING

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.

Corresponds to “Rendered creative size” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED, OFF_PROPERTY_CAMPAIGNS

Data format: STRING

REQUESTED_AD_SIZES (352):

Inventory Requested Ad Sizes dimension

Corresponds to “Requested ad sizes” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

REQUESTED_CREATIVE_ORIENTATION (828):

The orientation of the creative requested.

Corresponds to “Requested creative orientation value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM_LIST

REQUESTED_CREATIVE_ORIENTATION_NAME (829):

Localized name of the requested creative orientation.

Corresponds to “Requested creative orientation” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING_LIST

REQUEST_TYPE (146):

Request type ENUM

Corresponds to “Request type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, AD_SPEED

Data format: ENUM

REQUEST_TYPE_NAME (147):

Request type localized name

Corresponds to “Request type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED

Data format: STRING

REVENUE_VERIFICATION_ID (645):

Revenue Verification bidder-provided ID.

Corresponds to “Revenue verification ID” in the Ad Manager UI.

Compatible with the following report types: REVENUE_VERIFICATION

Data format: IDENTIFIER

SERVER_SIDE_UNWRAPPING_ELIGIBLE (597):

Indicates if a request was eligible for server-side unwrapping.

Corresponds to “Server-side unwrapping eligible” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: BOOLEAN

SERVING_RESTRICTION (631):

The serving restriction mode for privacy.

Corresponds to “Serving restriction value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

SERVING_RESTRICTION_NAME (632):

The localized name of the serving restriction mode for privacy.

Corresponds to “Serving restriction” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

SITE (387):

Information about domain or subdomains.

Corresponds to “Site” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, PRIVACY_AND_MESSAGING

Data format: STRING

TARGETING_ID (232):

The ID of the browser, device or other environment into which a line item or creative was served.

Corresponds to “Targeting ID” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

TARGETING_NAME (233):

Information about the browser, device and other environments into which a line item or creative was served.

Corresponds to “Targeting” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

TARGETING_TYPE (385):

The way in which advertisers targeted their ads.

Corresponds to “Targeting type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

TARGETING_TYPE_NAME (386):

The localized name of the way in which advertisers targeted their ads.

Corresponds to “Targeting type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

TARGETS_CUSTOMER_MATCHING_LIST (789):

Targets customer matching list. Whether the query is siloed customer match attributed.

Corresponds to “Targets customer matching list” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: BOOLEAN

THIRD_PARTY_ID_STATUS (402):

Whether a third-party cookie or device ID was present on a given ad request.

Corresponds to “Third-party ID status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

THIRD_PARTY_ID_STATUS_NAME (403):

The localized name of whether a third-party cookie or device ID was present on a given ad request.

Corresponds to “Third-party ID status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

TOPICS_STATUS (504):

Reports the status of Topics in the ad request.

Corresponds to “Topics status value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

TOPICS_STATUS_NAME (505):

The localized name of the status of Topics in the ad request.

Corresponds to “Topics status” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

TOP_PRIVATE_DOMAIN (444):

Inventory top private domain dimension

Corresponds to “Domain” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, OFF_PROPERTY_CAMPAIGNS, PRIVACY_AND_MESSAGING

Data format: STRING

TRAFFIC_SOURCE (388):

Inventory Traffic source dimension

Corresponds to “Traffic source value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

TRAFFIC_SOURCE_NAME (389):

Inventory Traffic source dimension name

Corresponds to “Traffic source” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

URL (506):

A URL defined under a publisher’s inventory.

Corresponds to “URL” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

URL_ID (507):

A URL defined under a publisher’s inventory.

Corresponds to “URL ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

USER_MESSAGES_CHOICE (702):

The choice made in a user message.

Corresponds to “User choice value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: ENUM

USER_MESSAGES_CHOICE_NAME (703):

Localized name of the choice made in a user message.

Corresponds to “User choice” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: STRING

USER_MESSAGES_ENTITLEMENT_SOURCE (635):

Enum value for the entitlement source.

Corresponds to “Entitlement source value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: ENUM

USER_MESSAGES_ENTITLEMENT_SOURCE_NAME (636):

The localized name of the entitlement source.

Corresponds to “Entitlement source” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: STRING

USER_MESSAGES_OPERATING_SYSTEM_CRITERIA_ID (637):

Targeting criteria ID for the operating system group. Used for User Messages reports.

Corresponds to “Operating system group ID” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_OPERATING_SYSTEM_CRITERIA_NAME (638):

The name of the operating system group. Used for User Messages reports.

Corresponds to “Operating system group” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: STRING

VAST_VERSION (554):

The VAST version of the creative that is returned for an ad request.

Corresponds to “Vast version value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

VAST_VERSION_NAME (555):

The localized name of the VAST version of the creative that is returned for an ad request.

Corresponds to “Vast version” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

VIDEO_AD_BREAK_TYPE (556):

The break type of a video ad request.

Corresponds to “Video ad break type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

VIDEO_AD_BREAK_TYPE_NAME (557):

The localized name of the break type of a video ad request.

Corresponds to “Video ad break type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

VIDEO_AD_DURATION (450):

Video ad duration

Corresponds to “Video ad duration” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

VIDEO_AD_FORMATS_RULE (561):

The name of the video ad formats rule used to control the ad formats eligible for your inventory.

Corresponds to “Video ad formats rule” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

VIDEO_AD_FORMATS_RULE_ID (560):

The ID of the video ad formats rule used to control the ad formats eligible for your inventory.

Corresponds to “Video ad formats rule ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

VIDEO_AD_REQUEST_DURATION (558):

The duration of a video ad request.

Corresponds to “Video ad request duration value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

VIDEO_AD_REQUEST_DURATION_MIDPOINT_NAME (751):

The localized name of the midpoint of the duration of a video ad request.

Corresponds to “Video ad request duration midpoint” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

VIDEO_AD_REQUEST_DURATION_NAME (559):

The localized name of the duration of a video ad request.

Corresponds to “Video ad request duration” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

VIDEO_AD_REQUEST_SOURCE (438):

The video ad request source enum.

Corresponds to “Ad request source value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REAL_TIME_VIDEO

Data format: ENUM

VIDEO_AD_REQUEST_SOURCE_NAME (439):

The localized name of the video ad request source.

Corresponds to “Ad request source” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REAL_TIME_VIDEO

Data format: STRING

VIDEO_AD_TYPE (432):

Video ad type

Corresponds to “Video ad type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

VIDEO_AD_TYPE_NAME (433):

Video ad type localized name

Corresponds to “Video ad type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

VIDEO_CONTINUOUS_PLAY_TYPE (721):

The continuous play type of the video ad impression.

Corresponds to “Video continuous play type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

VIDEO_CONTINUOUS_PLAY_TYPE_NAME (722):

Video continuous play type localized name.

Corresponds to “Video continuous play type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

VIDEO_FALLBACK_POSITION (530):

Fallback position of the video ad.

Corresponds to “Fallback position” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

VIDEO_LIVE_STREAM_EVENT_AD_BREAK_DURATION (547):

The expected duration of the ad break in seconds for a live stream event.

Corresponds to “Ad break duration (seconds)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_LIVE_STREAM_EVENT_AD_BREAK_ID (548):

The ID of the ad break in a live stream event.

Corresponds to “Live stream ad break ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REAL_TIME_VIDEO

Data format: STRING

VIDEO_LIVE_STREAM_EVENT_AD_BREAK_NAME (549):

The name of the ad break in a live stream event.

Corresponds to “Live stream ad break” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REAL_TIME_VIDEO

Data format: STRING

VIDEO_LIVE_STREAM_EVENT_AD_BREAK_TIME (550):

The time of the ad break in a live stream event in the format of YYYY-MM-DD HH:MM:SS+Timezone.

Corresponds to “Ad break time” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: TIMESTAMP

VIDEO_LIVE_STREAM_EVENT_ID (551):

The ID of the live stream event.

Corresponds to “Live stream ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_LIVE_STREAM_EVENT_NAME (552):

The name of the live stream event.

Corresponds to “Live stream” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REAL_TIME_VIDEO

Data format: STRING

VIDEO_MEASUREMENT_SOURCE (601):

The performance of the video ad inventory broken out by source.

Corresponds to “Video measurement source value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

VIDEO_MEASUREMENT_SOURCE_NAME (602):

Video measurement source localized name.

Corresponds to “Video measurement source” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

VIDEO_PLCMT (172):

The video placement enum as defined by ADCOM 1.0-202303.

Corresponds to “Video placement value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

VIDEO_PLCMT_NAME (173):

The localized name of the video placement as defined by ADCOM 1.0-202303.

Corresponds to “Video placement” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

VIDEO_POSITION_IN_POD (538):

The position in the video pod. For example 0, 1, 2, etc.

Corresponds to “Position in pod” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

VIDEO_POSITION_OF_POD (539):

The position of the pod in the video stream. For example pre-roll, mid-roll, post-roll.

Corresponds to “Position of pod” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REAL_TIME_VIDEO, OFF_PROPERTY_CAMPAIGNS

Data format: STRING

VIDEO_SDK_VERSION (440):

The video SDK version enum.

Corresponds to “Video SDK version value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL, REAL_TIME_VIDEO

Data format: ENUM

VIDEO_SDK_VERSION_NAME (441):

The localized name of the video SDK version.

Corresponds to “Video SDK version” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, REAL_TIME_VIDEO

Data format: STRING

VIDEO_STITCHER_TYPE (752):

Video stitcher type.

Corresponds to “Video stitcher type value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: HISTORICAL

Data format: ENUM

VIDEO_STITCHER_TYPE_NAME (753):

Localized name of the video stitcher type.

Corresponds to “Video stitcher type” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

WEB_PROPERTY_CODE (730):

Web property code

Corresponds to “Web property code” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

WEEK (5):

Breaks down reporting data by week of the year.

Corresponds to “Week” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, FUTURE_SELL_THROUGH, REACH, PRIVACY_AND_MESSAGING, YOUTUBE_CONSOLIDATED, OFF_PROPERTY_CAMPAIGNS, ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

YIELD_GROUP_BUYER_NAME (184):

Name of the company within a yield group

Corresponds to “Yield partner” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

YIELD_GROUP_BUYER_TAG_NAME (627):

Tag of the company within a yield group.

Corresponds to “Yield group buyer tag” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

YIELD_GROUP_ID (182):

ID of the group of ad networks or exchanges used for Mediation and Open Bidding

Corresponds to “Yield group ID” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: IDENTIFIER

YIELD_GROUP_NAME (183):

Name of the group of ad networks or exchanges used for Mediation and Open Bidding

Corresponds to “Yield group” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: STRING

YOUTUBE_AD_DURATION_BUCKET (430):

YouTube instream ad duration bucket.

Corresponds to “Ad duration value” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: ENUM

YOUTUBE_AD_DURATION_BUCKET_NAME (431):

YouTube instream ad duration bucket name.

Corresponds to “Ad duration” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: STRING

YOUTUBE_AD_TYPE (399):

YouTube instream Ad Type.

Corresponds to “YouTube ad type ID” in the Ad Manager UI (when showing API fields).

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: ENUM

YOUTUBE_AD_TYPE_NAME (400):

YouTube instream Ad Type localized name.

Corresponds to “YouTube ad type” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: STRING

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. Treats the value as a string. Can only be used if the custom field at index 0 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 1 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 2 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 3 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 4 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 5 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 6 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 7 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 8 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 9 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 10 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 11 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 12 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 13 is of type STRING or DROPDOWN.

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. Treats the value as a string. Can only be used if the custom field at index 14 is of type STRING or DROPDOWN.

LINE_ITEM_CUSTOM_FIELD_0_VALUE_DOUBLE (11015):

Custom field value for Line Item with custom field ID equal to the ID in index 0 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 0 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_1_VALUE_DOUBLE (11016):

Custom field value for Line Item with custom field ID equal to the ID in index 1 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 1 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_2_VALUE_DOUBLE (11017):

Custom field value for Line Item with custom field ID equal to the ID in index 2 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 2 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_3_VALUE_DOUBLE (11018):

Custom field value for Line Item with custom field ID equal to the ID in index 3 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 3 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_4_VALUE_DOUBLE (11019):

Custom field value for Line Item with custom field ID equal to the ID in index 4 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 4 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_5_VALUE_DOUBLE (11020):

Custom field value for Line Item with custom field ID equal to the ID in index 5 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 5 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_6_VALUE_DOUBLE (11021):

Custom field value for Line Item with custom field ID equal to the ID in index 6 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 6 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_7_VALUE_DOUBLE (11022):

Custom field value for Line Item with custom field ID equal to the ID in index 7 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 7 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_8_VALUE_DOUBLE (11023):

Custom field value for Line Item with custom field ID equal to the ID in index 8 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 8 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_9_VALUE_DOUBLE (11024):

Custom field value for Line Item with custom field ID equal to the ID in index 9 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 9 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_10_VALUE_DOUBLE (11025):

Custom field value for Line Item with custom field ID equal to the ID in index 10 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 10 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_11_VALUE_DOUBLE (11026):

Custom field value for Line Item with custom field ID equal to the ID in index 11 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 11 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_12_VALUE_DOUBLE (11027):

Custom field value for Line Item with custom field ID equal to the ID in index 12 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 12 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_13_VALUE_DOUBLE (11028):

Custom field value for Line Item with custom field ID equal to the ID in index 13 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 13 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_14_VALUE_DOUBLE (11029):

Custom field value for Line Item with custom field ID equal to the ID in index 14 of ReportDefinition.line_item_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 14 is of type DOUBLE.

LINE_ITEM_CUSTOM_FIELD_0_VALUE_BOOL (11030):

Custom field value for Line Item with custom field ID equal to the ID in index 0 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 0 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_1_VALUE_BOOL (11031):

Custom field value for Line Item with custom field ID equal to the ID in index 1 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 1 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_2_VALUE_BOOL (11032):

Custom field value for Line Item with custom field ID equal to the ID in index 2 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 2 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_3_VALUE_BOOL (11033):

Custom field value for Line Item with custom field ID equal to the ID in index 3 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 3 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_4_VALUE_BOOL (11034):

Custom field value for Line Item with custom field ID equal to the ID in index 4 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 4 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_5_VALUE_BOOL (11035):

Custom field value for Line Item with custom field ID equal to the ID in index 5 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 5 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_6_VALUE_BOOL (11036):

Custom field value for Line Item with custom field ID equal to the ID in index 6 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 6 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_7_VALUE_BOOL (11037):

Custom field value for Line Item with custom field ID equal to the ID in index 7 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 7 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_8_VALUE_BOOL (11038):

Custom field value for Line Item with custom field ID equal to the ID in index 8 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 8 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_9_VALUE_BOOL (11039):

Custom field value for Line Item with custom field ID equal to the ID in index 9 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 9 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_10_VALUE_BOOL (11040):

Custom field value for Line Item with custom field ID equal to the ID in index 10 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 10 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_11_VALUE_BOOL (11041):

Custom field value for Line Item with custom field ID equal to the ID in index 11 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 11 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_12_VALUE_BOOL (11042):

Custom field value for Line Item with custom field ID equal to the ID in index 12 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 12 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_13_VALUE_BOOL (11043):

Custom field value for Line Item with custom field ID equal to the ID in index 13 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 13 is of type BOOLEAN.

LINE_ITEM_CUSTOM_FIELD_14_VALUE_BOOL (11044):

Custom field value for Line Item with custom field ID equal to the ID in index 14 of ReportDefinition.line_item_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 14 is of type BOOLEAN.

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. Treats the value as a string. Can only be used if the custom field at index 0 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 1 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 2 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 3 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 4 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 5 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 6 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 7 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 8 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 9 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 10 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 11 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 12 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 13 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 14 is of type STRING.

ORDER_CUSTOM_FIELD_0_VALUE_DOUBLE (13015):

Custom field value for Order with custom field ID equal to the ID in index 0 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 0 is of type DOUBLE.

ORDER_CUSTOM_FIELD_1_VALUE_DOUBLE (13016):

Custom field value for Order with custom field ID equal to the ID in index 1 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 1 is of type DOUBLE.

ORDER_CUSTOM_FIELD_2_VALUE_DOUBLE (13017):

Custom field value for Order with custom field ID equal to the ID in index 2 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 2 is of type DOUBLE.

ORDER_CUSTOM_FIELD_3_VALUE_DOUBLE (13018):

Custom field value for Order with custom field ID equal to the ID in index 3 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 3 is of type DOUBLE.

ORDER_CUSTOM_FIELD_4_VALUE_DOUBLE (13019):

Custom field value for Order with custom field ID equal to the ID in index 4 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 4 is of type DOUBLE.

ORDER_CUSTOM_FIELD_5_VALUE_DOUBLE (13020):

Custom field value for Order with custom field ID equal to the ID in index 5 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 5 is of type DOUBLE.

ORDER_CUSTOM_FIELD_6_VALUE_DOUBLE (13021):

Custom field value for Order with custom field ID equal to the ID in index 6 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 6 is of type DOUBLE.

ORDER_CUSTOM_FIELD_7_VALUE_DOUBLE (13022):

Custom field value for Order with custom field ID equal to the ID in index 7 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 7 is of type DOUBLE.

ORDER_CUSTOM_FIELD_8_VALUE_DOUBLE (13023):

Custom field value for Order with custom field ID equal to the ID in index 8 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 8 is of type DOUBLE.

ORDER_CUSTOM_FIELD_9_VALUE_DOUBLE (13024):

Custom field value for Order with custom field ID equal to the ID in index 9 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 9 is of type DOUBLE.

ORDER_CUSTOM_FIELD_10_VALUE_DOUBLE (13025):

Custom field value for Order with custom field ID equal to the ID in index 10 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 10 is of type DOUBLE.

ORDER_CUSTOM_FIELD_11_VALUE_DOUBLE (13026):

Custom field value for Order with custom field ID equal to the ID in index 11 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 11 is of type DOUBLE.

ORDER_CUSTOM_FIELD_12_VALUE_DOUBLE (13027):

Custom field value for Order with custom field ID equal to the ID in index 12 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 12 is of type DOUBLE.

ORDER_CUSTOM_FIELD_13_VALUE_DOUBLE (13028):

Custom field value for Order with custom field ID equal to the ID in index 13 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 13 is of type DOUBLE.

ORDER_CUSTOM_FIELD_14_VALUE_DOUBLE (13029):

Custom field value for Order with custom field ID equal to the ID in index 14 of ReportDefinition.order_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 14 is of type DOUBLE.

ORDER_CUSTOM_FIELD_0_VALUE_BOOL (13030):

Custom field value for Order with custom field ID equal to the ID in index 0 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 0 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_1_VALUE_BOOL (13031):

Custom field value for Order with custom field ID equal to the ID in index 1 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 1 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_2_VALUE_BOOL (13032):

Custom field value for Order with custom field ID equal to the ID in index 2 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 2 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_3_VALUE_BOOL (13033):

Custom field value for Order with custom field ID equal to the ID in index 3 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 3 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_4_VALUE_BOOL (13034):

Custom field value for Order with custom field ID equal to the ID in index 4 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 4 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_5_VALUE_BOOL (13035):

Custom field value for Order with custom field ID equal to the ID in index 5 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 5 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_6_VALUE_BOOL (13036):

Custom field value for Order with custom field ID equal to the ID in index 6 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 6 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_7_VALUE_BOOL (13037):

Custom field value for Order with custom field ID equal to the ID in index 7 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 7 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_8_VALUE_BOOL (13038):

Custom field value for Order with custom field ID equal to the ID in index 8 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 8 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_9_VALUE_BOOL (13039):

Custom field value for Order with custom field ID equal to the ID in index 9 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 9 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_10_VALUE_BOOL (13040):

Custom field value for Order with custom field ID equal to the ID in index 10 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 10 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_11_VALUE_BOOL (13041):

Custom field value for Order with custom field ID equal to the ID in index 11 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 11 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_12_VALUE_BOOL (13042):

Custom field value for Order with custom field ID equal to the ID in index 12 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 12 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_13_VALUE_BOOL (13043):

Custom field value for Order with custom field ID equal to the ID in index 13 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 13 is of type BOOLEAN.

ORDER_CUSTOM_FIELD_14_VALUE_BOOL (13044):

Custom field value for Order with custom field ID equal to the ID in index 14 of ReportDefinition.order_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 14 is of type BOOLEAN.

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. Treats the value as a string. Can only be used if the custom field at index 0 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 1 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 2 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 3 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 4 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 5 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 6 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 7 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 8 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 9 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 10 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 11 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 12 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 13 is of type STRING.

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. Treats the value as a string. Can only be used if the custom field at index 14 is of type STRING.

CREATIVE_CUSTOM_FIELD_0_VALUE_DOUBLE (15015):

Custom field value for Creative with custom field ID equal to the ID in index 0 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 0 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_1_VALUE_DOUBLE (15016):

Custom field value for Creative with custom field ID equal to the ID in index 1 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 1 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_2_VALUE_DOUBLE (15017):

Custom field value for Creative with custom field ID equal to the ID in index 2 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 2 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_3_VALUE_DOUBLE (15018):

Custom field value for Creative with custom field ID equal to the ID in index 3 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 3 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_4_VALUE_DOUBLE (15019):

Custom field value for Creative with custom field ID equal to the ID in index 4 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 4 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_5_VALUE_DOUBLE (15020):

Custom field value for Creative with custom field ID equal to the ID in index 5 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 5 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_6_VALUE_DOUBLE (15021):

Custom field value for Creative with custom field ID equal to the ID in index 6 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 6 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_7_VALUE_DOUBLE (15022):

Custom field value for Creative with custom field ID equal to the ID in index 7 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 7 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_8_VALUE_DOUBLE (15023):

Custom field value for Creative with custom field ID equal to the ID in index 8 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 8 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_9_VALUE_DOUBLE (15024):

Custom field value for Creative with custom field ID equal to the ID in index 9 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 9 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_10_VALUE_DOUBLE (15025):

Custom field value for Creative with custom field ID equal to the ID in index 10 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 10 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_11_VALUE_DOUBLE (15026):

Custom field value for Creative with custom field ID equal to the ID in index 11 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 11 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_12_VALUE_DOUBLE (15027):

Custom field value for Creative with custom field ID equal to the ID in index 12 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 12 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_13_VALUE_DOUBLE (15028):

Custom field value for Creative with custom field ID equal to the ID in index 13 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 13 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_14_VALUE_DOUBLE (15029):

Custom field value for Creative with custom field ID equal to the ID in index 14 of ReportDefinition.creative_custom_field_ids. Treats the value as double. Can only be used if the custom field at index 14 is of type DOUBLE.

CREATIVE_CUSTOM_FIELD_0_VALUE_BOOL (15030):

Custom field value for Creative with custom field ID equal to the ID in index 0 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 0 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_1_VALUE_BOOL (15031):

Custom field value for Creative with custom field ID equal to the ID in index 1 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 1 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_2_VALUE_BOOL (15032):

Custom field value for Creative with custom field ID equal to the ID in index 2 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 2 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_3_VALUE_BOOL (15033):

Custom field value for Creative with custom field ID equal to the ID in index 3 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 3 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_4_VALUE_BOOL (15034):

Custom field value for Creative with custom field ID equal to the ID in index 4 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 4 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_5_VALUE_BOOL (15035):

Custom field value for Creative with custom field ID equal to the ID in index 5 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 5 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_6_VALUE_BOOL (15036):

Custom field value for Creative with custom field ID equal to the ID in index 6 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 6 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_7_VALUE_BOOL (15037):

Custom field value for Creative with custom field ID equal to the ID in index 7 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 7 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_8_VALUE_BOOL (15038):

Custom field value for Creative with custom field ID equal to the ID in index 8 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 8 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_9_VALUE_BOOL (15039):

Custom field value for Creative with custom field ID equal to the ID in index 9 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 9 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_10_VALUE_BOOL (15040):

Custom field value for Creative with custom field ID equal to the ID in index 10 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 10 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_11_VALUE_BOOL (15041):

Custom field value for Creative with custom field ID equal to the ID in index 11 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 11 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_12_VALUE_BOOL (15042):

Custom field value for Creative with custom field ID equal to the ID in index 12 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 12 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_13_VALUE_BOOL (15043):

Custom field value for Creative with custom field ID equal to the ID in index 13 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 13 is of type BOOLEAN.

CREATIVE_CUSTOM_FIELD_14_VALUE_BOOL (15044):

Custom field value for Creative with custom field ID equal to the ID in index 14 of ReportDefinition.creative_custom_field_ids. Treats the value as boolean. Can only be used if the custom field at index 14 is of type BOOLEAN.

CMS_METADATA_DIMENSION_0_VALUE_ID (102000):

CMS Metadata Dimension Value ID for CMS Metadata Dimension with key equal to the key in index 0 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_1_VALUE_ID (102001):

CMS Metadata Dimension Value ID for CMS Metadata Dimension with key equal to the key in index 1 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_2_VALUE_ID (102002):

CMS Metadata Dimension Value ID for CMS Metadata Dimension with key equal to the key in index 2 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_3_VALUE_ID (102003):

CMS Metadata Dimension Value ID for CMS Metadata Dimension with key equal to the key in index 3 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_4_VALUE_ID (102004):

CMS Metadata Dimension Value ID for CMS Metadata Dimension with key equal to the key in index 4 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_5_VALUE_ID (102005):

CMS Metadata Dimension Value ID for CMS Metadata Dimension with key equal to the key in index 5 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_6_VALUE_ID (102006):

CMS Metadata Dimension Value ID for CMS Metadata Dimension with key equal to the key in index 6 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_7_VALUE_ID (102007):

CMS Metadata Dimension Value ID for CMS Metadata Dimension with key equal to the key in index 7 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_8_VALUE_ID (102008):

CMS Metadata Dimension Value ID for CMS Metadata Dimension with key equal to the key in index 8 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_9_VALUE_ID (102009):

CMS Metadata Dimension Value ID for CMS Metadata Dimension with key equal to the key in index 9 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_0_VALUE (103000):

CMS Metadata Dimension Value Name for CMS Metadata Dimension with key equal to the key in index 9 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_1_VALUE (103001):

CMS Metadata Dimension Value Name for CMS Metadata Dimension with key equal to the key in index 1 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_2_VALUE (103002):

CMS Metadata Dimension Value Name for CMS Metadata Dimension with key equal to the key in index 2 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_3_VALUE (103003):

CMS Metadata Dimension Value Name for CMS Metadata Dimension with key equal to the key in index 3 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_4_VALUE (103004):

CMS Metadata Dimension Value Name for CMS Metadata Dimension with key equal to the key in index 4 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_5_VALUE (103005):

CMS Metadata Dimension Value Name for CMS Metadata Dimension with key equal to the key in index 5 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_6_VALUE (103006):

CMS Metadata Dimension Value Name for CMS Metadata Dimension with key equal to the key in index 6 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_7_VALUE (103007):

CMS Metadata Dimension Value Name for CMS Metadata Dimension with key equal to the key in index 7 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_8_VALUE (103008):

CMS Metadata Dimension Value Name for CMS Metadata Dimension with key equal to the key in index 8 of ReportDefinition.cms_metadata_dimension_key_ids.

CMS_METADATA_DIMENSION_9_VALUE (103009):

CMS Metadata Dimension Value Name for CMS Metadata Dimension with key equal to the key in index 9 of ReportDefinition.cms_metadata_dimension_key_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.

EKV_DIMENSION_0_VALUE_ID (105000):

Enhanced Key-values Dimension Value ID for EKV Dimension with key equal to the key in index 0 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_1_VALUE_ID (105001):

Enhanced Key-values Dimension Value ID for EKV Dimension with key equal to the key in index 1 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_2_VALUE_ID (105002):

Enhanced Key-values Dimension Value ID for EKV Dimension with key equal to the key in index 2 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_3_VALUE_ID (105003):

Enhanced Key-values Dimension Value ID for EKV Dimension with key equal to the key in index 3 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_4_VALUE_ID (105004):

Enhanced Key-values Dimension Value ID for EKV Dimension with key equal to the key in index 4 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_5_VALUE_ID (105005):

Enhanced Key-values Dimension Value ID for EKV Dimension with key equal to the key in index 5 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_6_VALUE_ID (105006):

Enhanced Key-values Dimension Value ID for EKV Dimension with key equal to the key in index 6 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_7_VALUE_ID (105007):

Enhanced Key-values Dimension Value ID for EKV Dimension with key equal to the key in index 9 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_8_VALUE_ID (105008):

Enhanced Key-values Dimension Value ID for EKV Dimension with key equal to the key in index 8 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_9_VALUE_ID (105009):

Enhanced Key-values Dimension Value ID for EKV Dimension with key equal to the key in index 9 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_0_VALUE (106000):

Enhanced Key-values Dimension Value name for EKV Dimension with key equal to the ID in index 0 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_1_VALUE (106001):

Enhanced Key-values Dimension Value name for EKV Dimension with key equal to the ID in index 1 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_2_VALUE (106002):

Enhanced Key-values Dimension Value name for EKV Dimension with key equal to the ID in index 2 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_3_VALUE (106003):

Enhanced Key-values Dimension Value name for EKV Dimension with key equal to the ID in index 3 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_4_VALUE (106004):

Enhanced Key-values Dimension Value name for EKV Dimension with key equal to the ID in index 4 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_5_VALUE (106005):

Enhanced Key-values Dimension Value name for EKV Dimension with key equal to the ID in index 5 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_6_VALUE (106006):

Enhanced Key-values Dimension Value name for EKV Dimension with key equal to the ID in index 6 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_7_VALUE (106007):

Enhanced Key-values Dimension Value name for EKV Dimension with key equal to the ID in index 7 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_8_VALUE (106008):

Enhanced Key-values Dimension Value name for EKV Dimension with key equal to the ID in index 8 of ReportDefinition.ekv_dimension_key_ids.

EKV_DIMENSION_9_VALUE (106009):

Enhanced Key-values Dimension Value name for EKV Dimension with key equal to the ID in index 9 of ReportDefinition.ekv_dimension_key_ids.

class Field(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.ReportDefinition.Dimension

metric

The metric this field represents.

This field is a member of oneof field.

Type

google.ads.admanager_v1.types.ReportDefinition.Metric

class Filter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.ReportDefinition.Filter.FieldFilter

not_filter

A filter whose result is negated.

This field is a member of oneof type.

Type

google.ads.admanager_v1.types.ReportDefinition.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.ReportDefinition.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.ReportDefinition.Filter.FilterList

class FieldFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A filter on a specific field.

field

Required. The field to filter on.

Type

google.ads.admanager_v1.types.ReportDefinition.Field

operation

Required. The operation of this filter.

Type

google.ads.admanager_v1.types.ReportDefinition.Filter.Operation

values

Required. Values to filter to.

Type

MutableSequence[google.ads.admanager_v1.types.ReportValue]

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.ReportDefinition.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.ReportDefinition.MetricValueType

class FilterList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A list of filters.

filters

Required. A list of filters.

Type

MutableSequence[google.ads.admanager_v1.types.ReportDefinition.Filter]

class Operation(value)

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 regular expression or set of regular expressions (one must match).

NOT_MATCHES (10):

Operand negative matches against a regular expression or set of regular expressions (none must match).

class Flag(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.ReportDefinition.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 won’t display flags with other names, but they are available for use by API clients.

Type

str

class Metric(value)

Bases: proto.enums.Enum

Reporting metrics.

Values:

METRIC_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE_USERS (223):

The number of people who engaged with your site or app in the specified date range from Google Analytics.

Corresponds to “Active users” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ACTIVE_VIEW_AUDIBLE_AT_START_PERCENT (445):

Number of impressions with unmuted playback at start.

Corresponds to “Active View % audible at start” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ACTIVE_VIEW_AUDIBLE_IMPRESSIONS (659):

Total Active View audible impressions

Corresponds to “Total Active View audible impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ACTIVE_VIEW_AUDIBLE_THROUGH_COMPLETION_PERCENT (446):

Number of impressions with unmuted playback through the entire stream.

Corresponds to “Active View % audible through completion” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ACTIVE_VIEW_AUDIBLE_THROUGH_FIRST_QUARTILE_PERCENT (447):

Number of impressions with unmuted playback through at least 25%.

Corresponds to “Active View % audible through first quartile” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ACTIVE_VIEW_AUDIBLE_THROUGH_MIDPOINT_PERCENT (448):

Number of impressions with unmuted playback through at least 50%.

Corresponds to “Active View % audible through midpoint” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ACTIVE_VIEW_AUDIBLE_THROUGH_THIRD_QUARTILE_PERCENT (449):

Number of impressions with unmuted playback through at least 75%.

Corresponds to “Active View % audible through third quartile” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ACTIVE_VIEW_AUDIO_ENABLED_IMPRESSIONS (660):

Total Active View audio enabled impressions

Corresponds to “Total Active View audio eligible impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ACTIVE_VIEW_AUDIO_MEASURABLE_IMPRESSIONS (661):

Total Active View audio measurable impressions

Corresponds to “Total Active View audio measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME (61):

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

Corresponds to “Total Active View average viewable time (seconds)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS (58):

Total number of impressions that were eligible to measure viewability.

Corresponds to “Total Active View eligible impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ACTIVE_VIEW_EVER_AUDIBLE_BACKGROUNDED_PERCENT (450):

Number of impressions where the ad player is in the background at any point during playback with volume > 0.

Corresponds to “Active View % ever audible while backgrounded” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ACTIVE_VIEW_EVER_AUDIBLE_PERCENT (451):

Number of impressions where volume > 0 at any point.

Corresponds to “Active View % ever audible” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ACTIVE_VIEW_EVER_BACKGROUNDED_PERCENT (452):

Number of impressions where the ad player is in the background at any point during playback.

Corresponds to “Active View % ever backgrounded” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ACTIVE_VIEW_EVER_MUTED_PERCENT (453):

Number of impressions where volume = 0 at any point.

Corresponds to “Active View % ever muted” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ACTIVE_VIEW_IMPRESSIONS_AUDIBLE_AND_VISIBLIE_AT_COMPLETION (411):

The number of measurable impressions that were played to video completion, and also audible and visible at the time of completion.

Corresponds to “Total Active View impressions audible and visible at completion” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ACTIVE_VIEW_MEASURABLE_IMPRESSIONS (57):

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

Corresponds to “Total Active View measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

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

Corresponds to “Total Active View % measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ACTIVE_VIEW_NON_MEASURABLE_IMPRESSIONS (662):

Total Active View non-measurable impressions

Corresponds to “Total Active View non-measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ACTIVE_VIEW_NON_VIEWABLE_IMPRESSIONS (663):

Total Active View non-viewable impressions

Corresponds to “Total Active View non-viewable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ACTIVE_VIEW_NON_VIEWABLE_IMPRESSIONS_DISTRIBUTION (664):

Total Active View non-viewable impressions distribution

Corresponds to “Total Active View non-viewable impression distribution” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ACTIVE_VIEW_PERCENT_AUDIBLE_IMPRESSIONS (665):

Total Active View percent audible impressions

Corresponds to “Total Active View % audible impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ACTIVE_VIEW_PLUS_MEASURABLE_COUNT (454):

Number of impressions where we were able to collect Active View+ signals.

Corresponds to “Active View+ measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ACTIVE_VIEW_REVENUE (414):

Revenue generated from Active View impressions.

Corresponds to “Total Active View revenue” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

ACTIVE_VIEW_UNDETERMINED_IMPRESSIONS_DISTRIBUTION (666):

Total Active View undetermined impressions distribution

Corresponds to “Total Active View undetermined impression distribution” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ACTIVE_VIEW_VIEWABLE_IMPRESSIONS (56):

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

Corresponds to “Total Active View viewable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_DISTRIBUTION (667):

Total Active View viewable impressions distribution

Corresponds to “Total Active View viewable impression distribution” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

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

Corresponds to “Total Active View % viewable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ADSENSE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME (73):

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

Corresponds to “AdSense Active View average viewable time (seconds)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

ADSENSE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS (70):

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

Corresponds to “AdSense Active View eligible impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS (69):

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

Corresponds to “AdSense Active View measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

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

Corresponds to “AdSense Active View % measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ADSENSE_ACTIVE_VIEW_NON_MEASURABLE_IMPRESSIONS (642):

AdSense Active View non-measurable impressions

Corresponds to “AdSense Active View non-measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ADSENSE_ACTIVE_VIEW_NON_VIEWABLE_IMPRESSIONS (643):

AdSense Active View non-viewable impressions

Corresponds to “AdSense Active View non-viewable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ADSENSE_ACTIVE_VIEW_NON_VIEWABLE_IMPRESSIONS_DISTRIBUTION (644):

AdSense Active View non-viewable impressions distribution

Corresponds to “AdSense Active View non-viewable impression distribution” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ADSENSE_ACTIVE_VIEW_UNDETERMINED_IMPRESSIONS_DISTRIBUTION (645):

AdSense Active View undetermined impressions distribution

Corresponds to “AdSense Active View undetermined impression distribution” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS (68):

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

Corresponds to “AdSense Active View viewable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_DISTRIBUTION (646):

AdSense Active View viewable impressions distribution

Corresponds to “AdSense Active View viewable impression distribution” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

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

Corresponds to “AdSense Active View % viewable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ADSENSE_AVERAGE_ECPM (26):

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

Corresponds to “AdSense average eCPM” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

ADSENSE_CLICKS (23):

Number of clicks delivered by AdSense demand channel.

Corresponds to “AdSense clicks” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

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

Corresponds to “AdSense CTR” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ADSENSE_IMPRESSIONS (22):

Total impressions delivered by AdSense.

Corresponds to “AdSense impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ADSENSE_PERCENT_CLICKS (28):

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

Corresponds to “AdSense clicks (%)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ADSENSE_PERCENT_IMPRESSIONS (27):

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

Corresponds to “AdSense impressions (%)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ADSENSE_PERCENT_REVENUE (29):

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

Corresponds to “AdSense revenue (%)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

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

Corresponds to “AdSense revenue w/o CPD (%)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ADSENSE_RESPONSES_SERVED (41):

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

Corresponds to “AdSense responses served” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ADSENSE_REVENUE (25):

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

Corresponds to “AdSense revenue” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_EXCHANGE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME (79):

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

Corresponds to “Ad Exchange Active View average viewable time (seconds)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

AD_EXCHANGE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS (76):

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

Corresponds to “Ad Exchange Active View eligible impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS (75):

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

Corresponds to “Ad Exchange Active View measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

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

Corresponds to “Ad Exchange Active View % measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_EXCHANGE_ACTIVE_VIEW_NON_MEASURABLE_IMPRESSIONS (654):

Ad Exchange Active View non-measurable impressions

Corresponds to “Ad Exchange Active View non-measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_EXCHANGE_ACTIVE_VIEW_NON_VIEWABLE_IMPRESSIONS (655):

Ad Exchange Active View non-viewable impressions

Corresponds to “Ad Exchange Active View non-viewable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_EXCHANGE_ACTIVE_VIEW_NON_VIEWABLE_IMPRESSIONS_DISTRIBUTION (656):

Ad Exchange Active View non-viewable impressions distribution

Corresponds to “Ad Exchange Active View non-viewable impression distribution” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_EXCHANGE_ACTIVE_VIEW_UNDETERMINED_IMPRESSIONS_DISTRIBUTION (657):

Ad Exchange Active View undetermined impressions distribution

Corresponds to “Ad Exchange Active View undetermined impression distribution” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS (74):

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

Corresponds to “Ad Exchange Active View viewable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_DISTRIBUTION (658):

Ad Exchange Active View viewable impressions distribution

Corresponds to “Ad Exchange Active View viewable impression distribution” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

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

Corresponds to “Ad Exchange Active View % viewable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

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.

Corresponds to “Ad Exchange average eCPM” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_EXCHANGE_CLICKS (15):

Number of clicks delivered by the Ad Exchange.

Corresponds to “Ad Exchange clicks” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_EXCHANGE_CPC (244):

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

Corresponds to “Ad Exchange CPC” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

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

Corresponds to “Ad Exchange CTR” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_EXCHANGE_DELIVERY_RATE (245):

Ratio of impressions delivered by Ad Exchange through line item dynamic allocation to ad requests.

Corresponds to “Ad Exchange delivery rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_EXCHANGE_IMPRESSIONS (14):

Total impressions delivered by the Ad Exchange.

Corresponds to “Ad Exchange impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_EXCHANGE_IMPRESSIONS_PER_AD_VIEWER (427):

The total number of impressions based on the number of ad viewers.

Corresponds to “Ad Exchange impressions per ad viewer” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

AD_EXCHANGE_IMPRESSIONS_PER_SESSION (428):

The total number of impressions based on the number of sessions.

Corresponds to “Ad Exchange impressions per session” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

AD_EXCHANGE_LIFT (246):

The increase in revenue gained for won impressions over the applicable third party price (the minimum CPM or the best price specified during dynamic allocation),

Corresponds to “Ad Exchange lift earnings” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_EXCHANGE_MATCHED_REQUEST_CTR (247):

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

Corresponds to “Ad Exchange matched request CTR” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_EXCHANGE_MATCHED_REQUEST_ECPM (248):

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

Corresponds to “Ad Exchange matched request eCPM” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_EXCHANGE_MATCH_RATE (249):

The number of responses served divided by the number of queries eligible in ad exchange.

Corresponds to “Ad Exchange match rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_EXCHANGE_OPPORTUNITIES_FROM_ERRORS (250):

Total opportunities from video VAST error within the waterfall for backfill ads.

Corresponds to “Ad Exchange opportunities from errors” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_EXCHANGE_OPPORTUNITIES_FROM_IMPRESSIONS (251):

Number of opportunities from impressions within the waterfall for backfill ads.

Corresponds to “Ad Exchange opportunities from impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_EXCHANGE_PERCENT_CLICKS (20):

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

Corresponds to “Ad Exchange clicks (%)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_EXCHANGE_PERCENT_IMPRESSIONS (19):

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

Corresponds to “Ad Exchange impressions (%)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_EXCHANGE_PERCENT_REVENUE (21):

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

Corresponds to “Ad Exchange revenue (%)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

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

Corresponds to “Ad Exchange revenue w/o CPD (%)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_EXCHANGE_PLUS_YIELD_GROUP_ECPM (252):

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

Corresponds to “Ad Exchange plus yield group eCPM” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_EXCHANGE_PLUS_YIELD_GROUP_IMPRESSIONS (253):

Total impressions delivered by the Ad Exchange and third-party networks.

Corresponds to “Ad Exchange plus yield group impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_EXCHANGE_PLUS_YIELD_GROUP_REVENUE (254):

Revenue generated from the Ad Exchange and Yield Group, calculated in your network’s currency and time zone.

Corresponds to “Ad Exchange plus yield group revenue” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_EXCHANGE_RESPONSES_SERVED (42):

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

Corresponds to “Ad Exchange responses served” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_EXCHANGE_REVENUE (17):

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

Corresponds to “Ad Exchange revenue” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_EXCHANGE_REVENUE_PAID_THROUGH_MCM_AUTOPAYMENT (212):

The Ad Exchange revenue accrued in the child network’s own account but paid to their parent network through auto-payment. This metric is only relevant for a “Manage Account” child network.

Corresponds to “Ad Exchange revenue paid through MCM auto-payment” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_EXCHANGE_REVENUE_PER_AD_VIEWER (429):

The total amount of Ad Exchange revenue based on the number of ad viewers.

Corresponds to “Ad Exchange revenue per ad viewer” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_EXCHANGE_TOTAL_REQUESTS (255):

The number of programmatic eligible queries in Ad Exchange.

Corresponds to “Ad Exchange total requests” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_EXCHANGE_TOTAL_REQUEST_CTR (256):

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

Corresponds to “Ad Exchange total request CTR” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_EXCHANGE_TOTAL_REQUEST_ECPM (257):

The average effective cost per thousand ad requests earned from the ads delivered by Ad Exchange through line item dynamic allocation and yield group partners.

Corresponds to “Ad Exchange total request eCPM” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_EXPOSURE_SECONDS (241):

Length of time in seconds that an ad is visible on the user’s screen from Google Analytics.

Corresponds to “Ad exposure (seconds)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

AD_REQUESTS (38):

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

Corresponds to “Total ad requests” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME (67):

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

Corresponds to “Ad server Active View average viewable time (seconds)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

AD_SERVER_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS (64):

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

Corresponds to “Ad server Active View eligible impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS (63):

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

Corresponds to “Ad server Active View measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

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

Corresponds to “Ad server Active View % measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_SERVER_ACTIVE_VIEW_NON_MEASURABLE_IMPRESSIONS (332):

The number of impressions delivered by Ad Server that were not measured. For example, impressions where measurement was attempted but failed.

Corresponds to “Ad server Active View non-measurable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_ACTIVE_VIEW_NON_VIEWABLE_IMPRESSIONS (331):

The number of impressions delivered by Ad Server that were measured by active view, but deemed not viewable.

Corresponds to “Ad server Active View non-viewable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_ACTIVE_VIEW_NON_VIEWABLE_IMPRESSIONS_DISTRIBUTION (334):

The fraction of non-viewable impressions among eligible impressions from Ad Server in Active View reporting.”

Corresponds to “Ad server Active View non-viewable impression distribution” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_SERVER_ACTIVE_VIEW_REVENUE (704):

Revenue generated from Ad Server Active View impressions.

Corresponds to “Ad server Active View revenue” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_SERVER_ACTIVE_VIEW_UNDETERMINED_IMPRESSIONS_DISTRIBUTION (335):

The fraction of non-eligible impressions among eligible impressions from Ad Server in Active View reporting.”

Corresponds to “Ad server Active View undetermined impression distribution” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS (62):

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

Corresponds to “Ad server Active View viewable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_DISTRIBUTION (333):

The fraction of viewable impressions among eligible impressions from Ad Server in Active View reporting.

Corresponds to “Ad server Active View viewable impression distribution” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

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

Corresponds to “Ad server Active View % viewable impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_SERVER_AVERAGE_ECPM (34):

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

Corresponds to “Ad server average eCPM” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

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.

Corresponds to “Ad server average eCPM w/o CPD” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_SERVER_BEGIN_TO_RENDER_IMPRESSIONS (262):

Total raw impressions counted when creative begins to render or the first frame of a video is shown.

Corresponds to “Ad server begin to render impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

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.

Corresponds to “Ad server clicks” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_COMPLETED_VIEWS (431):

The number of completed views for ad server.

Corresponds to “Ad server completed views” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_COVIEWED_IMPRESSIONS (554):

Total coviewed impressions delivered by the Ad Server.

Corresponds to “Ad server impressions (co-viewed)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

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.

Corresponds to “Ad server CPD revenue” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

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

Corresponds to “Ad server CTR” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_SERVER_GROSS_REVENUE (483):

Gross revenue earned, calculated in your network’s currency, for the ads delivered by the Google Ad Manager server. This includes pre-rev-share revenue for Programmatic traffic. This metric is to help with the transition from gross to net revenue reporting.

Corresponds to “Ad server total revenue (gross)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_SERVER_GROSS_REVENUE_WITHOUT_CPD (484):

Gross revenue earned, calculated in your network’s currency, for the ads delivered by the Google Ad Manager server, excluding CPD revenue. This includes pre-rev-share revenue for Programmatic traffic. This metric is to help with the transition from gross to net revenue reporting.

Corresponds to “Ad server CPM and CPC revenue (gross)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_SERVER_IMPRESSIONS (6):

Total impressions delivered by the Ad Server.

Corresponds to “Ad server impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_IMPRESSIONS_WITH_COMPANION (222):

Total impressions delivered by the Ad Server with companion impressions.

Corresponds to “Ad server impressions with companion” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_INACTIVE_BEGIN_TO_RENDER_IMPRESSIONS (338):

Impressions (via begin to render methodology) delivered by the Google Ad Manager server considered inactive, as defined by served to a device receiving ad or bid requests continuously for a session of greater than 16 hours without a “reset” event.

Corresponds to “Ad server inactive begin to render impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_OPPORTUNITIES_FROM_ERRORS (461):

Total number of ad server VAST errors discounting errors generated from video fallback ads.

Corresponds to “Ad Server opportunities from errors” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_OPPORTUNITIES_FROM_IMPRESSIONS (462):

Total number of ad server impressions discounting video fallback impressions.

Corresponds to “Ad Server opportunities from impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_PERCENT_CLICKS (12):

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

Corresponds to “Ad server clicks (%)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_SERVER_PERCENT_IMPRESSIONS (11):

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

Corresponds to “Ad server impressions (%)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_SERVER_PERCENT_REVENUE (35):

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

Corresponds to “Ad server revenue (%)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

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.

Corresponds to “Ad server revenue w/o CPD (%)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

AD_SERVER_RESPONSES_SERVED (40):

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

Corresponds to “Ad server responses served” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

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.

Corresponds to “Ad server total revenue” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_SERVER_REVENUE_PAID_THROUGH_MCM_AUTOPAYMENT (213):

The Google Ad Manager server revenue accrued in the child network’s own account but paid to their parent network through auto-payment. This metric is only relevant for a “Manage Account” child network.

Corresponds to “Ad server revenue paid through MCM auto-payment” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

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.

Corresponds to “Ad server CPM and CPC revenue” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AD_SERVER_TARGETED_CLICKS (274):

The number of clicks delivered by the ad server by explicit custom criteria targeting.

Corresponds to “Ad server targeted clicks” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_TARGETED_IMPRESSIONS (275):

The number of impressions delivered by the ad server by explicit custom criteria targeting.

Corresponds to “Ad server targeted impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_TRACKED_ADS (264):

The number of tracked ads delivered by the ad server.

Corresponds to “Ad server tracked ads” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_UNFILTERED_BEGIN_TO_RENDER_IMPRESSIONS (261):

Total raw impressions counted when creative begins to render or the first frame of a video is shown, before invalid traffic filtrations by Ad Server.

Corresponds to “Ad server unfiltered begin to render impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_UNFILTERED_CLICKS (259):

Total clicks delivered by the Ad Server before spam filtering.

Corresponds to “Ad server unfiltered clicks” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_UNFILTERED_DOWNLOADED_IMPRESSIONS (260):

Total downloaded impressions delivered by the Ad Server before spam filtering.

Corresponds to “Ad server unfiltered downloaded impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_SERVER_UNFILTERED_IMPRESSIONS (260):

Deprecated. This metric has been renamed to AD_SERVER_UNFILTERED_DOWNLOADED_IMPRESSIONS. The server will normalize any requests using this value to AD_SERVER_UNFILTERED_DOWNLOADED_IMPRESSIONS. This value will be removed on or after October 1, 2025.

AD_SERVER_UNFILTERED_TRACKED_ADS (263):

The number of tracked ads delivered by the ad server before invalid traffic filtrations.

Corresponds to “Ad server unfiltered tracked ads” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

AD_UNIT_EXPOSURE_SECONDS (242):

Length of time in seconds that an ad unit is visible on the user’s screen from Google Analytics.

Corresponds to “Ad unit exposure (seconds)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

AD_VIEWERS (425):

The number of users who viewed an ads on your site or app in the specified date range from Google Analytics.

Corresponds to “Ad viewers” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ATN_ADS_FAILED_TO_RENDER (430):

Number of ads that Ad Manager failed to render in the Ads traffic navigator report.

Corresponds to “Ads failed to render” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_ELIGIBLE_LINE_ITEMS (342):

Number of line items that matched an ad request in the Ads traffic navigator report.

Corresponds to “Eligible line items” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_ELIGIBLE_LINE_ITEMS_AD_REQUESTS (343):

Number of ad requests that contain eligible line items for the auction in the Ads traffic navigator report.

Corresponds to “Ad requests with eligible line items” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_HBT_ALLOWED_AD_REQUESTS (344):

Number of ad requests that have header bidding trafficking demand in the Ads traffic navigator report.

Corresponds to “Ad requests allowing header bidding trafficking” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_HBT_BIDS_IN_AUCTION (345):

Number of header bidding trafficking bids that are able to match an ad request and enter the auction in the Ads traffic navigator report.

Corresponds to “Competing header bidding trafficking bids” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_HBT_BIDS_IN_AUCTION_AD_REQUESTS (346):

Number of header bidding trafficking ad requests with bids in auction in the Ads traffic navigator report.

Corresponds to “Ad requests with competing header bidding trafficking bids” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_HBT_CANDIDATE_BIDS (347):

Number of header bidding trafficking candidate bids that match an ad request in the Ads traffic navigator report.

Corresponds to “Header bidding trafficking bids” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_HBT_INVALID_AD_REQUESTS (348):

Number of invalid header bidding trafficking ad requests in the Ads traffic navigator report.

Corresponds to “Invalid ad requests allowing header bidding trafficking” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_HBT_NO_BIDS_AD_REQUESTS (472):

Number of header bidding trafficking ad requests with no bids in the Ads traffic navigator report.

Corresponds to “Ad requests with no header bidding trafficking bids” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_HBT_REJECTED_BIDS (349):

Number of header bidding trafficking bids that didn’t match the ad request in the Ads traffic navigator report.

Corresponds to “Rejected header bidding trafficking bids” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_HBT_VALID_AD_REQUESTS (350):

Number of ad requests with the header bidding trafficking demand that are valid in the Ads traffic navigator report.

Corresponds to “Valid header bidding trafficking ad requests” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_HBT_WITH_BIDS_AD_REQUESTS (473):

Number of header bidding trafficking ad requests with bids in the Ads traffic navigator report.

Corresponds to “Ad requests with header bidding trafficking bids” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_INVALID_AD_REQUESTS (351):

Ad requests that are not valid in the Ads traffic navigator report.

Corresponds to “Invalid ad requests” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_LINE_ITEMS_CREATIVE_NOT_RETRIEVED (476):

Number of line items with no creative retrieved in the Ads traffic navigator report.

Corresponds to “Line items with no creative retrieved” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_LINE_ITEMS_IN_AUCTION (352):

Number of line items that matched an ad request and entered in auction in the Ads traffic navigator report.

Corresponds to “Competing line items” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_LINE_ITEMS_NOT_COMPETING (515):

Number of line items that were ranked but did not compete in auction in the Ads traffic navigator report.

Corresponds to “Non-competing line items” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_LINE_ITEMS_NOT_SELECTED (353):

Number of line items that matched an ad request but were not selected to compete in the auction in the Ads traffic navigator report.

Corresponds to “Line items not selected to compete” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_LINE_ITEM_IN_AUCTION_AD_REQUESTS (354):

Number of line item ad requests in auction in the Ads traffic navigator report.

Corresponds to “Ad requests with competing line items” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_LINE_ITEM_TARGETED_AD_REQUESTS (355):

Number of line item targeted ad requests in the Ads traffic navigator report.

Corresponds to “Ad requests with targeted line items” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_MEDIATION_ALLOWED_AD_REQUESTS (356):

Number of ad requests with the mediation demand in the Ads traffic navigator report.

Corresponds to “Ad requests allowing mediation” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_MEDIATION_INVALID_AD_REQUESTS (357):

Number of invalid mediation ad requests in the Ads traffic navigator report.

Corresponds to “Invalid ad requests allowing mediation” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_MEDIATION_LOADED_ADS_FROM_CHAINS (358):

Number of times the Yield Partner’s ad was loaded in the Ads traffic navigator report.

Corresponds to “Loaded ads from chains” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_MEDIATION_NO_PARTNER_AD_REQUESTS (474):

Number of ad requests with mediation demand having no partners in the Ads traffic navigator report.

Corresponds to “Ad requests with no targeted mediation partners” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_MEDIATION_PARTNERS_IN_AUCTION (359):

Number of mediation yield partners in auction in the Ads traffic navigator report.

Corresponds to “Competing mediation partners” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_MEDIATION_PARTNERS_IN_AUCTION_AD_REQUESTS (360):

Number of ad requests in auction that serve mediation chains in the Ads traffic navigator report.

Corresponds to “Ad requests with competing mediation partners” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_MEDIATION_REJECTED_PARTNERS (361):

Number of mediation partners that didn’t match an ad request in the Ads traffic navigator report.

Corresponds to “Rejected partners” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_MEDIATION_TARGETED_PARTNERS (362):

Number of mediation partners that have targeted an ad request and are able to match it in the Ads traffic navigator report.

Corresponds to “Targeted mediation partners” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_MEDIATION_TOTAL_ADS_IN_CHAINS (703):

Number of ads in mediation chains in the Ads traffic navigator report.

Corresponds to “Total ads in chains” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_MEDIATION_UNLOADED_ADS_FROM_CHAINS (363):

Number of ads from mediation chains that Ad Manager won’t serve in the Ads traffic navigator report.

Corresponds to “Unloaded ads from chains” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_MEDIATION_UNUSED_BIDS_OR_PARTNERS (364):

Number of times the Yield Partner’s mediation chain ad was not reached in the Ads traffic navigator report.

Corresponds to “Unused bids or partners” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_MEDIATION_VALID_AD_REQUESTS (365):

Number of ad requests that have mediation demand in the Ads traffic navigator report.

Corresponds to “Valid mediation ad requests” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_MEDIATION_WITH_PARTNERS_AD_REQUESTS (475):

Number of ad requests with mediation demand having partners in the Ads traffic navigator report.

Corresponds to “Ad requests with targeted mediation partners” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_AD_REQUESTS_WITH_BIDS (366):

Number of ad requests with programmatic demand that have received a bid in the Ads traffic navigator report.

Corresponds to “Ad requests with bids” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_AD_REQUESTS_WITH_BID_REQUESTS_SENT (367):

Number of ad requests with programmatic demand that have sent a bid to at least one buyer in the Ads traffic navigator report.

Corresponds to “Ad requests with bid requests sent” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_ALLOWED_AD_REQUESTS (368):

Number of ad requests with programmatic demand in the Ads traffic navigator report.

Corresponds to “Ad requests allowing programmatic” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_BIDS_IN_AUCTION (369):

Number of ads with programmatic bids that entered the auction in the Ads traffic navigator report.

Corresponds to “Competing programmatic bids” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_BID_IN_AUCTION_AD_REQUESTS (370):

Number of ad requests that have received eligible programmatic bids to compete in the auction in the Ads traffic navigator report.

Corresponds to “Ad requests with competing programmatic bids” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_BID_REQUESTS_SENT (371):

Number of programmatic callout bid requests sent to buyers in the Ads traffic navigator report.

Corresponds to “Bid requests sent” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_BID_REQUESTS_WITH_RESPONSE (372):

Number of programmatic callout bid requests that resulted with a response in the Ads traffic navigator report.

Corresponds to “Bid requests with response” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_BID_REQUEST_CANDIDATES (373):

All buyers that Ad Manager could potentially send a programmatic bid request to in the Ads traffic navigator report.

Corresponds to “Bid request candidates” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_BID_REQUEST_ERRORS (374):

Number of programmatic callout bid requests with errors in the Ads traffic navigator report.

Corresponds to “Bid request errors” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_INELIGIBLE_AD_REQUESTS (375):

Number of ad requests that are ineligible for programmatic in the Ads traffic navigator report.

Corresponds to “Invalid ad requests allowing programmatic” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_REJECTED_BIDS (376):

Number of programmatic callout bids rejected in the Ads traffic navigator report.

Corresponds to “Rejected bids” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_SKIPPED_BID_REQUESTS (377):

Number of programmatic callout bid requests Ad Manager won’t send to buyers in the Ads traffic navigator report.

Corresponds to “Skipped bid requests” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_TOTAL_BIDS (378):

Number of programmatic bids that Ad Manager received from buyers in the Ads traffic navigator report.

Corresponds to “Total programmatic bids” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_PROGRAMMATIC_VALID_AD_REQUESTS (379):

Number of ad requests that allow programmatic in the Ads traffic navigator report.

Corresponds to “Valid ad requests allowing programmatic” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_REJECTED_LINE_ITEMS (380):

Number of line items targeted that didn’t match an ad request in the Ads traffic navigator report.

Corresponds to “Rejected line items” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_SERVED_MEDIATION_CHAINS (381):

Number of mediation chains Ad Manager serves in the Ads traffic navigator report.

Corresponds to “Served mediation chains” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_SERVED_SINGLE_ADS (382):

Number of single ads served in the Ads traffic navigator report.

Corresponds to “Served single ads” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_TARGETED_LINE_ITEMS (383):

Number of line items with targeting that matches an ad request in the Ads traffic navigator report.

Corresponds to “Targeted line items” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_TOTAL_AD_REQUESTS (384):

Total number of ad requests which counts optimized pod request as a single request in the Ads traffic navigator report.

Corresponds to “Total ad requests (Ads traffic navigator)” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_TOTAL_LOADED_ADS (387):

Total number of ads loaded in the Ads traffic navigator report.

Corresponds to “Total loaded ads” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_VALID_AD_REQUESTS (389):

Ad requests that are valid in the Ads traffic navigator report.

Corresponds to “Valid ad requests” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

ATN_YIELD_GROUP_MEDIATION_PASSBACKS (390):

Number of times the Yield Partner passed-back on a Mediation chain ad in the Ads traffic navigator report.

Corresponds to “Yield group mediation passbacks” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

AUDIENCE_SEGMENT_COST (558):

Cost of the audience segment.

Corresponds to “Audience segment cost” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AVERAGE_ECPM (37):

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

Corresponds to “Total average eCPM” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AVERAGE_ECPM_WITHOUT_CPD (5):

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

Corresponds to “Total average eCPM w/o CPD” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED

Data format: MONEY

AVERAGE_ENGAGEMENT_SECONDS_PER_SESSION (224):

Average user engagement seconds per session in Google Analytics.

Corresponds to “Average engagement time per session (seconds)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

AVERAGE_ENGAGEMENT_SECONDS_PER_USER (225):

Average user engagement seconds per user in Google Analytics.

Corresponds to “Average engagement time per user (seconds)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

AVERAGE_IMPRESSIONS_PER_UNIQUE_VISITOR (418):

The average number of unique users reached per ad impression.

Corresponds to “Average impressions/unique visitor” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: DOUBLE

AVERAGE_PURCHASE_REVENUE_PER_PAYING_USER (226):

Average total purchase revenue per user in Google Analytics.

Corresponds to “ARPPU” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AVERAGE_REVENUE_PER_USER (227):

Average revenue earned from each active user in Google Analytics.

Corresponds to “ARPU” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

AVERAGE_SESSION_SECONDS (228):

Average length of a session in Google Analytics.

Corresponds to “Average session duration (seconds)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

BIDS (443):

The number of bids.

Corresponds to “Bids” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

BID_AVERAGE_CPM (444):

The average CPM of the bids submitted by bidders.

Corresponds to “Average bid CPM” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

BOUNCE_RATE (433):

The ratio of (sessions - engaged sessions) / sessions.

Corresponds to “Bounce rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

CLICKS (2):

The number of times a user clicked on an ad.

Corresponds to “Total clicks” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, ADS_TRAFFIC_NAVIGATOR, AD_SPEED

Data format: INTEGER

CODE_SERVED_COUNT (44):

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

Corresponds to “Total code served count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, ADS_TRAFFIC_NAVIGATOR

Data format: INTEGER

CPC_REVENUE (440):

Total amount of CPC revenue.

Corresponds to “CPC revenue” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: MONEY

CPM_REVENUE (441):

Total amount of CPM revenue.

Corresponds to “CPM revenue” in the Ad Manager UI.

Compatible with the following report types: ADS_TRAFFIC_NAVIGATOR

Data format: MONEY

CREATIVE_LOAD_TIME_0_500_PERCENT (324):

Percent of creatives whose load time is between [0, 500ms).

Corresponds to “Creative load time 0 - 500ms (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

CREATIVE_LOAD_TIME_1000_2000_PERCENT (326):

Percent of creatives whose load time is between [1000, 2000ms).

Corresponds to “Creative load time 1s - 2s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

CREATIVE_LOAD_TIME_2000_4000_PERCENT (327):

Percent of creatives whose load time is between [2000, 4000ms).

Corresponds to “Creative load time 2s - 4s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

CREATIVE_LOAD_TIME_4000_8000_PERCENT (328):

Percent of creatives whose load time is between [4000, 8000ms).

Corresponds to “Creative load time 4s - 8s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

CREATIVE_LOAD_TIME_500_1000_PERCENT (325):

Percent of creatives whose load time is between [500, 1000ms).

Corresponds to “Creative load time 500ms - 1s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

CREATIVE_LOAD_TIME_GT_8000_PERCENT (329):

Percent of creatives load time is greater than 8000ms.

Corresponds to “Creative load time >8s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

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.

Corresponds to “Total CTR” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED

Data format: PERCENT

CTR_WITH_COMPANION (742):

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. Counts companion impressions in the number of ad impressions.

Corresponds to “Total CTR with companion” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, ADS_TRAFFIC_NAVIGATOR, AD_SPEED

Data format: PERCENT

DEALS_BIDS (542):

Number of bids received for a deal.

Corresponds to “Deals bids” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

DEALS_BID_RATE (543):

Bid rate for a deal.

Corresponds to “Deals bid rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

DEALS_BID_REQUESTS (544):

Number of bid requests sent for a deal.

Corresponds to “Deals bid requests” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

DEALS_WINNING_BIDS (545):

Number of winning bids for a deal.

Corresponds to “Deals winning bids” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

DEALS_WIN_RATE (546):

Bid win rate for a deal.

Corresponds to “Deals win rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

DOM_LOAD_TO_FIRST_AD_REQUEST_0_500_PERCENT (521):

Percent of dom load time to 1st ad request in [0, 500ms) range.

Corresponds to “Page navigation to first ad request time 0 - 500ms (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

DOM_LOAD_TO_FIRST_AD_REQUEST_1000_2000_PERCENT (522):

Percent of dom load time to 1st ad request in [1000ms, 2000ms) range.

Corresponds to “Page navigation to first ad request time 1s - 2s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

DOM_LOAD_TO_FIRST_AD_REQUEST_2000_4000_PERCENT (523):

Percent of dom load time to 1st ad request in [2000ms, 4000ms) range.

Corresponds to “Page navigation to first ad request time 2s - 4s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

DOM_LOAD_TO_FIRST_AD_REQUEST_4000_8000_PERCENT (524):

Percent of dom load time to 1st ad request in [4000ms, 8000ms) range.

Corresponds to “Page navigation to first ad request time 4s - 8s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

DOM_LOAD_TO_FIRST_AD_REQUEST_500_1000_PERCENT (525):

Percent of dom load time to 1st ad request in [500ms, 1000ms) range.

Corresponds to “Page navigation to first ad request time 500ms - 1s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

DOM_LOAD_TO_FIRST_AD_REQUEST_GT_8000_PERCENT (520):

Percent of dom load time to 1st ad request in [8000ms, +inf) range.

Corresponds to “Page navigation to first ad request time >8s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

DOM_LOAD_TO_TAG_LOAD_TIME_0_500_PERCENT (526):

Percent of dom load time to tag load time in [0, 500ms) range.

Corresponds to “Page navigation to tag loaded time 0 - 500ms (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

DOM_LOAD_TO_TAG_LOAD_TIME_1000_2000_PERCENT (527):

Percent of dom load time to tag load time in [1000ms, 2000ms) range.

Corresponds to “Page navigation to tag loaded time 1s - 2s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

DOM_LOAD_TO_TAG_LOAD_TIME_2000_4000_PERCENT (528):

Percent of dom load time to tag load time in [2000ms, 4000ms) range.

Corresponds to “Page navigation to tag loaded time 2s - 4s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

DOM_LOAD_TO_TAG_LOAD_TIME_4000_8000_PERCENT (529):

Percent of dom load time to tag load time in [4000ms, 8000ms) range.

Corresponds to “Page navigation to tag loaded time 4s - 8s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

DOM_LOAD_TO_TAG_LOAD_TIME_500_1000_PERCENT (531):

Percent of dom load time to tag load time in [500ms, 1000ms) range.

Corresponds to “Page navigation to tag loaded time 500ms - 1s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

DOM_LOAD_TO_TAG_LOAD_TIME_GT_8000_PERCENT (530):

Percent of dom load time to tag load time in [8000ms, +inf) range.

Corresponds to “Page navigation to tag loaded time >8s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

DROPOFF_RATE (415):

Percentage of ad responses that didn’t result in an impression.

Corresponds to “Drop-off rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

ENGAGED_SESSIONS (229):

Engaged session count from Google Analytics.

Corresponds to “Engaged sessions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

ENGAGED_SESSIONS_PER_USER (230):

Engaged sessions per user from Google Analytics.

Corresponds to “Engaged sessions per user” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

ENGAGEMENT_RATE (426):

The ratio of engaged sessions to sessions.

Corresponds to “Engagement rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

EUROPEAN_REGULATIONS_CONSENT_RATE (270):

Percentage of European regulations messages where the user consented to all of the purposes and vendors.

Corresponds to “European regulations consent rate” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: PERCENT

EUROPEAN_REGULATIONS_CUSTOM_CONSENT_RATE (271):

Percentage of European regulations messages where users made a consent choice after selecting “Manage options”.

Corresponds to “European regulations custom consent rate” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: PERCENT

EUROPEAN_REGULATIONS_MESSAGES_SHOWN (272):

Number of times a European regulations message was shown to users.

Corresponds to “European regulations messages shown” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

EUROPEAN_REGULATIONS_NO_CONSENT_RATE (273):

Percentage of European regulations messages where the user rejected all purposes and vendors.

Corresponds to “European regulations no consent rate” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: PERCENT

FILL_RATE (258):

The rate at which an ad request is filled by the ad server including dynamic allocation.

Corresponds to “Total fill rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

GOOGLE_ANALYTICS_CLICKS (231):

The number of clicks joined with Google Analytics data.

Corresponds to “Google Analytics clicks” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

GOOGLE_ANALYTICS_CTR (232):

The click-through rate from Google Analytics data.

Corresponds to “Google Analytics CTR” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

GOOGLE_ANALYTICS_ECPM (233):

The eCPM revenue data from Google Analytics.

Corresponds to “Google Analytics eCPM” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

GOOGLE_ANALYTICS_IMPRESSIONS (234):

The number of impressions joined with Google Analytics data.

Corresponds to “Google Analytics impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

GOOGLE_ANALYTICS_REVENUE (235):

The amount of revenue joined with Google Analytics data.

Corresponds to “Google Analytics revenue” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

GOOGLE_ANALYTICS_VIEWS (236):

Number of views of a web site or mobile screen from Google Analytics.

Corresponds to “Views” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

GOOGLE_ANALYTICS_VIEWS_PER_USER (237):

Number of views per user from Google Analytics.

Corresponds to “Views per user” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

GOOGLE_SOLD_AUCTION_COVIEWED_IMPRESSIONS (129):

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

Corresponds to “Google-sold auction impressions (co-viewed)” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: INTEGER

GOOGLE_SOLD_AUCTION_IMPRESSIONS (128):

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

Corresponds to “Google-sold auction impressions” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: INTEGER

GOOGLE_SOLD_COVIEWED_IMPRESSIONS (131):

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

Corresponds to “Google-sold impressions (co-viewed)” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: INTEGER

GOOGLE_SOLD_IMPRESSIONS (130):

The number of impressions sold by Google in partner sales.

Corresponds to “Google-sold impressions” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: INTEGER

GOOGLE_SOLD_RESERVATION_COVIEWED_IMPRESSIONS (127):

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

Corresponds to “Google-sold reservation impressions (co-viewed)” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: INTEGER

GOOGLE_SOLD_RESERVATION_IMPRESSIONS (126):

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

Corresponds to “Google-sold reservation impressions” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: INTEGER

IMPRESSIONS (1):

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

Corresponds to “Total impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, ADS_TRAFFIC_NAVIGATOR, AD_SPEED

Data format: INTEGER

IMPRESSIONS_WITH_COMPANION (741):

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

Corresponds to “Total impressions with companion” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, ADS_TRAFFIC_NAVIGATOR, AD_SPEED

Data format: INTEGER

INACTIVE_BEGIN_TO_RENDER_IMPRESSIONS (407):

The number of impressions (via begin to render methodology) considered inactive, as defined by served to a device receiving ad or bid requests continuously for a session of greater than 16 hours without a “reset” event. Only applied to CTV ads.

Corresponds to “Inactive begin to render impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

INVENTORY_SHARES (547):

The total number of inventory shares

Corresponds to “Inventory shares” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

INVENTORY_SHARE_PARTNER_UNFILLED_OPPORTUNITIES (548):

The total number of partner unfilled opportunities from an inventory share

Corresponds to “Inventory share partner unfilled opportunities” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

INVOICED_IMPRESSIONS (404):

The number of invoiced impressions.

Corresponds to “Invoiced impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

INVOICED_UNFILLED_IMPRESSIONS (405):

The number of invoiced unfilled impressions.

Corresponds to “Invoiced unfilled impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

MEDIATION_CHAINS_FILLED (584):

The number of mediation chains that were filled.

Corresponds to “Mediation chains filled” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

MUTED_IMPRESSIONS (412):

The number of impressions where the user chose to mute the ad.

Corresponds to “Total muted impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

MUTE_ELIGIBLE_IMPRESSIONS (409):

The number of impressions that had the “Mute This Ad” overlay applied.

Corresponds to “Total mute eligible impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

NIELSEN_AUDIENCE_INDEX (568):

Nielsen: The relative unique audience in the demographic compared with its share of the overall population.

Corresponds to “Audience index” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: PERCENT

NIELSEN_AVERAGE_FREQUENCY (569):

Nielsen: The average number of times that a person within the target audience sees an advertisement.

Corresponds to “Average frequency” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: DOUBLE

NIELSEN_AVERAGE_NUMBER_OF_VIEWERS (570):

Nielsen: The average number of viewers.

Corresponds to “Average number of viewers” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: DOUBLE

NIELSEN_GROSS_RATING_POINTS (571):

Nielsen: The unit of audience volume, based on the percentage of the reached target audience population multiplied by the average frequency.

Corresponds to “Gross rating points” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: PERCENT

NIELSEN_IMPRESSIONS (572):

Nielsen: The total number of impressions tracked for Nielsen Digital Ad Ratings measurement.

Corresponds to “Impressions” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: INTEGER

NIELSEN_IMPRESSIONS_INDEX (573):

Nielsen: The relative impressions per person in the demographic compared with the impressions per person for the overall population.

Corresponds to “Impressions index” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: PERCENT

NIELSEN_IN_TARGET_RATIO (576):

Nielsen: The adjusted in-target impression share used for pacing and billing.

Corresponds to “Processed Nielsen in-target rate” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: PERCENT

NIELSEN_PERCENT_AUDIENCE_REACH (578):

Nielsen: The unique audience reached as a percentage of the population base.

Corresponds to “% audience reach” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: PERCENT

NIELSEN_PERCENT_AUDIENCE_SHARE (579):

Nielsen: The share of the unique audience in the demographic.

Corresponds to “% audience share” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: PERCENT

NIELSEN_PERCENT_IMPRESSIONS_SHARE (580):

Nielsen: The share of impressions that reached the target demographic.

Corresponds to “% impression share” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: PERCENT

NIELSEN_PERCENT_POPULATION_SHARE (581):

Nielsen: The share of the total population represented by the population base.

Corresponds to “% population share” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: PERCENT

NIELSEN_POPULATION_BASE (582):

Nielsen: The population in the demographic.

Corresponds to “Population base” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: INTEGER

NIELSEN_UNIQUE_AUDIENCE (583):

Nielsen: The total number of different people within the selected demographic who were reached.

Corresponds to “Unique audience” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: INTEGER

OFF_PROPERTY_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS (395):

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

Corresponds to “Off-property Active View measurable impressions” in the Ad Manager UI.

Compatible with the following report types: OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

OFF_PROPERTY_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS (396):

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

Corresponds to “Off-property Active View viewable impressions” in the Ad Manager UI.

Compatible with the following report types: OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

OFF_PROPERTY_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE (397):

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

Corresponds to “Off-property Active View % viewable impressions” in the Ad Manager UI.

Compatible with the following report types: OFF_PROPERTY_CAMPAIGNS

Data format: PERCENT

OFF_PROPERTY_CLICKS (398):

The total number of cross publisher clicks.

Corresponds to “Off-property clicks” in the Ad Manager UI.

Compatible with the following report types: OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

OFF_PROPERTY_CTR (399):

The ratio of cross publisher impressions that resulted in users clicking on an ad. Cross publisher CTR is calculated as: (Cross publisher clicks / Cross publisher impressions).

Corresponds to “Off-property CTR” in the Ad Manager UI.

Compatible with the following report types: OFF_PROPERTY_CAMPAIGNS

Data format: PERCENT

OFF_PROPERTY_IMPRESSIONS (400):

The total number of cross publisher impressions.

Corresponds to “Off-property impressions” in the Ad Manager UI.

Compatible with the following report types: OFF_PROPERTY_CAMPAIGNS

Data format: INTEGER

OFF_PROPERTY_REVENUE (401):

The total cross publisher revenue from line item and works with the currency code from the same line item.

Corresponds to “Off-property revenue” in the Ad Manager UI.

Compatible with the following report types: OFF_PROPERTY_CAMPAIGNS

Data format: MONEY

OFF_PROPERTY_SPEND (402):

The total cross publisher spend and works with the billing currency code of the this network.

Corresponds to “Off-property spend” in the Ad Manager UI.

Compatible with the following report types: OFF_PROPERTY_CAMPAIGNS

Data format: MONEY

OFF_PROPERTY_SPEND_ECPM (403):

The average effective cost-per-thousand-impressions earned from the ads delivered from cross publisher traffic.

Corresponds to “Off-property spend eCPM” in the Ad Manager UI.

Compatible with the following report types: OFF_PROPERTY_CAMPAIGNS

Data format: MONEY

ON_PLATFORM_MULTIPLE_CALL_ECPM (678):

Average effective cost-per-thousand-impressions earned from the mediation on-platform multiple call, excluding CPD value.

Corresponds to “On-platform multiple call eCPM” in the Ad Manager UI.

Compatible with the following report types: ON_PLATFORM_MULTICALL

Data format: MONEY

ON_PLATFORM_MULTIPLE_CALL_IMPRESSIONS (676):

Total impressions delivered by the mediation on-platform multiple call.

Corresponds to “On-platform multiple call impressions” in the Ad Manager UI.

Compatible with the following report types: ON_PLATFORM_MULTICALL

Data format: INTEGER

ON_PLATFORM_MULTIPLE_CALL_REVENUE (677):

Total revenue from the mediation on-platform multiple call.

Corresponds to “On-platform multiple call revenue” in the Ad Manager UI.

Compatible with the following report types: ON_PLATFORM_MULTICALL

Data format: MONEY

OPPORTUNITIES (463):

The total number of opportunities from impressions and errors.

Corresponds to “Total opportunities” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

OVERDELIVERED_IMPRESSIONS (432):

The number of impressions that were overdelivered.

Corresponds to “Total overdelivered impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

PARTNER_FINANCE_GROSS_REVENUE (648):

The gross revenue for partner finance reports.

Corresponds to “Gross revenue” in the Ad Manager UI.

Compatible with the following report types: PARTNER_FINANCE

Data format: MONEY

PARTNER_FINANCE_HOST_ECPM (649):

Monthly host eCPM for partner finance reports

Corresponds to “Host eCPM” in the Ad Manager UI.

Compatible with the following report types: PARTNER_FINANCE

Data format: MONEY

PARTNER_FINANCE_HOST_IMPRESSIONS (650):

The host impressions for partner finance reports.

Corresponds to “Host impressions” in the Ad Manager UI.

Compatible with the following report types: PARTNER_FINANCE

Data format: INTEGER

PARTNER_FINANCE_HOST_REVENUE (651):

Monthly host revenue for partner finance reports

Corresponds to “Host revenue” in the Ad Manager UI.

Compatible with the following report types: PARTNER_FINANCE

Data format: MONEY

PARTNER_FINANCE_PARTNER_ECPM (652):

Monthly partner eCPM for partner finance reports

Corresponds to “Partner eCPM” in the Ad Manager UI.

Compatible with the following report types: PARTNER_FINANCE

Data format: MONEY

PARTNER_FINANCE_PARTNER_REVENUE (653):

Monthly partner revenue for partner finance reports

Corresponds to “Partner revenue” in the Ad Manager UI.

Compatible with the following report types: PARTNER_FINANCE

Data format: MONEY

PARTNER_MANAGEMENT_GROSS_REVENUE (533):

The gross revenue in the partner management.

Corresponds to “Partner management gross revenue” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

PARTNER_MANAGEMENT_HOST_CLICKS (534):

The host clicks in the partner management.

Corresponds to “Partner management host clicks” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

PARTNER_MANAGEMENT_HOST_CTR (535):

The host CTR in the partner management.

Corresponds to “Partner management host CTR” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

PARTNER_MANAGEMENT_HOST_IMPRESSIONS (536):

The host impressions in the partner management.

Corresponds to “Partner management host impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

PARTNER_MANAGEMENT_PARTNER_CLICKS (537):

The partner clicks in the partner management.

Corresponds to “Partner management partner clicks” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

PARTNER_MANAGEMENT_PARTNER_CTR (538):

The partner CTR in the partner management.

Corresponds to “Partner management partner CTR” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

PARTNER_MANAGEMENT_PARTNER_IMPRESSIONS (539):

The partner impressions in the partner management.

Corresponds to “Partner management partner impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

PARTNER_MANAGEMENT_TOTAL_CONTENT_VIEWS (540):

The total content views in the partner management.

Corresponds to “Partner management total monetizable content views” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

PARTNER_MANAGEMENT_UNFILLED_IMPRESSIONS (541):

The unfilled impressions in the partner management.

Corresponds to “Partner management unfilled impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, PARTNER_FINANCE

Data format: INTEGER

PARTNER_SALES_FILLED_POD_REQUESTS (135):

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

Corresponds to “Filled pod requests” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: INTEGER

PARTNER_SALES_FILL_RATE (136):

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

Corresponds to “Fill rate” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: PERCENT

PARTNER_SALES_PARTNER_MATCH_RATE (137):

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

Corresponds to “Partner match rate” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: PERCENT

PARTNER_SALES_QUERIES (132):

The number of queries eligible for partner sales.

Corresponds to “Total partner sales ad requests” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: INTEGER

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.

Corresponds to “Partner unfilled impressions” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: INTEGER

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.

Corresponds to “Partner unmatched ad requests” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: INTEGER

PARTNER_SOLD_CODE_SERVED (125):

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

Corresponds to “Partner-sold code served count” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: INTEGER

PARTNER_SOLD_COVIEWED_IMPRESSIONS (124):

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

Corresponds to “Partner-sold impressions (co-viewed)” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: INTEGER

PARTNER_SOLD_IMPRESSIONS (123):

The number of impressions sold by partner in partner sales.

Corresponds to “Partner-sold impressions” in the Ad Manager UI.

Compatible with the following report types: YOUTUBE_CONSOLIDATED

Data format: INTEGER

POD_ECPM (738):

Total pod eCPM.

Corresponds to “Total pod eCPM” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

POD_ECPM_WITHOUT_CPD (739):

Total pod eCPM without CPD.

Corresponds to “Total pod eCPM without CPD” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

POD_VIEWS (740):

Total pod views.

Corresponds to “Total pod views” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

PROGRAMMATIC_ELIGIBLE_AD_REQUESTS (177):

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

Corresponds to “Programmatic eligible ad requests” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

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.

Corresponds to “Programmatic match rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

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.

Corresponds to “Programmatic responses served” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

REACH_IMPRESSIONS (416):

Number of impressions for reach reports.

Corresponds to “Total reach impressions” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: INTEGER

RESPONSES_SERVED (39):

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

Corresponds to “Total responses served” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RETENTION (238):

Retention of users in Google Analytics

Corresponds to “Retention” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

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.

Corresponds to “Total revenue” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, AD_SPEED

Data format: MONEY

REVENUE_PAID_THROUGH_MCM_AUTOPAYMENT (214):

The total revenue accrued in the child network’s own account but paid to their parent network through auto-payment. This metric is only relevant for a “Manage Account” child network.

Corresponds to “Total revenue paid through MCM auto-payment” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

REVENUE_VERIFICATION_CPD_REVENUE (560):

The total CPD net revenue for Revenue Verification reporting.

Corresponds to “Total CPD revenue” in the Ad Manager UI.

Compatible with the following report types: REVENUE_VERIFICATION

Data format: MONEY

REVENUE_VERIFICATION_GROSS_CPD_REVENUE (559):

The total CPD gross revenue for Revenue Verification reporting.

Corresponds to “Total CPD revenue (gross)” in the Ad Manager UI.

Compatible with the following report types: REVENUE_VERIFICATION

Data format: MONEY

REVENUE_VERIFICATION_GROSS_REVENUE_WITHOUT_CPD (561):

The total gross revenue (excluding CPD) for Revenue Verification reporting.

Corresponds to “Total CPM and CPC revenue (gross)” in the Ad Manager UI.

Compatible with the following report types: REVENUE_VERIFICATION

Data format: MONEY

REVENUE_VERIFICATION_IMPRESSIONS (564):

The total impressions for Revenue Verification reporting.

Corresponds to “Total impressions” in the Ad Manager UI.

Compatible with the following report types: REVENUE_VERIFICATION

Data format: INTEGER

REVENUE_VERIFICATION_REVENUE_WITHOUT_CPD (567):

The total net revenue (excluding CPD) for Revenue Verification reporting.

Corresponds to “Total CPM and CPC revenue” in the Ad Manager UI.

Compatible with the following report types: REVENUE_VERIFICATION

Data format: MONEY

REVENUE_WITHOUT_CPD (4):

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

Corresponds to “Total CPM and CPC revenue” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL, ADS_TRAFFIC_NAVIGATOR

Data format: MONEY

REWARDS_GRANTED (413):

The number of rewards granted to users from watching ads.

Corresponds to “Total rewards granted” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_AVERAGE_DISPLAY_TIME (587):

The average amount of time (in seconds) that each rich media ad is displayed to users.

Corresponds to “Average display time” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

RICH_MEDIA_AVERAGE_INTERACTION_TIME (588):

The average amount of time (in seconds) that a user interacts with a rich media ad.

Corresponds to “Average interaction time” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

RICH_MEDIA_BACKUP_IMAGES (589):

The total number of times a backup image is served in place of a rich media ad.

Corresponds to “Backup image impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_CUSTOM_EVENT_COUNT (599):

The number of times a user interacts with a specific part of a rich media ad.

Corresponds to “Custom event - count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_CUSTOM_EVENT_TIME (600):

The amount of time (in seconds) that a user interacts with a specific part of a rich media ad.

Corresponds to “Custom event - time” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

RICH_MEDIA_DISPLAY_TIME (590):

The amount of time (in seconds) that each rich media ad is displayed to users.

Corresponds to “Total display time” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

RICH_MEDIA_EXPANDING_TIME (591):

The average amount of time (in seconds) that an expanding ad is viewed in an expanded state.

Corresponds to “Average expanding time” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

RICH_MEDIA_EXPANSIONS (592):

The number of times an expanding ad was expanded.

Corresponds to “Total expansions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_FULL_SCREEN_IMPRESSIONS (593):

The number of times a user opens a rich media ad in full screen mode.

Corresponds to “Full-screen impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_INTERACTION_COUNT (594):

The number of times that a user interacts with a rich media ad.

Corresponds to “Total interactions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_INTERACTION_RATE (595):

The ratio of rich media ad interactions to the number of times the ad was displayed.

Corresponds to “Interaction rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

RICH_MEDIA_INTERACTION_TIME (596):

The total amount of time (in seconds) that a user interacts with a rich media ad.

Corresponds to “Interaction time” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

RICH_MEDIA_INTERACTIVE_IMPRESSIONS (597):

The number of impressions where a user interacted with a rich media ad.

Corresponds to “Interactive impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_MANUAL_CLOSES (598):

The number of times that a user manually closes a rich media ad.

Corresponds to “Manual closes” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_VIDEO_COMPLETES (503):

The number of times a rich media video was fully played.

Corresponds to “Rich media video completes” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_VIDEO_INTERACTIONS (505):

The number of times a user clicked on the graphical controls of a video player.

Corresponds to “Rich media total video interactions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_VIDEO_INTERACTION_RATE (504):

The ratio of video interactions to video plays. Represented as a percentage.

Corresponds to “Rich media video interaction rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

RICH_MEDIA_VIDEO_MIDPOINTS (506):

The number of times a rich media video was played up to midpoint.

Corresponds to “Rich media video midpoints” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_VIDEO_MUTES (507):

The number of times a rich media video was muted.

Corresponds to “Rich media video mutes” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_VIDEO_PAUSES (508):

The number of times a rich media video was paused.

Corresponds to “Rich media video pauses” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_VIDEO_PLAYS (509):

The number of times a rich media video was played.

Corresponds to “Rich media video plays” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_VIDEO_REPLAYS (510):

The number of times a rich media video was restarted.

Corresponds to “Rich media video replays” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_VIDEO_STOPS (511):

The number of times a rich media video was stopped.

Corresponds to “Rich media video stops” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_VIDEO_UNMUTES (512):

The number of times a rich media video was unmuted.

Corresponds to “Rich media video unmutes” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

RICH_MEDIA_VIDEO_VIEW_RATE (513):

The percentage of a video watched by a user.

Corresponds to “Rich media video view rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

RICH_MEDIA_VIDEO_VIEW_TIME (514):

The average amount of time(seconds) that a rich media video was viewed per view.

Corresponds to “Rich media video average view time” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

SELL_THROUGH_AVAILABLE_IMPRESSIONS (477):

The number of forecasted impressions not reserved by any line item.

Corresponds to “Available impressions” in the Ad Manager UI.

Compatible with the following report types: FUTURE_SELL_THROUGH

Data format: INTEGER

SELL_THROUGH_FORECASTED_IMPRESSIONS (478):

The total number of forecasted impressions.

Corresponds to “Forecasted impressions” in the Ad Manager UI.

Compatible with the following report types: FUTURE_SELL_THROUGH

Data format: INTEGER

SELL_THROUGH_RESERVED_IMPRESSIONS (479):

The number of forecasted impressions reserved by line items.

Corresponds to “Reserved impressions” in the Ad Manager UI.

Compatible with the following report types: FUTURE_SELL_THROUGH

Data format: INTEGER

SELL_THROUGH_SELL_THROUGH_RATE (480):

The fraction of forecasted impressions reserved by line items.

Corresponds to “Sell-through rate” in the Ad Manager UI.

Compatible with the following report types: FUTURE_SELL_THROUGH

Data format: PERCENT

SERVER_SIDE_UNWRAPPING_AVERAGE_LATENCY_MS (434):

The average latency in milliseconds across all server-side unwrapping callout requests. There is no special handling for error or timeout responses. This reflects the entire chain of a parent callout request, which may result in multiple child callouts. This metric is not sliced by child callout dimensions.

Corresponds to “Server-side unwrapping average latency (milliseconds)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

SERVER_SIDE_UNWRAPPING_CALLOUTS (435):

The total number of server-side unwrapping callout requests.

Corresponds to “Server-side unwrapping callouts” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

SERVER_SIDE_UNWRAPPING_EMPTY_RESPONSES (436):

The total number of server-side unwrapping callouts that returned an empty response. Timeouts are not considered empty responses.

Corresponds to “Server-side unwrapping empty responses” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

SERVER_SIDE_UNWRAPPING_ERROR_RESPONSES (437):

The total number of server-side unwrapping callouts that returned an error response. Timeouts and empty responses are not considered errors.

Corresponds to “Server-side unwrapping error responses” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

SERVER_SIDE_UNWRAPPING_SUCCESSFUL_RESPONSES (438):

The total number of successfully unwrapped, non-empty server-side wrapping callouts. Successful unwrapping does not indicate that the resulting creative was served.

Corresponds to “Server-side unwrapping successful responses” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

SERVER_SIDE_UNWRAPPING_TIMEOUTS (439):

The total number of server-side unwrapping callouts that timed out before returning a response.

Corresponds to “Server-side unwrapping timeouts” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

SESSIONS (239):

Count of sessions from Google Analytics.

Corresponds to “Sessions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

TAG_LOAD_TO_FIRST_AD_REQUEST_0_500_PERCENT (455):

Percent of tag load time to 1st ad request in [0, 500ms) range.

Corresponds to “Tag loaded to first ad request time 0 - 500ms (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

TAG_LOAD_TO_FIRST_AD_REQUEST_1000_2000_PERCENT (457):

Percent of tag load time to 1st ad request in [1000ms, 2000ms) range.

Corresponds to “Tag loaded to first ad request time 1s - 2s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

TAG_LOAD_TO_FIRST_AD_REQUEST_2000_4000_PERCENT (458):

Percent of tag load time to 1st ad request in [2000ms, 4000ms) range.

Corresponds to “Tag loaded to first ad request time 2s - 4s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

TAG_LOAD_TO_FIRST_AD_REQUEST_4000_8000_PERCENT (459):

Percent of tag load time to 1st ad request in [4000ms, 8000ms) range.

Corresponds to “Tag loaded to first ad request time 4s - 8s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

TAG_LOAD_TO_FIRST_AD_REQUEST_500_1000_PERCENT (456):

Percent of tag load time to 1st ad request in [500ms, 1000ms) range.

Corresponds to “Tag loaded to first ad request time 500ms - 1s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

TAG_LOAD_TO_FIRST_AD_REQUEST_GT_8000_PERCENT (460):

Percent of tag load time to 1st ad request in [8000ms, +inf) range.

Corresponds to “Tag loaded to first ad request time >8s (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

TARGETED_CLICKS (276):

The total number of clicks delivered including line item-level dynamic allocation by explicit custom criteria targeting.

Corresponds to “Total targeted clicks” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

TARGETED_IMPRESSIONS (277):

The total number of impressions delivered including line item-level dynamic allocation by explicit custom criteria targeting.

Corresponds to “Total targeted impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

UNFILLED_IMPRESSIONS (45):

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

Corresponds to “Unfilled impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

UNIQUE_VISITORS (417):

The total number of unique users who viewed the ad.

Corresponds to “Total unique visitors” in the Ad Manager UI.

Compatible with the following report types: REACH

Data format: INTEGER

UNLOADED_IMPRESSIONS_DUE_TO_CPU (408):

The number of impressions impacted by Chrome Ads Intervention due to CPU usage.

Corresponds to “Total unloaded impressions due to CPU” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

UNLOADED_IMPRESSIONS_DUE_TO_NETWORK (406):

The number of impressions impacted by Chrome Ads Intervention due to network usage.

Corresponds to “Total unloaded impressions due to Network” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

UNMATCHED_AD_REQUESTS (43):

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

Corresponds to “Total unmatched ad requests” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

UNVIEWED_REASON_OTHER_PERCENT (550):

The percentage of unviewed impressions due to other reasons.

Corresponds to “Other non-viewable impression reasons (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

UNVIEWED_REASON_SLOT_NEVER_ENTERED_VIEWPORT_PERCENT (553):

The percentage of unviewed impressions due to slot never entered viewport.

Corresponds to “Slot never entered viewport (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_FILLED_PERCENT (551):

The percentage of unviewed impressions due to scrolled past before ad filled.

Corresponds to “User scrolled before ad filled (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_LOADED_PERCENT (552):

The percentage of unviewed impressions due to scrolled past before ad loaded.

Corresponds to “User scrolled/navigated before ad loaded (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

UNVIEWED_REASON_USER_SCROLLED_BEFORE_ONE_SECOND_PERCENT (549):

The percentage of unviewed impressions due to insufficient time on screen.

Corresponds to “User scrolled/navigated before 1 second (%)” in the Ad Manager UI.

Compatible with the following report types: AD_SPEED

Data format: PERCENT

USER_ENGAGEMENT_DURATION_IN_SECONDS (240):

Time of users interacting with web site or mobile app from Google Analytics in seconds.

Corresponds to “User engagement duration (seconds)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

USER_MESSAGES_AD_BLOCKING_EXTENSION_RATE (486):

Fraction of page views where users had ad blocker extensions installed. Includes only Desktop page views.

Corresponds to “Ad blocking extension rate” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: PERCENT

USER_MESSAGES_AD_BLOCKING_RECOVERY_ALLOWLISTED_COUNT (487):

Number of ad-blocking messages shown in the selected date range that resulted in users adding the site to their allowlist to view ads

Corresponds to “Ad blocking recovery message conversions” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_AD_BLOCKING_RECOVERY_MESSAGES_SHOWN (488):

Number of times an ad blocking recovery message was shown to users.

Corresponds to “Ad blocking recovery messages shown” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_ALLOW_ADS_PAGEVIEWS (489):

The number of page views generated by users with an ad blocking extension installed who were shown the ad blocking recovery message and later allowed ads.

Corresponds to “Allow-ads page views” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_IDFA_ATT_ALERTS_SHOWN (491):

Number of iOS ATT alerts that were triggered by an IDFA message (IDFA messages can be IDFA explainers or GDPR messages).

Corresponds to “IDFA ATT alerts shown” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_IDFA_ATT_CONSENT (492):

Number of iOS ATT alerts triggered by the IDFA message where the user chose to allow tracking.

Corresponds to “IDFA ATT consent” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_IDFA_ATT_CONSENT_RATE (493):

Percentage of iOS ATT alerts triggered by the IDFA message where the outcome was to allow tracking.

Corresponds to “IDFA ATT consent rate” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: PERCENT

USER_MESSAGES_IDFA_ATT_DECLINE_CONSENT (494):

Number of iOS ATT alerts triggered by the IDFA message where the user chose to deny tracking.

Corresponds to “IDFA ATT decline consent” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_IDFA_ATT_DECLINE_RATE (495):

Percentage of iOS ATT alerts triggered by the IDFA message where the user chose to deny tracking.

Corresponds to “IDFA ATT decline rate” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: PERCENT

USER_MESSAGES_IDFA_EXPLAINERS_SHOWN (496):

Number of times an IDFA explainer message was shown to users.

Corresponds to “IDFA explainers shown” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_IDFA_IAB_MESSAGES_SHOWN (497):

Number of times a European regulations message was shown immediately before the iOS ATT alert.

Corresponds to “IDFA IAB messages shown” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_IDFA_NO_DECISION (498):

Number of IDFA explainer messages where the user didn’t choose anything.

Corresponds to “IDFA no decision” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_OFFERWALL_MESSAGES_SHOWN (121):

Number of times an Offerwall message was shown to users.

Corresponds to “Offerwall messages shown” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_OFFERWALL_SUCCESSFUL_ENGAGEMENTS (122):

The number of messages where the user gained an entitlement.

Corresponds to “Monetized Offerwall engagements” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_POST_OFFERWALL_PAGEVIEWS (499):

The number of pages viewed by users after gaining an entitlement. Only counts pages included for Offerwall.

Corresponds to “Post-offerwall page views” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_TOTAL_ESTIMATED_REVENUE (500):

Revenue earned through Offerwall, including Rewarded ad revenue and third-party integrations.

Corresponds to “Estimated Offerwall revenue” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: MONEY

USER_MESSAGES_UPTC_MESSAGES_SHOWN (501):

Number of times an ads personalization controls message was shown to users.

Corresponds to “Ads personalization messages shown” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_UPTC_PERSONALIZATION_OPT_OUT_RATIO (502):

Percentage of ads personalization controls messages where users chose the opt-out option.

Corresponds to “Personalization opt-out ratio” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: PERCENT

USER_MESSAGES_US_STATES_MESSAGES_SHOWN (490):

Number of times a US state regulations message was shown to users.

Corresponds to “US states messages shown” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

USER_MESSAGES_US_STATES_OPT_OUT_SELECTIONS (586):

Number of times users selected the opt-out option in a US states message.

Corresponds to “US states opt-out selections” in the Ad Manager UI.

Compatible with the following report types: PRIVACY_AND_MESSAGING

Data format: INTEGER

VIDEO_ERROR_100_COUNT (180):

The number of errors of type 100 in reporting.

Corresponds to “VAST error 100 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_101_COUNT (181):

The number of errors of type 101 in reporting.

Corresponds to “VAST error 101 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_102_COUNT (182):

The number of errors of type 102 in reporting.

Corresponds to “VAST error 102 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_200_COUNT (183):

The number of errors of type 200 in reporting.

Corresponds to “VAST error 200 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_201_COUNT (184):

The number of errors of type 201 in reporting.

Corresponds to “VAST error 201 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_202_COUNT (185):

The number of errors of type 202 in reporting.

Corresponds to “VAST error 202 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_203_COUNT (186):

The number of errors of type 203 in reporting.

Corresponds to “VAST error 203 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_300_COUNT (187):

The number of errors of type 300 in reporting.

Corresponds to “VAST error 300 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_301_COUNT (188):

The number of errors of type 301 in reporting.

Corresponds to “VAST error 301 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_302_COUNT (189):

The number of errors of type 302 in reporting.

Corresponds to “VAST error 302 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_303_COUNT (190):

The number of errors of type 303 in reporting.

Corresponds to “VAST error 303 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_400_COUNT (191):

The number of errors of type 400 in reporting.

Corresponds to “VAST error 400 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_401_COUNT (192):

The number of errors of type 401 in reporting.

Corresponds to “VAST error 401 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_402_COUNT (193):

The number of errors of type 402 in reporting.

Corresponds to “VAST error 402 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_403_COUNT (194):

The number of errors of type 403 in reporting.

Corresponds to “VAST error 403 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_405_COUNT (195):

The number of errors of type 405 in reporting.

Corresponds to “VAST error 405 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_406_COUNT (196):

The number of errors of type 406 in reporting.

Corresponds to “VAST error 406 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_407_COUNT (197):

The number of errors of type 407 in reporting.

Corresponds to “VAST error 407 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_408_COUNT (198):

The number of errors of type 408 in reporting.

Corresponds to “VAST error 408 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_409_COUNT (199):

The number of errors of type 409 in reporting.

Corresponds to “VAST error 409 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_410_COUNT (200):

The number of errors of type 410 in reporting.

Corresponds to “VAST error 410 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_500_COUNT (201):

The number of errors of type 500 in reporting.

Corresponds to “VAST error 500 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_501_COUNT (202):

The number of errors of type 501 in reporting.

Corresponds to “VAST error 501 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_502_COUNT (203):

The number of errors of type 502 in reporting.

Corresponds to “VAST error 502 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_503_COUNT (204):

The number of errors of type 503 in reporting.

Corresponds to “VAST error 503 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_600_COUNT (205):

The number of errors of type 600 in reporting.

Corresponds to “VAST error 600 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_601_COUNT (206):

The number of errors of type 601 in reporting.

Corresponds to “VAST error 601 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_602_COUNT (207):

The number of errors of type 602 in reporting.

Corresponds to “VAST error 602 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_603_COUNT (208):

The number of errors of type 603 in reporting.

Corresponds to “VAST error 603 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_604_COUNT (209):

The number of errors of type 604 in reporting.

Corresponds to “VAST error 604 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_900_COUNT (210):

The number of errors of type 900 in reporting.

Corresponds to “VAST error 900 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_ERROR_901_COUNT (211):

The number of errors of type 901 in reporting.

Corresponds to “VAST error 901 count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_INTERACTION_AVERAGE_INTERACTION_RATE (92):

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

Corresponds to “Average interaction rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

VIDEO_INTERACTION_COLLAPSES (93):

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

Corresponds to “Collapses” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_INTERACTION_EXPANDS (95):

The number of times a user expands a video.

Corresponds to “Expands” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_INTERACTION_FULL_SCREENS (96):

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

Corresponds to “Full screens” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_INTERACTION_MUTES (97):

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

Corresponds to “Mutes” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_INTERACTION_PAUSES (98):

The number of times user paused ad clip.

Corresponds to “Pauses” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_INTERACTION_RESUMES (99):

The number of times the user unpaused the video.

Corresponds to “Resumes” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_INTERACTION_REWINDS (100):

The number of times a user rewinds the video.

Corresponds to “Rewinds” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_INTERACTION_UNMUTES (101):

The number of times a user unmutes the video.

Corresponds to “Unmutes” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_INTERACTION_VIDEO_SKIPS (102):

The number of times a skippable video is skipped.

Corresponds to “Skips” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_MONETIZABLE_CONTENT_VIEWS (601):

The number of views for monetizable video content.

Corresponds to “Monetizable content views” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_REAL_TIME_CREATIVE_SERVES (139):

The number of total creative serves in video realtime reporting.

Corresponds to “Total creative serves” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_100_COUNT (143):

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

Corresponds to “VAST error 100 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_101_COUNT (144):

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

Corresponds to “VAST error 101 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_102_COUNT (145):

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

Corresponds to “VAST error 102 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_200_COUNT (146):

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

Corresponds to “VAST error 200 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_201_COUNT (147):

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

Corresponds to “VAST error 201 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_202_COUNT (148):

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

Corresponds to “VAST error 202 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_203_COUNT (149):

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

Corresponds to “VAST error 203 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_300_COUNT (150):

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

Corresponds to “VAST error 300 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_301_COUNT (151):

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

Corresponds to “VAST error 301 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_302_COUNT (152):

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

Corresponds to “VAST error 302 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_303_COUNT (153):

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

Corresponds to “VAST error 303 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_400_COUNT (154):

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

Corresponds to “VAST error 400 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_401_COUNT (155):

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

Corresponds to “VAST error 401 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_402_COUNT (156):

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

Corresponds to “VAST error 402 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_403_COUNT (157):

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

Corresponds to “VAST error 403 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_405_COUNT (158):

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

Corresponds to “VAST error 405 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_406_COUNT (159):

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

Corresponds to “VAST error 406 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_407_COUNT (160):

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

Corresponds to “VAST error 407 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_408_COUNT (161):

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

Corresponds to “VAST error 408 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_409_COUNT (162):

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

Corresponds to “VAST error 409 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_410_COUNT (163):

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

Corresponds to “VAST error 410 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_500_COUNT (164):

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

Corresponds to “VAST error 500 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_501_COUNT (165):

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

Corresponds to “VAST error 501 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_502_COUNT (166):

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

Corresponds to “VAST error 502 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_503_COUNT (167):

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

Corresponds to “VAST error 503 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_600_COUNT (168):

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

Corresponds to “VAST error 600 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_601_COUNT (169):

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

Corresponds to “VAST error 601 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_602_COUNT (170):

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

Corresponds to “VAST error 602 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_603_COUNT (171):

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

Corresponds to “VAST error 603 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_604_COUNT (172):

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

Corresponds to “VAST error 604 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_900_COUNT (173):

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

Corresponds to “VAST error 900 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_ERROR_901_COUNT (174):

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

Corresponds to “VAST error 901 count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_IMPRESSIONS (138):

The number of total impressions in video realtime reporting.

Corresponds to “Total impressions” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_MATCHED_QUERIES (140):

The number of matched queries in video realtime reporting.

Corresponds to “Total responses served” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_TOTAL_ERROR_COUNT (175):

The number of all errors in video realtime reporting.

Corresponds to “Total error count” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_TOTAL_QUERIES (142):

The number of total queries in video realtime reporting.

Corresponds to “Total ad requests” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_REAL_TIME_UNMATCHED_QUERIES (141):

The number of unmatched queries in video realtime reporting.

Corresponds to “Total unmatched ad requests” in the Ad Manager UI.

Compatible with the following report types: REAL_TIME_VIDEO

Data format: INTEGER

VIDEO_TRUE_OPPORTUNITIES_TOTAL_BREAK_END (279):

The total number of breaks completed or fatal errors for the last ad in the pod.

Corresponds to “Break end” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_TRUE_OPPORTUNITIES_TOTAL_BREAK_START (280):

The total number of breaks starts or errors for the first ad in a pod that users made it to.

Corresponds to “Break start” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_TRUE_OPPORTUNITIES_TOTAL_CAPPED_OPPORTUNITIES_ADBREAK (281):

The number of video ad opportunities reached by a user (rounded down, or capped based on your max ads setting, whichever is less).

Corresponds to “Capped opportunities (adbreak)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_TRUE_OPPORTUNITIES_TOTAL_CAPPED_OPPORTUNITIES_SUBPOD (282):

The number of video ad opportunities reached by a user (rounded down, or capped based on your max ads setting, whichever is less).

Corresponds to “Capped opportunities (subpod)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_TRUE_OPPORTUNITIES_TOTAL_DURATION_ADBREAK (283):

The total number of seconds available to be filled.

Corresponds to “Total duration (adbreak)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_TRUE_OPPORTUNITIES_TOTAL_DURATION_SUBPOD (284):

The total number of seconds available to be filled.

Corresponds to “Total duration (subpod)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_TRUE_OPPORTUNITIES_TOTAL_MATCHED_DURATION_ADBREAK (285):

The total number of seconds filled.

Corresponds to “Matched duration (adbreak)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_TRUE_OPPORTUNITIES_TOTAL_MATCHED_DURATION_SUBPOD (286):

The total number of seconds filled.

Corresponds to “Matched duration (subpod)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_TRUE_OPPORTUNITIES_TOTAL_MATCHED_OPPORTUNITIES_ADBREAK (287):

The total matched opportunities in video true opportunities reporting.

Corresponds to “Matched opportunities (adbreak)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_TRUE_OPPORTUNITIES_TOTAL_MATCHED_OPPORTUNITIES_SUBPOD (288):

The total matched opportunities in video true opportunities reporting.

Corresponds to “Matched opportunities (subpod)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_TRUE_OPPORTUNITIES_TOTAL_VIEWED_OPPORTUNITIES_ADBREAK (289):

The number of video ad opportunities reached by a user (rounded down).

Corresponds to “Viewed opportunities (adbreak)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_TRUE_OPPORTUNITIES_TOTAL_VIEWED_OPPORTUNITIES_SUBPOD (290):

The number of video ad opportunities reached by a user (rounded down).

Corresponds to “Viewed opportunities (subpod)” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_TRUE_VIEWS (392):

The number of TrueView ad impressions viewed.

Corresponds to “True views” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_TRUE_VIEW_SKIP_RATE (393):

Measures the percentage of skips.

Corresponds to “True views skip rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

VIDEO_TRUE_VIEW_VIEW_THROUGH_RATE (394):

The view-through rate is the percentage of views divided by number of impressions

Corresponds to “True views view-through rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

VIDEO_VIEWERSHIP_AUTO_PLAYS (103):

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

Corresponds to “Auto-plays” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_VIEWERSHIP_AVERAGE_VIEW_RATE (104):

Average percentage of the video watched by users.

Corresponds to “Average view rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

VIDEO_VIEWERSHIP_AVERAGE_VIEW_TIME (105):

Average time(seconds) users watched the video.

Corresponds to “Average view time” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

VIDEO_VIEWERSHIP_CLICK_TO_PLAYS (106):

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

Corresponds to “Click-to-plays” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_VIEWERSHIP_COMPLETES (107):

The number of times the video played to completion.

Corresponds to “Completes” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_VIEWERSHIP_COMPLETION_RATE (108):

Percentage of times the video played to the end.

Corresponds to “Completion rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

VIDEO_VIEWERSHIP_ENGAGED_VIEWS (109):

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

Corresponds to “Engaged views” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_VIEWERSHIP_FIRST_QUARTILES (110):

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

Corresponds to “First quartiles” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_VIEWERSHIP_MIDPOINTS (111):

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

Corresponds to “Midpoints” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_VIEWERSHIP_SKIP_BUTTONS_SHOWN (112):

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

Corresponds to “Skip buttons shown” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_VIEWERSHIP_STARTS (113):

The number of impressions where the video was played.

Corresponds to “Starts” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_VIEWERSHIP_THIRD_QUARTILES (114):

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

Corresponds to “Third quartiles” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

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.

Corresponds to “Total error count” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

VIDEO_VIEWERSHIP_TOTAL_ERROR_RATE (94):

The percentage of video error count.

Corresponds to “Total error rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

VIDEO_VIEWERSHIP_VIDEO_LENGTH (116):

Duration of the video creative.

Corresponds to “Video length” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

VIDEO_VIEWERSHIP_VIEW_THROUGH_RATE (117):

View-through rate represented as a percentage.

Corresponds to “Video view through rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: PERCENT

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

Corresponds to “Yield group auctions won” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

YIELD_GROUP_BIDS (81):

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

Corresponds to “Yield group bids” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

YIELD_GROUP_BIDS_IN_AUCTION (82):

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

Corresponds to “Yield group bids in auction” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

YIELD_GROUP_CALLOUTS (83):

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

Corresponds to “Yield group callouts” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

YIELD_GROUP_ESTIMATED_CPM (88):

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

Corresponds to “Yield group estimated CPM” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

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.

Corresponds to “Yield group estimated revenue” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

YIELD_GROUP_IMPRESSIONS (85):

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

Corresponds to “Yield group impressions” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

YIELD_GROUP_MEDIATION_FILL_RATE (89):

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

Corresponds to “Yield group mediation fill rate” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

YIELD_GROUP_MEDIATION_MATCHED_QUERIES (86):

Total requests where a Mediation chain was served.

Corresponds to “Yield group mediation matched queries” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

YIELD_GROUP_MEDIATION_PASSBACKS (118):

The number of mediation chain passback across all channels.

Corresponds to “Yield group mediation passbacks” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

YIELD_GROUP_MEDIATION_THIRD_PARTY_ECPM (90):

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

Corresponds to “Yield group mediation third party ECPM” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: DOUBLE

YIELD_GROUP_REVENUE_PAID_THROUGH_MCM_AUTOPAYMENT (215):

The yield group revenue accrued in the child network’s own account but paid to their parent network through auto-payment. This metric is only relevant for a “Manage Account” child network.

Corresponds to “Yield group revenue paid through MCM auto-payment” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: MONEY

YIELD_GROUP_SUCCESSFUL_RESPONSES (84):

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

Corresponds to “Yield group successful responses” in the Ad Manager UI.

Compatible with the following report types: HISTORICAL

Data format: INTEGER

class MetricValueType(value)

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)

Bases: proto.enums.Enum

Supported report types.

Values:

REPORT_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

HISTORICAL (1):

Historical.

FUTURE_SELL_THROUGH (4):

Future sell through.

REACH (5):

Reach.

PRIVACY_AND_MESSAGING (6):

Privacy and messaging.

REVENUE_VERIFICATION (7):

Gross revenue.

PARTNER_FINANCE (8):

Partner finance.

AD_SPEED (13):

Ad speed.

REAL_TIME_VIDEO (15):

Real time video.

YOUTUBE_CONSOLIDATED (16):

Youtube consolidated.

ADS_TRAFFIC_NAVIGATOR (21):

Ads traffic navigator report.

OFF_PROPERTY_CAMPAIGNS (22):

Off property campaigns report.

ON_PLATFORM_MULTICALL (24):

On platform multicall report.

class Slice(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.ReportDefinition.Dimension

value

Required. The value of the dimension.

Type

google.ads.admanager_v1.types.ReportValue

class Sort(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.ReportDefinition.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.ReportDefinition.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.ReportDefinition.MetricValueType

class TimePeriodColumn(value)

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 TimeZoneSource(value)

Bases: proto.enums.Enum

The source to determine the time zone for the report.

Values:

TIME_ZONE_SOURCE_UNSPECIFIED (0):

Unspecified default value.

PUBLISHER (1):

Use the publisher’s time zone in network settings.

AD_EXCHANGE (2):

Use the time zone of the ad exchange. Only compatible with Ad Exchange dimensions and metrics.

UTC (3):

Use UTC time zone. Only compatible with Revenue Verification reports.

PROVIDED (4):

Use the time zone provided in the ReportDefinition.time_zone field. Has limited dimension and metric compatibility compared with PUBLISHER, and reports may take longer to run since the dates are dynamically calculated at request time.

class google.ads.admanager_v1.types.ReportValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.ReportValue.IntList

string_list_value

For lists of string values.

This field is a member of oneof value.

Type

google.ads.admanager_v1.types.ReportValue.StringList

double_list_value

For lists of double values.

This field is a member of oneof value.

Type

google.ads.admanager_v1.types.ReportValue.DoubleList

bytes_value

For bytes values.

This field is a member of oneof value.

Type

bytes

class DoubleList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A list of double values.

values

The values

Type

MutableSequence[float]

class IntList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A list of integer values.

values

The values

Type

MutableSequence[int]

class StringList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A list of string values.

values

The values

Type

MutableSequence[str]

class google.ads.admanager_v1.types.ReportVisibilityEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for ReportVisibility enum.

class ReportVisibility(value)

Bases: proto.enums.Enum

The visibility of a report.

Values:

HIDDEN (0):

Default value. Reports with hidden visibility won’t appear in the Ad Manager UI.

VISIBLE (2):

Reports with this visibility will appear in the Ad Manager UI.

class google.ads.admanager_v1.types.RequestFormatTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request Format Targeting

This message specifies inclusion or exclusion of various request formats for targeting. Each optional boolean field controls the targeting of a specific request format:

• If set to true, the corresponding format is included in targeting.

• If set to false, the corresponding format is excluded from targeting.

• If unset, the format is neither explicitly included nor excluded.

app_open_enabled

Optional. Controls app open format targeting. Set to true to include, false to exclude, or leave unset for neither.

This field is a member of oneof _app_open_enabled.

Type

bool

rewarded_enabled

Optional. Controls rewarded format targeting. Set to true to include, false to exclude, or leave unset for neither.

This field is a member of oneof _rewarded_enabled.

Type

bool

rewarded_interstitial_enabled

Optional. Controls rewarded interstitial format targeting. Set to true to include, false to exclude, or leave unset for neither.

This field is a member of oneof _rewarded_interstitial_enabled.

Type

bool

interstitial_enabled

Optional. Controls interstitial format targeting. Set to true to include, false to exclude, or leave unset for neither.

This field is a member of oneof _interstitial_enabled.

Type

bool

anchor_enabled

Optional. Controls anchor format targeting. Set to true to include, false to exclude, or leave unset for neither.

This field is a member of oneof _anchor_enabled.

Type

bool

banner_enabled

Optional. Controls banner format targeting. Set to true to include, false to exclude, or leave unset for neither.

This field is a member of oneof _banner_enabled.

Type

bool

instream_video_enabled

Optional. Controls instream video format targeting. Set to true to include, false to exclude, or leave unset for neither.

This field is a member of oneof _instream_video_enabled.

Type

bool

instream_audio_enabled

Optional. Controls instream audio format targeting. Set to true to include, false to exclude, or leave unset for neither.

This field is a member of oneof _instream_audio_enabled.

Type

bool

native_advanced_enabled

Optional. Controls native advanced format targeting. Set to true to include, false to exclude, or leave unset for neither.

This field is a member of oneof _native_advanced_enabled.

Type

bool

class google.ads.admanager_v1.types.RequestPlatformEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [RequestPlatform].

Describes the platform from which a request is made and on which the ad is rendered. In the event of multiple platforms, the platform that ultimately renders the ad is the targeted platform. For example, a video player on a website would have a request platform of VIDEO_PLAYER.

class RequestPlatform(value)

Bases: proto.enums.Enum

The different environments in which an ad can be shown.

Values:

REQUEST_PLATFORM_UNSPECIFIED (0):

No value specified

BROWSER (1):

Represents a request made from a web browser (incl. desktop browsers, mobile browsers, webviews, etc.).

MOBILE_APP (2):

Represents a request made from a Mobile Application.

VIDEO_PLAYER (3):

Represents a request made from a video player.

class google.ads.admanager_v1.types.RequestPlatformTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a list of targeted request platforms.

request_platforms

Optional. The list of request platforms that should be targeted.

Type

MutableSequence[google.ads.admanager_v1.types.RequestPlatformEnum.RequestPlatform]

class google.ads.admanager_v1.types.RichMediaAdsCompany(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Rich Media Ads Company, typically used for vendor compliance.

name

Identifier. The resource name of the RichMediaAdsCompany. Format: networks/{network_code}/richMediaAdsCompanies/{rich_media_ads_company_id}

Type

str

display_name

Output only. The name of the Rich Media Ads Company.

This field is a member of oneof _display_name.

Type

str

policy_url

Output only. The policy URL of the Rich Media Ads Company.

This field is a member of oneof _policy_url.

Type

str

gdpr_status

Output only. The GDPR status of the Rich Media Ads Company.

This field is a member of oneof _gdpr_status.

Type

google.ads.admanager_v1.types.RichMediaAdsCompanyGdprStatusEnum.RichMediaAdsCompanyGdprStatus

company_gvl_id

Output only. The GVL ID of the Rich Media Ads Company.

This field is a member of oneof _company_gvl_id.

Type

int

class google.ads.admanager_v1.types.RichMediaAdsCompanyGdprStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [RichMediaAdsCompanyGdprStatus][google.ads.admanager.v1.RichMediaAdsCompanyGdprStatusEnum.RichMediaAdsCompanyGdprStatus]

class RichMediaAdsCompanyGdprStatus(value)

Bases: proto.enums.Enum

The status of a RichMediaAdsCompany for use in a GdprProtection.

Values:

RICH_MEDIA_ADS_COMPANY_GDPR_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

COMPLIANCE_UNKNOWN (1):

The company has not been contacted or responded about GDPR compliance, or otherwise the GDPR compliance is undetermined.

COMPLIANT (2):

The company has been determined as compliant for GDPR.

COMPLIANT_AND_DEFAULT (3):

The company has been determined as compliant, and is part of the default set of companies eligible as a vendor.

COMPLIANT_LIGHTWEIGHT_VERIFIED (4):

The company has been determined to be compliant through certification process.

NOT_COMPLIANT (5):

The company has been determined as non-compliant for GDPR.

class google.ads.admanager_v1.types.RoadblockingTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [RoadblockingType][google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType]

class RoadblockingType(value)

Bases: proto.enums.Enum

Describes the roadblocking types.

Values:

ROADBLOCKING_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

ALL_ROADBLOCK (1):

All or none of the creatives from a line item will serve. This option will only work if served to a GPT tag using SRA (single request architecture mode).

AS_MANY_AS_POSSIBLE (2):

As many creatives from a line item as can fit on a page will serve. This could mean anywhere from one to all of a line item’s creatives given the size constraints of ad slots on a page.

CREATIVE_SET (3):

A master/companion creative set roadblocking type. A [CreativePlaceholder][google.ads.admanager.v1.CreativePlaceholder] must be set accordingly.

ONE_OR_MORE (4):

Any number of creatives from a line item can serve together at a time.

ONLY_ONE (5):

Only one creative from a line item can serve at a time.

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

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. Deprecated: Role ID.

This field is a member of oneof _role_id.

Type

int

display_name

Required. The display name of the Role.

This field is a member of oneof _display_name.

Type

str

description

Optional. The description of the Role.

This field is a member of oneof _description.

Type

str

built_in

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

This field is a member of oneof _built_in.

Type

bool

status

Output only. The status of the Role.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.RoleStatusEnum.RoleStatus

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

Bases: proto.message.Message

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

class RoleStatus(value)

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)

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)

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)

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.ScheduleOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The options for a scheduled report.

schedule

Information pertaining to schedule itself.

Type

google.ads.admanager_v1.types.ScheduleOptions.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.ReportDefinition.Flag]

class DeliveryCondition(value)

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 Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

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)

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)

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.SearchAdReviewCenterAdsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for SearchAdReviewCenterAds method.

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.

status

Optional. Only return ads with the given status.

This field is a member of oneof ad_review_status.

Type

google.ads.admanager_v1.types.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus

manual_review_status

Optional. Only return ads with the given manual review status. Only available for networks with Manual Creative Review enabled. For more information, see https://support.google.com/admanager/answer/2586531#manual-creative-review.

This field is a member of oneof ad_review_status.

Type

google.ads.admanager_v1.types.ManualAdReviewCenterAdStatusEnum.ManualAdReviewCenterAdStatus

parent

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

Since a network can only have a single web property of each ExchangeSyndicationProduct, you can use the ExchangeSyndicationProduct as an alias for the web property code:

networks/{network_code}/webProperties/display

networks/{network_code}/webProperties/videoAndAudio

networks/{network_code}/webProperties/mobileApp

networks/{network_code}/webProperties/games

Type

str

page_size

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

Type

int

page_token

Optional. The page token to fetch the next page of AdReviewCenterAds. This is the value returned from a previous Search request, or empty.

Type

str

ad_review_center_ad_id

Optional. Only return ads with the given AdReviewCenterAd IDs. If provided, no other filter can be set (other than page size and page token).

Type

MutableSequence[str]

date_time_range

Optional. If provided, only return ads that served within the given date range (inclusive). The date range must be within the last 30 days. If not provided, the date range will be the last 30 days. This filter does not apply to the PENDING manual review status.

Type

google.type.interval_pb2.Interval

search_text

Optional. If provided, restrict the search to AdReviewCenterAds associated with the text (including any text on the ad or in the destination URL). If more than one value is provided, the search will combine them in a logical AND. For example, [‘car’, ‘blue’] will match ads that contain both “car” and “blue”, but not an ad that only contains “car”.

Type

MutableSequence[str]

buyer_account_id

Optional. If provided, restrict the search to creatives belonging to one of the given Adx buyer account IDs. Only applicable to RTB creatives. Adx buyer account IDs can be found using the ProgrammaticBuyerService.

Type

MutableSequence[int]

class google.ads.admanager_v1.types.SearchAdReviewCenterAdsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response object for SearchAdReviewCenterAds method.

ad_review_center_ads

The AdReviewCenterAds that match the search request.

Type

MutableSequence[google.ads.admanager_v1.types.AdReviewCenterAd]

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

class google.ads.admanager_v1.types.Site(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A Site represents a domain owned or represented by a network. For a parent network managing other networks as part of Multiple Customer Management “Manage Inventory” model, it could be the child’s domain.

name

Identifier. The resource name of the Site. Format: networks/{network_code}/sites/{site_id}

Type

str

url

Required. The URL of the Site.

This field is a member of oneof _url.

Type

str

child_network_code

Optional. The network code of the child if the Site is being managed for an MCM child network, or null if owned by this network.

This field is a member of oneof _child_network_code.

Type

str

approval_status

Output only. Status of the review performed on the Site by Google.

This field is a member of oneof _approval_status.

Type

google.ads.admanager_v1.types.SiteApprovalStatusEnum.SiteApprovalStatus

approval_status_update_time

Output only. The latest Site approval status change time.

This field is a member of oneof _approval_status_update_time.

Type

google.protobuf.timestamp_pb2.Timestamp

disapproval_reasons

Output only. Provides reasons for disapproving the Site. It is null when the Site is not disapproved.

Type

MutableSequence[google.ads.admanager_v1.types.DisapprovalReason]

class google.ads.admanager_v1.types.SiteApprovalStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [SiteApprovalStatus][google.ads.admanager.v1.SiteApprovalStatusEnum.SiteApprovalStatus]

class SiteApprovalStatus(value)

Bases: proto.enums.Enum

Represents the approval status of a site.

Values:

SITE_APPROVAL_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

APPROVED (1):

The site has been approved to serve ads.

DISAPPROVED (2):

The site has been disapproved from serving ads.

DRAFT (3):

The default status with which a site is created.

REQUIRES_REVIEW (4):

The site has been deactivated and is not serving ads due to dormancy. It must be resubmitted for approval.

UNCHECKED (5):

Once the site is submitted for approval, its status changes from draft to unchecked. It will be reviwed with an estimated turn-around time of 24h. Such a site cannot serve ads.

class google.ads.admanager_v1.types.SiteDisapprovalReasonEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [SiteDisapprovalReason][google.ads.admanager.v1.SiteDisapprovalReasonEnum.SiteDisapprovalReason]

class SiteDisapprovalReason(value)

Bases: proto.enums.Enum

The list of possible policy violation types for a Site.

Values:

SITE_DISAPPROVAL_REASON_UNSPECIFIED (0):

Default value. This value is unused.

CONTENT (1):

The site has content that violates policy.

OTHER (2):

Generic error type.

OWNERSHIP (3):

The parent must be an authorized seller of the child network’s inventory.

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

Bases: proto.message.Message

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

width

Required. The width of the Creative, [AdUnit][google.ads.admanager.v1.AdUnit], or LineItem.

Type

int

height

Required. The height of the Creative, [AdUnit][google.ads.admanager.v1.AdUnit], or LineItem.

Type

int

size_type

Required. The SizeType of the Creative, [AdUnit][google.ads.admanager.v1.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)

Bases: proto.message.Message

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

class SizeType(value)

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.SkippableAdTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [SkippableAdType][google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType]

class SkippableAdType(value)

Bases: proto.enums.Enum

The different types of skippable ads.

Values:

SKIPPABLE_AD_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

ANY (1):

Any skippable or not skippable. This is only for programmatic case when the creative skippability is decided by the buyside.

DISABLED (2):

The ad is not skippable.

ENABLED (3):

The ad is skippable.

INSTREAM_SELECT (4):

The ad is an instream select ad.

class google.ads.admanager_v1.types.Slate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A Slate encapsulates all the information necessary to represent a Slate entity, the video creative used by Dynamic Ad Insertion to fill vacant ad slots.

name

Identifier. The resource name of the Slate. Format: networks/{network_code}/slates/{slate_id}

Type

str

display_name

Required. The display name of the Slate. It has a maximum length of 255 characters.

This field is a member of oneof _display_name.

Type

str

status

Output only. The status of this Slate. Slates are created in the [SlateStatus.ACTIVE][] state.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.SlateStatusEnum.SlateStatus

transcode_status

Output only. Server side transcoding status of the current slate.

This field is a member of oneof _transcode_status.

Type

google.ads.admanager_v1.types.VideoTranscodeStatusEnum.VideoTranscodeStatus

video_source_url

Optional. The location of the original asset if publisher provided and slate is externally hosted.

This field is a member of oneof _video_source_url.

Type

str

update_time

Output only. The date and time this slate was last modified.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.ads.admanager_v1.types.SlateStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [SlateStatus][google.ads.admanager.v1.SlateStatusEnum.SlateStatus]

class SlateStatus(value)

Bases: proto.enums.Enum

Describes the status of a Slate object.

Values:

SLATE_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE (1):

Indicates the Slate has been created and is eligible for streaming.

ARCHIVED (2):

Indicates the Slate has been archived.

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

Bases: proto.message.Message

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

class SmartSizeMode(value)

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.SourceContentConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Parameters about this CDN config as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.

ingest_settings

Required. Config for how DAI should ingest media. At ingest time, we match the URL prefix of media in a stream’s playlist with an ingest location and use the authentication credentials from the corresponding ingest settings to download the media. This value is required for a valid source content config.

Type

google.ads.admanager_v1.types.MediaLocation

default_delivery_settings

Required. Default config for how DAI should deliver the non-modified media segments. At delivery time, we replace the ingest location’s URL prefix with the delivery location’s URL prefix and use the security policy from the delivery settings to determine how DAI needs to deliver the media so that users can access it. This value is required for a valid source content config.

Type

google.ads.admanager_v1.types.MediaLocation

class google.ads.admanager_v1.types.SuggestedAdUnit(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A read-only suggestion for a new ad unit based on an ad tag that has served 10+ times in the past week for an undefined ad unit.

name

Identifier. Resource name of the SuggestedAdUnit. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

Type

str

weekly_request_count

Output only. Number of times the ad tag has been served in the past week.

This field is a member of oneof _weekly_request_count.

Type

int

new_code_path

Output only. Path of suggested ad unit codes from the closest existing ancestor ad unit that will all be created as ad units when the suggestion is approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the new_code_path is (x). If x is the grandchild of c, the new_code_path is (y, x) where y is an ad unit that would be created as the parent ad unit of x (and the child of c) if the suggestion is approved.

Type

MutableSequence[str]

existing_code_path

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

Type

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

target_window

Output only. Target window of the underlying ad tag which will be used in the ad unit if the suggestion is approved.

This field is a member of oneof _target_window.

Type

google.ads.admanager_v1.types.TargetWindowEnum.TargetWindow

target_platform

Output only. Target platform for the browser that clicked the underlying ad tag.

This field is a member of oneof _target_platform.

Type

google.ads.admanager_v1.types.TargetPlatformEnum.TargetPlatform

ad_unit_sizes

Output only. Sizes associated with this suggested ad unit.

Type

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

class google.ads.admanager_v1.types.TargetPlatformEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [TargetPlatform][google.ads.admanager.v1.TargetPlatformEnum.TargetPlatform]

class TargetPlatform(value)

Bases: proto.enums.Enum

The target platform of a line item.

Values:

TARGET_PLATFORM_UNSPECIFIED (0):

Default value. This value is unused.

ANY (1):

A universal target platform that combines mobile and desktop features.

MOBILE (2):

Mobile devices.

WEB (3):

The desktop web.

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

Bases: proto.message.Message

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

class TargetWindow(value)

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.TargetedVideoBumperTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [TargetedVideoBumperType][google.ads.admanager.v1.TargetedVideoBumperTypeEnum.TargetedVideoBumperType]

class TargetedVideoBumperType(value)

Bases: proto.enums.Enum

Represents the options for targetable bumper positions, surrounding an ad pod, within a video stream. This includes before and after the supported ad pod positions, VideoPositionType.PREROLL, VideoPositionType.MIDROLL, and VideoPositionType.POSTROLL.

Values:

TARGETED_VIDEO_BUMPER_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

AFTER (1):

Represents the bumper position after the ad pod.

BEFORE (2):

Represents the bumper position before the ad pod.

class google.ads.admanager_v1.types.Targeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Targeting expression.

geo_targeting

Optional. Used to target/exclude various geo targets.

Type

google.ads.admanager_v1.types.GeoTargeting

technology_targeting

Optional. Used to target various technology targeting dimensions.

Type

google.ads.admanager_v1.types.TechnologyTargeting

inventory_targeting

Optional. Used to target/exclude various ad units and/or placements.

Type

google.ads.admanager_v1.types.InventoryTargeting

request_platform_targeting

Optional. Used to target specific request platforms.

Type

google.ads.admanager_v1.types.RequestPlatformTargeting

custom_targeting

Optional. Used to target key/values, audience segments, and/or CMS metadata.

Type

google.ads.admanager_v1.types.CustomTargeting

user_domain_targeting

Optional. Used to target user domains.

Type

google.ads.admanager_v1.types.UserDomainTargeting

video_position_targeting

Optional. Used to target video positions.

Type

google.ads.admanager_v1.types.VideoPositionTargeting

data_segment_targeting

Optional. Used to target data segments.

Type

google.ads.admanager_v1.types.DataSegmentTargeting

request_format_targeting

Optional. Used to target inventory formats.

Type

google.ads.admanager_v1.types.RequestFormatTargeting

content_targeting

Optional. Used to target content.

Type

google.ads.admanager_v1.types.ContentTargeting

mobile_application_targeting

Optional. Used to target mobile applications.

Type

google.ads.admanager_v1.types.MobileApplicationTargeting

class google.ads.admanager_v1.types.TargetingPreset(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

User-defined preset targeting criteria.

name

Identifier. The resource name of the TargetingPreset. Format: networks/{network_code}/targetingPresets/{targeting_preset_id}

Type

str

display_name

Required. The name of the TargetingPreset. This attribute has a maximum length of 255 characters.

This field is a member of oneof _display_name.

Type

str

targeting

Required. Contains the targeting criteria for the TargetingPreset. If not provided, empty targeting will be used as a default.

This field is a member of oneof _targeting.

Type

google.ads.admanager_v1.types.Targeting

status

Output only. The status of the TargetingPreset.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.TargetingPresetStatusEnum.TargetingPresetStatus

class google.ads.admanager_v1.types.TargetingPresetStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [TargetingPresetStatus][google.ads.admanager.main.TargetingPresetStatusEnum.TargetingPresetStatus]

class TargetingPresetStatus(value)

Bases: proto.enums.Enum

The status of a targeting preset.

Values:

TARGETING_PRESET_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE (1):

The targeting preset is active.

INACTIVE (2):

The targeting preset is inactive.

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

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. Deprecated: TaxonomyCategory ID.

This field is a member of oneof _taxonomy_category_id.

Type

int

display_name

Output only. Display name of the TaxonomyCategory.

This field is a member of oneof _display_name.

Type

str

grouping_only

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

This field is a member of oneof _grouping_only.

Type

bool

parent_taxonomy_category_id

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

This field is a member of oneof _parent_taxonomy_category_id.

Type

int

taxonomy_type

Output only. The taxonomy that this TaxonomyCategory belongs to.

This field is a member of oneof _taxonomy_type.

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)

Bases: proto.message.Message

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

class TaxonomyType(value)

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_1_0 (8):

The IAB Content Taxonomy v1.0.

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)

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

display_name

Required. The name of the Team. This value has a maximum length of 127 characters.

This field is a member of oneof _display_name.

Type

str

description

Optional. The description of the Team. This value has a maximum length of 255 characters.

This field is a member of oneof _description.

Type

str

status

Output only. The status of the Team. This value determines the visibility of the team in the UI.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.TeamStatusEnum.TeamStatus

all_companies_access

Optional. Whether or not users on this team have access to all companies. If this value is true, then an error will be thrown if an attempt is made to associate this team with a Company.

This field is a member of oneof _all_companies_access.

Type

bool

all_inventory_access

Optional. Whether or not users on this team have access to all inventory. If this value is true, then an error will be thrown if an attempt is made to associate this team with an AdUnit.

This field is a member of oneof _all_inventory_access.

Type

bool

access_type

Optional. The default access to orders for users on this team.

This field is a member of oneof _access_type.

Type

google.ads.admanager_v1.types.TeamAccessTypeEnum.TeamAccessType

class google.ads.admanager_v1.types.TeamAccessTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [TeamAccessType][google.ads.admanager.v1.TeamAccessTypeEnum.TeamAccessType]

class TeamAccessType(value)

Bases: proto.enums.Enum

Represents the types of team access supported for orders.

Values:

TEAM_ACCESS_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

NONE (1):

The level of access in which team members can’t view or edit a team’s orders.

READ_ONLY (2):

The level of access in which team members can only view a team’s orders.

READ_WRITE (3):

The level of access in which team members can view and edit a team’s orders.

class google.ads.admanager_v1.types.TeamStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [TeamStatus][google.ads.admanager.v1.TeamStatusEnum.TeamStatus]

class TeamStatus(value)

Bases: proto.enums.Enum

Represents the status of a team, whether it is active or inactive.

Values:

TEAM_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE (1):

The status of an active team.

INACTIVE (2):

The status of an inactive team.

class google.ads.admanager_v1.types.TechnologyTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Various types of technology targeting expressed by child messages are applied with logical AND.

bandwidth_targeting

Optional. Bandwidth targeting dimension.

Type

google.ads.admanager_v1.types.BandwidthTargeting

browser_targeting

Optional. Browser targeting dimension.

Type

google.ads.admanager_v1.types.BrowserTargeting

browser_language_targeting

Optional. Browser language targeting dimension.

Type

google.ads.admanager_v1.types.BrowserLanguageTargeting

device_capability_targeting

Optional. Device capability targeting dimension.

Type

google.ads.admanager_v1.types.DeviceCapabilityTargeting

device_category_targeting

Optional. Device category targeting dimension.

Type

google.ads.admanager_v1.types.DeviceCategoryTargeting

device_manufacturer_targeting

Optional. Device manufacturer targeting dimension.

Type

google.ads.admanager_v1.types.DeviceManufacturerTargeting

mobile_carrier_targeting

Optional. Mobile carrier targeting dimension.

Type

google.ads.admanager_v1.types.MobileCarrierTargeting

operating_system_targeting

Optional. Operating system targeting dimension.

Type

google.ads.admanager_v1.types.OperatingSystemTargeting

class google.ads.admanager_v1.types.ThirdPartyCompany(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a third-party company recognized by Google Ad Manager, which can be an ad network, ad server, or video technology partner.

name

Identifier. The resource name of the ThirdPartyCompany. Format: networks/{network_code}/thirdPartyCompanies/{third_party_company_id}

Type

str

display_name

Output only. The display name of the ThirdPartyCompany. This field must be unique among all ThirdPartyCompanies for this network.

This field is a member of oneof _display_name.

Type

str

status

Output only. The status of the ThirdPartyCompany. ThirdPartyCompanies are set to inactive rather than deleting them.

This field is a member of oneof _status.

Type

google.ads.admanager_v1.types.ThirdPartyCompanyStatusEnum.ThirdPartyCompanyStatus

type_

Output only. The type of the ThirdPartyCompany.

This field is a member of oneof _type.

Type

google.ads.admanager_v1.types.ThirdPartyCompanyTypeEnum.ThirdPartyCompanyType

class google.ads.admanager_v1.types.ThirdPartyCompanyStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ThirdPartyCompanyStatus][google.ads.admanager.v1.ThirdPartyCompanyStatusEnum.ThirdPartyCompanyStatus]

class ThirdPartyCompanyStatus(value)

Bases: proto.enums.Enum

Status of a third party company.

Values:

THIRD_PARTY_COMPANY_STATUS_UNSPECIFIED (0):

No value specified

ACTIVE (1):

The third party company is active.

INACTIVE (2):

The third party company is inactive.

class google.ads.admanager_v1.types.ThirdPartyCompanyTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ThirdPartyCompanyType][google.ads.admanager.v1.ThirdPartyCompanyTypeEnum.ThirdPartyCompanyType]

class ThirdPartyCompanyType(value)

Bases: proto.enums.Enum

The type of a third party company.

Values:

THIRD_PARTY_COMPANY_TYPE_UNSPECIFIED (0):

No value specified

AD_NETWORK (1):

A company representing multiple advertisers and agencies.

AD_SERVER (2):

An organization that provides ad serving technology.

VIDEO_TECHNOLOGY_PARTNER (3):

A company that provides video technology.

class google.ads.admanager_v1.types.ThirdPartyDataDeclaration(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a set of declarations about what (if any) third party companies are associated with a given creative. This can also be set on the Network to serve as a default for those creatives that don’t have such field set.

declaration_type

Optional. The declaration about third party data usage on the associated entity.

Type

google.ads.admanager_v1.types.ThirdPartyDataDeclarationTypeEnum.ThirdPartyDataDeclarationType

third_party_companies

Optional. A list of ThirdPartyCompanies associated with this entity. Format: “networks/{network_code}/thirdPartyCompanies/{third_party_company}”.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.ThirdPartyDataDeclarationTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ThirdPartyDataDeclarationTypeEnum][google.ads.admanager.v1.ThirdPartyDataDeclarationTypeEnum]

class ThirdPartyDataDeclarationType(value)

Bases: proto.enums.Enum

The declaration about third party data usage on the associated entity.

Values:

THIRD_PARTY_DATA_DECLARATION_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

DECLARED (1):

There is a set of ThirdPartyCompanies associated with this entity.

NONE (2):

There are no companies associated. Functionally the same as DECLARED, combined with an empty company list.

class google.ads.admanager_v1.types.ThirdPartyMeasurementSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains third party auto-pixeling settings for cross-sell Partners.

viewability_partner

Optional. A field to determine the type of ViewabilityPartner. This field default is NONE.

This field is a member of oneof _viewability_partner.

Type

google.ads.admanager_v1.types.ViewabilityPartnerEnum.ViewabilityPartner

viewability_client_id

Optional. The third party partner ID for YouTube viewability verification.

This field is a member of oneof _viewability_client_id.

Type

str

viewability_reporting_id

Optional. The reporting ID that maps viewability partner data with a campaign (or a group of related campaigns) specific data.

This field is a member of oneof _viewability_reporting_id.

Type

str

publisher_viewability_partner

Optional. A field to determine the type of publisher’s viewability partner. This field default is NONE.

This field is a member of oneof _publisher_viewability_partner.

Type

google.ads.admanager_v1.types.ViewabilityPartnerEnum.ViewabilityPartner

publisher_viewability_client_id

Optional. The third party partner ID for YouTube viewability verification for publisher.

This field is a member of oneof _publisher_viewability_client_id.

Type

str

publisher_viewability_reporting_id

Optional. The reporting ID that maps viewability partner data with a campaign (or a group of related campaigns) specific data for publisher.

This field is a member of oneof _publisher_viewability_reporting_id.

Type

str

brand_lift_partner

Optional. A field to determine the type of BrandLiftPartner. This field default is NONE.

This field is a member of oneof _brand_lift_partner.

Type

google.ads.admanager_v1.types.BrandLiftPartnerEnum.BrandLiftPartner

brand_lift_client_id

Optional. The third party partner ID for YouTube brand lift verification.

This field is a member of oneof _brand_lift_client_id.

Type

str

brand_lift_reporting_id

Optional. The reporting ID that maps brand lift partner data with a campaign (or a group of related campaigns) specific data.

This field is a member of oneof _brand_lift_reporting_id.

Type

str

reach_partner

Optional. A field to determine the type of advertiser’s ReachPartner. This field default is UNKNOWN.

This field is a member of oneof _reach_partner.

Type

google.ads.admanager_v1.types.ReachPartnerEnum.ReachPartner

reach_client_id

Optional. The third party partner ID for YouTube reach verification for advertiser.

This field is a member of oneof _reach_client_id.

Type

str

reach_reporting_id

Optional. The reporting ID that maps reach partner data with a campaign (or a group of related campaigns) specific data for advertiser.

This field is a member of oneof _reach_reporting_id.

Type

str

publisher_reach_partner

Optional. A field to determine the type of publisher’s ReachPartner. This field default is UNKNOWN.

This field is a member of oneof _publisher_reach_partner.

Type

google.ads.admanager_v1.types.ReachPartnerEnum.ReachPartner

publisher_reach_client_id

Optional. The third party partner ID for YouTube reach verification for publisher.

This field is a member of oneof _publisher_reach_client_id.

Type

str

publisher_reach_reporting_id

Optional. The reporting ID that maps reach partner data with a campaign (or a group of related campaigns) specific data for publisher.

This field is a member of oneof _publisher_reach_reporting_id.

Type

str

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

Bases: proto.message.Message

Wrapper message for TimeUnit.

class TimeUnit(value)

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.UnitTypeEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [UnitType][google.ads.admanager.v1.UnitTypeEnum.UnitType].

class UnitType(value)

Bases: proto.enums.Enum

Indicates the type of unit used for defining a reservation. The [LineItem.cost_type][google.ads.admanager.v1.LineItem.cost_type] can differ from the UnitType - an ad can have an impression goal, but be billed by its click. Usually CostType and UnitType will refer to the same unit.

Values:

UNIT_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

IMPRESSIONS (1):

The number of impressions served by creatives associated with the line item.

CLICKS (2):

The number of clicks reported by creatives associated with the line item. The line item [type][google.ads.admanager.v1.LineItem.line_item_type] must be one of:

• [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD]

• [LineItemTypeEnum.LineItemType.BULK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.BULK]

• [LineItemTypeEnum.LineItemType.PRICE_PRIORITY][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.PRICE_PRIORITY]

CLICK_THROUGH_CPA_CONVERSIONS (3):

The number of click-through Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the [LineItem.cost_type][google.ads.admanager.v1.LineItem.cost_type] must be [CostTypeEnum.CostType.CPA][].

VIEW_THROUGH_CPA_CONVERSIONS (4):

The number of view-through Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the [LineItem.cost_type][google.ads.admanager.v1.LineItem.cost_type] must be [CostTypeEnum.CostType.CPA}.

TOTAL_CPA_CONVERSIONS (5):

The number of total Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the [LineItem.cost_type} must be [CostTypeEnum.CostType.CPA}.

VIEWABLE_IMPRESSIONS (6):

The number of viewable impressions reported by creatives associated with the line item. The [LineItem.line_item_type][google.ads.admanager.v1.LineItem.line_item_type] must be [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD].

IN_TARGET_IMPRESSIONS (7):

The number of in-target impressions reported by third party measurements. The [LineItem.line_item_type][google.ads.admanager.v1.LineItem.line_item_type] must be [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD].

COMPLETED_VIEWS (8):

The number of completed views reported by creatives associated with the line item. A completed view is defined as having watched the entirety of the in-stream video ad and is only supported for standard reservation video line items. The [LineItem.line_item_type][google.ads.admanager.v1.LineItem.line_item_type] must be [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD].

class google.ads.admanager_v1.types.UpdateAdBreakRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateAdBreak method.

ad_break

Required. The AdBreak to update.

The AdBreak’s name is used to identify the AdBreak to update.

Type

google.ads.admanager_v1.types.AdBreak

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateAdRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateAdRule method.

ad_rule

Required. The AdRule to update.

The AdRule’s name is used to identify the AdRule to update.

Type

google.ads.admanager_v1.types.AdRule

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateAdSpotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateAdSpot method.

ad_spot

Required. The AdSpot to update.

The AdSpot’s name is used to identify the AdSpot to update.

Type

google.ads.admanager_v1.types.AdSpot

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateAdUnitRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateAdUnit method.

ad_unit

Required. The AdUnit to update.

The AdUnit’s name is used to identify the AdUnit to update. Format: networks/{network_code}/adUnits/{ad_unit_id}

Type

google.ads.admanager_v1.types.AdUnit

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateApplicationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateApplication method.

application

Required. The Application to update.

The Application’s name is used to identify the Application to update.

Type

google.ads.admanager_v1.types.Application

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateCdnConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateCdnConfig method.

cdn_config

Required. The CdnConfig to update.

The CdnConfig’s name is used to identify the CdnConfig to update.

Type

google.ads.admanager_v1.types.CdnConfig

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateChildPublisherRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [UpdateChildPublisher][] method.

child_publisher

Required. The [ChildPublisher][google.ads.admanager.v1.ChildPublisher] to update.

The [ChildPublisher][google.ads.admanager.v1.ChildPublisher]’s name is used to identify the [ChildPublisher][google.ads.admanager.v1.ChildPublisher] to update.

Type

google.ads.admanager_v1.types.ChildPublisher

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateCompanyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [UpdateCompany][] method.

company

Required. The [Company][google.ads.admanager.v1.Company] to update.

The [Company][google.ads.admanager.v1.Company]’s name is used to identify the [Company][google.ads.admanager.v1.Company] to update.

Type

google.ads.admanager_v1.types.Company

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateContactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateContact method.

contact

Required. The Contact to update.

The Contact’s name is used to identify the Contact to update.

Type

google.ads.admanager_v1.types.Contact

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateCreativeSetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateCreativeSet method.

creative_set

Required. The CreativeSet to update.

The CreativeSet’s name is used to identify the CreativeSet to update.

Type

google.ads.admanager_v1.types.CreativeSet

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateCreativeWrapperRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateCreativeWrapper method.

creative_wrapper

Required. The CreativeWrapper to update.

The CreativeWrapper’s name is used to identify the CreativeWrapper to update.

Type

google.ads.admanager_v1.types.CreativeWrapper

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateCustomFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateCustomField method.

custom_field

Required. The CustomField to update.

The CustomField’s name is used to identify the CustomField to update.

Type

google.ads.admanager_v1.types.CustomField

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateCustomTargetingKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateCustomTargetingKey method.

custom_targeting_key

Required. The CustomTargetingKey to update.

The CustomTargetingKey’s name is used to identify the CustomTargetingKey to update.

Type

google.ads.admanager_v1.types.CustomTargetingKey

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateCustomTargetingValueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateCustomTargetingValue method.

custom_targeting_value

Required. The CustomTargetingValue to update.

The CustomTargetingValue’s name is used to identify the CustomTargetingValue to update.

Type

google.ads.admanager_v1.types.CustomTargetingValue

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateDaiAuthenticationKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateDaiAuthenticationKey method.

dai_authentication_key

Required. The DaiAuthenticationKey to update.

The DaiAuthenticationKey’s name is used to identify the DaiAuthenticationKey to update.

Type

google.ads.admanager_v1.types.DaiAuthenticationKey

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateDaiEncodingProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateDaiEncodingProfile method.

dai_encoding_profile

Required. The DaiEncodingProfile to update.

The DaiEncodingProfile’s name is used to identify the DaiEncodingProfile to update.

Type

google.ads.admanager_v1.types.DaiEncodingProfile

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

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

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

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateLabelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateLabel method.

label

Required. The Label to update.

The Label’s name is used to identify the Label to update.

Type

google.ads.admanager_v1.types.Label

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateLiveStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateLiveStream method.

live_stream

Required. The LiveStream to update.

The LiveStream’s name is used to identify the LiveStream to update.

Type

google.ads.admanager_v1.types.LiveStream

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateOrderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateOrder method.

order

Required. The Order to update.

The Order’s name is used to identify the order to update. Format: networks/{network_code}/orders/{order_id}

Type

google.ads.admanager_v1.types.Order

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdatePartnerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [UpdatePartner][] method.

partner

Required. The [Partner][google.ads.admanager.v1.Partner] to update.

The [Partner][google.ads.admanager.v1.Partner]’s name is used to identify the [Partner][google.ads.admanager.v1.Partner] to update.

Type

google.ads.admanager_v1.types.Partner

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdatePlacementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdatePlacement method.

placement

Required. The Placement to update.

The Placement’s name is used to identify the Placement to update. Format: networks/{network_code}/placements/{placement_id}

Type

google.ads.admanager_v1.types.Placement

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdatePrivateAuctionDealRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdatePrivateAuctionDeal method.

private_auction_deal

Required. The PrivateAuctionDeal to update.

The PrivateAuctionDeal’s name is used to identify the PrivateAuctionDeal to update.

Type

google.ads.admanager_v1.types.PrivateAuctionDeal

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdatePrivateAuctionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdatePrivateAuction method.

private_auction

Required. The PrivateAuction to update.

The PrivateAuction’s name is used to identify the PrivateAuction to update.

Type

google.ads.admanager_v1.types.PrivateAuction

update_mask

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

Bases: proto.message.Message

Request object for UpdateReport method.

report

Required. The Report to update.

Type

google.ads.admanager_v1.types.Report

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateSiteRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateSite method.

site

Required. The Site to update.

The Site’s name is used to identify the Site to update.

Type

google.ads.admanager_v1.types.Site

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateSlateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateSlate method.

slate

Required. The Slate to update.

The Slate’s name is used to identify the Slate to update.

Type

google.ads.admanager_v1.types.Slate

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateTargetingPresetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateTargetingPreset method.

targeting_preset

Required. The TargetingPreset to update.

The TargetingPreset’s name is used to identify the TargetingPreset to update.

Type

google.ads.admanager_v1.types.TargetingPreset

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateTeamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for UpdateTeam method.

team

Required. The Team to update.

The Team’s name is used to identify the Team to update.

Type

google.ads.admanager_v1.types.Team

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.admanager_v1.types.UpdateViewabilityProviderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request object for [UpdateViewabilityProvider][] method.

viewability_provider

Required. The [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] to update.

The [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]’s name is used to identify the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] to update.

Type

google.ads.admanager_v1.types.ViewabilityProvider

update_mask

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

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. Deprecated: User ID.

This field is a member of oneof _user_id.

Type

int

display_name

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

This field is a member of oneof _display_name.

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.

This field is a member of oneof _email.

Type

str

role

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

This field is a member of oneof _role.

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.

This field is a member of oneof _active.

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.

This field is a member of oneof _external_id.

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.

This field is a member of oneof _service_account.

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.

This field is a member of oneof _orders_ui_local_time_zone.

Type

str

class google.ads.admanager_v1.types.UserDomainTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

User Domain Targeting

targeted_user_domains

Optional. A list of user domains that should be targeted/included.

Type

MutableSequence[str]

excluded_user_domains

Optional. A list of user domains that should be excluded.

Type

MutableSequence[str]

class google.ads.admanager_v1.types.VideoPosition(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Video Position Targeting Criterion

midroll_index

Optional. The index of the mid-roll to target. This field is ignored when targeting any video position (e.g. position_type) other than MIDROLL.

This field is a member of oneof _midroll_index.

Type

int

reverse_midroll_index

Optional. The index from the back of the pod of the mid-roll to target. This field is ignored when targeting any video position (e.g. position_type) other than MIDROLL or if targeting a specific midroll index (e.g. midroll_index != 0).

This field is a member of oneof _reverse_midroll_index.

Type

int

pod_position

Optional. The video position within a pod to target. This field must be unset in order to target a specific video position (e.g. position_type), bumper type (e.g. bumper_type), or custom ad spot (e.g. custom_spot_id).

This field is a member of oneof _pod_position.

Type

int

position_type

Optional. The position within a video to target. A video ad can target a position (pre-roll, all mid-rolls, or post-roll) or a specific mid-roll index.

This field is a member of oneof _position_type.

Type

google.ads.admanager_v1.types.VideoPositionEnum.VideoPosition

bumper_type

Optional. The video bumper type to target. This field must be unset in order to target a specific video position (e.g. position_type), pod position (e.g. pod_position), or custom ad spot (e.g. custom_spot_id).

This field is a member of oneof _bumper_type.

Type

google.ads.admanager_v1.types.TargetedVideoBumperTypeEnum.TargetedVideoBumperType

class google.ads.admanager_v1.types.VideoPositionEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [VideoPosition][google.ads.admanager.v1.VideoPositionEnum.VideoPosition]

class VideoPosition(value)

Bases: proto.enums.Enum

Represents a targetable position within a video.

Values:

VIDEO_POSITION_UNSPECIFIED (0):

Default value. This value is unused.

ALL (1):

Allow ad placement at any position within the video.

MIDROLL (2):

Target ad placement during the video.

POSTROLL (3):

Target ad placement after the video ends.

PREROLL (4):

Target ad placement before the video starts.

class google.ads.admanager_v1.types.VideoPositionTargeting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Video Position Targeting

video_positions

Optional. A list of video position targeting criterion (applied with a logical AND).

Type

MutableSequence[google.ads.admanager_v1.types.VideoPosition]

class google.ads.admanager_v1.types.VideoSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Information about the video settings of an encoding profile.

codec

Required. The RFC6381 codec string of the video.

This field is a member of oneof _codec.

Type

str

bitrate

Required. The bitrate of the video, in bits per second. This value must be between 32kbps and 250 Mbps.

This field is a member of oneof _bitrate.

Type

int

frames_per_second

Required. The frames per second of the video. This value will be truncated to three decimal places.

This field is a member of oneof _frames_per_second.

Type

float

resolution

Required. The resolution of the video, in pixels.

This field is a member of oneof _resolution.

Type

google.ads.admanager_v1.types.Size

class google.ads.admanager_v1.types.VideoTrackingUrl(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a [ConversionEventEnum][google.ads.admanager.v1.ConversionEventEnum] to URL pair that will be pinged when the event happens.

conversion_event

Required. All possible tracking event types.

Type

google.ads.admanager_v1.types.ConversionEventEnum.ConversionEvent

url

Optional. A URL that should be pinged for the conversion event.

Type

str

class google.ads.admanager_v1.types.VideoTranscodeStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [VideoTranscodeStatus][google.ads.admanager.v1.VideoTranscodeStatusEnum.VideoTranscodeStatus]

class VideoTranscodeStatus(value)

Bases: proto.enums.Enum

Possible server side transcoding states.

Values:

VIDEO_TRANSCODE_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

COMPLETED (1):

The video transcoding is complete.

FAILED (2):

The video transcoding failed.

IN_PROGRESS (3):

The video transcode is in progress.

NEEDS_TRANSCODE (4):

The video needs to be transcoded.

NOT_READY (5):

The video is not ready.

class google.ads.admanager_v1.types.ViewabilityPartnerEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [ViewabilityPartner][google.ads.admanager.v1.ViewabilityPartnerEnum.ViewabilityPartner]

class ViewabilityPartner(value)

Bases: proto.enums.Enum

Possible options for viewabitility. The enum may receive new values in the future.

Values:

VIEWABILITY_PARTNER_UNSPECIFIED (0):

Default value. This value is unused.

COMSCORE (1):

Indicates viewability partner Comscore.

DOUBLE_VERIFY (2):

Indicates viewability partner Double Verify.

INTEGRAL_AD_SCIENCE (4):

Indicates viewability partner Integral Ad Science.

MOAT (5):

Indicates viewability partner Oracle Moat.

NONE (6):

Indicates there’s no viewability partner.

TELEMETRY (7):

Indicates viewability partner Telemetry.

class google.ads.admanager_v1.types.ViewabilityProvider(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] resource.

Represents a third-party company used to measure creative viewability.

name

Identifier. The resource name of the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]. Format: networks/{network_code}/viewabilityProviders/{viewability_provider}

Type

str

display_name

Required. The display name of the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].

This field is a member of oneof _display_name.

Type

str

vendor_key

Required. The key for the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].

This field is a member of oneof _vendor_key.

Type

str

verification_script_url

Required. The URL that hosts the verification script for the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].

This field is a member of oneof _verification_script_url.

Type

str

verification_script_url_parameters

Optional. The URL parameters that will be passed to the verification script.

This field is a member of oneof _verification_script_url_parameters.

Type

str

rejection_tracker_url

Optional. The URL that should be pinged if the verification script cannot be run.

This field is a member of oneof _rejection_tracker_url.

Type

str

address

Optional. The address of the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].

This field is a member of oneof _address.

Type

str

email

Optional. The email of the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].

This field is a member of oneof _email.

Type

str

fax

Optional. The fax number of the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].

This field is a member of oneof _fax.

Type

str

phone

Optional. The phone number of the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].

This field is a member of oneof _phone.

Type

str

external_id

Optional. The external ID of the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].

This field is a member of oneof _external_id.

Type

str

comment

Optional. Comment about the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider].

This field is a member of oneof _comment.

Type

str

primary_contact

Optional. The resource name of primary Contact of the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]. 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 [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider]. Format: “networks/{network_code}/teams/{team_id}”.

Type

MutableSequence[str]

update_time

Output only. The time the [ViewabilityProvider][google.ads.admanager.v1.ViewabilityProvider] was last updated.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.ads.admanager_v1.types.WebProperty(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a web property.

name

Identifier. The resource name of the WebProperty. Format: networks/{network_code}/webProperties/{web_property_code}

Type

str

web_property_code

Required. The WebProperty code.

Type

str

product_type

Required. The ExchangeSyndicationProduct associated with this WebProperty.

Type

google.ads.admanager_v1.types.ExchangeSyndicationProductEnum.ExchangeSyndicationProduct

web_property_id

Optional. The WebProperty ID.

Type

int

class google.ads.admanager_v1.types.WebviewClaimingStatusEnum(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper message for [WebviewClaimingStatus][google.ads.admanager.v1.WebviewClaimingStatusEnum.WebviewClaimingStatus]

class WebviewClaimingStatus(value)

Bases: proto.enums.Enum

The webview claiming status of a Application.

Values:

WEBVIEW_CLAIMING_STATUS_UNSPECIFIED (0):

Default value. This value is unused.

SOFT_CLAIMED (1):

The application is soft claimed (claimed for targeting, but not ownership).

SOFT_CLAIMING_REVERTED (2):

The application had its soft claiming status reverted (usually by a user action).