REST Resource: ads

Resource: Ad

Contains properties of a Campaign Manager ad .

JSON representation

JSON representation
{ "id" : string , "campaignId" : string , "advertiserId" : string , "subaccountId" : string , "accountId" : string , "name" : string , "active" : boolean , "archived" : boolean , "comments" : string , "startTime" : string , "endTime" : string , "placementAssignments" : [ { object ( `PlacementAssignment` ) } ] , "eventTagOverrides" : [ { object ( `EventTagOverride` ) } ] , "clickThroughUrlSuffixProperties" : { object ( `ClickThroughUrlSuffixProperties` ) } , "defaultClickThroughEventTagProperties" : { object ( `DefaultClickThroughEventTagProperties` ) } , "createInfo" : { object ( `LastModifiedInfo` ) } , "lastModifiedInfo" : { object ( `LastModifiedInfo` ) } , "sslRequired" : boolean , "sslCompliant" : boolean , "type" : enum ( `AdServingType` ) , "geoTargeting" : { object ( `GeoTargeting` ) } , "technologyTargeting" : { object ( `TechnologyTargeting` ) } , "dayPartTargeting" : { object ( `DayPartTargeting` ) } , "deliverySchedule" : { object ( `DeliverySchedule` ) } , "creativeRotation" : { object ( `CreativeRotation` ) } , "remarketingListExpression" : { object ( `ListTargetingExpression` ) } , "audienceSegmentId" : string , "keyValueTargetingExpression" : { object ( `KeyValueTargetingExpression` ) } , "clickThroughUrl" : { object ( `ClickThroughUrl` ) } , "creativeGroupAssignments" : [ { object ( `CreativeGroupAssignment` ) } ] , "size" : { object ( `Size` ) } , "compatibility" : enum ( `Compatibility` ) , "idDimensionValue" : { object ( `DimensionValue` ) } , "campaignIdDimensionValue" : { object ( `DimensionValue` ) } , "advertiserIdDimensionValue" : { object ( `DimensionValue` ) } , "dynamicClickTracker" : boolean , "languageTargeting" : { object ( `LanguageTargeting` ) } , "targetingTemplateId" : string , "kind" : string }

 { 
 "id" 
 : 
 string 
 , 
 "campaignId" 
 : 
 string 
 , 
 "advertiserId" 
 : 
 string 
 , 
 "subaccountId" 
 : 
 string 
 , 
 "accountId" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "active" 
 : 
 boolean 
 , 
 "archived" 
 : 
 boolean 
 , 
 "comments" 
 : 
 string 
 , 
 "startTime" 
 : 
 string 
 , 
 "endTime" 
 : 
 string 
 , 
 "placementAssignments" 
 : 
 [ 
 { 
 object (  PlacementAssignment 
 
) 
 } 
 ] 
 , 
 "eventTagOverrides" 
 : 
 [ 
 { 
 object (  EventTagOverride 
 
) 
 } 
 ] 
 , 
 "clickThroughUrlSuffixProperties" 
 : 
 { 
 object (  ClickThroughUrlSuffixProperties 
 
) 
 } 
 , 
 "defaultClickThroughEventTagProperties" 
 : 
 { 
 object (  DefaultClickThroughEventTagProperties 
 
) 
 } 
 , 
 "createInfo" 
 : 
 { 
 object (  LastModifiedInfo 
 
) 
 } 
 , 
 "lastModifiedInfo" 
 : 
 { 
 object (  LastModifiedInfo 
 
) 
 } 
 , 
 "sslRequired" 
 : 
 boolean 
 , 
 "sslCompliant" 
 : 
 boolean 
 , 
 "type" 
 : 
 enum (  AdServingType 
 
) 
 , 
 "geoTargeting" 
 : 
 { 
 object (  GeoTargeting 
 
) 
 } 
 , 
 "technologyTargeting" 
 : 
 { 
 object (  TechnologyTargeting 
 
) 
 } 
 , 
 "dayPartTargeting" 
 : 
 { 
 object (  DayPartTargeting 
 
) 
 } 
 , 
 "deliverySchedule" 
 : 
 { 
 object (  DeliverySchedule 
 
) 
 } 
 , 
 "creativeRotation" 
 : 
 { 
 object (  CreativeRotation 
 
) 
 } 
 , 
 "remarketingListExpression" 
 : 
 { 
 object (  ListTargetingExpression 
 
) 
 } 
 , 
 "audienceSegmentId" 
 : 
 string 
 , 
 "keyValueTargetingExpression" 
 : 
 { 
 object (  KeyValueTargetingExpression 
 
) 
 } 
 , 
 "clickThroughUrl" 
 : 
 { 
 object (  ClickThroughUrl 
 
) 
 } 
 , 
 "creativeGroupAssignments" 
 : 
 [ 
 { 
 object (  CreativeGroupAssignment 
 
) 
 } 
 ] 
 , 
 "size" 
 : 
 { 
 object (  Size 
 
) 
 } 
 , 
 "compatibility" 
 : 
 enum (  Compatibility 
 
) 
 , 
 "idDimensionValue" 
 : 
 { 
 object (  DimensionValue 
 
) 
 } 
 , 
 "campaignIdDimensionValue" 
 : 
 { 
 object (  DimensionValue 
 
) 
 } 
 , 
 "advertiserIdDimensionValue" 
 : 
 { 
 object (  DimensionValue 
 
) 
 } 
 , 
 "dynamicClickTracker" 
 : 
 boolean 
 , 
 "languageTargeting" 
 : 
 { 
 object (  LanguageTargeting 
 
) 
 } 
 , 
 "targetingTemplateId" 
 : 
 string 
 , 
 "kind" 
 : 
 string 
 }

