profileId INTEGER Required

User profile ID associated with this request

active BOOLEAN

Select only active ads

advertiserId INTEGER

Select only ads with this advertiser ID

archived BOOLEAN

Select only archived ads

audienceSegmentIds INTEGER

Select only ads with these audience segment IDs

campaignIds INTEGER

Select only ads with these campaign IDs

compatibility ENUMERATION

Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard

creativeIds INTEGER

Select only ads with these creative IDs assigned

creativeOptimizationConfigurationIds INTEGER

Select only ads with these creative optimization configuration IDs

dynamicClickTracker BOOLEAN

Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both

ids INTEGER

Select only ads with these IDs

landingPageIds INTEGER

Select only ads with these landing page IDs

maxResults INTEGER

Maximum number of results to return

overriddenEventTagId INTEGER

Select only ads with this event tag override ID

pageToken STRING

Value of the nextPageToken from the previous result page

placementIds INTEGER

Select only ads with these placement IDs assigned

remarketingListIds INTEGER

Select only ads whose list targeting expression use these remarketing list IDs

searchString STRING

Allows searching for objects by name or ID. Wildcards () are allowed. For example, "ad2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad"

sizeIds INTEGER

Select only ads with these size IDs

sortField ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

sslCompliant BOOLEAN

Select only ads that are SSL-compliant

sslRequired BOOLEAN

Select only ads that require SSL

type ENUMERATION

Select only ads with these types

ads[] OBJECT

Contains properties of a Campaign Manager ad

ads[].accountId INTEGER

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

ads[].active BOOLEAN

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

ads[].advertiserId INTEGER

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

ads[].advertiserIdDimensionValue OBJECT

Represents a DimensionValue resource

ads[].advertiserIdDimensionValue.dimensionName STRING

The name of the dimension

ads[].advertiserIdDimensionValue.etag STRING

The eTag of this response for caching purposes

ads[].advertiserIdDimensionValue.id STRING

The ID associated with the value if available

ads[].advertiserIdDimensionValue.kind STRING

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

ads[].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

ads[].advertiserIdDimensionValue.value STRING

The value of the dimension

ads[].archived BOOLEAN

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

ads[].audienceSegmentId INTEGER

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

ads[].campaignId INTEGER

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

ads[].campaignIdDimensionValue OBJECT

Represents a DimensionValue resource

ads[].campaignIdDimensionValue.dimensionName STRING

The name of the dimension

ads[].campaignIdDimensionValue.etag STRING

The eTag of this response for caching purposes

ads[].campaignIdDimensionValue.id STRING

The ID associated with the value if available

ads[].campaignIdDimensionValue.kind STRING

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

ads[].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

ads[].campaignIdDimensionValue.value STRING

The value of the dimension

ads[].clickThroughUrl OBJECT

Click-through URL

ads[].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.

ads[].clickThroughUrl.customClickThroughUrl STRING

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

ads[].clickThroughUrl.defaultLandingPage BOOLEAN

Whether the campaign default landing page is used

ads[].clickThroughUrl.landingPageId INTEGER

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

ads[].clickThroughUrlSuffixProperties OBJECT

Click Through URL Suffix settings

ads[].clickThroughUrlSuffixProperties.clickThroughUrlSuffix STRING

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

ads[].clickThroughUrlSuffixProperties.overrideInheritedSuffix BOOLEAN

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

ads[].comments STRING

Comments for this ad

ads[].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

ads[].createInfo OBJECT

Modification timestamp

ads[].createInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

ads[].creativeGroupAssignments[] OBJECT

Creative Group Assignment

ads[].creativeGroupAssignments[].creativeGroupId INTEGER

ID of the creative group to be assigned

ads[].creativeGroupAssignments[].creativeGroupNumber ENUMERATION

Creative group number of the creative group assignment

ads[].creativeRotation OBJECT

Creative Rotation

ads[].creativeRotation.creativeAssignments[] OBJECT

Creative Assignment

ads[].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

