Blame - docs/dyn/realtimebidding_v1.bidders.creatives.html - platform/external/python/google-api-python-client

<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>

76

<h2>Instance Methods</h2>

77

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

81

<code><a href="#list">list(parent, view=None, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

82

<p class="firstline">Lists creatives.</p>

83

84

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

85

<p class="firstline">Retrieves the next page of results.</p>

86

87

<code><a href="#watch">watch(parent, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

88

<p class="firstline">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.</p>

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

89

<h3>Method Details</h3>

90

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

91

<code class="details" id="close">close()</code>

92

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="list">list(parent, view=None, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

97

<pre>Lists creatives.

98

99

Args:

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

100

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)

101

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".

102

Allowed values

103

CREATIVE_VIEW_UNSPECIFIED - Not specified, equivalent to SERVING_DECISION_ONLY.

104

SERVING_DECISION_ONLY - Only creativeServingDecision is included in the response.

105

FULL - The entire creative resource (including the declared fields and the creative content) is included in the response.

106

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'

107

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.

108

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.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

109

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

116

117

{ # A response for listing creatives.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

118

"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.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

119

"creatives": [ # The list of creatives.

120

{ # A creative and its classification data.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

121

"native": { # Native content for a creative. # A native creative.

122

"body": "A String", # A long description of the ad.

123

"advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.

124

"headline": "A String", # A short title for the ad.

125

"videoUrl": "A String", # The URL to fetch a native video ad.

126

"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].

127

"callToAction": "A String", # A label for the button that the user is supposed to click.

128

"priceDisplayText": "A String", # The price of the promoted app including currency info.

129

"image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.

130

"height": 42, # Image height in pixels.

131

"width": 42, # Image width in pixels.

132

"url": "A String", # The URL of the image.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

133

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

134

"clickTrackingUrl": "A String", # The URL to use for click tracking.

135

"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.

136

"logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.

137

"height": 42, # Image height in pixels.

138

"width": 42, # Image width in pixels.

139

"url": "A String", # The URL of the image.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

140

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

141

"appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.

142

"height": 42, # Image height in pixels.

143

"width": 42, # Image width in pixels.

144

"url": "A String", # The URL of the image.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

145

},

146

},

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

147

"impressionTrackingUrls": [ # The set of URLs to be called to record an impression.

148

"A String",

149

],

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

150

"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.

151

42,

152

],

153

"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.

154

"A String",

155

],

156

"version": 42, # Output only. The version of this creative. Version for a new creative is 1 and it increments during subsequent creative updates.

157

"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.

158

"declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

159

"A String",

160

],

161

"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.

162

"A String",

163

],

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

164

"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.

165

"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.

166

"A String",

167

],

168

"lastStatusUpdate": "A String", # The last time the creative status was updated. Can be used to filter the response of the creatives.list method.

169

"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).

170

"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.

171

"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.

172

{ # 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.

173

"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

174

"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.

175

"evidences": [ # Pieces of evidence associated with this policy topic entry.

176

{ # Evidence associated with a policy topic entry.

177

"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.

178

"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.

179

"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",

],

},

"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.

184

"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.

185

{ # The URL-level breakdown for the download size.

186

"downloadSizeKb": 42, # Download size of the URL in kilobytes.

187

"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.

188

},

189

],

190

"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.

191

},

192

"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.

193

"crawledUrl": "A String", # Destination URL that was attempted to be crawled.

194

"crawlTime": "A String", # Approximate time of the crawl.

195

"reason": "A String", # Reason of destination not crawlable.

196

},

197

"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.

198

"destinationUrl": "A String", # The full landing page URL of the destination.

199

},

200

"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.

201

"topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative.

202

{ # The number of HTTP calls made to the given domain.

203

"domain": "A String", # The domain name.

204

"httpCallCount": 42, # Number of HTTP calls made to the domain.

205

},

206

],

207

"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.

208

},

209

"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.

210

"urls": [ # URLs of HTTP calls made by the creative.

"A String",

],

},

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.

215

"redirectionError": "A String", # HTTP redirect chain error.

216

"expandedUrl": "A String", # The full non-working URL.

217

"dnsError": "A String", # DNS lookup errors.

