profileId INTEGER Required

User profile ID associated with this request

accountId INTEGER

Account ID of this ad. This is a read-only field that can be left blank

active BOOLEAN

Whether this ad is active. When true, archived must be false

advertiserId INTEGER

Advertiser ID of this ad. This is a required field on insertion

advertiserIdDimensionValue OBJECT

Represents a DimensionValue resource

advertiserIdDimensionValue.dimensionName STRING

The name of the dimension

advertiserIdDimensionValue.etag STRING

The eTag of this response for caching purposes

advertiserIdDimensionValue.id STRING

The ID associated with the value if available

advertiserIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

advertiserIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

advertiserIdDimensionValue.value STRING

The value of the dimension

archived BOOLEAN

Whether this ad is archived. When true, active must be false

audienceSegmentId INTEGER

Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD

campaignId INTEGER

Campaign ID of this ad. This is a required field on insertion

campaignIdDimensionValue OBJECT

Represents a DimensionValue resource

campaignIdDimensionValue.dimensionName STRING

The name of the dimension

campaignIdDimensionValue.etag STRING

The eTag of this response for caching purposes

campaignIdDimensionValue.id STRING

The ID associated with the value if available

campaignIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

campaignIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

campaignIdDimensionValue.value STRING

The value of the dimension

clickThroughUrl OBJECT

Click-through URL

clickThroughUrl.computedClickThroughUrl STRING

Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:

• If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
• If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
• If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.

clickThroughUrl.customClickThroughUrl STRING

Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset

clickThroughUrl.defaultLandingPage BOOLEAN

Whether the campaign default landing page is used

clickThroughUrl.landingPageId INTEGER

ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false

clickThroughUrlSuffixProperties OBJECT

Click Through URL Suffix settings

clickThroughUrlSuffixProperties.clickThroughUrlSuffix STRING

Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long

clickThroughUrlSuffixProperties.overrideInheritedSuffix BOOLEAN

Whether this entity should override the inherited click-through URL suffix with its own defined value

comments STRING

Comments for this ad

compatibility ENUMERATION

Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard

createInfo OBJECT

Modification timestamp

createInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

creativeGroupAssignments[] OBJECT

Creative Group Assignment

creativeGroupAssignments[].creativeGroupId INTEGER

ID of the creative group to be assigned

creativeGroupAssignments[].creativeGroupNumber ENUMERATION

Creative group number of the creative group assignment

creativeRotation OBJECT

Creative Rotation

creativeRotation.creativeAssignments[] OBJECT

Creative Assignment

creativeRotation.creativeAssignments[].active BOOLEAN

Whether this creative assignment is active. When true, the creative will be included in the ad's rotation

creativeRotation.creativeAssignments[].applyEventTags BOOLEAN

Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO

creativeRotation.creativeAssignments[].clickThroughUrl OBJECT

Click-through URL

creativeRotation.creativeAssignments[].clickThroughUrl.computedClickThroughUrl STRING

Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:

• If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
• If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
• If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.

creativeRotation.creativeAssignments[].clickThroughUrl.customClickThroughUrl STRING

Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset

creativeRotation.creativeAssignments[].clickThroughUrl.defaultLandingPage BOOLEAN

Whether the campaign default landing page is used

creativeRotation.creativeAssignments[].clickThroughUrl.landingPageId INTEGER

ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false

creativeRotation.creativeAssignments[].companionCreativeOverrides[] OBJECT

Companion Click-through override

creativeRotation.creativeAssignments[].creativeGroupAssignments[] OBJECT

Creative Group Assignment

creativeRotation.creativeAssignments[].creativeId INTEGER

ID of the creative to be assigned. This is a required field

creativeRotation.creativeAssignments[].creativeIdDimensionValue OBJECT

Represents a DimensionValue resource

creativeRotation.creativeAssignments[].creativeIdDimensionValue.dimensionName STRING

The name of the dimension

creativeRotation.creativeAssignments[].creativeIdDimensionValue.etag STRING

