chore: update docs/dyn (#1162)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/b5e48daa-1759-436b-9fe7-ffce1482b520/targets
- [ ] To automatically regenerate this PR, check this box.
diff --git a/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html b/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html
index 77d80a4..fe18e3e 100644
--- a/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html
+++ b/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html
@@ -119,177 +119,177 @@
The object takes the form of:
{ # A creative and its classification data.
- "agencyId": "A String", # The agency ID for this creative.
- "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
- "A String",
- ],
- "version": 42, # Output only. The version of this creative.
- "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
- 42,
- ],
- "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
- 42,
- ],
- "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
- { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
- "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
- "A String",
- ],
- },
- "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
- "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
- { # Output only. The reason and details for a disapproval.
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
- "A String",
- ],
- },
- ],
- "contexts": [ # The contexts for the restriction.
- { # The serving context for this restriction.
- "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
- "auctionTypes": [ # The auction types this restriction applies to.
- "A String",
- ],
- },
- "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
- "platforms": [ # The platforms this restriction applies to.
- "A String",
- ],
- },
- "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
- "appTypes": [ # The app types this restriction applies to.
- "A String",
- ],
- },
- "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
- "securities": [ # The security types in this context.
- "A String",
- ],
- },
- "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
- "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
- 42,
- ],
- },
- "all": "A String", # Matches all contexts.
- },
- ],
- },
- ],
- "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
- "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
- "A String",
- ],
- "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
- "A String",
- ],
- "impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
- "A String",
- ],
- "clickThroughUrls": [ # The set of destination URLs for the creative.
- "A String",
- ],
"accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "advertiserName": "A String", # The name of the company being advertised in the creative.
- "native": { # Native content for a creative. # A native creative.
- "clickTrackingUrl": "A String", # The URL to use for click tracking.
- "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
- "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
- "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
- "body": "A String", # A long description of the ad.
- "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "videoUrl": "A String", # The URL to fetch a native video ad.
- "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
- "priceDisplayText": "A String", # The price of the promoted app including currency info.
- "callToAction": "A String", # A label for the button that the user is supposed to click.
- "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "headline": "A String", # A short title for the ad.
- },
- "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
- "A String",
- ],
- "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
- "detectedDomains": [ # Output only. The detected domains for this creative.
- "A String",
- ],
- "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
- "html": { # HTML content for a creative. # An HTML creative.
- "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
- "width": 42, # The width of the HTML snippet in pixels.
- "height": 42, # The height of the HTML snippet in pixels.
- },
- "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.
- "corrections": [ # Output only. Shows any corrections that were applied to this creative.
- { # Output only. Shows any corrections that were applied to this creative.
- "details": [ # Additional details about what was corrected.
- "A String",
- ],
- "type": "A String", # The type of correction that was applied to the creative.
- "contexts": [ # The contexts for the correction.
- { # The serving context for this restriction.
- "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
- "auctionTypes": [ # The auction types this restriction applies to.
- "A String",
- ],
- },
- "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
- "platforms": [ # The platforms this restriction applies to.
- "A String",
- ],
- },
- "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
- "appTypes": [ # The app types this restriction applies to.
- "A String",
- ],
- },
- "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
- "securities": [ # The security types in this context.
- "A String",
- ],
- },
- "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
- "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
- 42,
- ],
- },
- "all": "A String", # Matches all contexts.
- },
- ],
- },
- ],
- "video": { # Video content for a creative. # A video creative.
- "videoUrl": "A String", # The URL to fetch a video ad.
- "videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
- },
- "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
- 42,
- ],
"adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
"detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction.
"A String",
],
"hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction.
},
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "agencyId": "A String", # The agency ID for this creative.
+ "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.
+ "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
+ "A String",
+ ],
+ "clickThroughUrls": [ # The set of destination URLs for the creative.
+ "A String",
+ ],
+ "corrections": [ # Output only. Shows any corrections that were applied to this creative.
+ { # Output only. Shows any corrections that were applied to this creative.
+ "contexts": [ # The contexts for the correction.
+ { # The serving context for this restriction.
+ "all": "A String", # Matches all contexts.
+ "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "appTypes": [ # The app types this restriction applies to.
+ "A String",
+ ],
+ },
+ "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "auctionTypes": [ # The auction types this restriction applies to.
+ "A String",
+ ],
+ },
+ "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
+ "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
+ 42,
+ ],
+ },
+ "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "platforms": [ # The platforms this restriction applies to.
+ "A String",
+ ],
+ },
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
+ "securities": [ # The security types in this context.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "details": [ # Additional details about what was corrected.
+ "A String",
+ ],
+ "type": "A String", # The type of correction that was applied to the creative.
+ },
+ ],
+ "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
+ "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
+ "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "A String",
+ ],
"detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
"A String",
],
+ "detectedDomains": [ # Output only. The detected domains for this creative.
+ "A String",
+ ],
+ "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
+ "A String",
+ ],
+ "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
+ 42,
+ ],
+ "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
+ 42,
+ ],
+ "html": { # HTML content for a creative. # An HTML creative.
+ "height": 42, # The height of the HTML snippet in pixels.
+ "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
+ "width": 42, # The width of the HTML snippet in pixels.
+ },
+ "impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
+ "A String",
+ ],
+ "native": { # Native content for a creative. # A native creative.
+ "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
+ "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "body": "A String", # A long description of the ad.
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ "headline": "A String", # A short title for the ad.
+ "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "priceDisplayText": "A String", # The price of the promoted app including currency info.
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "videoUrl": "A String", # The URL to fetch a native video ad.
+ },
+ "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
+ "A String",
+ ],
+ "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
+ { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
+ "contexts": [ # The contexts for the restriction.
+ { # The serving context for this restriction.
+ "all": "A String", # Matches all contexts.
+ "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "appTypes": [ # The app types this restriction applies to.
+ "A String",
+ ],
+ },
+ "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "auctionTypes": [ # The auction types this restriction applies to.
+ "A String",
+ ],
+ },
+ "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
+ "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
+ 42,
+ ],
+ },
+ "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "platforms": [ # The platforms this restriction applies to.
+ "A String",
+ ],
+ },
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
+ "securities": [ # The security types in this context.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ "reason": "A String", # The categorized reason for disapproval.
+ },
+ "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
+ { # Output only. The reason and details for a disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ "reason": "A String", # The categorized reason for disapproval.
+ },
+ ],
+ "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
+ },
+ ],
+ "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
+ 42,
+ ],
+ "version": 42, # Output only. The version of this creative.
+ "video": { # Video content for a creative. # A video creative.
+ "videoUrl": "A String", # The URL to fetch a video ad.
+ "videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
+ },
}
duplicateIdMode: string, Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative).
@@ -305,178 +305,178 @@
An object of the form:
{ # A creative and its classification data.
- "agencyId": "A String", # The agency ID for this creative.
- "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
+ "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
+ "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
+ "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction.
"A String",
],
- "version": 42, # Output only. The version of this creative.
- "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
- 42,
- ],
- "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
- 42,
- ],
- "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
- { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
- "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
- "A String",
- ],
- },
- "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
- "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
- { # Output only. The reason and details for a disapproval.
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
+ "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction.
+ },
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "agencyId": "A String", # The agency ID for this creative.
+ "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.
+ "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
+ "A String",
+ ],
+ "clickThroughUrls": [ # The set of destination URLs for the creative.
+ "A String",
+ ],
+ "corrections": [ # Output only. Shows any corrections that were applied to this creative.
+ { # Output only. Shows any corrections that were applied to this creative.
+ "contexts": [ # The contexts for the correction.
+ { # The serving context for this restriction.
+ "all": "A String", # Matches all contexts.
+ "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "appTypes": [ # The app types this restriction applies to.
"A String",
],
},
- ],
- "contexts": [ # The contexts for the restriction.
- { # The serving context for this restriction.
- "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
- "auctionTypes": [ # The auction types this restriction applies to.
- "A String",
- ],
- },
- "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
- "platforms": [ # The platforms this restriction applies to.
- "A String",
- ],
- },
- "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
- "appTypes": [ # The app types this restriction applies to.
- "A String",
- ],
- },
- "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
- "securities": [ # The security types in this context.
- "A String",
- ],
- },
- "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
- "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
- 42,
- ],
- },
- "all": "A String", # Matches all contexts.
+ "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "auctionTypes": [ # The auction types this restriction applies to.
+ "A String",
+ ],
},
- ],
- },
- ],
- "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
- "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
- "A String",
- ],
- "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
- "A String",
- ],
- "impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
- "A String",
- ],
- "clickThroughUrls": [ # The set of destination URLs for the creative.
- "A String",
- ],
- "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
- "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "advertiserName": "A String", # The name of the company being advertised in the creative.
- "native": { # Native content for a creative. # A native creative.
- "clickTrackingUrl": "A String", # The URL to use for click tracking.
- "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
- "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
- "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
- "body": "A String", # A long description of the ad.
- "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "videoUrl": "A String", # The URL to fetch a native video ad.
- "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
- "priceDisplayText": "A String", # The price of the promoted app including currency info.
- "callToAction": "A String", # A label for the button that the user is supposed to click.
- "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "headline": "A String", # A short title for the ad.
- },
- "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
- "A String",
- ],
- "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
- "detectedDomains": [ # Output only. The detected domains for this creative.
- "A String",
- ],
- "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
- "html": { # HTML content for a creative. # An HTML creative.
- "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
- "width": 42, # The width of the HTML snippet in pixels.
- "height": 42, # The height of the HTML snippet in pixels.
- },
- "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.
- "corrections": [ # Output only. Shows any corrections that were applied to this creative.
- { # Output only. Shows any corrections that were applied to this creative.
- "details": [ # Additional details about what was corrected.
- "A String",
- ],
- "type": "A String", # The type of correction that was applied to the creative.
- "contexts": [ # The contexts for the correction.
- { # The serving context for this restriction.
- "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
- "auctionTypes": [ # The auction types this restriction applies to.
- "A String",
- ],
- },
- "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
- "platforms": [ # The platforms this restriction applies to.
- "A String",
- ],
- },
- "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
- "appTypes": [ # The app types this restriction applies to.
- "A String",
- ],
- },
- "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
- "securities": [ # The security types in this context.
- "A String",
- ],
- },
- "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
- "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
- 42,
- ],
- },
- "all": "A String", # Matches all contexts.
+ "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
+ "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
+ 42,
+ ],
},
- ],
- },
- ],
- "video": { # Video content for a creative. # A video creative.
- "videoUrl": "A String", # The URL to fetch a video ad.
- "videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
- },
- "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
- 42,
- ],
- "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
- "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction.
+ "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "platforms": [ # The platforms this restriction applies to.
+ "A String",
+ ],
+ },
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
+ "securities": [ # The security types in this context.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "details": [ # Additional details about what was corrected.
"A String",
],
- "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction.
+ "type": "A String", # The type of correction that was applied to the creative.
},
- "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
- "A String",
- ],
- }</pre>
+ ],
+ "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
+ "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
+ "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "A String",
+ ],
+ "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
+ "A String",
+ ],
+ "detectedDomains": [ # Output only. The detected domains for this creative.
+ "A String",
+ ],
+ "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
+ "A String",
+ ],
+ "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
+ 42,
+ ],
+ "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
+ 42,
+ ],
+ "html": { # HTML content for a creative. # An HTML creative.
+ "height": 42, # The height of the HTML snippet in pixels.
+ "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
+ "width": 42, # The width of the HTML snippet in pixels.
+ },
+ "impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
+ "A String",
+ ],
+ "native": { # Native content for a creative. # A native creative.
+ "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
+ "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "body": "A String", # A long description of the ad.
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ "headline": "A String", # A short title for the ad.
+ "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "priceDisplayText": "A String", # The price of the promoted app including currency info.
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "videoUrl": "A String", # The URL to fetch a native video ad.
+ },
+ "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
+ "A String",
+ ],
+ "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
+ { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
+ "contexts": [ # The contexts for the restriction.
+ { # The serving context for this restriction.
+ "all": "A String", # Matches all contexts.
+ "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "appTypes": [ # The app types this restriction applies to.
+ "A String",
+ ],
+ },
+ "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "auctionTypes": [ # The auction types this restriction applies to.
+ "A String",
+ ],
+ },
+ "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
+ "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
+ 42,
+ ],
+ },
+ "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "platforms": [ # The platforms this restriction applies to.
+ "A String",
+ ],
+ },
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
+ "securities": [ # The security types in this context.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ "reason": "A String", # The categorized reason for disapproval.
+ },
+ "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
+ { # Output only. The reason and details for a disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ "reason": "A String", # The categorized reason for disapproval.
+ },
+ ],
+ "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
+ },
+ ],
+ "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
+ 42,
+ ],
+ "version": 42, # Output only. The version of this creative.
+ "video": { # Video content for a creative. # A video creative.
+ "videoUrl": "A String", # The URL to fetch a video ad.
+ "videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
+ },
+}</pre>
</div>
<div class="method">
@@ -495,178 +495,178 @@
An object of the form:
{ # A creative and its classification data.
- "agencyId": "A String", # The agency ID for this creative.
- "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
+ "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
+ "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
+ "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction.
"A String",
],
- "version": 42, # Output only. The version of this creative.
- "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
- 42,
- ],
- "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
- 42,
- ],
- "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
- { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
- "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
- "A String",
- ],
- },
- "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
- "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
- { # Output only. The reason and details for a disapproval.
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
+ "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction.
+ },
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "agencyId": "A String", # The agency ID for this creative.
+ "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.
+ "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
+ "A String",
+ ],
+ "clickThroughUrls": [ # The set of destination URLs for the creative.
+ "A String",
+ ],
+ "corrections": [ # Output only. Shows any corrections that were applied to this creative.
+ { # Output only. Shows any corrections that were applied to this creative.
+ "contexts": [ # The contexts for the correction.
+ { # The serving context for this restriction.
+ "all": "A String", # Matches all contexts.
+ "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "appTypes": [ # The app types this restriction applies to.
"A String",
],
},
- ],
- "contexts": [ # The contexts for the restriction.
- { # The serving context for this restriction.
- "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
- "auctionTypes": [ # The auction types this restriction applies to.
- "A String",
- ],
- },
- "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
- "platforms": [ # The platforms this restriction applies to.
- "A String",
- ],
- },
- "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
- "appTypes": [ # The app types this restriction applies to.
- "A String",
- ],
- },
- "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
- "securities": [ # The security types in this context.
- "A String",
- ],
- },
- "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
- "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
- 42,
- ],
- },
- "all": "A String", # Matches all contexts.
+ "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "auctionTypes": [ # The auction types this restriction applies to.
+ "A String",
+ ],
},
- ],
- },
- ],
- "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
- "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
- "A String",
- ],
- "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
- "A String",
- ],
- "impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
- "A String",
- ],
- "clickThroughUrls": [ # The set of destination URLs for the creative.
- "A String",
- ],
- "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
- "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "advertiserName": "A String", # The name of the company being advertised in the creative.
- "native": { # Native content for a creative. # A native creative.
- "clickTrackingUrl": "A String", # The URL to use for click tracking.
- "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
- "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
- "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
- "body": "A String", # A long description of the ad.
- "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "videoUrl": "A String", # The URL to fetch a native video ad.
- "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
- "priceDisplayText": "A String", # The price of the promoted app including currency info.
- "callToAction": "A String", # A label for the button that the user is supposed to click.
- "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "headline": "A String", # A short title for the ad.
- },
- "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
- "A String",
- ],
- "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
- "detectedDomains": [ # Output only. The detected domains for this creative.
- "A String",
- ],
- "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
- "html": { # HTML content for a creative. # An HTML creative.
- "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
- "width": 42, # The width of the HTML snippet in pixels.
- "height": 42, # The height of the HTML snippet in pixels.
- },
- "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.
- "corrections": [ # Output only. Shows any corrections that were applied to this creative.
- { # Output only. Shows any corrections that were applied to this creative.
- "details": [ # Additional details about what was corrected.
- "A String",
- ],
- "type": "A String", # The type of correction that was applied to the creative.
- "contexts": [ # The contexts for the correction.
- { # The serving context for this restriction.
- "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
- "auctionTypes": [ # The auction types this restriction applies to.
- "A String",
- ],
- },
- "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
- "platforms": [ # The platforms this restriction applies to.
- "A String",
- ],
- },
- "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
- "appTypes": [ # The app types this restriction applies to.
- "A String",
- ],
- },
- "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
- "securities": [ # The security types in this context.
- "A String",
- ],
- },
- "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
- "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
- 42,
- ],
- },
- "all": "A String", # Matches all contexts.
+ "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
+ "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
+ 42,
+ ],
},
- ],
- },
- ],
- "video": { # Video content for a creative. # A video creative.
- "videoUrl": "A String", # The URL to fetch a video ad.
- "videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
- },
- "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
- 42,
- ],
- "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
- "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction.
+ "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "platforms": [ # The platforms this restriction applies to.
+ "A String",
+ ],
+ },
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
+ "securities": [ # The security types in this context.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "details": [ # Additional details about what was corrected.
"A String",
],
- "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction.
+ "type": "A String", # The type of correction that was applied to the creative.
},
- "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
- "A String",
- ],
- }</pre>
+ ],
+ "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
+ "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
+ "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "A String",
+ ],
+ "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
+ "A String",
+ ],
+ "detectedDomains": [ # Output only. The detected domains for this creative.
+ "A String",
+ ],
+ "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
+ "A String",
+ ],
+ "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
+ 42,
+ ],
+ "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
+ 42,
+ ],
+ "html": { # HTML content for a creative. # An HTML creative.
+ "height": 42, # The height of the HTML snippet in pixels.
+ "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
+ "width": 42, # The width of the HTML snippet in pixels.
+ },
+ "impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
+ "A String",
+ ],
+ "native": { # Native content for a creative. # A native creative.
+ "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
+ "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "body": "A String", # A long description of the ad.
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ "headline": "A String", # A short title for the ad.
+ "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "priceDisplayText": "A String", # The price of the promoted app including currency info.
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "videoUrl": "A String", # The URL to fetch a native video ad.
+ },
+ "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
+ "A String",
+ ],
+ "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
+ { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
+ "contexts": [ # The contexts for the restriction.
+ { # The serving context for this restriction.
+ "all": "A String", # Matches all contexts.
+ "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "appTypes": [ # The app types this restriction applies to.
+ "A String",
+ ],
+ },
+ "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "auctionTypes": [ # The auction types this restriction applies to.
+ "A String",
+ ],
+ },
+ "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
+ "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
+ 42,
+ ],
+ },
+ "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "platforms": [ # The platforms this restriction applies to.
+ "A String",
+ ],
+ },
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
+ "securities": [ # The security types in this context.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ "reason": "A String", # The categorized reason for disapproval.
+ },
+ "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
+ { # Output only. The reason and details for a disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ "reason": "A String", # The categorized reason for disapproval.
+ },
+ ],
+ "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
+ },
+ ],
+ "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
+ 42,
+ ],
+ "version": 42, # Output only. The version of this creative.
+ "video": { # Video content for a creative. # A video creative.
+ "videoUrl": "A String", # The URL to fetch a video ad.
+ "videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
+ },
+}</pre>
</div>
<div class="method">
@@ -687,183 +687,183 @@
An object of the form:
{ # A response for listing creatives.
- "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.page_token field in the subsequent call to `ListCreatives` method to retrieve the next page of results.
- "creatives": [ # The list of creatives.
- { # A creative and its classification data.
- "agencyId": "A String", # The agency ID for this creative.
- "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "creatives": [ # The list of creatives.
+ { # A creative and its classification data.
+ "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
+ "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
+ "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
+ "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction.
"A String",
],
- "version": 42, # Output only. The version of this creative.
- "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
- 42,
- ],
- "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
- 42,
- ],
- "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
- { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
- "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
- "A String",
- ],
- },
- "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
- "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
- { # Output only. The reason and details for a disapproval.
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
+ "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction.
+ },
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "agencyId": "A String", # The agency ID for this creative.
+ "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.
+ "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
+ "A String",
+ ],
+ "clickThroughUrls": [ # The set of destination URLs for the creative.
+ "A String",
+ ],
+ "corrections": [ # Output only. Shows any corrections that were applied to this creative.
+ { # Output only. Shows any corrections that were applied to this creative.
+ "contexts": [ # The contexts for the correction.
+ { # The serving context for this restriction.
+ "all": "A String", # Matches all contexts.
+ "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "appTypes": [ # The app types this restriction applies to.
"A String",
],
},
- ],
- "contexts": [ # The contexts for the restriction.
- { # The serving context for this restriction.
- "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
- "auctionTypes": [ # The auction types this restriction applies to.
- "A String",
- ],
- },
- "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
- "platforms": [ # The platforms this restriction applies to.
- "A String",
- ],
- },
- "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
- "appTypes": [ # The app types this restriction applies to.
- "A String",
- ],
- },
- "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
- "securities": [ # The security types in this context.
- "A String",
- ],
- },
- "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
- "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
- 42,
- ],
- },
- "all": "A String", # Matches all contexts.
+ "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "auctionTypes": [ # The auction types this restriction applies to.
+ "A String",
+ ],
},
- ],
- },
- ],
- "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
- "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
- "A String",
- ],
- "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
- "A String",
- ],
- "impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
- "A String",
- ],
- "clickThroughUrls": [ # The set of destination URLs for the creative.
- "A String",
- ],
- "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
- "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "advertiserName": "A String", # The name of the company being advertised in the creative.
- "native": { # Native content for a creative. # A native creative.
- "clickTrackingUrl": "A String", # The URL to use for click tracking.
- "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
- "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
- "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
- "body": "A String", # A long description of the ad.
- "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "videoUrl": "A String", # The URL to fetch a native video ad.
- "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
- "priceDisplayText": "A String", # The price of the promoted app including currency info.
- "callToAction": "A String", # A label for the button that the user is supposed to click.
- "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "headline": "A String", # A short title for the ad.
- },
- "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
- "A String",
- ],
- "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
- "detectedDomains": [ # Output only. The detected domains for this creative.
- "A String",
- ],
- "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
- "html": { # HTML content for a creative. # An HTML creative.
- "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
- "width": 42, # The width of the HTML snippet in pixels.
- "height": 42, # The height of the HTML snippet in pixels.
- },
- "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.
- "corrections": [ # Output only. Shows any corrections that were applied to this creative.
- { # Output only. Shows any corrections that were applied to this creative.
- "details": [ # Additional details about what was corrected.
- "A String",
- ],
- "type": "A String", # The type of correction that was applied to the creative.
- "contexts": [ # The contexts for the correction.
- { # The serving context for this restriction.
- "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
- "auctionTypes": [ # The auction types this restriction applies to.
- "A String",
- ],
- },
- "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
- "platforms": [ # The platforms this restriction applies to.
- "A String",
- ],
- },
- "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
- "appTypes": [ # The app types this restriction applies to.
- "A String",
- ],
- },
- "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
- "securities": [ # The security types in this context.
- "A String",
- ],
- },
- "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
- "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
- 42,
- ],
- },
- "all": "A String", # Matches all contexts.
+ "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
+ "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
+ 42,
+ ],
},
- ],
- },
- ],
- "video": { # Video content for a creative. # A video creative.
- "videoUrl": "A String", # The URL to fetch a video ad.
- "videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
- },
- "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
- 42,
- ],
- "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
- "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction.
+ "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "platforms": [ # The platforms this restriction applies to.
+ "A String",
+ ],
+ },
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
+ "securities": [ # The security types in this context.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "details": [ # Additional details about what was corrected.
"A String",
],
- "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction.
+ "type": "A String", # The type of correction that was applied to the creative.
},
- "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
- "A String",
- ],
+ ],
+ "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
+ "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
+ "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "A String",
+ ],
+ "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
+ "A String",
+ ],
+ "detectedDomains": [ # Output only. The detected domains for this creative.
+ "A String",
+ ],
+ "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
+ "A String",
+ ],
+ "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
+ 42,
+ ],
+ "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
+ 42,
+ ],
+ "html": { # HTML content for a creative. # An HTML creative.
+ "height": 42, # The height of the HTML snippet in pixels.
+ "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
+ "width": 42, # The width of the HTML snippet in pixels.
},
- ],
- }</pre>
+ "impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
+ "A String",
+ ],
+ "native": { # Native content for a creative. # A native creative.
+ "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
+ "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "body": "A String", # A long description of the ad.
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ "headline": "A String", # A short title for the ad.
+ "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "priceDisplayText": "A String", # The price of the promoted app including currency info.
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "videoUrl": "A String", # The URL to fetch a native video ad.
+ },
+ "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
+ "A String",
+ ],
+ "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
+ { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
+ "contexts": [ # The contexts for the restriction.
+ { # The serving context for this restriction.
+ "all": "A String", # Matches all contexts.
+ "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "appTypes": [ # The app types this restriction applies to.
+ "A String",
+ ],
+ },
+ "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "auctionTypes": [ # The auction types this restriction applies to.
+ "A String",
+ ],
+ },
+ "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
+ "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
+ 42,
+ ],
+ },
+ "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "platforms": [ # The platforms this restriction applies to.
+ "A String",
+ ],
+ },
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
+ "securities": [ # The security types in this context.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ "reason": "A String", # The categorized reason for disapproval.
+ },
+ "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
+ { # Output only. The reason and details for a disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ "reason": "A String", # The categorized reason for disapproval.
+ },
+ ],
+ "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
+ },
+ ],
+ "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
+ 42,
+ ],
+ "version": 42, # Output only. The version of this creative.
+ "video": { # Video content for a creative. # A video creative.
+ "videoUrl": "A String", # The URL to fetch a video ad.
+ "videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
+ },
+ },
+ ],
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.page_token field in the subsequent call to `ListCreatives` method to retrieve the next page of results.
+}</pre>
</div>
<div class="method">
@@ -891,7 +891,7 @@
The object takes the form of:
{ # A request for stopping notifications for changes to creative Status.
- }
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -902,7 +902,7 @@
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
- }</pre>
+}</pre>
</div>
<div class="method">
@@ -916,177 +916,177 @@
The object takes the form of:
{ # A creative and its classification data.
- "agencyId": "A String", # The agency ID for this creative.
- "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
- "A String",
- ],
- "version": 42, # Output only. The version of this creative.
- "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
- 42,
- ],
- "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
- 42,
- ],
- "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
- { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
- "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
- "A String",
- ],
- },
- "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
- "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
- { # Output only. The reason and details for a disapproval.
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
- "A String",
- ],
- },
- ],
- "contexts": [ # The contexts for the restriction.
- { # The serving context for this restriction.
- "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
- "auctionTypes": [ # The auction types this restriction applies to.
- "A String",
- ],
- },
- "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
- "platforms": [ # The platforms this restriction applies to.
- "A String",
- ],
- },
- "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
- "appTypes": [ # The app types this restriction applies to.
- "A String",
- ],
- },
- "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
- "securities": [ # The security types in this context.
- "A String",
- ],
- },
- "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
- "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
- 42,
- ],
- },
- "all": "A String", # Matches all contexts.
- },
- ],
- },
- ],
- "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
- "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
- "A String",
- ],
- "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
- "A String",
- ],
- "impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
- "A String",
- ],
- "clickThroughUrls": [ # The set of destination URLs for the creative.
- "A String",
- ],
"accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "advertiserName": "A String", # The name of the company being advertised in the creative.
- "native": { # Native content for a creative. # A native creative.
- "clickTrackingUrl": "A String", # The URL to use for click tracking.
- "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
- "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
- "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
- "body": "A String", # A long description of the ad.
- "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "videoUrl": "A String", # The URL to fetch a native video ad.
- "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
- "priceDisplayText": "A String", # The price of the promoted app including currency info.
- "callToAction": "A String", # A label for the button that the user is supposed to click.
- "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "headline": "A String", # A short title for the ad.
- },
- "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
- "A String",
- ],
- "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
- "detectedDomains": [ # Output only. The detected domains for this creative.
- "A String",
- ],
- "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
- "html": { # HTML content for a creative. # An HTML creative.
- "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
- "width": 42, # The width of the HTML snippet in pixels.
- "height": 42, # The height of the HTML snippet in pixels.
- },
- "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.
- "corrections": [ # Output only. Shows any corrections that were applied to this creative.
- { # Output only. Shows any corrections that were applied to this creative.
- "details": [ # Additional details about what was corrected.
- "A String",
- ],
- "type": "A String", # The type of correction that was applied to the creative.
- "contexts": [ # The contexts for the correction.
- { # The serving context for this restriction.
- "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
- "auctionTypes": [ # The auction types this restriction applies to.
- "A String",
- ],
- },
- "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
- "platforms": [ # The platforms this restriction applies to.
- "A String",
- ],
- },
- "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
- "appTypes": [ # The app types this restriction applies to.
- "A String",
- ],
- },
- "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
- "securities": [ # The security types in this context.
- "A String",
- ],
- },
- "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
- "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
- 42,
- ],
- },
- "all": "A String", # Matches all contexts.
- },
- ],
- },
- ],
- "video": { # Video content for a creative. # A video creative.
- "videoUrl": "A String", # The URL to fetch a video ad.
- "videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
- },
- "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
- 42,
- ],
"adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
"detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction.
"A String",
],
"hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction.
},
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "agencyId": "A String", # The agency ID for this creative.
+ "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.
+ "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
+ "A String",
+ ],
+ "clickThroughUrls": [ # The set of destination URLs for the creative.
+ "A String",
+ ],
+ "corrections": [ # Output only. Shows any corrections that were applied to this creative.
+ { # Output only. Shows any corrections that were applied to this creative.
+ "contexts": [ # The contexts for the correction.
+ { # The serving context for this restriction.
+ "all": "A String", # Matches all contexts.
+ "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "appTypes": [ # The app types this restriction applies to.
+ "A String",
+ ],
+ },
+ "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "auctionTypes": [ # The auction types this restriction applies to.
+ "A String",
+ ],
+ },
+ "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
+ "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
+ 42,
+ ],
+ },
+ "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "platforms": [ # The platforms this restriction applies to.
+ "A String",
+ ],
+ },
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
+ "securities": [ # The security types in this context.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "details": [ # Additional details about what was corrected.
+ "A String",
+ ],
+ "type": "A String", # The type of correction that was applied to the creative.
+ },
+ ],
+ "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
+ "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
+ "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "A String",
+ ],
"detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
"A String",
],
+ "detectedDomains": [ # Output only. The detected domains for this creative.
+ "A String",
+ ],
+ "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
+ "A String",
+ ],
+ "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
+ 42,
+ ],
+ "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
+ 42,
+ ],
+ "html": { # HTML content for a creative. # An HTML creative.
+ "height": 42, # The height of the HTML snippet in pixels.
+ "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
+ "width": 42, # The width of the HTML snippet in pixels.
+ },
+ "impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
+ "A String",
+ ],
+ "native": { # Native content for a creative. # A native creative.
+ "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
+ "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "body": "A String", # A long description of the ad.
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ "headline": "A String", # A short title for the ad.
+ "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "priceDisplayText": "A String", # The price of the promoted app including currency info.
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "videoUrl": "A String", # The URL to fetch a native video ad.
+ },
+ "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
+ "A String",
+ ],
+ "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
+ { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
+ "contexts": [ # The contexts for the restriction.
+ { # The serving context for this restriction.
+ "all": "A String", # Matches all contexts.
+ "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "appTypes": [ # The app types this restriction applies to.
+ "A String",
+ ],
+ },
+ "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "auctionTypes": [ # The auction types this restriction applies to.
+ "A String",
+ ],
+ },
+ "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
+ "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
+ 42,
+ ],
+ },
+ "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "platforms": [ # The platforms this restriction applies to.
+ "A String",
+ ],
+ },
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
+ "securities": [ # The security types in this context.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ "reason": "A String", # The categorized reason for disapproval.
+ },
+ "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
+ { # Output only. The reason and details for a disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ "reason": "A String", # The categorized reason for disapproval.
+ },
+ ],
+ "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
+ },
+ ],
+ "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
+ 42,
+ ],
+ "version": 42, # Output only. The version of this creative.
+ "video": { # Video content for a creative. # A video creative.
+ "videoUrl": "A String", # The URL to fetch a video ad.
+ "videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
+ },
}
x__xgafv: string, V1 error format.
@@ -1098,178 +1098,178 @@
An object of the form:
{ # A creative and its classification data.
- "agencyId": "A String", # The agency ID for this creative.
- "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
+ "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
+ "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
+ "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction.
"A String",
],
- "version": 42, # Output only. The version of this creative.
- "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
- 42,
- ],
- "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
- 42,
- ],
- "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
- { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
- "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
- "A String",
- ],
- },
- "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
- "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
- { # Output only. The reason and details for a disapproval.
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
+ "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction.
+ },
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "agencyId": "A String", # The agency ID for this creative.
+ "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.
+ "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
+ "A String",
+ ],
+ "clickThroughUrls": [ # The set of destination URLs for the creative.
+ "A String",
+ ],
+ "corrections": [ # Output only. Shows any corrections that were applied to this creative.
+ { # Output only. Shows any corrections that were applied to this creative.
+ "contexts": [ # The contexts for the correction.
+ { # The serving context for this restriction.
+ "all": "A String", # Matches all contexts.
+ "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "appTypes": [ # The app types this restriction applies to.
"A String",
],
},
- ],
- "contexts": [ # The contexts for the restriction.
- { # The serving context for this restriction.
- "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
- "auctionTypes": [ # The auction types this restriction applies to.
- "A String",
- ],
- },
- "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
- "platforms": [ # The platforms this restriction applies to.
- "A String",
- ],
- },
- "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
- "appTypes": [ # The app types this restriction applies to.
- "A String",
- ],
- },
- "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
- "securities": [ # The security types in this context.
- "A String",
- ],
- },
- "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
- "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
- 42,
- ],
- },
- "all": "A String", # Matches all contexts.
+ "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "auctionTypes": [ # The auction types this restriction applies to.
+ "A String",
+ ],
},
- ],
- },
- ],
- "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
- "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
- "A String",
- ],
- "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
- "A String",
- ],
- "impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
- "A String",
- ],
- "clickThroughUrls": [ # The set of destination URLs for the creative.
- "A String",
- ],
- "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
- "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "advertiserName": "A String", # The name of the company being advertised in the creative.
- "native": { # Native content for a creative. # A native creative.
- "clickTrackingUrl": "A String", # The URL to use for click tracking.
- "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
- "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
- "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
- "body": "A String", # A long description of the ad.
- "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "videoUrl": "A String", # The URL to fetch a native video ad.
- "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
- "priceDisplayText": "A String", # The price of the promoted app including currency info.
- "callToAction": "A String", # A label for the button that the user is supposed to click.
- "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.
- "width": 42, # Image width in pixels.
- "url": "A String", # The URL of the image.
- "height": 42, # Image height in pixels.
- },
- "headline": "A String", # A short title for the ad.
- },
- "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
- "A String",
- ],
- "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
- "detectedDomains": [ # Output only. The detected domains for this creative.
- "A String",
- ],
- "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
- "html": { # HTML content for a creative. # An HTML creative.
- "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
- "width": 42, # The width of the HTML snippet in pixels.
- "height": 42, # The height of the HTML snippet in pixels.
- },
- "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.
- "corrections": [ # Output only. Shows any corrections that were applied to this creative.
- { # Output only. Shows any corrections that were applied to this creative.
- "details": [ # Additional details about what was corrected.
- "A String",
- ],
- "type": "A String", # The type of correction that was applied to the creative.
- "contexts": [ # The contexts for the correction.
- { # The serving context for this restriction.
- "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
- "auctionTypes": [ # The auction types this restriction applies to.
- "A String",
- ],
- },
- "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
- "platforms": [ # The platforms this restriction applies to.
- "A String",
- ],
- },
- "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
- "appTypes": [ # The app types this restriction applies to.
- "A String",
- ],
- },
- "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
- "securities": [ # The security types in this context.
- "A String",
- ],
- },
- "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
- "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
- 42,
- ],
- },
- "all": "A String", # Matches all contexts.
+ "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
+ "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
+ 42,
+ ],
},
- ],
- },
- ],
- "video": { # Video content for a creative. # A video creative.
- "videoUrl": "A String", # The URL to fetch a video ad.
- "videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
- },
- "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
- 42,
- ],
- "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
- "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction.
+ "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "platforms": [ # The platforms this restriction applies to.
+ "A String",
+ ],
+ },
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
+ "securities": [ # The security types in this context.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "details": [ # Additional details about what was corrected.
"A String",
],
- "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction.
+ "type": "A String", # The type of correction that was applied to the creative.
},
- "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
- "A String",
- ],
- }</pre>
+ ],
+ "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
+ "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
+ "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "A String",
+ ],
+ "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
+ "A String",
+ ],
+ "detectedDomains": [ # Output only. The detected domains for this creative.
+ "A String",
+ ],
+ "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
+ "A String",
+ ],
+ "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
+ 42,
+ ],
+ "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
+ 42,
+ ],
+ "html": { # HTML content for a creative. # An HTML creative.
+ "height": 42, # The height of the HTML snippet in pixels.
+ "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
+ "width": 42, # The width of the HTML snippet in pixels.
+ },
+ "impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
+ "A String",
+ ],
+ "native": { # Native content for a creative. # A native creative.
+ "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
+ "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "body": "A String", # A long description of the ad.
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ "headline": "A String", # A short title for the ad.
+ "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.
+ "height": 42, # Image height in pixels.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ },
+ "priceDisplayText": "A String", # The price of the promoted app including currency info.
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "videoUrl": "A String", # The URL to fetch a native video ad.
+ },
+ "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
+ "A String",
+ ],
+ "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
+ { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
+ "contexts": [ # The contexts for the restriction.
+ { # The serving context for this restriction.
+ "all": "A String", # Matches all contexts.
+ "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "appTypes": [ # The app types this restriction applies to.
+ "A String",
+ ],
+ },
+ "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "auctionTypes": [ # The auction types this restriction applies to.
+ "A String",
+ ],
+ },
+ "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location.
+ "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
+ 42,
+ ],
+ },
+ "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "platforms": [ # The platforms this restriction applies to.
+ "A String",
+ ],
+ },
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
+ "securities": [ # The security types in this context.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ "reason": "A String", # The categorized reason for disapproval.
+ },
+ "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
+ { # Output only. The reason and details for a disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ "reason": "A String", # The categorized reason for disapproval.
+ },
+ ],
+ "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
+ },
+ ],
+ "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
+ 42,
+ ],
+ "version": 42, # Output only. The version of this creative.
+ "video": { # Video content for a creative. # A video creative.
+ "videoUrl": "A String", # The URL to fetch a video ad.
+ "videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
+ },
+}</pre>
</div>
<div class="method">
@@ -1283,8 +1283,8 @@
The object takes the form of:
{ # A request for watching changes to creative Status.
- "topic": "A String", # The Pub/Sub topic to publish notifications to. This topic must already exist and must give permission to ad-exchange-buyside-reports@google.com to write to the topic. This should be the full resource name in "projects/{project_id}/topics/{topic_id}" format.
- }
+ "topic": "A String", # The Pub/Sub topic to publish notifications to. This topic must already exist and must give permission to ad-exchange-buyside-reports@google.com to write to the topic. This should be the full resource name in "projects/{project_id}/topics/{topic_id}" format.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -1295,7 +1295,7 @@
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
- }</pre>
+}</pre>
</div>
</body></html>
\ No newline at end of file