Fields
`id`	`string ( int64 format)` ID of this ad. This is a read-only, auto-generated field.
`campaignId`	`string ( int64 format)` Campaign ID of this ad. This is a required field on insertion.
`advertiserId`	`string ( int64 format)` Advertiser ID of this ad. This is a required field on insertion.
`subaccountId`	`string ( int64 format)` Subaccount ID of this ad. This is a read-only field that can be left blank.
`accountId`	`string ( int64 format)` Account ID of this ad. This is a read-only field that can be left blank.
`name`	`string` Name of this ad. This is a required field and must be less than 256 characters long.
`active`	`boolean` Whether this ad is active. When true, `archived` must be false.
`archived`	`boolean` Whether this ad is archived. When true, `active` must be false.
`comments`	`string` Comments for this ad.
`startTime`	`string` 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.
`endTime`	`string` Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
`placementAssignments[]`	`object ( PlacementAssignment )` Placement assignments for this ad.
`eventTagOverrides[]`	`object ( EventTagOverride )` Event tag overrides for this ad.
`clickThroughUrlSuffixProperties`	`object ( ClickThroughUrlSuffixProperties )` Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
`defaultClickThroughEventTagProperties`	`object ( DefaultClickThroughEventTagProperties )` Default click-through event tag properties for this ad.
`createInfo`	`object ( LastModifiedInfo )` Information about the creation of this ad. This is a read-only field.
`lastModifiedInfo`	`object ( LastModifiedInfo )` Information about the most recent modification of this ad. This is a read-only field.
`sslRequired`	`boolean` Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
`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.
`type`	`enum ( AdServingType )` 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).
`geoTargeting`	`object ( GeoTargeting )` Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when `type` is `AD_SERVING_STANDARD_AD` .
`technologyTargeting`	`object ( TechnologyTargeting )` Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when `type` is `AD_SERVING_STANDARD_AD` .
`dayPartTargeting`	`object ( DayPartTargeting )` Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when `type` is `AD_SERVING_STANDARD_AD` .
`deliverySchedule`	`object ( DeliverySchedule )` Delivery schedule information for this ad. Applicable when `type` is `AD_SERVING_STANDARD_AD` or `AD_SERVING_TRACKING` . This field along with subfields `priority` and `impressionRatio` are required on insertion when `type` is `AD_SERVING_STANDARD_AD` .
`creativeRotation`	`object ( CreativeRotation )` Creative rotation for this ad. Applicable when `type` is `AD_SERVING_DEFAULT_AD` , `AD_SERVING_STANDARD_AD` , or `AD_SERVING_TRACKING` . When `type` is `AD_SERVING_DEFAULT_AD` , this field should have exactly one `creativeAssignment` .
`remarketingListExpression`	`object ( ListTargetingExpression )` Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when `type` is `AD_SERVING_STANDARD_AD` .
`audienceSegmentId`	`string ( int64 format)` Audience segment ID that is being targeted for this ad. Applicable when `type` is `AD_SERVING_STANDARD_AD` .
`keyValueTargetingExpression`	`object ( KeyValueTargetingExpression )` Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when `type` is `AD_SERVING_STANDARD_AD` .
`clickThroughUrl`	`object ( ClickThroughUrl )` Click-through URL for this ad. This is a required field on insertion. Applicable when `type` is `AD_SERVING_CLICK_TRACKER` .
`creativeGroupAssignments[]`	`object ( CreativeGroupAssignment )` Creative group assignments for this ad. Applicable when `type` is `AD_SERVING_CLICK_TRACKER` . Only one assignment per creative group number is allowed for a maximum of two assignments.
`size`	`object ( Size )` Size of this ad. Applicable when `type` is `AD_SERVING_DEFAULT_AD` .
`compatibility`	`enum ( Compatibility )` 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.
`idDimensionValue`	`object ( DimensionValue )` Dimension value for the ID of this ad. This is a read-only, auto-generated field.
`campaignIdDimensionValue`	`object ( DimensionValue )` Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
`advertiserIdDimensionValue`	`object ( DimensionValue )` Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
`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.
`languageTargeting`	`object ( LanguageTargeting )` Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when `type` is `AD_SERVING_STANDARD_AD` .
`targetingTemplateId`	`string ( int64 format)` 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` .
`kind`	`string` Identifies what kind of resource this is. Value: the fixed string `"dfareporting#ad"` .

PlacementAssignment

Placement Assignment.

JSON representation
{ "placementId" : string , "active" : boolean , "sslRequired" : boolean , "placementIdDimensionValue" : { object ( `DimensionValue` ) } }

Fields
`placementId`	`string ( int64 format)` ID of the placement to be assigned. This is a required field.
`active`	`boolean` Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
`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.
`placementIdDimensionValue`	`object ( DimensionValue )` Dimension value for the ID of the placement. This is a read-only, auto-generated field.