218

"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.

219

"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.

220

"httpError": 42, # HTTP error code (e.g. 404 or 5xx)

221

"platform": "A String", # Platform of the non-working URL.

222

"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.

223

},

224

},

225

],

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

226

},

227

],

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

228

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

229

"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.

230

"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.

231

"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.

232

{ # 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.

233

"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

234

"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.

235

"evidences": [ # Pieces of evidence associated with this policy topic entry.

236

{ # Evidence associated with a policy topic entry.

237

"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.

238

"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.

239

"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",

],

},

"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.

244

"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.

245

{ # The URL-level breakdown for the download size.

246

"downloadSizeKb": 42, # Download size of the URL in kilobytes.

247

"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.

248

},

249

],

250

"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.

251

},

252

"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.

253

"crawledUrl": "A String", # Destination URL that was attempted to be crawled.

254

"crawlTime": "A String", # Approximate time of the crawl.

255

"reason": "A String", # Reason of destination not crawlable.

256

},

257

"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.

258

"destinationUrl": "A String", # The full landing page URL of the destination.

259

},

260

"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.

261

"topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative.

262

{ # The number of HTTP calls made to the given domain.

263

"domain": "A String", # The domain name.

264

"httpCallCount": 42, # Number of HTTP calls made to the domain.

265

},

266

],

267

"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.

268

},

269

"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.

270

"urls": [ # URLs of HTTP calls made by the creative.

"A String",

],

},

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.

275

"redirectionError": "A String", # HTTP redirect chain error.

276

"expandedUrl": "A String", # The full non-working URL.

277

"dnsError": "A String", # DNS lookup errors.

278

"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.

279

"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.

280

"httpError": 42, # HTTP error code (e.g. 404 or 5xx)

281

"platform": "A String", # Platform of the non-working URL.

282

"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.

},

},

],

},

],

},

"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.

290

42,

291

],

292

"detectedClickThroughUrls": [ # The set of detected destination URLs for the creative. Can be used to filter the response of the creatives.list method.

293

"A String",

294

],

295

"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).

296

"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.

297

"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.

298

{ # 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.

299

"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

300

"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.

301

"evidences": [ # Pieces of evidence associated with this policy topic entry.

302

{ # Evidence associated with a policy topic entry.

303

"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.

304

"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.

305

"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",

],

},

"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.

310

"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.

311

{ # The URL-level breakdown for the download size.

312

"downloadSizeKb": 42, # Download size of the URL in kilobytes.

313

"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.

314

},

315

],

316

"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.

317

},

318

"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.

319

"crawledUrl": "A String", # Destination URL that was attempted to be crawled.

320

"crawlTime": "A String", # Approximate time of the crawl.

321

"reason": "A String", # Reason of destination not crawlable.

322

},

323

"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.

324

"destinationUrl": "A String", # The full landing page URL of the destination.

325

},

326

"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.

327

"topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative.

328

{ # The number of HTTP calls made to the given domain.

329

"domain": "A String", # The domain name.

330

"httpCallCount": 42, # Number of HTTP calls made to the domain.

331

},

332

],

333

"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.

334

},

335

"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.

336

"urls": [ # URLs of HTTP calls made by the creative.

"A String",

],

},

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.

341

"redirectionError": "A String", # HTTP redirect chain error.

342

"expandedUrl": "A String", # The full non-working URL.

343

"dnsError": "A String", # DNS lookup errors.

344

"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.

345

"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.

346

"httpError": 42, # HTTP error code (e.g. 404 or 5xx)

347

"platform": "A String", # Platform of the non-working URL.

348

"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.

},

},

],

},

],

},

"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.

356

42,

357

],

358

"adTechnologyProviders": { # Detected ad technology provider information. # The detected ad technology providers.

359

"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.

360

"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",

],

},

"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.

365

"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.

366

"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.

367

{ # 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.

368

"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

369

"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.

370

"evidences": [ # Pieces of evidence associated with this policy topic entry.

371

{ # Evidence associated with a policy topic entry.

372

"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.

373

"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.

374

"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",

],

},

"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.

379

"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.

380

{ # The URL-level breakdown for the download size.

381

"downloadSizeKb": 42, # Download size of the URL in kilobytes.

382

"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.

383

},

384

],