ads[].creativeRotation.type ENUMERATION

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

ads[].creativeRotation.weightCalculationStrategy ENUMERATION

Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM

ads[].dayPartTargeting OBJECT

Day Part Targeting

ads[].dayPartTargeting.daysOfWeek[] ENUMERATION

ads[].dayPartTargeting.hoursOfDay[] INTEGER

ads[].dayPartTargeting.userLocalTime BOOLEAN

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

ads[].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

ads[].defaultClickThroughEventTagProperties.defaultClickThroughEventTagId INTEGER

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

ads[].defaultClickThroughEventTagProperties.overrideInheritedEventTag BOOLEAN

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

ads[].deliverySchedule OBJECT

Delivery Schedule

ads[].deliverySchedule.frequencyCap OBJECT

Frequency Cap

ads[].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

ads[].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

ads[].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

ads[].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

ads[].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

ads[].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

ads[].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

ads[].eventTagOverrides[] OBJECT

Event tag override information

ads[].eventTagOverrides[].enabled BOOLEAN

Whether this override is enabled

ads[].eventTagOverrides[].id INTEGER

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

ads[].geoTargeting OBJECT

Geographical Targeting

ads[].geoTargeting.cities[] OBJECT

Contains information about a city that can be targeted by ads

ads[].geoTargeting.countries[] OBJECT

Contains information about a country that can be targeted by ads

ads[].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

ads[].geoTargeting.metros[] OBJECT

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

ads[].geoTargeting.postalCodes[] OBJECT

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

ads[].geoTargeting.regions[] OBJECT

Contains information about a region that can be targeted by ads

ads[].id INTEGER

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

ads[].idDimensionValue OBJECT

Represents a DimensionValue resource

ads[].idDimensionValue.dimensionName STRING

The name of the dimension

ads[].idDimensionValue.etag STRING

The eTag of this response for caching purposes

ads[].idDimensionValue.id STRING

The ID associated with the value if available

ads[].idDimensionValue.kind STRING

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

ads[].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

ads[].idDimensionValue.value STRING

The value of the dimension

ads[].keyValueTargetingExpression OBJECT

Key Value Targeting Expression

ads[].keyValueTargetingExpression.expression STRING

Keyword expression being targeted by the ad

ads[].kind STRING

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

ads[].languageTargeting OBJECT

Language Targeting

ads[].languageTargeting.languages[] OBJECT

Contains information about a language that can be targeted by ads

ads[].lastModifiedInfo OBJECT

Modification timestamp

ads[].lastModifiedInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

ads[].name STRING

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

ads[].placementAssignments[] OBJECT

Placement Assignment

ads[].placementAssignments[].active BOOLEAN

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

ads[].placementAssignments[].placementId INTEGER

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

ads[].placementAssignments[].placementIdDimensionValue OBJECT

Represents a DimensionValue resource

ads[].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

ads[].remarketingListExpression OBJECT

Remarketing List Targeting Expression

ads[].remarketingListExpression.expression STRING

Expression describing which lists are being targeted by the ad

ads[].size OBJECT

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

ads[].size.height INTEGER

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

ads[].size.iab BOOLEAN

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

ads[].size.id INTEGER

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

ads[].size.kind STRING

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

ads[].size.width INTEGER

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

ads[].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

ads[].sslRequired BOOLEAN

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

ads[].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

ads[].subaccountId INTEGER

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

ads[].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

ads[].technologyTargeting OBJECT

Technology Targeting

ads[].technologyTargeting.browsers[] OBJECT

Contains information about a browser that can be targeted by ads

ads[].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

ads[].technologyTargeting.mobileCarriers[] OBJECT

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

ads[].technologyTargeting.operatingSystemVersions[] OBJECT

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

ads[].technologyTargeting.operatingSystems[] OBJECT

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

ads[].technologyTargeting.platformTypes[] OBJECT

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

ads[].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)

kind STRING

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

nextPageToken STRING

Pagination token to be used for the next list operation