DeliverySchedule

Delivery Schedule.

JSON representation
{ "hardCutoff" : boolean , "priority" : enum ( `Priority` ) , "impressionRatio" : string , "frequencyCap" : { object ( `FrequencyCap` ) } }

Fields
`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.
`priority`	`enum ( Priority )` Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
`impressionRatio`	`string ( int64 format)` 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.
`frequencyCap`	`object ( FrequencyCap )` Limit on the number of times an individual user can be served the ad within a specified period of time.

Priority

Enums
`AD_PRIORITY_01`
`AD_PRIORITY_02`
`AD_PRIORITY_03`
`AD_PRIORITY_04`
`AD_PRIORITY_05`
`AD_PRIORITY_06`
`AD_PRIORITY_07`
`AD_PRIORITY_08`
`AD_PRIORITY_09`
`AD_PRIORITY_10`
`AD_PRIORITY_11`
`AD_PRIORITY_12`
`AD_PRIORITY_13`
`AD_PRIORITY_14`
`AD_PRIORITY_15`
`AD_PRIORITY_16`

FrequencyCap

Frequency Cap.

JSON representation
{ "impressions" : string , "duration" : string }

Fields

Fields
`impressions`	`string ( int64 format)` Number of times an individual user can be served the ad within the specified duration. Acceptable values are `1` to `15` , inclusive.
`duration`	`string ( int64 format)` Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are `1` to `7776000` , inclusive.

impressions

string ( int64 format)

Number of times an individual user can be served the ad within the specified duration. Acceptable values are

1

15

, inclusive.

duration

string ( int64 format)

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

1

7776000

, inclusive.

CreativeRotation

Creative Rotation.

JSON representation

JSON representation
{ "type" : enum ( `CreativeRotationType` ) , "weightCalculationStrategy" : enum ( `CreativeRotationWeightStrategy` ) , "creativeOptimizationConfigurationId" : string , "creativeAssignments" : [ { object ( `CreativeAssignment` ) } ] }

 { 
 "type" 
 : 
 enum (  CreativeRotationType 
 
) 
 , 
 "weightCalculationStrategy" 
 : 
 enum (  CreativeRotationWeightStrategy 
 
) 
 , 
 "creativeOptimizationConfigurationId" 
 : 
 string 
 , 
 "creativeAssignments" 
 : 
 [ 
 { 
 object (  CreativeAssignment 
 
) 
 } 
 ] 
 }

Fields
`type`	`enum ( CreativeRotationType )` Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
`weightCalculationStrategy`	`enum ( CreativeRotationWeightStrategy )` Strategy for calculating weights. Used with `CREATIVE_ROTATION_TYPE_RANDOM` .
`creativeOptimizationConfigurationId`	`string ( int64 format)` 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.
`creativeAssignments[]`	`object ( CreativeAssignment )` Creative assignments in this creative rotation.

CreativeAssignment

Creative Assignment.

JSON representation

JSON representation
{ "creativeId" : string , "active" : boolean , "weight" : integer , "startTime" : string , "endTime" : string , "sequence" : integer , "clickThroughUrl" : { object ( `ClickThroughUrl` ) } , "creativeGroupAssignments" : [ { object ( `CreativeGroupAssignment` ) } ] , "richMediaExitOverrides" : [ { object ( `RichMediaExitOverride` ) } ] , "companionCreativeOverrides" : [ { object ( `CompanionClickThroughOverride` ) } ] , "applyEventTags" : boolean , "sslCompliant" : boolean , "creativeIdDimensionValue" : { object ( `DimensionValue` ) } }

 { 
 "creativeId" 
 : 
 string 
 , 
 "active" 
 : 
 boolean 
 , 
 "weight" 
 : 
 integer 
 , 
 "startTime" 
 : 
 string 
 , 
 "endTime" 
 : 
 string 
 , 
 "sequence" 
 : 
 integer 
 , 
 "clickThroughUrl" 
 : 
 { 
 object (  ClickThroughUrl 
 
) 
 } 
 , 
 "creativeGroupAssignments" 
 : 
 [ 
 { 
 object (  CreativeGroupAssignment 
 
) 
 } 
 ] 
 , 
 "richMediaExitOverrides" 
 : 
 [ 
 { 
 object (  RichMediaExitOverride 
 
) 
 } 
 ] 
 , 
 "companionCreativeOverrides" 
 : 
 [ 
 { 
 object (  CompanionClickThroughOverride 
 
) 
 } 
 ] 
 , 
 "applyEventTags" 
 : 
 boolean 
 , 
 "sslCompliant" 
 : 
 boolean 
 , 
 "creativeIdDimensionValue" 
 : 
 { 
 object (  DimensionValue 
 
) 
 } 
 }

Fields

creativeId

string ( int64 format)

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

active

boolean

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

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

startTime

string

Date and time that the assigned creative should start serving.

endTime

string

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

sequence

integer

Sequence number of the creative assignment, applicable when the rotation type is

CREATIVE_ROTATION_TYPE_SEQUENTIAL

. Acceptable values are

1

65535

, inclusive.

clickThroughUrl

object ( ClickThroughUrl )

Click-through URL of the creative assignment.

creativeGroupAssignments[]

object ( CreativeGroupAssignment )

Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.

richMediaExitOverrides[]

object ( RichMediaExitOverride )

Rich media exit overrides for this creative assignment.

Applicable when the creative type is any of the following:

DISPLAY
RICH_MEDIA_INPAGE
RICH_MEDIA_INPAGE_FLOATING
RICH_MEDIA_IM_EXPAND
RICH_MEDIA_EXPANDING
RICH_MEDIA_INTERSTITIAL_FLOAT
RICH_MEDIA_MOBILE_IN_APP
RICH_MEDIA_MULTI_FLOATING
RICH_MEDIA_PEEL_DOWN
VPAID_LINEAR
VPAID_NON_LINEAR

companionCreativeOverrides[]

object ( CompanionClickThroughOverride )

Companion creative overrides for this creative assignment. Applicable to video ads.

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

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.

creativeIdDimensionValue

object ( DimensionValue )

Dimension value for the ID of the creative. This is a read-only, auto-generated field.

ClickThroughUrl

Click-through URL

JSON representation
{ "defaultLandingPage" : boolean , "landingPageId" : string , "customClickThroughUrl" : string , "computedClickThroughUrl" : string }

Fields

defaultLandingPage

boolean

Whether the campaign default landing page is used.

landingPageId

string ( int64 format)

ID of the landing page for the click-through URL. Applicable if the

defaultLandingPage

field is set to false.

customClickThroughUrl

string

Custom click-through URL. Applicable if the

defaultLandingPage

field is set to false and the

landingPageId

field is left unset.

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.

CreativeGroupAssignment

Creative Group Assignment.

JSON representation
{ "creativeGroupId" : string , "creativeGroupNumber" : enum ( `CreativeGroupNumber` ) }

Fields

Fields
`creativeGroupId`	`string ( int64 format)` ID of the creative group to be assigned.
`creativeGroupNumber`	`enum ( CreativeGroupNumber )` Creative group number of the creative group assignment.

creativeGroupId

string ( int64 format)

ID of the creative group to be assigned.

creativeGroupNumber

enum ( CreativeGroupNumber )

Creative group number of the creative group assignment.

RichMediaExitOverride

Rich Media Exit Override.

JSON representation
{ "exitId" : string , "enabled" : boolean , "clickThroughUrl" : { object ( `ClickThroughUrl` ) } }

Fields

Fields
`exitId`	`string ( int64 format)` ID for the override to refer to a specific exit in the creative.
`enabled`	`boolean` Whether to use the `clickThroughUrl` . If false, the creative-level exit will be used.
`clickThroughUrl`	`object ( ClickThroughUrl )` Click-through URL of this rich media exit override. Applicable if the `enabled` field is set to true.

exitId

string ( int64 format)

ID for the override to refer to a specific exit in the creative.

enabled

boolean

Whether to use the

clickThroughUrl

. If false, the creative-level exit will be used.

clickThroughUrl

object ( ClickThroughUrl )

Click-through URL of this rich media exit override. Applicable if the

enabled

field is set to true.

CompanionClickThroughOverride

Companion Click-through override.

JSON representation
{ "creativeId" : string , "clickThroughUrl" : { object ( `ClickThroughUrl` ) } }

Fields

Fields
`creativeId`	`string ( int64 format)` ID of the creative for this companion click-through override.
`clickThroughUrl`	`object ( ClickThroughUrl )` Click-through URL of this companion click-through override.

creativeId

string ( int64 format)

ID of the creative for this companion click-through override.

clickThroughUrl

object ( ClickThroughUrl )

Click-through URL of this companion click-through override.

Methods
`get`	Gets one ad by ID.
`insert`	Inserts a new ad.
`list`	Retrieves a list of ads, possibly filtered.
`patch`	Updates an existing ad.
`update`	Updates an existing ad.

REST Resource: ads

Resource: Ad

PlacementAssignment

DeliverySchedule

Priority

FrequencyCap

CreativeRotation

CreativeAssignment

ClickThroughUrl

CreativeGroupAssignment

RichMediaExitOverride

CompanionClickThroughOverride

Methods

`get`

`insert`

`list`

`patch`

`update`

REST Resource: ads Stay organized with collections Save and categorize content based on your preferences.

Resource: Ad

PlacementAssignment

DeliverySchedule

Priority

FrequencyCap

CreativeRotation

CreativeAssignment

ClickThroughUrl

CreativeGroupAssignment

RichMediaExitOverride

CompanionClickThroughOverride

Methods

get

insert

list

patch

update

REST Resource: ads

`get`

`insert`

`list`

`patch`

`update`