385

"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.

386

},

387

"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.

388

"crawledUrl": "A String", # Destination URL that was attempted to be crawled.

389

"crawlTime": "A String", # Approximate time of the crawl.

390

"reason": "A String", # Reason of destination not crawlable.

391

},

392

"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.

393

"destinationUrl": "A String", # The full landing page URL of the destination.

394

},

395

"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.

396

"topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative.

397

{ # The number of HTTP calls made to the given domain.

398

"domain": "A String", # The domain name.

399

"httpCallCount": 42, # Number of HTTP calls made to the domain.

400

},

401

],

402

"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.

403

},

404

"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.

405

"urls": [ # URLs of HTTP calls made by the creative.

"A String",

],

},

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.

410

"redirectionError": "A String", # HTTP redirect chain error.

411

"expandedUrl": "A String", # The full non-working URL.

412

"dnsError": "A String", # DNS lookup errors.

413

"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.

414

"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.

415

"httpError": 42, # HTTP error code (e.g. 404 or 5xx)

416

"platform": "A String", # Platform of the non-working URL.

417

"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.

},

},

],

},

],

},

"detectedDomains": [ # The detected domains for this creative.

425

"A String",

426

],

427

"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.

428

42,

429

],

430

"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.

431

"A String",

432

],

433

"detectedAdvertisers": [ # Detected advertisers and brands.

434

{ # Detected advertiser and brand information.

435

"advertiserName": "A String", # Advertiser name. Can be used to filter the response of the creatives.list method.

436

"brandName": "A String", # Brand name. Can be used to filter the response of the creatives.list method.

437

"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.

438

"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.

439

},

440

],

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

441

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

442

"video": { # Video content for a creative. # A video creative.

443

"videoUrl": "A String", # The URL to fetch a video ad.

444

"videoMetadata": { # Video metadata for a creative. # Output only. Video metadata.

445

"duration": "A String", # The duration of the ad. Can be used to filter the response of the creatives.list method.

446

"isValidVast": True or False, # Is this a valid VAST ad? Can be used to filter the response of the creatives.list method.

447

"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.

448

"isVpaid": True or False, # Is this a VPAID ad? Can be used to filter the response of the creatives.list method.

449

"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.

450

{ # Information about each media file in the VAST.

451

"bitrate": "A String", # Bitrate of the video file, in Kbps. Can be used to filter the response of the creatives.list method.

452

"mimeType": "A String", # The MIME type of this media file. Can be used to filter the response of the creatives.list method.

453

},

454

],

455

"vastVersion": "A String", # The maximum VAST version across all wrapped VAST documents. Can be used to filter the response of the creatives.list method.

456

},

457

"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.

458

},

459

"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.

460

"A String",

461

],

462

"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.

463

"apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.

464

"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. This is only supported for native ads.

465

"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.

466

"html": { # HTML content for a creative. # An HTML creative.

467

"width": 42, # The width of the HTML snippet in pixels. Can be used to filter the response of the creatives.list method.

468

"height": 42, # The height of the HTML snippet in pixels. Can be used to filter the response of the creatives.list method.

469

"snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.

470

},

471

"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.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

472

"A String",

473

],

474

"agencyId": "A String", # The agency ID for this creative.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

475

"creativeFormat": "A String", # Output only. The format of this creative. Can be used to filter the response of the creatives.list method.

476

"name": "A String", # 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.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

484

<pre>Retrieves the next page of results.

485

486

Args:

487

previous_request: The request for the previous page. (required)

488

previous_response: The response from the request for the previous page. (required)

489

490

Returns:

491

A request object that you can call 'execute()' on to request the next

492

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="watch">watch(parent, body=None, x__xgafv=None)</code>

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

498

<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.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

499

500

Args:

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

501

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)

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

502

body: object, The request body.

503

The object takes the form of:

504

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

505

{ # A request to receive push notifications when any of the creatives belonging to the bidder changes status.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

506

}

507

508

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

515

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

516

{ # A response for the request to receive push notification when a bidder's creatives change status.

517

"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}`.

518

"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.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

}</pre>

</div>

</body></html>