Resource: Ad
Contains properties of a Campaign Manager ad.
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 ( |
Fields | |
---|---|
id |
ID of this ad. This is a read-only, auto-generated field. |
campaignId |
Campaign ID of this ad. This is a required field on insertion. |
advertiserId |
Advertiser ID of this ad. This is a required field on insertion. |
subaccountId |
Subaccount ID of this ad. This is a read-only field that can be left blank. |
accountId |
Account ID of this ad. This is a read-only field that can be left blank. |
name |
Name of this ad. This is a required field and must be less than 256 characters long. |
active |
Whether this ad is active. When true,
must be false. |
archived |
Whether this ad is archived. When true,
must be false. |
comments |
Comments for this ad. |
startTime |
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 |
Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. |
placementAssignments[] |
Placement assignments for this ad. |
eventTagOverrides[] |
Event tag overrides for this ad. |
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 |
Default click-through event tag properties for this ad. |
createInfo |
Information about the creation of this ad. This is a read-only field. |
lastModifiedInfo |
Information about the most recent modification of this ad. This is a read-only field. |
sslRequired |
Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. |
sslCompliant |
Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. |
type |
Type of ad. This is a required field on insertion. Note that default ads (
) cannot be created directly (see Creative resource). |
geoTargeting |
Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when
is
. |
technologyTargeting |
Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when
is
. |
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
is
. |
deliverySchedule |
Delivery schedule information for this ad. Applicable when
is
or
. This field along with subfields
and
are required on insertion when
is
. |
creativeRotation |
Creative rotation for this ad. Applicable when
is
,
, or
. When
is
, this field should have exactly one
. |
remarketingListExpression |
Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when
is
. |
audienceSegmentId |
Audience segment ID that is being targeted for this ad. Applicable when
is
. |
keyValueTargetingExpression |
Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when
is
. |
clickThroughUrl |
Click-through URL for this ad. This is a required field on insertion. Applicable when
is
. |
creativeGroupAssignments[] |
Creative group assignments for this ad. Applicable when
is
. Only one assignment per creative group number is allowed for a maximum of two assignments. |
size |
Size of this ad. Applicable when
is
. |
compatibility |
Compatibility of this ad. Applicable when
is
.
and
refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively.
and
are only used for existing default ads. New mobile placements must be assigned
or
and default ads created for those placements will be limited to those compatibility types.
refers to rendering in-stream video ads developed with the VAST standard. |
idDimensionValue |
Dimension value for the ID of this ad. This is a read-only, auto-generated field. |
campaignIdDimensionValue |
Dimension value for the ID of the campaign. This is a read-only, auto-generated field. |
advertiserIdDimensionValue |
Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
dynamicClickTracker |
Whether this ad is a dynamic click tracker. Applicable when
is
. This is a required field on insert, and is read-only after insert. |
languageTargeting |
Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when
is
. |
targetingTemplateId |
Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of
,
,
,
,
, or
are set. Applicable when
is
. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
PlacementAssignment
Placement Assignment.
JSON representation |
---|
{
"placementId": string,
"active": boolean,
"sslRequired": boolean,
"placementIdDimensionValue": {
object ( |
Fields | |
---|---|
placementId |
ID of the placement to be assigned. This is a required field. |
active |
Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. |
sslRequired |
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 |
Dimension value for the ID of the placement. This is a read-only, auto-generated field. |
Type
Enums | |
---|---|
AD_SERVING_STANDARD_AD |
|
AD_SERVING_DEFAULT_AD |
|
AD_SERVING_CLICK_TRACKER |
|
AD_SERVING_TRACKING |
|
AD_SERVING_BRAND_SAFE_AD |
DeliverySchedule
Delivery Schedule.
JSON representation |
---|
{ "hardCutoff": boolean, "priority": enum ( |
Fields | |
---|---|
hardCutoff |
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 |
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 |
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
to
, inclusive. |
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 | |
---|---|
impressions |
Number of times an individual user can be served the ad within the specified duration. Acceptable values are
to
, inclusive. |
duration |
Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are
to
, inclusive. |
CreativeRotation
Creative Rotation.
JSON representation |
---|
{ "type": enum ( |
Fields | |
---|---|
type |
Type of creative rotation. Can be used to specify whether to use sequential or random rotation. |
weightCalculationStrategy |
Strategy for calculating weights. Used with
. |
creativeOptimizationConfigurationId |
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[] |
Creative assignments in this creative rotation. |
Type
Enums | |
---|---|
CREATIVE_ROTATION_TYPE_SEQUENTIAL |
|
CREATIVE_ROTATION_TYPE_RANDOM |
WeightCalculationStrategy
Enums | |
---|---|
WEIGHT_STRATEGY_EQUAL |
|
WEIGHT_STRATEGY_CUSTOM |
|
WEIGHT_STRATEGY_HIGHEST_CTR |
|
WEIGHT_STRATEGY_OPTIMIZED |
CreativeAssignment
Creative Assignment.
JSON representation |
---|
{ "creativeId": string, "active": boolean, "weight": integer, "startTime": string, "endTime": string, "sequence": integer, "clickThroughUrl": { object ( |
Fields | |
---|---|
creativeId |
ID of the creative to be assigned. This is a required field. |
active |
Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. |
weight |
Weight of the creative assignment, applicable when the rotation type is
. Value must be greater than or equal to
. |
startTime |
Date and time that the assigned creative should start serving. |
endTime |
Date and time that the assigned creative should stop serving. Must be later than the start time. |
sequence |
Sequence number of the creative assignment, applicable when the rotation type is
. Acceptable values are
to
, inclusive. |
clickThroughUrl |
Click-through URL of the creative assignment. |
creativeGroupAssignments[] |
Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. |
richMediaExitOverrides[] |
Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following:
|
companionCreativeOverrides[] |
Companion creative overrides for this creative assignment. Applicable to video ads. |
applyEventTags |
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
,
, and
. |
sslCompliant |
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 |
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 |
Whether the campaign default landing page is used. |
landingPageId |
ID of the landing page for the click-through URL. Applicable if the
field is set to false. |
customClickThroughUrl |
Custom click-through URL. Applicable if the
field is set to false and the
field is left unset. |
computedClickThroughUrl |
Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
|
CreativeGroupAssignment
Creative Group Assignment.
JSON representation |
---|
{
"creativeGroupId": string,
"creativeGroupNumber": enum ( |
Fields | |
---|---|
creativeGroupId |
ID of the creative group to be assigned. |
creativeGroupNumber |
Creative group number of the creative group assignment. |
CreativeGroupNumber
Enums | |
---|---|
CREATIVE_GROUP_ONE |
|
CREATIVE_GROUP_TWO |
RichMediaExitOverride
Rich Media Exit Override.
JSON representation |
---|
{
"exitId": string,
"enabled": boolean,
"clickThroughUrl": {
object ( |
Fields | |
---|---|
exitId |
ID for the override to refer to a specific exit in the creative. |
enabled |
Whether to use the
. If false, the creative-level exit will be used. |
clickThroughUrl |
Click-through URL of this rich media exit override. Applicable if the
field is set to true. |
CompanionClickThroughOverride
Companion Click-through override.
JSON representation |
---|
{
"creativeId": string,
"clickThroughUrl": {
object ( |
Fields | |
---|---|
creativeId |
ID of the creative for this companion click-through override. |
clickThroughUrl |
Click-through URL of this companion click-through override. |
Methods |
|
---|---|
|
Gets one ad by ID. |
|
Inserts a new ad. |
|
Retrieves a list of ads, possibly filtered. |
|
Updates an existing ad. |
|
Updates an existing ad. |