The eTag of this response for caching purposes

creativeRotation.creativeAssignments[].creativeIdDimensionValue.id STRING

The ID associated with the value if available

creativeRotation.creativeAssignments[].creativeIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

creativeRotation.creativeAssignments[].creativeIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

creativeRotation.creativeAssignments[].creativeIdDimensionValue.value STRING

The value of the dimension

creativeRotation.creativeAssignments[].endTime DATE_TIME

Date and time that the assigned creative should stop serving. Must be later than the start time

creativeRotation.creativeAssignments[].richMediaExitOverrides[] OBJECT

Rich Media Exit Override

creativeRotation.creativeAssignments[].sequence INTEGER

Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive

creativeRotation.creativeAssignments[].sslCompliant BOOLEAN

Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated

creativeRotation.creativeAssignments[].startTime DATE_TIME

Date and time that the assigned creative should start serving

creativeRotation.creativeAssignments[].weight INTEGER

Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1

creativeRotation.creativeOptimizationConfigurationId INTEGER

Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad

creativeRotation.type ENUMERATION

Type of creative rotation. Can be used to specify whether to use sequential or random rotation

creativeRotation.weightCalculationStrategy ENUMERATION

Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM

dayPartTargeting OBJECT

Day Part Targeting

dayPartTargeting.daysOfWeek[] ENUMERATION

dayPartTargeting.hoursOfDay[] INTEGER

dayPartTargeting.userLocalTime BOOLEAN

Whether or not to use the user's local time. If false, the America/New York time zone applies

defaultClickThroughEventTagProperties OBJECT

Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further

defaultClickThroughEventTagProperties.defaultClickThroughEventTagId INTEGER

ID of the click-through event tag to apply to all ads in this entity's scope

defaultClickThroughEventTagProperties.overrideInheritedEventTag BOOLEAN

Whether this entity should override the inherited default click-through event tag with its own defined value

deliverySchedule OBJECT

Delivery Schedule

deliverySchedule.frequencyCap OBJECT

Frequency Cap

deliverySchedule.frequencyCap.duration INTEGER

Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive

deliverySchedule.frequencyCap.impressions INTEGER

Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive

deliverySchedule.hardCutoff BOOLEAN

Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals

deliverySchedule.impressionRatio INTEGER

Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive

deliverySchedule.priority ENUMERATION

Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served

dynamicClickTracker BOOLEAN

Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert

endTime DATE_TIME

Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion

eventTagOverrides[] OBJECT

Event tag override information

eventTagOverrides[].enabled BOOLEAN

Whether this override is enabled

eventTagOverrides[].id INTEGER

ID of this event tag override. This is a read-only, auto-generated field

geoTargeting OBJECT

Geographical Targeting

geoTargeting.cities[] OBJECT

Contains information about a city that can be targeted by ads

geoTargeting.cities[].countryCode STRING

Country code of the country to which this city belongs

geoTargeting.cities[].countryDartId INTEGER

DART ID of the country to which this city belongs

geoTargeting.cities[].dartId INTEGER

DART ID of this city. This is the ID used for targeting and generating reports

