Gets one ad by ID.
Inserts a new ad.
Retrieves a list of ads, possibly filtered. This method supports paging.
list_next(previous_request, previous_response)
Retrieves the next page of results.
Updates an existing ad. This method supports patch semantics.
Updates an existing ad.
get(profileId, id)
Gets one ad by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Ad ID. (required)
Returns:
An object of the form:
{ # Contains properties of a Campaign Manager ad.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"languageTargeting": { # Language Targeting. # 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.
"languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a language that can be targeted by ads.
"languageCode": "A 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.
"kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
"id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
"name": "A String", # Name of this language.
},
],
},
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
"geoTargeting": { # Geographical Targeting. # 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.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
"kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"countryCode": "A String", # Country code.
"name": "A String", # Name of this country.
},
],
"excludeCountries": True or False, # 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.
"postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
{ # Contains information about a postal code that can be targeted by ads.
"countryDartId": "A String", # DART ID of the country to which this postal code belongs.
"kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
"code": "A String", # Postal code. This is equivalent to the id field.
"id": "A String", # ID of this postal code.
"countryCode": "A String", # Country code of the country to which this postal code belongs.
},
],
"regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
{ # Contains information about a region that can be targeted by ads.
"kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
"countryDartId": "A String", # DART ID of the country to which this region belongs.
"name": "A String", # Name of this region.
"countryCode": "A String", # Country code of the country to which this region belongs.
"regionCode": "A String", # Region code.
"dartId": "A String", # DART ID of this region.
},
],
"cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
{ # Contains information about a city that can be targeted by ads.
"kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
"countryDartId": "A String", # DART ID of the country to which this city belongs.
"name": "A String", # Name of this city.
"countryCode": "A String", # Country code of the country to which this city belongs.
"metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
"regionCode": "A String", # Region code of the region to which this city belongs.
"metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
"dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
"regionDartId": "A String", # DART ID of the region to which this city belongs.
},
],
"metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
{ # Contains information about a metro region that can be targeted by ads.
"kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
"countryDartId": "A String", # DART ID of the country to which this metro region belongs.
"name": "A String", # Name of this metro region.
"countryCode": "A String", # Country code of the country to which this metro region belongs.
"metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
"dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
"dartId": "A String", # DART ID of this metro region.
},
],
},
"creativeGroupAssignments": [ # 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.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"deliverySchedule": { # Delivery Schedule. # 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.
"priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
"hardCutoff": True or False, # 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.
"frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
"duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
"impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
},
"impressionRatio": "A String", # 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.
},
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Event tag overrides for this ad.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived. When true, active must be false.
"targetingTemplateId": "A String", # 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": { # Technology Targeting. # 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.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
"id": "A String", # ID of this platform type.
"name": "A String", # Name of this platform type.
},
],
"operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
{ # Contains information about a particular version of an operating system that can be targeted by ads.
"majorVersion": "A String", # Major version (leftmost number) of this operating system version.
"kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
"name": "A String", # Name of this operating system version.
"id": "A String", # ID of this operating system version.
"operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
"browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A 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.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
"name": "A String", # Name of this browser.
"browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
"dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
"minorVersion": "A 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.
},
],
"operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
{ # Contains information about an operating system that can be targeted by ads.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
],
"mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
{ # Contains information about a mobile carrier that can be targeted by ads.
"kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
"countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
"id": "A String", # ID of this mobile carrier.
"countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
"name": "A String", # Name of this mobile carrier.
},
],
"connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # 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.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
"name": "A String", # Name of this connection type.
},
],
},
"creativeRotation": { # Creative Rotation. # 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.
"creativeAssignments": [ # Creative assignments in this creative rotation.
{ # Creative Assignment.
"weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
"sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
"applyEventTags": True or False, # 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.
"richMediaExitOverrides": [ # 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
{ # Rich Media Exit Override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
"exitId": "A String", # ID for the override to refer to a specific exit in the creative.
},
],
"sslCompliant": True or False, # 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.
"creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
{ # Companion Click-through override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"creativeId": "A String", # ID of the creative for this companion click-through override.
},
],
"startTime": "A String", # Date and time that the assigned creative should start serving.
"clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
"creativeId": "A String", # ID of the creative to be assigned. This is a required field.
"endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
"creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
"creativeOptimizationConfigurationId": "A String", # 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.
"type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
},
"clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
"remarketingListExpression": { # Remarketing List Targeting Expression. # 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.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"type": "A String", # 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).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
"keyValueTargetingExpression": { # Key Value Targeting Expression. # 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.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A 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.
"active": True or False, # Whether this ad is active. When true, archived must be false.
"compatibility": "A String", # 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.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
"dayPartTargeting": { # Day Part Targeting. # 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.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
42,
],
"daysOfWeek": [ # Days of the week when the ad will serve.
#
# Acceptable values are:
# - "SUNDAY"
# - "MONDAY"
# - "TUESDAY"
# - "WEDNESDAY"
# - "THURSDAY"
# - "FRIDAY"
# - "SATURDAY"
"A String",
],
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
"placementAssignments": [ # Placement assignments for this ad.
{ # Placement Assignment.
"active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
"placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"placementId": "A String", # ID of the placement to be assigned. This is a required field.
"sslRequired": True or False, # 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.
},
],
"endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
"dynamicClickTracker": True or False, # 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.
}
insert(profileId, body)
Inserts a new ad.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a Campaign Manager ad.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"languageTargeting": { # Language Targeting. # 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.
"languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a language that can be targeted by ads.
"languageCode": "A 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.
"kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
"id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
"name": "A String", # Name of this language.
},
],
},
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
"geoTargeting": { # Geographical Targeting. # 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.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
"kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"countryCode": "A String", # Country code.
"name": "A String", # Name of this country.
},
],
"excludeCountries": True or False, # 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.
"postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
{ # Contains information about a postal code that can be targeted by ads.
"countryDartId": "A String", # DART ID of the country to which this postal code belongs.
"kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
"code": "A String", # Postal code. This is equivalent to the id field.
"id": "A String", # ID of this postal code.
"countryCode": "A String", # Country code of the country to which this postal code belongs.
},
],
"regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
{ # Contains information about a region that can be targeted by ads.
"kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
"countryDartId": "A String", # DART ID of the country to which this region belongs.
"name": "A String", # Name of this region.
"countryCode": "A String", # Country code of the country to which this region belongs.
"regionCode": "A String", # Region code.
"dartId": "A String", # DART ID of this region.
},
],
"cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
{ # Contains information about a city that can be targeted by ads.
"kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
"countryDartId": "A String", # DART ID of the country to which this city belongs.
"name": "A String", # Name of this city.
"countryCode": "A String", # Country code of the country to which this city belongs.
"metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
"regionCode": "A String", # Region code of the region to which this city belongs.
"metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
"dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
"regionDartId": "A String", # DART ID of the region to which this city belongs.
},
],
"metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
{ # Contains information about a metro region that can be targeted by ads.
"kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
"countryDartId": "A String", # DART ID of the country to which this metro region belongs.
"name": "A String", # Name of this metro region.
"countryCode": "A String", # Country code of the country to which this metro region belongs.
"metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
"dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
"dartId": "A String", # DART ID of this metro region.
},
],
},
"creativeGroupAssignments": [ # 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.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"deliverySchedule": { # Delivery Schedule. # 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.
"priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
"hardCutoff": True or False, # 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.
"frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
"duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
"impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
},
"impressionRatio": "A String", # 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.
},
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Event tag overrides for this ad.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived. When true, active must be false.
"targetingTemplateId": "A String", # 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": { # Technology Targeting. # 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.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
"id": "A String", # ID of this platform type.
"name": "A String", # Name of this platform type.
},
],
"operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
{ # Contains information about a particular version of an operating system that can be targeted by ads.
"majorVersion": "A String", # Major version (leftmost number) of this operating system version.
"kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
"name": "A String", # Name of this operating system version.
"id": "A String", # ID of this operating system version.
"operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
"browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A 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.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
"name": "A String", # Name of this browser.
"browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
"dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
"minorVersion": "A 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.
},
],
"operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
{ # Contains information about an operating system that can be targeted by ads.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
],
"mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
{ # Contains information about a mobile carrier that can be targeted by ads.
"kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
"countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
"id": "A String", # ID of this mobile carrier.
"countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
"name": "A String", # Name of this mobile carrier.
},
],
"connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # 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.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
"name": "A String", # Name of this connection type.
},
],
},
"creativeRotation": { # Creative Rotation. # 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.
"creativeAssignments": [ # Creative assignments in this creative rotation.
{ # Creative Assignment.
"weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
"sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
"applyEventTags": True or False, # 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.
"richMediaExitOverrides": [ # 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
{ # Rich Media Exit Override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
"exitId": "A String", # ID for the override to refer to a specific exit in the creative.
},
],
"sslCompliant": True or False, # 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.
"creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
{ # Companion Click-through override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"creativeId": "A String", # ID of the creative for this companion click-through override.
},
],
"startTime": "A String", # Date and time that the assigned creative should start serving.
"clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
"creativeId": "A String", # ID of the creative to be assigned. This is a required field.
"endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
"creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
"creativeOptimizationConfigurationId": "A String", # 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.
"type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
},
"clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
"remarketingListExpression": { # Remarketing List Targeting Expression. # 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.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"type": "A String", # 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).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
"keyValueTargetingExpression": { # Key Value Targeting Expression. # 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.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A 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.
"active": True or False, # Whether this ad is active. When true, archived must be false.
"compatibility": "A String", # 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.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
"dayPartTargeting": { # Day Part Targeting. # 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.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
42,
],
"daysOfWeek": [ # Days of the week when the ad will serve.
#
# Acceptable values are:
# - "SUNDAY"
# - "MONDAY"
# - "TUESDAY"
# - "WEDNESDAY"
# - "THURSDAY"
# - "FRIDAY"
# - "SATURDAY"
"A String",
],
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
"placementAssignments": [ # Placement assignments for this ad.
{ # Placement Assignment.
"active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
"placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"placementId": "A String", # ID of the placement to be assigned. This is a required field.
"sslRequired": True or False, # 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.
},
],
"endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
"dynamicClickTracker": True or False, # 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.
}
Returns:
An object of the form:
{ # Contains properties of a Campaign Manager ad.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"languageTargeting": { # Language Targeting. # 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.
"languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a language that can be targeted by ads.
"languageCode": "A 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.
"kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
"id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
"name": "A String", # Name of this language.
},
],
},
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
"geoTargeting": { # Geographical Targeting. # 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.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
"kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"countryCode": "A String", # Country code.
"name": "A String", # Name of this country.
},
],
"excludeCountries": True or False, # 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.
"postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
{ # Contains information about a postal code that can be targeted by ads.
"countryDartId": "A String", # DART ID of the country to which this postal code belongs.
"kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
"code": "A String", # Postal code. This is equivalent to the id field.
"id": "A String", # ID of this postal code.
"countryCode": "A String", # Country code of the country to which this postal code belongs.
},
],
"regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
{ # Contains information about a region that can be targeted by ads.
"kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
"countryDartId": "A String", # DART ID of the country to which this region belongs.
"name": "A String", # Name of this region.
"countryCode": "A String", # Country code of the country to which this region belongs.
"regionCode": "A String", # Region code.
"dartId": "A String", # DART ID of this region.
},
],
"cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
{ # Contains information about a city that can be targeted by ads.
"kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
"countryDartId": "A String", # DART ID of the country to which this city belongs.
"name": "A String", # Name of this city.
"countryCode": "A String", # Country code of the country to which this city belongs.
"metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
"regionCode": "A String", # Region code of the region to which this city belongs.
"metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
"dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
"regionDartId": "A String", # DART ID of the region to which this city belongs.
},
],
"metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
{ # Contains information about a metro region that can be targeted by ads.
"kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
"countryDartId": "A String", # DART ID of the country to which this metro region belongs.
"name": "A String", # Name of this metro region.
"countryCode": "A String", # Country code of the country to which this metro region belongs.
"metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
"dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
"dartId": "A String", # DART ID of this metro region.
},
],
},
"creativeGroupAssignments": [ # 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.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"deliverySchedule": { # Delivery Schedule. # 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.
"priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
"hardCutoff": True or False, # 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.
"frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
"duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
"impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
},
"impressionRatio": "A String", # 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.
},
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Event tag overrides for this ad.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived. When true, active must be false.
"targetingTemplateId": "A String", # 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": { # Technology Targeting. # 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.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
"id": "A String", # ID of this platform type.
"name": "A String", # Name of this platform type.
},
],
"operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
{ # Contains information about a particular version of an operating system that can be targeted by ads.
"majorVersion": "A String", # Major version (leftmost number) of this operating system version.
"kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
"name": "A String", # Name of this operating system version.
"id": "A String", # ID of this operating system version.
"operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
"browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A 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.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
"name": "A String", # Name of this browser.
"browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
"dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
"minorVersion": "A 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.
},
],
"operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
{ # Contains information about an operating system that can be targeted by ads.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
],
"mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
{ # Contains information about a mobile carrier that can be targeted by ads.
"kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
"countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
"id": "A String", # ID of this mobile carrier.
"countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
"name": "A String", # Name of this mobile carrier.
},
],
"connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # 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.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
"name": "A String", # Name of this connection type.
},
],
},
"creativeRotation": { # Creative Rotation. # 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.
"creativeAssignments": [ # Creative assignments in this creative rotation.
{ # Creative Assignment.
"weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
"sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
"applyEventTags": True or False, # 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.
"richMediaExitOverrides": [ # 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
{ # Rich Media Exit Override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
"exitId": "A String", # ID for the override to refer to a specific exit in the creative.
},
],
"sslCompliant": True or False, # 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.
"creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
{ # Companion Click-through override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"creativeId": "A String", # ID of the creative for this companion click-through override.
},
],
"startTime": "A String", # Date and time that the assigned creative should start serving.
"clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
"creativeId": "A String", # ID of the creative to be assigned. This is a required field.
"endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
"creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
"creativeOptimizationConfigurationId": "A String", # 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.
"type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
},
"clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
"remarketingListExpression": { # Remarketing List Targeting Expression. # 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.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"type": "A String", # 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).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
"keyValueTargetingExpression": { # Key Value Targeting Expression. # 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.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A 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.
"active": True or False, # Whether this ad is active. When true, archived must be false.
"compatibility": "A String", # 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.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
"dayPartTargeting": { # Day Part Targeting. # 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.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
42,
],
"daysOfWeek": [ # Days of the week when the ad will serve.
#
# Acceptable values are:
# - "SUNDAY"
# - "MONDAY"
# - "TUESDAY"
# - "WEDNESDAY"
# - "THURSDAY"
# - "FRIDAY"
# - "SATURDAY"
"A String",
],
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
"placementAssignments": [ # Placement assignments for this ad.
{ # Placement Assignment.
"active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
"placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"placementId": "A String", # ID of the placement to be assigned. This is a required field.
"sslRequired": True or False, # 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.
},
],
"endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
"dynamicClickTracker": True or False, # 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.
}
list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None)
Retrieves a list of ads, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
landingPageIds: string, Select only ads with these landing page IDs. (repeated)
overriddenEventTagId: string, Select only ads with this event tag override ID.
campaignIds: string, Select only ads with these campaign IDs. (repeated)
sizeIds: string, Select only ads with these size IDs. (repeated)
archived: boolean, Select only archived ads.
creativeOptimizationConfigurationIds: string, Select only ads with these creative optimization configuration IDs. (repeated)
sslCompliant: boolean, Select only ads that are SSL-compliant.
pageToken: string, Value of the nextPageToken from the previous result page.
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
type: string, Select only ads with these types. (repeated)
Allowed values
AD_SERVING_CLICK_TRACKER -
AD_SERVING_DEFAULT_AD -
AD_SERVING_STANDARD_AD -
AD_SERVING_TRACKING -
sslRequired: boolean, Select only ads that require SSL.
creativeIds: string, Select only ads with these creative IDs assigned. (repeated)
remarketingListIds: string, Select only ads whose list targeting expression use these remarketing list IDs. (repeated)
maxResults: integer, Maximum number of results to return.
placementIds: string, Select only ads with these placement IDs assigned. (repeated)
active: boolean, Select only active ads.
compatibility: string, 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.
Allowed values
APP -
APP_INTERSTITIAL -
DISPLAY -
DISPLAY_INTERSTITIAL -
IN_STREAM_AUDIO -
IN_STREAM_VIDEO -
advertiserId: string, Select only ads with this advertiser ID.
searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" 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".
audienceSegmentIds: string, Select only ads with these audience segment IDs. (repeated)
ids: string, Select only ads with these IDs. (repeated)
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
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.
Returns:
An object of the form:
{ # Ad List Response
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"kind": "dfareporting#adsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse".
"ads": [ # Ad collection.
{ # Contains properties of a Campaign Manager ad.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"languageTargeting": { # Language Targeting. # 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.
"languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a language that can be targeted by ads.
"languageCode": "A 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.
"kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
"id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
"name": "A String", # Name of this language.
},
],
},
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
"geoTargeting": { # Geographical Targeting. # 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.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
"kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"countryCode": "A String", # Country code.
"name": "A String", # Name of this country.
},
],
"excludeCountries": True or False, # 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.
"postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
{ # Contains information about a postal code that can be targeted by ads.
"countryDartId": "A String", # DART ID of the country to which this postal code belongs.
"kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
"code": "A String", # Postal code. This is equivalent to the id field.
"id": "A String", # ID of this postal code.
"countryCode": "A String", # Country code of the country to which this postal code belongs.
},
],
"regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
{ # Contains information about a region that can be targeted by ads.
"kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
"countryDartId": "A String", # DART ID of the country to which this region belongs.
"name": "A String", # Name of this region.
"countryCode": "A String", # Country code of the country to which this region belongs.
"regionCode": "A String", # Region code.
"dartId": "A String", # DART ID of this region.
},
],
"cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
{ # Contains information about a city that can be targeted by ads.
"kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
"countryDartId": "A String", # DART ID of the country to which this city belongs.
"name": "A String", # Name of this city.
"countryCode": "A String", # Country code of the country to which this city belongs.
"metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
"regionCode": "A String", # Region code of the region to which this city belongs.
"metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
"dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
"regionDartId": "A String", # DART ID of the region to which this city belongs.
},
],
"metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
{ # Contains information about a metro region that can be targeted by ads.
"kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
"countryDartId": "A String", # DART ID of the country to which this metro region belongs.
"name": "A String", # Name of this metro region.
"countryCode": "A String", # Country code of the country to which this metro region belongs.
"metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
"dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
"dartId": "A String", # DART ID of this metro region.
},
],
},
"creativeGroupAssignments": [ # 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.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"deliverySchedule": { # Delivery Schedule. # 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.
"priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
"hardCutoff": True or False, # 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.
"frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
"duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
"impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
},
"impressionRatio": "A String", # 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.
},
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Event tag overrides for this ad.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived. When true, active must be false.
"targetingTemplateId": "A String", # 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": { # Technology Targeting. # 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.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
"id": "A String", # ID of this platform type.
"name": "A String", # Name of this platform type.
},
],
"operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
{ # Contains information about a particular version of an operating system that can be targeted by ads.
"majorVersion": "A String", # Major version (leftmost number) of this operating system version.
"kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
"name": "A String", # Name of this operating system version.
"id": "A String", # ID of this operating system version.
"operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
"browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A 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.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
"name": "A String", # Name of this browser.
"browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
"dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
"minorVersion": "A 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.
},
],
"operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
{ # Contains information about an operating system that can be targeted by ads.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
],
"mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
{ # Contains information about a mobile carrier that can be targeted by ads.
"kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
"countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
"id": "A String", # ID of this mobile carrier.
"countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
"name": "A String", # Name of this mobile carrier.
},
],
"connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # 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.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
"name": "A String", # Name of this connection type.
},
],
},
"creativeRotation": { # Creative Rotation. # 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.
"creativeAssignments": [ # Creative assignments in this creative rotation.
{ # Creative Assignment.
"weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
"sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
"applyEventTags": True or False, # 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.
"richMediaExitOverrides": [ # 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
{ # Rich Media Exit Override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
"exitId": "A String", # ID for the override to refer to a specific exit in the creative.
},
],
"sslCompliant": True or False, # 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.
"creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
{ # Companion Click-through override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"creativeId": "A String", # ID of the creative for this companion click-through override.
},
],
"startTime": "A String", # Date and time that the assigned creative should start serving.
"clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
"creativeId": "A String", # ID of the creative to be assigned. This is a required field.
"endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
"creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
"creativeOptimizationConfigurationId": "A String", # 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.
"type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
},
"clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
"remarketingListExpression": { # Remarketing List Targeting Expression. # 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.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"type": "A String", # 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).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
"keyValueTargetingExpression": { # Key Value Targeting Expression. # 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.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A 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.
"active": True or False, # Whether this ad is active. When true, archived must be false.
"compatibility": "A String", # 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.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
"dayPartTargeting": { # Day Part Targeting. # 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.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
42,
],
"daysOfWeek": [ # Days of the week when the ad will serve.
#
# Acceptable values are:
# - "SUNDAY"
# - "MONDAY"
# - "TUESDAY"
# - "WEDNESDAY"
# - "THURSDAY"
# - "FRIDAY"
# - "SATURDAY"
"A String",
],
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
"placementAssignments": [ # Placement assignments for this ad.
{ # Placement Assignment.
"active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
"placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"placementId": "A String", # ID of the placement to be assigned. This is a required field.
"sslRequired": True or False, # 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.
},
],
"endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
"dynamicClickTracker": True or False, # 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.
},
],
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(profileId, id, body)
Updates an existing ad. This method supports patch semantics.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Ad ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a Campaign Manager ad.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"languageTargeting": { # Language Targeting. # 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.
"languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a language that can be targeted by ads.
"languageCode": "A 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.
"kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
"id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
"name": "A String", # Name of this language.
},
],
},
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
"geoTargeting": { # Geographical Targeting. # 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.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
"kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"countryCode": "A String", # Country code.
"name": "A String", # Name of this country.
},
],
"excludeCountries": True or False, # 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.
"postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
{ # Contains information about a postal code that can be targeted by ads.
"countryDartId": "A String", # DART ID of the country to which this postal code belongs.
"kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
"code": "A String", # Postal code. This is equivalent to the id field.
"id": "A String", # ID of this postal code.
"countryCode": "A String", # Country code of the country to which this postal code belongs.
},
],
"regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
{ # Contains information about a region that can be targeted by ads.
"kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
"countryDartId": "A String", # DART ID of the country to which this region belongs.
"name": "A String", # Name of this region.
"countryCode": "A String", # Country code of the country to which this region belongs.
"regionCode": "A String", # Region code.
"dartId": "A String", # DART ID of this region.
},
],
"cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
{ # Contains information about a city that can be targeted by ads.
"kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
"countryDartId": "A String", # DART ID of the country to which this city belongs.
"name": "A String", # Name of this city.
"countryCode": "A String", # Country code of the country to which this city belongs.
"metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
"regionCode": "A String", # Region code of the region to which this city belongs.
"metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
"dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
"regionDartId": "A String", # DART ID of the region to which this city belongs.
},
],
"metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
{ # Contains information about a metro region that can be targeted by ads.
"kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
"countryDartId": "A String", # DART ID of the country to which this metro region belongs.
"name": "A String", # Name of this metro region.
"countryCode": "A String", # Country code of the country to which this metro region belongs.
"metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
"dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
"dartId": "A String", # DART ID of this metro region.
},
],
},
"creativeGroupAssignments": [ # 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.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"deliverySchedule": { # Delivery Schedule. # 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.
"priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
"hardCutoff": True or False, # 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.
"frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
"duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
"impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
},
"impressionRatio": "A String", # 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.
},
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Event tag overrides for this ad.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived. When true, active must be false.
"targetingTemplateId": "A String", # 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": { # Technology Targeting. # 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.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
"id": "A String", # ID of this platform type.
"name": "A String", # Name of this platform type.
},
],
"operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
{ # Contains information about a particular version of an operating system that can be targeted by ads.
"majorVersion": "A String", # Major version (leftmost number) of this operating system version.
"kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
"name": "A String", # Name of this operating system version.
"id": "A String", # ID of this operating system version.
"operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
"browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A 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.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
"name": "A String", # Name of this browser.
"browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
"dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
"minorVersion": "A 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.
},
],
"operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
{ # Contains information about an operating system that can be targeted by ads.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
],
"mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
{ # Contains information about a mobile carrier that can be targeted by ads.
"kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
"countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
"id": "A String", # ID of this mobile carrier.
"countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
"name": "A String", # Name of this mobile carrier.
},
],
"connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # 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.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
"name": "A String", # Name of this connection type.
},
],
},
"creativeRotation": { # Creative Rotation. # 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.
"creativeAssignments": [ # Creative assignments in this creative rotation.
{ # Creative Assignment.
"weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
"sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
"applyEventTags": True or False, # 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.
"richMediaExitOverrides": [ # 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
{ # Rich Media Exit Override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
"exitId": "A String", # ID for the override to refer to a specific exit in the creative.
},
],
"sslCompliant": True or False, # 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.
"creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
{ # Companion Click-through override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"creativeId": "A String", # ID of the creative for this companion click-through override.
},
],
"startTime": "A String", # Date and time that the assigned creative should start serving.
"clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
"creativeId": "A String", # ID of the creative to be assigned. This is a required field.
"endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
"creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
"creativeOptimizationConfigurationId": "A String", # 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.
"type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
},
"clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
"remarketingListExpression": { # Remarketing List Targeting Expression. # 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.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"type": "A String", # 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).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
"keyValueTargetingExpression": { # Key Value Targeting Expression. # 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.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A 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.
"active": True or False, # Whether this ad is active. When true, archived must be false.
"compatibility": "A String", # 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.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
"dayPartTargeting": { # Day Part Targeting. # 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.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
42,
],
"daysOfWeek": [ # Days of the week when the ad will serve.
#
# Acceptable values are:
# - "SUNDAY"
# - "MONDAY"
# - "TUESDAY"
# - "WEDNESDAY"
# - "THURSDAY"
# - "FRIDAY"
# - "SATURDAY"
"A String",
],
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
"placementAssignments": [ # Placement assignments for this ad.
{ # Placement Assignment.
"active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
"placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"placementId": "A String", # ID of the placement to be assigned. This is a required field.
"sslRequired": True or False, # 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.
},
],
"endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
"dynamicClickTracker": True or False, # 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.
}
Returns:
An object of the form:
{ # Contains properties of a Campaign Manager ad.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"languageTargeting": { # Language Targeting. # 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.
"languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a language that can be targeted by ads.
"languageCode": "A 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.
"kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
"id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
"name": "A String", # Name of this language.
},
],
},
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
"geoTargeting": { # Geographical Targeting. # 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.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
"kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"countryCode": "A String", # Country code.
"name": "A String", # Name of this country.
},
],
"excludeCountries": True or False, # 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.
"postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
{ # Contains information about a postal code that can be targeted by ads.
"countryDartId": "A String", # DART ID of the country to which this postal code belongs.
"kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
"code": "A String", # Postal code. This is equivalent to the id field.
"id": "A String", # ID of this postal code.
"countryCode": "A String", # Country code of the country to which this postal code belongs.
},
],
"regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
{ # Contains information about a region that can be targeted by ads.
"kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
"countryDartId": "A String", # DART ID of the country to which this region belongs.
"name": "A String", # Name of this region.
"countryCode": "A String", # Country code of the country to which this region belongs.
"regionCode": "A String", # Region code.
"dartId": "A String", # DART ID of this region.
},
],
"cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
{ # Contains information about a city that can be targeted by ads.
"kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
"countryDartId": "A String", # DART ID of the country to which this city belongs.
"name": "A String", # Name of this city.
"countryCode": "A String", # Country code of the country to which this city belongs.
"metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
"regionCode": "A String", # Region code of the region to which this city belongs.
"metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
"dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
"regionDartId": "A String", # DART ID of the region to which this city belongs.
},
],
"metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
{ # Contains information about a metro region that can be targeted by ads.
"kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
"countryDartId": "A String", # DART ID of the country to which this metro region belongs.
"name": "A String", # Name of this metro region.
"countryCode": "A String", # Country code of the country to which this metro region belongs.
"metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
"dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
"dartId": "A String", # DART ID of this metro region.
},
],
},
"creativeGroupAssignments": [ # 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.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"deliverySchedule": { # Delivery Schedule. # 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.
"priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
"hardCutoff": True or False, # 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.
"frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
"duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
"impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
},
"impressionRatio": "A String", # 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.
},
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Event tag overrides for this ad.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived. When true, active must be false.
"targetingTemplateId": "A String", # 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": { # Technology Targeting. # 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.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
"id": "A String", # ID of this platform type.
"name": "A String", # Name of this platform type.
},
],
"operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
{ # Contains information about a particular version of an operating system that can be targeted by ads.
"majorVersion": "A String", # Major version (leftmost number) of this operating system version.
"kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
"name": "A String", # Name of this operating system version.
"id": "A String", # ID of this operating system version.
"operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
"browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A 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.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
"name": "A String", # Name of this browser.
"browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
"dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
"minorVersion": "A 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.
},
],
"operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
{ # Contains information about an operating system that can be targeted by ads.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
],
"mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
{ # Contains information about a mobile carrier that can be targeted by ads.
"kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
"countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
"id": "A String", # ID of this mobile carrier.
"countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
"name": "A String", # Name of this mobile carrier.
},
],
"connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # 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.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
"name": "A String", # Name of this connection type.
},
],
},
"creativeRotation": { # Creative Rotation. # 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.
"creativeAssignments": [ # Creative assignments in this creative rotation.
{ # Creative Assignment.
"weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
"sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
"applyEventTags": True or False, # 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.
"richMediaExitOverrides": [ # 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
{ # Rich Media Exit Override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
"exitId": "A String", # ID for the override to refer to a specific exit in the creative.
},
],
"sslCompliant": True or False, # 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.
"creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
{ # Companion Click-through override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"creativeId": "A String", # ID of the creative for this companion click-through override.
},
],
"startTime": "A String", # Date and time that the assigned creative should start serving.
"clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
"creativeId": "A String", # ID of the creative to be assigned. This is a required field.
"endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
"creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
"creativeOptimizationConfigurationId": "A String", # 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.
"type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
},
"clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
"remarketingListExpression": { # Remarketing List Targeting Expression. # 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.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"type": "A String", # 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).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
"keyValueTargetingExpression": { # Key Value Targeting Expression. # 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.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A 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.
"active": True or False, # Whether this ad is active. When true, archived must be false.
"compatibility": "A String", # 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.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
"dayPartTargeting": { # Day Part Targeting. # 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.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
42,
],
"daysOfWeek": [ # Days of the week when the ad will serve.
#
# Acceptable values are:
# - "SUNDAY"
# - "MONDAY"
# - "TUESDAY"
# - "WEDNESDAY"
# - "THURSDAY"
# - "FRIDAY"
# - "SATURDAY"
"A String",
],
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
"placementAssignments": [ # Placement assignments for this ad.
{ # Placement Assignment.
"active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
"placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"placementId": "A String", # ID of the placement to be assigned. This is a required field.
"sslRequired": True or False, # 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.
},
],
"endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
"dynamicClickTracker": True or False, # 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.
}
update(profileId, body)
Updates an existing ad.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a Campaign Manager ad.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"languageTargeting": { # Language Targeting. # 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.
"languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a language that can be targeted by ads.
"languageCode": "A 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.
"kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
"id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
"name": "A String", # Name of this language.
},
],
},
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
"geoTargeting": { # Geographical Targeting. # 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.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
"kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"countryCode": "A String", # Country code.
"name": "A String", # Name of this country.
},
],
"excludeCountries": True or False, # 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.
"postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
{ # Contains information about a postal code that can be targeted by ads.
"countryDartId": "A String", # DART ID of the country to which this postal code belongs.
"kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
"code": "A String", # Postal code. This is equivalent to the id field.
"id": "A String", # ID of this postal code.
"countryCode": "A String", # Country code of the country to which this postal code belongs.
},
],
"regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
{ # Contains information about a region that can be targeted by ads.
"kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
"countryDartId": "A String", # DART ID of the country to which this region belongs.
"name": "A String", # Name of this region.
"countryCode": "A String", # Country code of the country to which this region belongs.
"regionCode": "A String", # Region code.
"dartId": "A String", # DART ID of this region.
},
],
"cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
{ # Contains information about a city that can be targeted by ads.
"kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
"countryDartId": "A String", # DART ID of the country to which this city belongs.
"name": "A String", # Name of this city.
"countryCode": "A String", # Country code of the country to which this city belongs.
"metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
"regionCode": "A String", # Region code of the region to which this city belongs.
"metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
"dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
"regionDartId": "A String", # DART ID of the region to which this city belongs.
},
],
"metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
{ # Contains information about a metro region that can be targeted by ads.
"kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
"countryDartId": "A String", # DART ID of the country to which this metro region belongs.
"name": "A String", # Name of this metro region.
"countryCode": "A String", # Country code of the country to which this metro region belongs.
"metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
"dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
"dartId": "A String", # DART ID of this metro region.
},
],
},
"creativeGroupAssignments": [ # 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.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"deliverySchedule": { # Delivery Schedule. # 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.
"priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
"hardCutoff": True or False, # 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.
"frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
"duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
"impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
},
"impressionRatio": "A String", # 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.
},
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Event tag overrides for this ad.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived. When true, active must be false.
"targetingTemplateId": "A String", # 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": { # Technology Targeting. # 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.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
"id": "A String", # ID of this platform type.
"name": "A String", # Name of this platform type.
},
],
"operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
{ # Contains information about a particular version of an operating system that can be targeted by ads.
"majorVersion": "A String", # Major version (leftmost number) of this operating system version.
"kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
"name": "A String", # Name of this operating system version.
"id": "A String", # ID of this operating system version.
"operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
"browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A 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.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
"name": "A String", # Name of this browser.
"browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
"dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
"minorVersion": "A 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.
},
],
"operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
{ # Contains information about an operating system that can be targeted by ads.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
],
"mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
{ # Contains information about a mobile carrier that can be targeted by ads.
"kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
"countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
"id": "A String", # ID of this mobile carrier.
"countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
"name": "A String", # Name of this mobile carrier.
},
],
"connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # 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.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
"name": "A String", # Name of this connection type.
},
],
},
"creativeRotation": { # Creative Rotation. # 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.
"creativeAssignments": [ # Creative assignments in this creative rotation.
{ # Creative Assignment.
"weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
"sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
"applyEventTags": True or False, # 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.
"richMediaExitOverrides": [ # 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
{ # Rich Media Exit Override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
"exitId": "A String", # ID for the override to refer to a specific exit in the creative.
},
],
"sslCompliant": True or False, # 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.
"creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
{ # Companion Click-through override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"creativeId": "A String", # ID of the creative for this companion click-through override.
},
],
"startTime": "A String", # Date and time that the assigned creative should start serving.
"clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
"creativeId": "A String", # ID of the creative to be assigned. This is a required field.
"endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
"creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
"creativeOptimizationConfigurationId": "A String", # 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.
"type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
},
"clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
"remarketingListExpression": { # Remarketing List Targeting Expression. # 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.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"type": "A String", # 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).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
"keyValueTargetingExpression": { # Key Value Targeting Expression. # 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.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A 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.
"active": True or False, # Whether this ad is active. When true, archived must be false.
"compatibility": "A String", # 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.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
"dayPartTargeting": { # Day Part Targeting. # 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.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
42,
],
"daysOfWeek": [ # Days of the week when the ad will serve.
#
# Acceptable values are:
# - "SUNDAY"
# - "MONDAY"
# - "TUESDAY"
# - "WEDNESDAY"
# - "THURSDAY"
# - "FRIDAY"
# - "SATURDAY"
"A String",
],
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
"placementAssignments": [ # Placement assignments for this ad.
{ # Placement Assignment.
"active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
"placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"placementId": "A String", # ID of the placement to be assigned. This is a required field.
"sslRequired": True or False, # 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.
},
],
"endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
"dynamicClickTracker": True or False, # 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.
}
Returns:
An object of the form:
{ # Contains properties of a Campaign Manager ad.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"languageTargeting": { # Language Targeting. # 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.
"languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a language that can be targeted by ads.
"languageCode": "A 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.
"kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
"id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
"name": "A String", # Name of this language.
},
],
},
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
"geoTargeting": { # Geographical Targeting. # 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.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
"kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"countryCode": "A String", # Country code.
"name": "A String", # Name of this country.
},
],
"excludeCountries": True or False, # 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.
"postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
{ # Contains information about a postal code that can be targeted by ads.
"countryDartId": "A String", # DART ID of the country to which this postal code belongs.
"kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
"code": "A String", # Postal code. This is equivalent to the id field.
"id": "A String", # ID of this postal code.
"countryCode": "A String", # Country code of the country to which this postal code belongs.
},
],
"regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
{ # Contains information about a region that can be targeted by ads.
"kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
"countryDartId": "A String", # DART ID of the country to which this region belongs.
"name": "A String", # Name of this region.
"countryCode": "A String", # Country code of the country to which this region belongs.
"regionCode": "A String", # Region code.
"dartId": "A String", # DART ID of this region.
},
],
"cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
{ # Contains information about a city that can be targeted by ads.
"kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
"countryDartId": "A String", # DART ID of the country to which this city belongs.
"name": "A String", # Name of this city.
"countryCode": "A String", # Country code of the country to which this city belongs.
"metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
"regionCode": "A String", # Region code of the region to which this city belongs.
"metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
"dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
"regionDartId": "A String", # DART ID of the region to which this city belongs.
},
],
"metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
{ # Contains information about a metro region that can be targeted by ads.
"kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
"countryDartId": "A String", # DART ID of the country to which this metro region belongs.
"name": "A String", # Name of this metro region.
"countryCode": "A String", # Country code of the country to which this metro region belongs.
"metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
"dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
"dartId": "A String", # DART ID of this metro region.
},
],
},
"creativeGroupAssignments": [ # 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.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"deliverySchedule": { # Delivery Schedule. # 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.
"priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
"hardCutoff": True or False, # 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.
"frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
"duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
"impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
},
"impressionRatio": "A String", # 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.
},
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Event tag overrides for this ad.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived. When true, active must be false.
"targetingTemplateId": "A String", # 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": { # Technology Targeting. # 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.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
"id": "A String", # ID of this platform type.
"name": "A String", # Name of this platform type.
},
],
"operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
{ # Contains information about a particular version of an operating system that can be targeted by ads.
"majorVersion": "A String", # Major version (leftmost number) of this operating system version.
"kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
"name": "A String", # Name of this operating system version.
"id": "A String", # ID of this operating system version.
"operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
"browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A 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.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
"name": "A String", # Name of this browser.
"browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
"dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
"minorVersion": "A 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.
},
],
"operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
{ # Contains information about an operating system that can be targeted by ads.
"mobile": True or False, # Whether this operating system is for mobile.
"dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
"kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
"name": "A String", # Name of this operating system.
"desktop": True or False, # Whether this operating system is for desktop.
},
],
"mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
{ # Contains information about a mobile carrier that can be targeted by ads.
"kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
"countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
"id": "A String", # ID of this mobile carrier.
"countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
"name": "A String", # Name of this mobile carrier.
},
],
"connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # 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.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
"name": "A String", # Name of this connection type.
},
],
},
"creativeRotation": { # Creative Rotation. # 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.
"creativeAssignments": [ # Creative assignments in this creative rotation.
{ # Creative Assignment.
"weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
"sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
"applyEventTags": True or False, # 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.
"richMediaExitOverrides": [ # 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
{ # Rich Media Exit Override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
"exitId": "A String", # ID for the override to refer to a specific exit in the creative.
},
],
"sslCompliant": True or False, # 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.
"creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
{ # Creative Group Assignment.
"creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
"creativeGroupId": "A String", # ID of the creative group to be assigned.
},
],
"companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
{ # Companion Click-through override.
"clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"creativeId": "A String", # ID of the creative for this companion click-through override.
},
],
"startTime": "A String", # Date and time that the assigned creative should start serving.
"clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
"creativeId": "A String", # ID of the creative to be assigned. This is a required field.
"endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
"creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
"creativeOptimizationConfigurationId": "A String", # 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.
"type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
},
"clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
"computedClickThroughUrl": "A 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
"remarketingListExpression": { # Remarketing List Targeting Expression. # 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.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"type": "A String", # 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).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
"keyValueTargetingExpression": { # Key Value Targeting Expression. # 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.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A 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.
"active": True or False, # Whether this ad is active. When true, archived must be false.
"compatibility": "A String", # 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.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
"dayPartTargeting": { # Day Part Targeting. # 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.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
42,
],
"daysOfWeek": [ # Days of the week when the ad will serve.
#
# Acceptable values are:
# - "SUNDAY"
# - "MONDAY"
# - "TUESDAY"
# - "WEDNESDAY"
# - "THURSDAY"
# - "FRIDAY"
# - "SATURDAY"
"A String",
],
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
"placementAssignments": [ # Placement assignments for this ad.
{ # Placement Assignment.
"active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
"placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"placementId": "A String", # ID of the placement to be assigned. This is a required field.
"sslRequired": True or False, # 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.
},
],
"endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
"dynamicClickTracker": True or False, # 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.
}