| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="realtimebidding_v1.html">Real-time Bidding API</a> . <a href="realtimebidding_v1.bidders.html">bidders</a> . <a href="realtimebidding_v1.bidders.creatives.html">creatives</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageToken=None, view=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists creatives.</p> |
| <p class="toc_element"> |
| <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="#watch">watch(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Watches all creatives pertaining to a bidder. It is sufficient to invoke</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageToken=None, view=None, pageSize=None, filter=None, x__xgafv=None)</code> |
| <pre>Lists creatives. |
| |
| Args: |
| parent: string, Required. Name of the parent buyer that owns the creatives. |
| |
| The pattern for this resource is either `buyers/{buyerAccountId}` or |
| `bidders/{bidderAccountId}`. |
| |
| For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the |
| following: |
| 1. The ID of the buyer that is accessing their own creatives. |
| 2. The ID of the child seat buyer under a bidder account. |
| So for listing creatives pertaining to the child seat buyer (`456`) |
| under bidder account (`123`), you would use the pattern: `buyers/456`. |
| 3. The ID of the bidder itself. |
| So for listing creatives pertaining to bidder (`123`), |
| you would use `buyers/123`. |
| |
| If you want to access all creatives pertaining to both the bidder and all |
| of its child seat accounts, you would use `bidders/{bidderAccountId}`, |
| e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`. (required) |
| pageToken: string, A token identifying a page of results the server should return. |
| Typically, this is the value of |
| ListCreativesResponse.nextPageToken |
| returned from the previous call to the 'ListCreatives' method. |
| view: string, Controls the amount of information included in the response. |
| By default only |
| creativeServingDecision |
| is included. To retrieve the entire creative |
| resource (including the declared |
| fields and the creative content) specify the view as "FULL". |
| pageSize: integer, Requested page size. The server may return fewer creatives than requested |
| (due to timeout constraint) even if more are available via another call. |
| If unspecified, server will pick an appropriate default. |
| Acceptable values are 1 to 1000, inclusive. |
| filter: string, Query string to filter creatives. If no filter is specified, |
| all active creatives will be returned. |
| |
| Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND |
| disapprovalReason:UNACCEPTABLE_CONTENT) OR |
| declaredAttributes:IS_COOKIE_TARGETED' |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| 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.pageToken |
| # field in the subsequent call to the `ListCreatives` method to retrieve the |
| # next page of results. |
| "creatives": [ # The list of creatives. |
| { # A creative and its classification data. |
| "creativeServingDecision": { # Top level status and detected attributes of a creative. # Output only. Top level status and detected attributes of a creative (for example domain, |
| # language, advertiser, product category, etc.) that affect whether (status) |
| # and where (context) a creative will be allowed to serve. |
| "detectedSensitiveCategories": [ # Detected sensitive categories, if any. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| # |
| # 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, |
| ], |
| "detectedClickThroughUrls": [ # The set of detected destination URLs for the creative. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "A String", |
| ], |
| "detectedVendorIds": [ # IDs of the ad technology vendors that were detected to be |
| # used by this creative. See |
| # https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for |
| # possible values. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| # |
| # If the `allowed_vendor_type` field of a [bid |
| # request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) |
| # does not contain one of the vendor type IDs that were declared or |
| # detected for a given creative, and a bid is submitted with that creative, |
| # the bid will be filtered before the auction. |
| 42, |
| ], |
| "dealsServingStatus": { # Serving status of the creative for a transaction type or a region. # Status of this creative when bidding on PG and PD deals (outside of |
| # Russia and China). |
| "topics": [ # Policy topics related to the serving decision for this transaction type |
| # (e.g., open auction, deals) or region (e.g., China, Russia). |
| # Topics may be present only if status is DISAPPROVED. |
| { # Each policy topic entry will represent a violation of a policy topic for a |
| # creative, with the policy topic information and optional evidence for the |
| # policy violation. |
| "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. |
| "evidences": [ # Pieces of evidence associated with this policy topic entry. |
| { # Evidence associated with a policy topic entry. |
| "downloadSize": { # Total download size and URL-level download size breakdown for resources in # Total download size and URL-level download size breakdown for resources |
| # in a creative. |
| # a creative. |
| "topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size. |
| { # The URL-level breakdown for the download size. |
| "normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed. |
| "downloadSizeKb": 42, # Download size of the URL in kilobytes. |
| }, |
| ], |
| "totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative. |
| }, |
| "httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations. |
| "maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, |
| # cookie_names above will be set to the cookie names of top domains with |
| # the largest number of cookies. |
| # This field will only be set for TOO_MANY_COOKIES policy. |
| "cookieNames": [ # Names of cookies that violate Google policies. |
| # For TOO_MANY_COOKIES policy, this will be the cookie names of top domains |
| # with the largest number of cookies. For other policies, this will be all |
| # the cookie names that violate the policy. |
| "A String", |
| ], |
| }, |
| "destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page. |
| "destinationUrl": "A String", # The full landing page URL of the destination. |
| }, |
| "httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations. |
| "urls": [ # URLs of HTTP calls made by the creative. |
| "A String", |
| ], |
| }, |
| "destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google. |
| "crawlTime": "A String", # Approximate time of the crawl. |
| "reason": "A String", # Reason of destination not crawlable. |
| "crawledUrl": "A String", # Destination URL that was attempted to be crawled. |
| }, |
| "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. |
| "totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not |
| # limited to the number of calls in the top_http_call_domains. |
| "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. |
| { # The number of HTTP calls made to the given domain. |
| "httpCallCount": 42, # Number of HTTP calls made to the domain. |
| "domain": "A String", # The domain name. |
| }, |
| ], |
| }, |
| "destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or # The creative's destination URL did not function properly or was |
| # incorrectly set up. |
| # having been incorrectly set up. |
| "platform": "A String", # Platform of the non-working URL. |
| "httpError": 42, # HTTP error code (e.g. 404 or 5xx) |
| "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with |
| # no content or an error page. |
| "dnsError": "A String", # DNS lookup errors. |
| "urlRejected": "A String", # Rejected because of malformed URLs or invalid requests. |
| "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. |
| "expandedUrl": "A String", # The full non-working URL. |
| "redirectionError": "A String", # HTTP redirect chain error. |
| }, |
| }, |
| ], |
| "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", |
| # "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible |
| # policy topics is not fixed for a particular API version and may change at |
| # any time. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method |
| }, |
| ], |
| "status": "A String", # Serving status for the given transaction type (e.g., open auction, |
| # deals) or region (e.g., China, Russia). |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| }, |
| "detectedAdvertisers": [ # Detected advertisers and brands. |
| { # Detected advertiser and brand information. |
| "advertiserId": "A String", # See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt |
| # for the list of possible values. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "brandName": "A String", # Brand name. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "brandId": "A String", # Detected brand ID or zero if no brand has been detected. |
| # See https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt for |
| # the list of possible values. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "advertiserName": "A String", # Advertiser name. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| }, |
| ], |
| "adTechnologyProviders": { # Detected ad technology provider information. # 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. |
| }, |
| "chinaServingStatus": { # Serving status of the creative for a transaction type or a region. # The serving status of this creative in China. |
| # When approved or disapproved, this status applies to both deals and open |
| # auction in China. When pending review, this creative is allowed to serve |
| # for deals but not for open auction. |
| "topics": [ # Policy topics related to the serving decision for this transaction type |
| # (e.g., open auction, deals) or region (e.g., China, Russia). |
| # Topics may be present only if status is DISAPPROVED. |
| { # Each policy topic entry will represent a violation of a policy topic for a |
| # creative, with the policy topic information and optional evidence for the |
| # policy violation. |
| "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. |
| "evidences": [ # Pieces of evidence associated with this policy topic entry. |
| { # Evidence associated with a policy topic entry. |
| "downloadSize": { # Total download size and URL-level download size breakdown for resources in # Total download size and URL-level download size breakdown for resources |
| # in a creative. |
| # a creative. |
| "topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size. |
| { # The URL-level breakdown for the download size. |
| "normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed. |
| "downloadSizeKb": 42, # Download size of the URL in kilobytes. |
| }, |
| ], |
| "totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative. |
| }, |
| "httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations. |
| "maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, |
| # cookie_names above will be set to the cookie names of top domains with |
| # the largest number of cookies. |
| # This field will only be set for TOO_MANY_COOKIES policy. |
| "cookieNames": [ # Names of cookies that violate Google policies. |
| # For TOO_MANY_COOKIES policy, this will be the cookie names of top domains |
| # with the largest number of cookies. For other policies, this will be all |
| # the cookie names that violate the policy. |
| "A String", |
| ], |
| }, |
| "destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page. |
| "destinationUrl": "A String", # The full landing page URL of the destination. |
| }, |
| "httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations. |
| "urls": [ # URLs of HTTP calls made by the creative. |
| "A String", |
| ], |
| }, |
| "destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google. |
| "crawlTime": "A String", # Approximate time of the crawl. |
| "reason": "A String", # Reason of destination not crawlable. |
| "crawledUrl": "A String", # Destination URL that was attempted to be crawled. |
| }, |
| "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. |
| "totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not |
| # limited to the number of calls in the top_http_call_domains. |
| "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. |
| { # The number of HTTP calls made to the given domain. |
| "httpCallCount": 42, # Number of HTTP calls made to the domain. |
| "domain": "A String", # The domain name. |
| }, |
| ], |
| }, |
| "destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or # The creative's destination URL did not function properly or was |
| # incorrectly set up. |
| # having been incorrectly set up. |
| "platform": "A String", # Platform of the non-working URL. |
| "httpError": 42, # HTTP error code (e.g. 404 or 5xx) |
| "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with |
| # no content or an error page. |
| "dnsError": "A String", # DNS lookup errors. |
| "urlRejected": "A String", # Rejected because of malformed URLs or invalid requests. |
| "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. |
| "expandedUrl": "A String", # The full non-working URL. |
| "redirectionError": "A String", # HTTP redirect chain error. |
| }, |
| }, |
| ], |
| "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", |
| # "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible |
| # policy topics is not fixed for a particular API version and may change at |
| # any time. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method |
| }, |
| ], |
| "status": "A String", # Serving status for the given transaction type (e.g., open auction, |
| # deals) or region (e.g., China, Russia). |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| }, |
| "detectedProductCategories": [ # Detected product categories, if any. |
| # See the ad-product-categories.txt file in the technical documentation |
| # for a list of IDs. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| 42, |
| ], |
| "detectedAttributes": [ # Publisher-excludable attributes that were detected for this creative. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| # |
| # If the `excluded_attribute` field of a [bid |
| # request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) |
| # contains one of the attributes that were declared or detected for a given |
| # creative, and a bid is submitted with that creative, the bid will be |
| # filtered before the auction. |
| "A String", |
| ], |
| "lastStatusUpdate": "A String", # The last time the creative status was updated. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "openAuctionServingStatus": { # Serving status of the creative for a transaction type or a region. # Status of this creative when bidding in open auction, private auction, or |
| # auction packages (outside of Russia and China). |
| "topics": [ # Policy topics related to the serving decision for this transaction type |
| # (e.g., open auction, deals) or region (e.g., China, Russia). |
| # Topics may be present only if status is DISAPPROVED. |
| { # Each policy topic entry will represent a violation of a policy topic for a |
| # creative, with the policy topic information and optional evidence for the |
| # policy violation. |
| "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. |
| "evidences": [ # Pieces of evidence associated with this policy topic entry. |
| { # Evidence associated with a policy topic entry. |
| "downloadSize": { # Total download size and URL-level download size breakdown for resources in # Total download size and URL-level download size breakdown for resources |
| # in a creative. |
| # a creative. |
| "topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size. |
| { # The URL-level breakdown for the download size. |
| "normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed. |
| "downloadSizeKb": 42, # Download size of the URL in kilobytes. |
| }, |
| ], |
| "totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative. |
| }, |
| "httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations. |
| "maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, |
| # cookie_names above will be set to the cookie names of top domains with |
| # the largest number of cookies. |
| # This field will only be set for TOO_MANY_COOKIES policy. |
| "cookieNames": [ # Names of cookies that violate Google policies. |
| # For TOO_MANY_COOKIES policy, this will be the cookie names of top domains |
| # with the largest number of cookies. For other policies, this will be all |
| # the cookie names that violate the policy. |
| "A String", |
| ], |
| }, |
| "destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page. |
| "destinationUrl": "A String", # The full landing page URL of the destination. |
| }, |
| "httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations. |
| "urls": [ # URLs of HTTP calls made by the creative. |
| "A String", |
| ], |
| }, |
| "destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google. |
| "crawlTime": "A String", # Approximate time of the crawl. |
| "reason": "A String", # Reason of destination not crawlable. |
| "crawledUrl": "A String", # Destination URL that was attempted to be crawled. |
| }, |
| "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. |
| "totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not |
| # limited to the number of calls in the top_http_call_domains. |
| "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. |
| { # The number of HTTP calls made to the given domain. |
| "httpCallCount": 42, # Number of HTTP calls made to the domain. |
| "domain": "A String", # The domain name. |
| }, |
| ], |
| }, |
| "destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or # The creative's destination URL did not function properly or was |
| # incorrectly set up. |
| # having been incorrectly set up. |
| "platform": "A String", # Platform of the non-working URL. |
| "httpError": 42, # HTTP error code (e.g. 404 or 5xx) |
| "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with |
| # no content or an error page. |
| "dnsError": "A String", # DNS lookup errors. |
| "urlRejected": "A String", # Rejected because of malformed URLs or invalid requests. |
| "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. |
| "expandedUrl": "A String", # The full non-working URL. |
| "redirectionError": "A String", # HTTP redirect chain error. |
| }, |
| }, |
| ], |
| "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", |
| # "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible |
| # policy topics is not fixed for a particular API version and may change at |
| # any time. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method |
| }, |
| ], |
| "status": "A String", # Serving status for the given transaction type (e.g., open auction, |
| # deals) or region (e.g., China, Russia). |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| }, |
| "detectedLanguages": [ # 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. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "A String", |
| ], |
| "detectedDomains": [ # The detected domains for this creative. |
| "A String", |
| ], |
| "russiaServingStatus": { # Serving status of the creative for a transaction type or a region. # The serving status of this creative in Russia. |
| # When approved or disapproved, this status applies to both deals and open |
| # auction in Russia. When pending review, this creative is allowed to serve |
| # for deals but not for open auction. |
| "topics": [ # Policy topics related to the serving decision for this transaction type |
| # (e.g., open auction, deals) or region (e.g., China, Russia). |
| # Topics may be present only if status is DISAPPROVED. |
| { # Each policy topic entry will represent a violation of a policy topic for a |
| # creative, with the policy topic information and optional evidence for the |
| # policy violation. |
| "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. |
| "evidences": [ # Pieces of evidence associated with this policy topic entry. |
| { # Evidence associated with a policy topic entry. |
| "downloadSize": { # Total download size and URL-level download size breakdown for resources in # Total download size and URL-level download size breakdown for resources |
| # in a creative. |
| # a creative. |
| "topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size. |
| { # The URL-level breakdown for the download size. |
| "normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed. |
| "downloadSizeKb": 42, # Download size of the URL in kilobytes. |
| }, |
| ], |
| "totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative. |
| }, |
| "httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations. |
| "maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, |
| # cookie_names above will be set to the cookie names of top domains with |
| # the largest number of cookies. |
| # This field will only be set for TOO_MANY_COOKIES policy. |
| "cookieNames": [ # Names of cookies that violate Google policies. |
| # For TOO_MANY_COOKIES policy, this will be the cookie names of top domains |
| # with the largest number of cookies. For other policies, this will be all |
| # the cookie names that violate the policy. |
| "A String", |
| ], |
| }, |
| "destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page. |
| "destinationUrl": "A String", # The full landing page URL of the destination. |
| }, |
| "httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations. |
| "urls": [ # URLs of HTTP calls made by the creative. |
| "A String", |
| ], |
| }, |
| "destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google. |
| "crawlTime": "A String", # Approximate time of the crawl. |
| "reason": "A String", # Reason of destination not crawlable. |
| "crawledUrl": "A String", # Destination URL that was attempted to be crawled. |
| }, |
| "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. |
| "totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not |
| # limited to the number of calls in the top_http_call_domains. |
| "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. |
| { # The number of HTTP calls made to the given domain. |
| "httpCallCount": 42, # Number of HTTP calls made to the domain. |
| "domain": "A String", # The domain name. |
| }, |
| ], |
| }, |
| "destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or # The creative's destination URL did not function properly or was |
| # incorrectly set up. |
| # having been incorrectly set up. |
| "platform": "A String", # Platform of the non-working URL. |
| "httpError": 42, # HTTP error code (e.g. 404 or 5xx) |
| "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with |
| # no content or an error page. |
| "dnsError": "A String", # DNS lookup errors. |
| "urlRejected": "A String", # Rejected because of malformed URLs or invalid requests. |
| "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. |
| "expandedUrl": "A String", # The full non-working URL. |
| "redirectionError": "A String", # HTTP redirect chain error. |
| }, |
| }, |
| ], |
| "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", |
| # "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible |
| # policy topics is not fixed for a particular API version and may change at |
| # any time. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method |
| }, |
| ], |
| "status": "A String", # Serving status for the given transaction type (e.g., open auction, |
| # deals) or region (e.g., China, Russia). |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| }, |
| }, |
| "version": 42, # Output only. The version of this creative. |
| # Version for a new creative is 1 and it increments during subsequent |
| # creative updates. |
| "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "A String", |
| ], |
| "html": { # HTML content for a creative. # An HTML creative. |
| "height": 42, # The height of the HTML snippet in pixels. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "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. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| }, |
| "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. |
| "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, # The app icon, for app download ads. |
| # so long as the aspect ratio is preserved. |
| "height": 42, # Image height in pixels. |
| "width": 42, # Image width in pixels. |
| "url": "A String", # The URL of the image. |
| }, |
| "headline": "A String", # A short title for the ad. |
| "logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo. |
| # so long as the aspect ratio is preserved. |
| "height": 42, # Image height in pixels. |
| "width": 42, # Image width in pixels. |
| "url": "A String", # The URL of the image. |
| }, |
| "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]. |
| "clickTrackingUrl": "A String", # The URL to use for click tracking. |
| "body": "A String", # A long description of the ad. |
| "callToAction": "A String", # A label for the button that the user is supposed to click. |
| "priceDisplayText": "A String", # The price of the promoted app including currency info. |
| "image": { # An image resource. You may provide a larger image than was requested, # A large image. |
| # so long as the aspect ratio is preserved. |
| "height": 42, # Image height in pixels. |
| "width": 42, # Image width in pixels. |
| "url": "A String", # The URL of the image. |
| }, |
| "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. |
| }, |
| "dealIds": [ # Output only. IDs of all of the deals with which this creative has been used |
| # in bidding. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "A String", |
| ], |
| "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. |
| "A String", |
| ], |
| "declaredRestrictedCategories": [ # All declared restricted categories for the ads that may be shown from this |
| # creative. Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "A String", |
| ], |
| "advertiserName": "A String", # The name of the company being advertised in the creative. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "video": { # Video content for a creative. # A video creative. |
| "videoMetadata": { # Video metadata for a creative. # Output only. Video metadata. |
| "vastVersion": "A String", # The maximum VAST version across all wrapped VAST documents. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "mediaFiles": [ # The list of all media files declared in the VAST. If there are multiple |
| # VASTs in a wrapper chain, this includes the media files from the deepest |
| # one in the chain. |
| { # Information about each media file in the VAST. |
| "bitrate": "A String", # Bitrate of the video file, in Kbps. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "mimeType": "A String", # The MIME type of this media file. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| }, |
| ], |
| "isVpaid": True or False, # Is this a VPAID ad? |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "duration": "A String", # The duration of the ad. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "skipOffset": "A String", # The minimum duration that the user has to watch before being able to |
| # skip this ad. If the field is not set, the ad is not skippable. If |
| # the field is set, the ad is skippable. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| "isValidVast": True or False, # Is this a valid VAST ad? |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| }, |
| "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. |
| "videoUrl": "A String", # The URL to fetch a video ad. |
| }, |
| "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. This is only supported for native |
| # ads. |
| "creativeId": "A String", # Buyer-specific creative ID that references this creative in bid responses. |
| # This field is Ignored in update operations. Can be used to filter the |
| # response of the |
| # creatives.list |
| # method. |
| # The maximum length of the creative ID is 128 bytes. |
| "declaredAttributes": [ # All declared attributes for the ads that may be shown from this creative. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| # |
| # If the `excluded_attribute` field of a [bid |
| # request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto") |
| # contains one of the attributes that were declared or detected for a given |
| # creative, and a bid is submitted with that creative, the bid will be |
| # filtered before the auction. |
| "A String", |
| ], |
| "agencyId": "A String", # The agency ID for this creative. |
| "accountId": "A String", # Output only. ID of the buyer account that this creative is owned by. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method with equality and inequality check. |
| "declaredVendorIds": [ # IDs for the declared ad technology vendors that may be used by this |
| # creative. See |
| # https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for |
| # possible values. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| 42, |
| ], |
| "name": "A String", # Output only. Name of the creative. |
| # Follows the pattern `buyers/{buyer}/creatives/{creative}`, where |
| # `{buyer}` represents the account ID of the buyer who owns the creative, |
| # and `{creative}` is the buyer-specific creative ID that references this |
| # creative in the bid response. |
| "creativeFormat": "A String", # Output only. The format of this creative. |
| # Can be used to filter the response of the |
| # creatives.list |
| # method. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="watch">watch(parent, body=None, x__xgafv=None)</code> |
| <pre>Watches all creatives pertaining to a bidder. It is sufficient to invoke |
| this endpoint once per bidder. A Pub/Sub topic will be created and |
| notifications will be pushed to the topic when any of the bidder's |
| creatives change status. All of the bidder's service accounts will have |
| access to read from the topic. |
| Subsequent invocations of this method will return the existing |
| Pub/Sub configuration. |
| |
| Args: |
| parent: string, Required. To watch all creatives pertaining to the bidder and all its child seat |
| accounts, the bidder must follow the pattern `bidders/{bidderAccountId}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A request to receive push notifications when any of the creatives belonging |
| # to the bidder changes status. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A response for the request to receive push notification when a bidder's |
| # creatives change status. |
| "subscription": "A String", # The Pub/Sub subscription that can be used to pull creative status |
| # notifications. This would be of the format |
| # `projects/{project_id}/subscriptions/{subscription_id}`. |
| # Subscription is created with pull delivery. All service accounts belonging |
| # to the bidder will have read access to this subscription. |
| # Subscriptions that are inactive for more than 90 days will be disabled. |
| # Please use |
| # watchCreatives to |
| # re-enable the subscription. |
| "topic": "A String", # The Pub/Sub topic that will be used to publish creative serving |
| # status notifications. This would be of the format |
| # `projects/{project_id}/topics/{topic_id}`. |
| }</pre> |
| </div> |
| |
| </body></html> |