geoTargeting.cities[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#city"

geoTargeting.cities[].metroCode STRING

Metro region code of the metro region (DMA) to which this city belongs

geoTargeting.cities[].metroDmaId INTEGER

ID of the metro region (DMA) to which this city belongs

geoTargeting.cities[].name STRING

Name of this city

geoTargeting.cities[].regionCode STRING

Region code of the region to which this city belongs

geoTargeting.cities[].regionDartId INTEGER

DART ID of the region to which this city belongs

geoTargeting.countries[] OBJECT

Contains information about a country that can be targeted by ads

geoTargeting.countries[].countryCode STRING

Country code

geoTargeting.countries[].dartId INTEGER

DART ID of this country. This is the ID used for targeting and generating reports

geoTargeting.countries[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#country"

geoTargeting.countries[].name STRING

Name of this country

geoTargeting.countries[].sslEnabled BOOLEAN

Whether ad serving supports secure servers in this country

geoTargeting.excludeCountries BOOLEAN

Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad

geoTargeting.metros[] OBJECT

Contains information about a metro region that can be targeted by ads

geoTargeting.metros[].countryCode STRING

Country code of the country to which this metro region belongs

geoTargeting.metros[].countryDartId INTEGER

DART ID of the country to which this metro region belongs

geoTargeting.metros[].dartId INTEGER

DART ID of this metro region

geoTargeting.metros[].dmaId INTEGER

DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code

geoTargeting.metros[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro"

geoTargeting.metros[].metroCode STRING

Metro code of this metro region. This is equivalent to dma_id

geoTargeting.metros[].name STRING

Name of this metro region

geoTargeting.postalCodes[] OBJECT

Contains information about a postal code that can be targeted by ads

geoTargeting.postalCodes[].code STRING

Postal code. This is equivalent to the id field

geoTargeting.postalCodes[].countryCode STRING

Country code of the country to which this postal code belongs

geoTargeting.postalCodes[].countryDartId INTEGER

DART ID of the country to which this postal code belongs

geoTargeting.postalCodes[].id STRING

ID of this postal code

geoTargeting.postalCodes[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode"

geoTargeting.regions[] OBJECT

Contains information about a region that can be targeted by ads

geoTargeting.regions[].countryCode STRING

Country code of the country to which this region belongs

geoTargeting.regions[].countryDartId INTEGER

DART ID of the country to which this region belongs

geoTargeting.regions[].dartId INTEGER

DART ID of this region

geoTargeting.regions[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#region"

geoTargeting.regions[].name STRING

Name of this region

geoTargeting.regions[].regionCode STRING

Region code

id INTEGER

ID of this ad. This is a read-only, auto-generated field

idDimensionValue OBJECT

Represents a DimensionValue resource

idDimensionValue.dimensionName STRING

The name of the dimension

idDimensionValue.etag STRING

The eTag of this response for caching purposes

idDimensionValue.id STRING

The ID associated with the value if available

idDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

idDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

idDimensionValue.value STRING

The value of the dimension

keyValueTargetingExpression OBJECT

Key Value Targeting Expression

keyValueTargetingExpression.expression STRING

Keyword expression being targeted by the ad

kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad"

languageTargeting OBJECT

Language Targeting

languageTargeting.languages[] OBJECT

Contains information about a language that can be targeted by ads

languageTargeting.languages[].id INTEGER

Language ID of this language. This is the ID used for targeting and generating reports

languageTargeting.languages[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#language"

languageTargeting.languages[].languageCode STRING

Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese

languageTargeting.languages[].name STRING

Name of this language

lastModifiedInfo OBJECT

Modification timestamp

lastModifiedInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

name STRING

Name of this ad. This is a required field and must be less than 256 characters long

placementAssignments[] OBJECT

Placement Assignment

placementAssignments[].active BOOLEAN

Whether this placement assignment is active. When true, the placement will be included in the ad's rotation

placementAssignments[].placementId INTEGER

ID of the placement to be assigned. This is a required field

placementAssignments[].placementIdDimensionValue OBJECT

Represents a DimensionValue resource

placementAssignments[].placementIdDimensionValue.dimensionName STRING

The name of the dimension

placementAssignments[].placementIdDimensionValue.etag STRING

The eTag of this response for caching purposes

placementAssignments[].placementIdDimensionValue.id STRING

The ID associated with the value if available

placementAssignments[].placementIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placementAssignments[].placementIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

placementAssignments[].placementIdDimensionValue.value STRING

The value of the dimension

placementAssignments[].sslRequired BOOLEAN

Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated

remarketingListExpression OBJECT

Remarketing List Targeting Expression

remarketingListExpression.expression STRING

Expression describing which lists are being targeted by the ad

size OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

size.height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

size.iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

size.id INTEGER

ID of this size. This is a read-only, auto-generated field

size.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

size.width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

sslCompliant BOOLEAN

Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated

sslRequired BOOLEAN

Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated

startTime DATE_TIME

Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion

subaccountId INTEGER

Subaccount ID of this ad. This is a read-only field that can be left blank

targetingTemplateId INTEGER

Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD

technologyTargeting OBJECT

Technology Targeting

technologyTargeting.browsers[] OBJECT

Contains information about a browser that can be targeted by ads

technologyTargeting.browsers[].browserVersionId INTEGER

ID referring to this grouping of browser and version numbers. This is the ID used for targeting

technologyTargeting.browsers[].dartId INTEGER

DART ID of this browser. This is the ID used when generating reports

technologyTargeting.browsers[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser"

technologyTargeting.browsers[].majorVersion STRING

Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk () may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome . targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3. targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is

technologyTargeting.browsers[].minorVersion STRING

Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk () may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome . targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3. targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is

technologyTargeting.browsers[].name STRING

Name of this browser

technologyTargeting.connectionTypes[] OBJECT

Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users

technologyTargeting.connectionTypes[].id INTEGER

ID of this connection type

technologyTargeting.connectionTypes[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType"

technologyTargeting.connectionTypes[].name STRING

Name of this connection type

technologyTargeting.mobileCarriers[] OBJECT

Contains information about a mobile carrier that can be targeted by ads

technologyTargeting.mobileCarriers[].countryCode STRING

Country code of the country to which this mobile carrier belongs

technologyTargeting.mobileCarriers[].countryDartId INTEGER

DART ID of the country to which this mobile carrier belongs

technologyTargeting.mobileCarriers[].id INTEGER

ID of this mobile carrier

technologyTargeting.mobileCarriers[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier"

technologyTargeting.mobileCarriers[].name STRING

Name of this mobile carrier

technologyTargeting.operatingSystemVersions[] OBJECT

Contains information about a particular version of an operating system that can be targeted by ads

technologyTargeting.operatingSystemVersions[].id INTEGER

ID of this operating system version

technologyTargeting.operatingSystemVersions[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion"

technologyTargeting.operatingSystemVersions[].majorVersion STRING

Major version (leftmost number) of this operating system version

technologyTargeting.operatingSystemVersions[].minorVersion STRING

Minor version (number after the first dot) of this operating system version

technologyTargeting.operatingSystemVersions[].name STRING

Name of this operating system version

technologyTargeting.operatingSystemVersions[].operatingSystem OBJECT

Contains information about an operating system that can be targeted by ads

technologyTargeting.operatingSystemVersions[].operatingSystem.dartId INTEGER

DART ID of this operating system. This is the ID used for targeting

technologyTargeting.operatingSystemVersions[].operatingSystem.desktop BOOLEAN

Whether this operating system is for desktop

technologyTargeting.operatingSystemVersions[].operatingSystem.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem"

technologyTargeting.operatingSystemVersions[].operatingSystem.mobile BOOLEAN

Whether this operating system is for mobile

technologyTargeting.operatingSystemVersions[].operatingSystem.name STRING

Name of this operating system

technologyTargeting.operatingSystems[] OBJECT

Contains information about an operating system that can be targeted by ads

technologyTargeting.operatingSystems[].dartId INTEGER

DART ID of this operating system. This is the ID used for targeting

technologyTargeting.operatingSystems[].desktop BOOLEAN

Whether this operating system is for desktop

technologyTargeting.operatingSystems[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem"

technologyTargeting.operatingSystems[].mobile BOOLEAN

Whether this operating system is for mobile

technologyTargeting.operatingSystems[].name STRING

Name of this operating system

technologyTargeting.platformTypes[] OBJECT

Contains information about a platform type that can be targeted by ads

technologyTargeting.platformTypes[].id INTEGER

ID of this platform type

technologyTargeting.platformTypes[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType"

technologyTargeting.platformTypes[].name STRING

Name of this platform type

type ENUMERATION

Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource)

accountId INTEGER

Account ID of this ad. This is a read-only field that can be left blank

active BOOLEAN

Whether this ad is active. When true, archived must be false

advertiserId INTEGER

Advertiser ID of this ad. This is a required field on insertion

advertiserIdDimensionValue OBJECT

Represents a DimensionValue resource

advertiserIdDimensionValue.dimensionName STRING

The name of the dimension

advertiserIdDimensionValue.etag STRING

The eTag of this response for caching purposes

advertiserIdDimensionValue.id STRING

The ID associated with the value if available

advertiserIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

advertiserIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

advertiserIdDimensionValue.value STRING

The value of the dimension

archived BOOLEAN

Whether this ad is archived. When true, active must be false

audienceSegmentId INTEGER

Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD

campaignId INTEGER

Campaign ID of this ad. This is a required field on insertion

campaignIdDimensionValue OBJECT

Represents a DimensionValue resource

campaignIdDimensionValue.dimensionName STRING

The name of the dimension

campaignIdDimensionValue.etag STRING

The eTag of this response for caching purposes

campaignIdDimensionValue.id STRING

The ID associated with the value if available

campaignIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

campaignIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

campaignIdDimensionValue.value STRING

The value of the dimension

clickThroughUrl OBJECT

Click-through URL

clickThroughUrl.computedClickThroughUrl STRING

Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:

• If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
• If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
• If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.

clickThroughUrl.customClickThroughUrl STRING

Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset

clickThroughUrl.defaultLandingPage BOOLEAN

Whether the campaign default landing page is used

clickThroughUrl.landingPageId INTEGER

ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false

clickThroughUrlSuffixProperties OBJECT

Click Through URL Suffix settings

clickThroughUrlSuffixProperties.clickThroughUrlSuffix STRING

Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long

clickThroughUrlSuffixProperties.overrideInheritedSuffix BOOLEAN

Whether this entity should override the inherited click-through URL suffix with its own defined value

comments STRING

Comments for this ad

compatibility ENUMERATION

Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard

createInfo OBJECT

Modification timestamp

createInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

creativeGroupAssignments[] OBJECT

Creative Group Assignment

creativeGroupAssignments[].creativeGroupId INTEGER

ID of the creative group to be assigned

creativeGroupAssignments[].creativeGroupNumber ENUMERATION

Creative group number of the creative group assignment

creativeRotation OBJECT

Creative Rotation

creativeRotation.creativeAssignments[] OBJECT

Creative Assignment

creativeRotation.creativeAssignments[].active BOOLEAN

Whether this creative assignment is active. When true, the creative will be included in the ad's rotation

creativeRotation.creativeAssignments[].applyEventTags BOOLEAN

Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO

creativeRotation.creativeAssignments[].clickThroughUrl OBJECT

Click-through URL

creativeRotation.creativeAssignments[].clickThroughUrl.computedClickThroughUrl STRING

Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:

• If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
• If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
• If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.

creativeRotation.creativeAssignments[].clickThroughUrl.customClickThroughUrl STRING

Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset

creativeRotation.creativeAssignments[].clickThroughUrl.defaultLandingPage BOOLEAN

Whether the campaign default landing page is used

creativeRotation.creativeAssignments[].clickThroughUrl.landingPageId INTEGER

ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false

creativeRotation.creativeAssignments[].companionCreativeOverrides[] OBJECT

Companion Click-through override

creativeRotation.creativeAssignments[].creativeGroupAssignments[] OBJECT

Creative Group Assignment

creativeRotation.creativeAssignments[].creativeId INTEGER

ID of the creative to be assigned. This is a required field

creativeRotation.creativeAssignments[].creativeIdDimensionValue OBJECT

Represents a DimensionValue resource

creativeRotation.creativeAssignments[].creativeIdDimensionValue.dimensionName STRING

The name of the dimension

creativeRotation.creativeAssignments[].creativeIdDimensionValue.etag STRING

The eTag of this response for caching purposes

creativeRotation.creativeAssignments[].creativeIdDimensionValue.id STRING

The ID associated with the value if available

creativeRotation.creativeAssignments[].creativeIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

creativeRotation.creativeAssignments[].creativeIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

creativeRotation.creativeAssignments[].creativeIdDimensionValue.value STRING

The value of the dimension

creativeRotation.creativeAssignments[].endTime DATE_TIME

Date and time that the assigned creative should stop serving. Must be later than the start time

creativeRotation.creativeAssignments[].richMediaExitOverrides[] OBJECT

Rich Media Exit Override

creativeRotation.creativeAssignments[].sequence INTEGER

Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive

creativeRotation.creativeAssignments[].sslCompliant BOOLEAN

Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated

creativeRotation.creativeAssignments[].startTime DATE_TIME

Date and time that the assigned creative should start serving

creativeRotation.creativeAssignments[].weight INTEGER

Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1

creativeRotation.creativeOptimizationConfigurationId INTEGER

Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad

creativeRotation.type ENUMERATION

Type of creative rotation. Can be used to specify whether to use sequential or random rotation

creativeRotation.weightCalculationStrategy ENUMERATION

Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM

dayPartTargeting OBJECT

Day Part Targeting

dayPartTargeting.daysOfWeek[] ENUMERATION

dayPartTargeting.hoursOfDay[] INTEGER

dayPartTargeting.userLocalTime BOOLEAN

Whether or not to use the user's local time. If false, the America/New York time zone applies

defaultClickThroughEventTagProperties OBJECT

Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further

defaultClickThroughEventTagProperties.defaultClickThroughEventTagId INTEGER

ID of the click-through event tag to apply to all ads in this entity's scope

defaultClickThroughEventTagProperties.overrideInheritedEventTag BOOLEAN

Whether this entity should override the inherited default click-through event tag with its own defined value

deliverySchedule OBJECT

Delivery Schedule

deliverySchedule.frequencyCap OBJECT

Frequency Cap

deliverySchedule.frequencyCap.duration INTEGER

Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive

deliverySchedule.frequencyCap.impressions INTEGER

Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive

deliverySchedule.hardCutoff BOOLEAN

Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals

deliverySchedule.impressionRatio INTEGER

Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive

deliverySchedule.priority ENUMERATION

Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served

dynamicClickTracker BOOLEAN

Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert

endTime DATE_TIME

Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion

eventTagOverrides[] OBJECT

Event tag override information

eventTagOverrides[].enabled BOOLEAN

Whether this override is enabled

eventTagOverrides[].id INTEGER

ID of this event tag override. This is a read-only, auto-generated field

geoTargeting OBJECT

Geographical Targeting

geoTargeting.cities[] OBJECT

Contains information about a city that can be targeted by ads

geoTargeting.cities[].countryCode STRING

Country code of the country to which this city belongs

geoTargeting.cities[].countryDartId INTEGER

DART ID of the country to which this city belongs

geoTargeting.cities[].dartId INTEGER

DART ID of this city. This is the ID used for targeting and generating reports

geoTargeting.cities[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#city"

geoTargeting.cities[].metroCode STRING

Metro region code of the metro region (DMA) to which this city belongs

geoTargeting.cities[].metroDmaId INTEGER

ID of the metro region (DMA) to which this city belongs

geoTargeting.cities[].name STRING

Name of this city

geoTargeting.cities[].regionCode STRING

Region code of the region to which this city belongs

geoTargeting.cities[].regionDartId INTEGER

DART ID of the region to which this city belongs

geoTargeting.countries[] OBJECT

Contains information about a country that can be targeted by ads

geoTargeting.countries[].countryCode STRING

Country code

geoTargeting.countries[].dartId INTEGER

DART ID of this country. This is the ID used for targeting and generating reports

geoTargeting.countries[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#country"

geoTargeting.countries[].name STRING

Name of this country

geoTargeting.countries[].sslEnabled BOOLEAN

Whether ad serving supports secure servers in this country

geoTargeting.excludeCountries BOOLEAN

Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad

geoTargeting.metros[] OBJECT

Contains information about a metro region that can be targeted by ads

geoTargeting.metros[].countryCode STRING

Country code of the country to which this metro region belongs

geoTargeting.metros[].countryDartId INTEGER

DART ID of the country to which this metro region belongs

geoTargeting.metros[].dartId INTEGER

DART ID of this metro region

geoTargeting.metros[].dmaId INTEGER

DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code

geoTargeting.metros[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro"

geoTargeting.metros[].metroCode STRING

Metro code of this metro region. This is equivalent to dma_id

geoTargeting.metros[].name STRING

Name of this metro region

geoTargeting.postalCodes[] OBJECT

Contains information about a postal code that can be targeted by ads

geoTargeting.postalCodes[].code STRING

Postal code. This is equivalent to the id field

geoTargeting.postalCodes[].countryCode STRING

Country code of the country to which this postal code belongs

geoTargeting.postalCodes[].countryDartId INTEGER

DART ID of the country to which this postal code belongs

geoTargeting.postalCodes[].id STRING

ID of this postal code

geoTargeting.postalCodes[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode"

geoTargeting.regions[] OBJECT

Contains information about a region that can be targeted by ads

geoTargeting.regions[].countryCode STRING

Country code of the country to which this region belongs

geoTargeting.regions[].countryDartId INTEGER

DART ID of the country to which this region belongs

geoTargeting.regions[].dartId INTEGER

DART ID of this region

geoTargeting.regions[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#region"

geoTargeting.regions[].name STRING

Name of this region

geoTargeting.regions[].regionCode STRING

Region code

id INTEGER

ID of this ad. This is a read-only, auto-generated field

idDimensionValue OBJECT

Represents a DimensionValue resource

idDimensionValue.dimensionName STRING

The name of the dimension

idDimensionValue.etag STRING

The eTag of this response for caching purposes

idDimensionValue.id STRING

The ID associated with the value if available

idDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

idDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

idDimensionValue.value STRING

The value of the dimension

keyValueTargetingExpression OBJECT

Key Value Targeting Expression

keyValueTargetingExpression.expression STRING

Keyword expression being targeted by the ad

kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad"

languageTargeting OBJECT

Language Targeting

languageTargeting.languages[] OBJECT

Contains information about a language that can be targeted by ads

languageTargeting.languages[].id INTEGER

Language ID of this language. This is the ID used for targeting and generating reports

languageTargeting.languages[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#language"

languageTargeting.languages[].languageCode STRING

Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese

languageTargeting.languages[].name STRING

Name of this language

lastModifiedInfo OBJECT

Modification timestamp

lastModifiedInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

name STRING

Name of this ad. This is a required field and must be less than 256 characters long

placementAssignments[] OBJECT

Placement Assignment

placementAssignments[].active BOOLEAN

Whether this placement assignment is active. When true, the placement will be included in the ad's rotation

placementAssignments[].placementId INTEGER

ID of the placement to be assigned. This is a required field

placementAssignments[].placementIdDimensionValue OBJECT

Represents a DimensionValue resource

placementAssignments[].placementIdDimensionValue.dimensionName STRING

The name of the dimension

placementAssignments[].placementIdDimensionValue.etag STRING

The eTag of this response for caching purposes

placementAssignments[].placementIdDimensionValue.id STRING

The ID associated with the value if available

placementAssignments[].placementIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placementAssignments[].placementIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

placementAssignments[].placementIdDimensionValue.value STRING

The value of the dimension

placementAssignments[].sslRequired BOOLEAN

Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated

remarketingListExpression OBJECT

Remarketing List Targeting Expression

remarketingListExpression.expression STRING

Expression describing which lists are being targeted by the ad

size OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

size.height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

size.iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

size.id INTEGER

ID of this size. This is a read-only, auto-generated field

size.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

size.width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

sslCompliant BOOLEAN

Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated

sslRequired BOOLEAN

Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated

startTime DATE_TIME

Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion

subaccountId INTEGER

Subaccount ID of this ad. This is a read-only field that can be left blank

targetingTemplateId INTEGER

Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD

technologyTargeting OBJECT

Technology Targeting

technologyTargeting.browsers[] OBJECT

Contains information about a browser that can be targeted by ads

technologyTargeting.browsers[].browserVersionId INTEGER

ID referring to this grouping of browser and version numbers. This is the ID used for targeting

technologyTargeting.browsers[].dartId INTEGER

DART ID of this browser. This is the ID used when generating reports

technologyTargeting.browsers[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser"

technologyTargeting.browsers[].majorVersion STRING

Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk () may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome . targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3. targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is

technologyTargeting.browsers[].minorVersion STRING

Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk () may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome . targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3. targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is

technologyTargeting.browsers[].name STRING

Name of this browser

technologyTargeting.connectionTypes[] OBJECT

Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users

technologyTargeting.connectionTypes[].id INTEGER

ID of this connection type

technologyTargeting.connectionTypes[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType"

technologyTargeting.connectionTypes[].name STRING

Name of this connection type

technologyTargeting.mobileCarriers[] OBJECT

Contains information about a mobile carrier that can be targeted by ads

technologyTargeting.mobileCarriers[].countryCode STRING

Country code of the country to which this mobile carrier belongs

technologyTargeting.mobileCarriers[].countryDartId INTEGER

DART ID of the country to which this mobile carrier belongs

technologyTargeting.mobileCarriers[].id INTEGER

ID of this mobile carrier

technologyTargeting.mobileCarriers[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier"

technologyTargeting.mobileCarriers[].name STRING

Name of this mobile carrier

technologyTargeting.operatingSystemVersions[] OBJECT

Contains information about a particular version of an operating system that can be targeted by ads

technologyTargeting.operatingSystemVersions[].id INTEGER

ID of this operating system version

technologyTargeting.operatingSystemVersions[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion"

technologyTargeting.operatingSystemVersions[].majorVersion STRING

Major version (leftmost number) of this operating system version

technologyTargeting.operatingSystemVersions[].minorVersion STRING

Minor version (number after the first dot) of this operating system version

technologyTargeting.operatingSystemVersions[].name STRING

Name of this operating system version

technologyTargeting.operatingSystemVersions[].operatingSystem OBJECT

Contains information about an operating system that can be targeted by ads

technologyTargeting.operatingSystemVersions[].operatingSystem.dartId INTEGER

DART ID of this operating system. This is the ID used for targeting

technologyTargeting.operatingSystemVersions[].operatingSystem.desktop BOOLEAN

Whether this operating system is for desktop

technologyTargeting.operatingSystemVersions[].operatingSystem.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem"

technologyTargeting.operatingSystemVersions[].operatingSystem.mobile BOOLEAN

Whether this operating system is for mobile

technologyTargeting.operatingSystemVersions[].operatingSystem.name STRING

Name of this operating system

technologyTargeting.operatingSystems[] OBJECT

Contains information about an operating system that can be targeted by ads

technologyTargeting.operatingSystems[].dartId INTEGER

DART ID of this operating system. This is the ID used for targeting

technologyTargeting.operatingSystems[].desktop BOOLEAN

Whether this operating system is for desktop

technologyTargeting.operatingSystems[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem"

technologyTargeting.operatingSystems[].mobile BOOLEAN

Whether this operating system is for mobile

technologyTargeting.operatingSystems[].name STRING

Name of this operating system

technologyTargeting.platformTypes[] OBJECT

Contains information about a platform type that can be targeted by ads

technologyTargeting.platformTypes[].id INTEGER

ID of this platform type

technologyTargeting.platformTypes[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType"

technologyTargeting.platformTypes[].name STRING

Name of this platform type

type ENUMERATION

Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource)