Regen all docs. (#700)
* Stop recursing if discovery == {}
* Generate docs with 'make docs'.
diff --git a/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html b/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html
index 679f8a7..667d53a 100644
--- a/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html
+++ b/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html
@@ -92,7 +92,7 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#stopWatching">stopWatching(accountId, creativeId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#stopWatching">stopWatching(accountId, creativeId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Stops watching a creative. Will stop push notifications being sent to the</p>
<p class="toc_element">
<code><a href="#update">update(accountId, creativeId, body, x__xgafv=None)</a></code></p>
@@ -117,38 +117,9 @@
"impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
"A String",
],
- "version": 42, # @OutputOnly The version of this creative.
- "filteringStats": { # @OutputOnly Filtering reasons for this creative during a period of a single # @OutputOnly The filtering stats for this creative.
- # day (from midnight to midnight Pacific).
- "reasons": [ # The set of filtering reasons for this date.
- { # A specific filtering status and how many times it occurred.
- "count": "A String", # The number of times the creative was filtered for the status. The
- # count is aggregated across all publishers on the exchange.
- "status": 42, # The filtering status code. Please refer to the
- # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)
- # file for different statuses.
- },
- ],
- "date": { # Represents a whole calendar date, e.g. date of birth. The time of day and # The day during which the data was collected.
- # The data is collected from 00:00:00 to 23:59:59 PT.
- # During switches from PST to PDT and back, the day may
- # contain 23 or 25 hours of data instead of the usual 24.
- # time zone are either specified elsewhere or are not significant. The date
- # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
- # represent a year and month where the day is not significant, e.g. credit card
- # expiration date. The year may be 0 to represent a month and day independent
- # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
- # and `google.protobuf.Timestamp`.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- },
- "detectedLanguages": [ # @OutputOnly
- # The detected languages for this creative. The order is arbitrary. The codes
- # are 2 or 5 characters and are documented at
+ "version": 42, # Output only. The version of this creative.
+ "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",
],
@@ -156,15 +127,12 @@
"clickThroughUrls": [ # The set of destination URLs for the creative.
"A String",
],
- "openAuctionStatus": "A String", # @OutputOnly 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.
- "detectedSensitiveCategories": [ # @OutputOnly Detected sensitive categories, if any.
+ "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.
+ },
+ "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.
@@ -174,26 +142,10 @@
# Can be used to filter the response of the
# creatives.list
# method.
- "detectedAdvertiserIds": [ # @OutputOnly Detected advertiser IDs, if any.
+ "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
"A String",
],
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "accountId": "A String", # The account that this creative belongs to.
- # Can be used to filter the response of the
- # creatives.list
- # method.
- "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,
- ],
- "agencyId": "A String", # The agency ID for this creative.
- "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", # @OutputOnly The last update timestamp of the creative via API.
"native": { # Native content for a creative. # A native creative.
"body": "A String", # A long description of the ad.
"videoUrl": "A String", # The URL to fetch a native video ad.
@@ -224,13 +176,52 @@
"storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
},
- "detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
+ "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,
+ ],
+ "agencyId": "A String", # The agency ID for this creative.
+ "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.
+ "accountId": "A String", # The account that this creative belongs to.
+ # Can be used to filter the response of the
+ # creatives.list
+ # method.
+ "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,
],
- "detectedDomains": [ # @OutputOnly
- # The detected domains for this creative.
+ "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
+ "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.
+ "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",
+ ],
+ },
+ "detectedDomains": [ # Output only. The detected domains for this creative.
"A String",
],
"attributes": [ # All attributes for the ads that may be shown from this creative.
@@ -239,7 +230,7 @@
# method.
"A String",
],
- "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
+ "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,
@@ -247,33 +238,33 @@
# Can be used to filter the response of the
# creatives.list
# method.
- "servingRestrictions": [ # @OutputOnly The granular status of this ad in specific contexts.
+ "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).
- { # @OutputOnly A representation of the status of an ad in a
+ { # 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": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "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": { # @OutputOnly A security context. # Matches impressions for a particular security type.
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
"securities": [ # The security types in this context.
"A String",
],
},
- "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "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",
],
},
- "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
+ "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
@@ -282,7 +273,7 @@
42,
],
},
- "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "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",
],
@@ -296,39 +287,55 @@
# Can be used to filter the response of the
# creatives.list
# method.
- { # @OutputOnly The reason and details for a disapproval.
+ # 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",
],
},
],
+ "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",
+ ],
+ },
},
],
+ "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "A String",
+ ],
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
"A String",
],
- "corrections": [ # @OutputOnly Shows any corrections that were applied to this creative.
- { # @OutputOnly Shows any corrections that were applied to this creative.
+ "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": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "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": { # @OutputOnly A security context. # Matches impressions for a particular security type.
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
"securities": [ # The security types in this context.
"A String",
],
},
- "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "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",
],
},
- "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
+ "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
@@ -337,7 +344,7 @@
42,
],
},
- "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "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",
],
@@ -350,9 +357,14 @@
],
},
],
- "video": { # Video content for a creative. # A video creative.
- "videoUrl": "A String", # The URL to fetch a 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.
}
duplicateIdMode: string, Indicates if multiple creatives can share an ID or not. Default is
@@ -369,38 +381,9 @@
"impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
"A String",
],
- "version": 42, # @OutputOnly The version of this creative.
- "filteringStats": { # @OutputOnly Filtering reasons for this creative during a period of a single # @OutputOnly The filtering stats for this creative.
- # day (from midnight to midnight Pacific).
- "reasons": [ # The set of filtering reasons for this date.
- { # A specific filtering status and how many times it occurred.
- "count": "A String", # The number of times the creative was filtered for the status. The
- # count is aggregated across all publishers on the exchange.
- "status": 42, # The filtering status code. Please refer to the
- # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)
- # file for different statuses.
- },
- ],
- "date": { # Represents a whole calendar date, e.g. date of birth. The time of day and # The day during which the data was collected.
- # The data is collected from 00:00:00 to 23:59:59 PT.
- # During switches from PST to PDT and back, the day may
- # contain 23 or 25 hours of data instead of the usual 24.
- # time zone are either specified elsewhere or are not significant. The date
- # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
- # represent a year and month where the day is not significant, e.g. credit card
- # expiration date. The year may be 0 to represent a month and day independent
- # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
- # and `google.protobuf.Timestamp`.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- },
- "detectedLanguages": [ # @OutputOnly
- # The detected languages for this creative. The order is arbitrary. The codes
- # are 2 or 5 characters and are documented at
+ "version": 42, # Output only. The version of this creative.
+ "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",
],
@@ -408,15 +391,12 @@
"clickThroughUrls": [ # The set of destination URLs for the creative.
"A String",
],
- "openAuctionStatus": "A String", # @OutputOnly 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.
- "detectedSensitiveCategories": [ # @OutputOnly Detected sensitive categories, if any.
+ "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.
+ },
+ "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.
@@ -426,26 +406,10 @@
# Can be used to filter the response of the
# creatives.list
# method.
- "detectedAdvertiserIds": [ # @OutputOnly Detected advertiser IDs, if any.
+ "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
"A String",
],
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "accountId": "A String", # The account that this creative belongs to.
- # Can be used to filter the response of the
- # creatives.list
- # method.
- "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,
- ],
- "agencyId": "A String", # The agency ID for this creative.
- "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", # @OutputOnly The last update timestamp of the creative via API.
"native": { # Native content for a creative. # A native creative.
"body": "A String", # A long description of the ad.
"videoUrl": "A String", # The URL to fetch a native video ad.
@@ -476,13 +440,52 @@
"storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
},
- "detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
+ "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,
+ ],
+ "agencyId": "A String", # The agency ID for this creative.
+ "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.
+ "accountId": "A String", # The account that this creative belongs to.
+ # Can be used to filter the response of the
+ # creatives.list
+ # method.
+ "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,
],
- "detectedDomains": [ # @OutputOnly
- # The detected domains for this creative.
+ "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
+ "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.
+ "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",
+ ],
+ },
+ "detectedDomains": [ # Output only. The detected domains for this creative.
"A String",
],
"attributes": [ # All attributes for the ads that may be shown from this creative.
@@ -491,7 +494,7 @@
# method.
"A String",
],
- "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
+ "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,
@@ -499,33 +502,33 @@
# Can be used to filter the response of the
# creatives.list
# method.
- "servingRestrictions": [ # @OutputOnly The granular status of this ad in specific contexts.
+ "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).
- { # @OutputOnly A representation of the status of an ad in a
+ { # 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": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "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": { # @OutputOnly A security context. # Matches impressions for a particular security type.
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
"securities": [ # The security types in this context.
"A String",
],
},
- "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "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",
],
},
- "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
+ "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
@@ -534,7 +537,7 @@
42,
],
},
- "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "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",
],
@@ -548,39 +551,55 @@
# Can be used to filter the response of the
# creatives.list
# method.
- { # @OutputOnly The reason and details for a disapproval.
+ # 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",
],
},
],
+ "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",
+ ],
+ },
},
],
+ "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "A String",
+ ],
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
"A String",
],
- "corrections": [ # @OutputOnly Shows any corrections that were applied to this creative.
- { # @OutputOnly Shows any corrections that were applied to this creative.
+ "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": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "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": { # @OutputOnly A security context. # Matches impressions for a particular security type.
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
"securities": [ # The security types in this context.
"A String",
],
},
- "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "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",
],
},
- "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
+ "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
@@ -589,7 +608,7 @@
42,
],
},
- "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "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",
],
@@ -602,9 +621,14 @@
],
},
],
- "video": { # Video content for a creative. # A video creative.
- "videoUrl": "A String", # The URL to fetch a 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.
}</pre>
</div>
@@ -627,38 +651,9 @@
"impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
"A String",
],
- "version": 42, # @OutputOnly The version of this creative.
- "filteringStats": { # @OutputOnly Filtering reasons for this creative during a period of a single # @OutputOnly The filtering stats for this creative.
- # day (from midnight to midnight Pacific).
- "reasons": [ # The set of filtering reasons for this date.
- { # A specific filtering status and how many times it occurred.
- "count": "A String", # The number of times the creative was filtered for the status. The
- # count is aggregated across all publishers on the exchange.
- "status": 42, # The filtering status code. Please refer to the
- # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)
- # file for different statuses.
- },
- ],
- "date": { # Represents a whole calendar date, e.g. date of birth. The time of day and # The day during which the data was collected.
- # The data is collected from 00:00:00 to 23:59:59 PT.
- # During switches from PST to PDT and back, the day may
- # contain 23 or 25 hours of data instead of the usual 24.
- # time zone are either specified elsewhere or are not significant. The date
- # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
- # represent a year and month where the day is not significant, e.g. credit card
- # expiration date. The year may be 0 to represent a month and day independent
- # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
- # and `google.protobuf.Timestamp`.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- },
- "detectedLanguages": [ # @OutputOnly
- # The detected languages for this creative. The order is arbitrary. The codes
- # are 2 or 5 characters and are documented at
+ "version": 42, # Output only. The version of this creative.
+ "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",
],
@@ -666,15 +661,12 @@
"clickThroughUrls": [ # The set of destination URLs for the creative.
"A String",
],
- "openAuctionStatus": "A String", # @OutputOnly 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.
- "detectedSensitiveCategories": [ # @OutputOnly Detected sensitive categories, if any.
+ "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.
+ },
+ "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.
@@ -684,26 +676,10 @@
# Can be used to filter the response of the
# creatives.list
# method.
- "detectedAdvertiserIds": [ # @OutputOnly Detected advertiser IDs, if any.
+ "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
"A String",
],
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "accountId": "A String", # The account that this creative belongs to.
- # Can be used to filter the response of the
- # creatives.list
- # method.
- "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,
- ],
- "agencyId": "A String", # The agency ID for this creative.
- "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", # @OutputOnly The last update timestamp of the creative via API.
"native": { # Native content for a creative. # A native creative.
"body": "A String", # A long description of the ad.
"videoUrl": "A String", # The URL to fetch a native video ad.
@@ -734,13 +710,52 @@
"storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
},
- "detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
+ "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,
+ ],
+ "agencyId": "A String", # The agency ID for this creative.
+ "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.
+ "accountId": "A String", # The account that this creative belongs to.
+ # Can be used to filter the response of the
+ # creatives.list
+ # method.
+ "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,
],
- "detectedDomains": [ # @OutputOnly
- # The detected domains for this creative.
+ "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
+ "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.
+ "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",
+ ],
+ },
+ "detectedDomains": [ # Output only. The detected domains for this creative.
"A String",
],
"attributes": [ # All attributes for the ads that may be shown from this creative.
@@ -749,7 +764,7 @@
# method.
"A String",
],
- "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
+ "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,
@@ -757,33 +772,33 @@
# Can be used to filter the response of the
# creatives.list
# method.
- "servingRestrictions": [ # @OutputOnly The granular status of this ad in specific contexts.
+ "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).
- { # @OutputOnly A representation of the status of an ad in a
+ { # 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": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "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": { # @OutputOnly A security context. # Matches impressions for a particular security type.
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
"securities": [ # The security types in this context.
"A String",
],
},
- "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "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",
],
},
- "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
+ "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
@@ -792,7 +807,7 @@
42,
],
},
- "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "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",
],
@@ -806,39 +821,55 @@
# Can be used to filter the response of the
# creatives.list
# method.
- { # @OutputOnly The reason and details for a disapproval.
+ # 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",
],
},
],
+ "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",
+ ],
+ },
},
],
+ "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "A String",
+ ],
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
"A String",
],
- "corrections": [ # @OutputOnly Shows any corrections that were applied to this creative.
- { # @OutputOnly Shows any corrections that were applied to this creative.
+ "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": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "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": { # @OutputOnly A security context. # Matches impressions for a particular security type.
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
"securities": [ # The security types in this context.
"A String",
],
},
- "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "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",
],
},
- "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
+ "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
@@ -847,7 +878,7 @@
42,
],
},
- "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "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",
],
@@ -860,9 +891,14 @@
],
},
],
- "video": { # Video content for a creative. # A video creative.
- "videoUrl": "A String", # The URL to fetch a 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.
}</pre>
</div>
@@ -883,7 +919,7 @@
returned from the previous call to 'ListCreatives' method.
query: string, An optional query string to filter creatives. If no filter is specified,
all active creatives will be returned.
-Supported queries are:
+<p>Supported queries are:
<ul>
<li>accountId=<i>account_id_string</i>
<li>creativeId=<i>creative_id_string</i>
@@ -892,9 +928,11 @@
<li>openAuctionStatus: {approved, conditionally_approved, disapproved,
not_checked}
<li>attribute: {a numeric attribute from the list of attributes}
-<li>disapprovalReason: {a reason from DisapprovalReason
+<li>disapprovalReason: {a reason from
+DisapprovalReason}
</ul>
-Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'
+Example: 'accountId=12345 AND (dealsStatus:disapproved AND
+disapprovalReason:unacceptable_content) OR attribute:47'
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -914,38 +952,9 @@
"impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
"A String",
],
- "version": 42, # @OutputOnly The version of this creative.
- "filteringStats": { # @OutputOnly Filtering reasons for this creative during a period of a single # @OutputOnly The filtering stats for this creative.
- # day (from midnight to midnight Pacific).
- "reasons": [ # The set of filtering reasons for this date.
- { # A specific filtering status and how many times it occurred.
- "count": "A String", # The number of times the creative was filtered for the status. The
- # count is aggregated across all publishers on the exchange.
- "status": 42, # The filtering status code. Please refer to the
- # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)
- # file for different statuses.
- },
- ],
- "date": { # Represents a whole calendar date, e.g. date of birth. The time of day and # The day during which the data was collected.
- # The data is collected from 00:00:00 to 23:59:59 PT.
- # During switches from PST to PDT and back, the day may
- # contain 23 or 25 hours of data instead of the usual 24.
- # time zone are either specified elsewhere or are not significant. The date
- # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
- # represent a year and month where the day is not significant, e.g. credit card
- # expiration date. The year may be 0 to represent a month and day independent
- # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
- # and `google.protobuf.Timestamp`.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- },
- "detectedLanguages": [ # @OutputOnly
- # The detected languages for this creative. The order is arbitrary. The codes
- # are 2 or 5 characters and are documented at
+ "version": 42, # Output only. The version of this creative.
+ "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",
],
@@ -953,15 +962,12 @@
"clickThroughUrls": [ # The set of destination URLs for the creative.
"A String",
],
- "openAuctionStatus": "A String", # @OutputOnly 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.
- "detectedSensitiveCategories": [ # @OutputOnly Detected sensitive categories, if any.
+ "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.
+ },
+ "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.
@@ -971,26 +977,10 @@
# Can be used to filter the response of the
# creatives.list
# method.
- "detectedAdvertiserIds": [ # @OutputOnly Detected advertiser IDs, if any.
+ "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
"A String",
],
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "accountId": "A String", # The account that this creative belongs to.
- # Can be used to filter the response of the
- # creatives.list
- # method.
- "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,
- ],
- "agencyId": "A String", # The agency ID for this creative.
- "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", # @OutputOnly The last update timestamp of the creative via API.
"native": { # Native content for a creative. # A native creative.
"body": "A String", # A long description of the ad.
"videoUrl": "A String", # The URL to fetch a native video ad.
@@ -1021,13 +1011,52 @@
"storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
},
- "detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
+ "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,
+ ],
+ "agencyId": "A String", # The agency ID for this creative.
+ "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.
+ "accountId": "A String", # The account that this creative belongs to.
+ # Can be used to filter the response of the
+ # creatives.list
+ # method.
+ "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,
],
- "detectedDomains": [ # @OutputOnly
- # The detected domains for this creative.
+ "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
+ "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.
+ "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",
+ ],
+ },
+ "detectedDomains": [ # Output only. The detected domains for this creative.
"A String",
],
"attributes": [ # All attributes for the ads that may be shown from this creative.
@@ -1036,7 +1065,7 @@
# method.
"A String",
],
- "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
+ "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,
@@ -1044,33 +1073,33 @@
# Can be used to filter the response of the
# creatives.list
# method.
- "servingRestrictions": [ # @OutputOnly The granular status of this ad in specific contexts.
+ "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).
- { # @OutputOnly A representation of the status of an ad in a
+ { # 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": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "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": { # @OutputOnly A security context. # Matches impressions for a particular security type.
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
"securities": [ # The security types in this context.
"A String",
],
},
- "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "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",
],
},
- "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
+ "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
@@ -1079,7 +1108,7 @@
42,
],
},
- "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "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",
],
@@ -1093,39 +1122,55 @@
# Can be used to filter the response of the
# creatives.list
# method.
- { # @OutputOnly The reason and details for a disapproval.
+ # 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",
],
},
],
+ "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",
+ ],
+ },
},
],
+ "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "A String",
+ ],
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
"A String",
],
- "corrections": [ # @OutputOnly Shows any corrections that were applied to this creative.
- { # @OutputOnly Shows any corrections that were applied to this creative.
+ "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": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "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": { # @OutputOnly A security context. # Matches impressions for a particular security type.
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
"securities": [ # The security types in this context.
"A String",
],
},
- "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "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",
],
},
- "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
+ "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
@@ -1134,7 +1179,7 @@
42,
],
},
- "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "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",
],
@@ -1147,9 +1192,14 @@
],
},
],
- "video": { # Video content for a creative. # A video creative.
- "videoUrl": "A String", # The URL to fetch a 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.
},
],
}</pre>
@@ -1170,7 +1220,7 @@
</div>
<div class="method">
- <code class="details" id="stopWatching">stopWatching(accountId, creativeId, body, x__xgafv=None)</code>
+ <code class="details" id="stopWatching">stopWatching(accountId, creativeId, body=None, x__xgafv=None)</code>
<pre>Stops watching a creative. Will stop push notifications being sent to the
topics when the creative changes status.
@@ -1178,7 +1228,7 @@
accountId: string, The account of the creative to stop notifications for. (required)
creativeId: string, The creative ID of the creative to stop notifications for.
Specify "-" to specify stopping account level notifications. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A request for stopping notifications for changes to creative Status.
@@ -1224,38 +1274,9 @@
"impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
"A String",
],
- "version": 42, # @OutputOnly The version of this creative.
- "filteringStats": { # @OutputOnly Filtering reasons for this creative during a period of a single # @OutputOnly The filtering stats for this creative.
- # day (from midnight to midnight Pacific).
- "reasons": [ # The set of filtering reasons for this date.
- { # A specific filtering status and how many times it occurred.
- "count": "A String", # The number of times the creative was filtered for the status. The
- # count is aggregated across all publishers on the exchange.
- "status": 42, # The filtering status code. Please refer to the
- # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)
- # file for different statuses.
- },
- ],
- "date": { # Represents a whole calendar date, e.g. date of birth. The time of day and # The day during which the data was collected.
- # The data is collected from 00:00:00 to 23:59:59 PT.
- # During switches from PST to PDT and back, the day may
- # contain 23 or 25 hours of data instead of the usual 24.
- # time zone are either specified elsewhere or are not significant. The date
- # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
- # represent a year and month where the day is not significant, e.g. credit card
- # expiration date. The year may be 0 to represent a month and day independent
- # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
- # and `google.protobuf.Timestamp`.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- },
- "detectedLanguages": [ # @OutputOnly
- # The detected languages for this creative. The order is arbitrary. The codes
- # are 2 or 5 characters and are documented at
+ "version": 42, # Output only. The version of this creative.
+ "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",
],
@@ -1263,15 +1284,12 @@
"clickThroughUrls": [ # The set of destination URLs for the creative.
"A String",
],
- "openAuctionStatus": "A String", # @OutputOnly 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.
- "detectedSensitiveCategories": [ # @OutputOnly Detected sensitive categories, if any.
+ "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.
+ },
+ "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.
@@ -1281,26 +1299,10 @@
# Can be used to filter the response of the
# creatives.list
# method.
- "detectedAdvertiserIds": [ # @OutputOnly Detected advertiser IDs, if any.
+ "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
"A String",
],
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "accountId": "A String", # The account that this creative belongs to.
- # Can be used to filter the response of the
- # creatives.list
- # method.
- "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,
- ],
- "agencyId": "A String", # The agency ID for this creative.
- "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", # @OutputOnly The last update timestamp of the creative via API.
"native": { # Native content for a creative. # A native creative.
"body": "A String", # A long description of the ad.
"videoUrl": "A String", # The URL to fetch a native video ad.
@@ -1331,13 +1333,52 @@
"storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
},
- "detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
+ "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,
+ ],
+ "agencyId": "A String", # The agency ID for this creative.
+ "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.
+ "accountId": "A String", # The account that this creative belongs to.
+ # Can be used to filter the response of the
+ # creatives.list
+ # method.
+ "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,
],
- "detectedDomains": [ # @OutputOnly
- # The detected domains for this creative.
+ "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
+ "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.
+ "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",
+ ],
+ },
+ "detectedDomains": [ # Output only. The detected domains for this creative.
"A String",
],
"attributes": [ # All attributes for the ads that may be shown from this creative.
@@ -1346,7 +1387,7 @@
# method.
"A String",
],
- "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
+ "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,
@@ -1354,33 +1395,33 @@
# Can be used to filter the response of the
# creatives.list
# method.
- "servingRestrictions": [ # @OutputOnly The granular status of this ad in specific contexts.
+ "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).
- { # @OutputOnly A representation of the status of an ad in a
+ { # 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": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "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": { # @OutputOnly A security context. # Matches impressions for a particular security type.
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
"securities": [ # The security types in this context.
"A String",
],
},
- "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "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",
],
},
- "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
+ "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
@@ -1389,7 +1430,7 @@
42,
],
},
- "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "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",
],
@@ -1403,39 +1444,55 @@
# Can be used to filter the response of the
# creatives.list
# method.
- { # @OutputOnly The reason and details for a disapproval.
+ # 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",
],
},
],
+ "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",
+ ],
+ },
},
],
+ "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "A String",
+ ],
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
"A String",
],
- "corrections": [ # @OutputOnly Shows any corrections that were applied to this creative.
- { # @OutputOnly Shows any corrections that were applied to this creative.
+ "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": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "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": { # @OutputOnly A security context. # Matches impressions for a particular security type.
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
"securities": [ # The security types in this context.
"A String",
],
},
- "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "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",
],
},
- "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
+ "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
@@ -1444,7 +1501,7 @@
42,
],
},
- "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "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",
],
@@ -1457,9 +1514,14 @@
],
},
],
- "video": { # Video content for a creative. # A video creative.
- "videoUrl": "A String", # The URL to fetch a 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.
}
x__xgafv: string, V1 error format.
@@ -1474,38 +1536,9 @@
"impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
"A String",
],
- "version": 42, # @OutputOnly The version of this creative.
- "filteringStats": { # @OutputOnly Filtering reasons for this creative during a period of a single # @OutputOnly The filtering stats for this creative.
- # day (from midnight to midnight Pacific).
- "reasons": [ # The set of filtering reasons for this date.
- { # A specific filtering status and how many times it occurred.
- "count": "A String", # The number of times the creative was filtered for the status. The
- # count is aggregated across all publishers on the exchange.
- "status": 42, # The filtering status code. Please refer to the
- # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)
- # file for different statuses.
- },
- ],
- "date": { # Represents a whole calendar date, e.g. date of birth. The time of day and # The day during which the data was collected.
- # The data is collected from 00:00:00 to 23:59:59 PT.
- # During switches from PST to PDT and back, the day may
- # contain 23 or 25 hours of data instead of the usual 24.
- # time zone are either specified elsewhere or are not significant. The date
- # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
- # represent a year and month where the day is not significant, e.g. credit card
- # expiration date. The year may be 0 to represent a month and day independent
- # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
- # and `google.protobuf.Timestamp`.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- },
- "detectedLanguages": [ # @OutputOnly
- # The detected languages for this creative. The order is arbitrary. The codes
- # are 2 or 5 characters and are documented at
+ "version": 42, # Output only. The version of this creative.
+ "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",
],
@@ -1513,15 +1546,12 @@
"clickThroughUrls": [ # The set of destination URLs for the creative.
"A String",
],
- "openAuctionStatus": "A String", # @OutputOnly 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.
- "detectedSensitiveCategories": [ # @OutputOnly Detected sensitive categories, if any.
+ "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.
+ },
+ "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.
@@ -1531,26 +1561,10 @@
# Can be used to filter the response of the
# creatives.list
# method.
- "detectedAdvertiserIds": [ # @OutputOnly Detected advertiser IDs, if any.
+ "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any.
"A String",
],
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "accountId": "A String", # The account that this creative belongs to.
- # Can be used to filter the response of the
- # creatives.list
- # method.
- "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,
- ],
- "agencyId": "A String", # The agency ID for this creative.
- "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", # @OutputOnly The last update timestamp of the creative via API.
"native": { # Native content for a creative. # A native creative.
"body": "A String", # A long description of the ad.
"videoUrl": "A String", # The URL to fetch a native video ad.
@@ -1581,13 +1595,52 @@
"storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
},
- "detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
+ "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,
+ ],
+ "agencyId": "A String", # The agency ID for this creative.
+ "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.
+ "accountId": "A String", # The account that this creative belongs to.
+ # Can be used to filter the response of the
+ # creatives.list
+ # method.
+ "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,
],
- "detectedDomains": [ # @OutputOnly
- # The detected domains for this creative.
+ "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers.
+ "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.
+ "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",
+ ],
+ },
+ "detectedDomains": [ # Output only. The detected domains for this creative.
"A String",
],
"attributes": [ # All attributes for the ads that may be shown from this creative.
@@ -1596,7 +1649,7 @@
# method.
"A String",
],
- "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
+ "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,
@@ -1604,33 +1657,33 @@
# Can be used to filter the response of the
# creatives.list
# method.
- "servingRestrictions": [ # @OutputOnly The granular status of this ad in specific contexts.
+ "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).
- { # @OutputOnly A representation of the status of an ad in a
+ { # 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": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "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": { # @OutputOnly A security context. # Matches impressions for a particular security type.
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
"securities": [ # The security types in this context.
"A String",
],
},
- "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "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",
],
},
- "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
+ "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
@@ -1639,7 +1692,7 @@
42,
],
},
- "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "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",
],
@@ -1653,39 +1706,55 @@
# Can be used to filter the response of the
# creatives.list
# method.
- { # @OutputOnly The reason and details for a disapproval.
+ # 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",
],
},
],
+ "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",
+ ],
+ },
},
],
+ "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.
+ "A String",
+ ],
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
"A String",
],
- "corrections": [ # @OutputOnly Shows any corrections that were applied to this creative.
- { # @OutputOnly Shows any corrections that were applied to this creative.
+ "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": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
+ "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": { # @OutputOnly A security context. # Matches impressions for a particular security type.
+ "securityType": { # Output only. A security context. # Matches impressions for a particular security type.
"securities": [ # The security types in this context.
"A String",
],
},
- "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
+ "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",
],
},
- "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
+ "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
@@ -1694,7 +1763,7 @@
42,
],
},
- "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
+ "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",
],
@@ -1707,9 +1776,14 @@
],
},
],
- "video": { # Video content for a creative. # A video creative.
- "videoUrl": "A String", # The URL to fetch a 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.
}</pre>
</div>