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

78

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

79

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

80

81

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

82

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

83

84

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

85

<p class="firstline">Watches all creatives pertaining to a bidder. It is sufficient to invoke</p>

86

<h3>Method Details</h3>

87

88

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

89

<pre>Lists creatives.

90

91

Args:

92

parent: string, Required. Name of the parent buyer that owns the creatives.

93

94

The pattern for this resource is either `buyers/{buyerAccountId}` or

95

`bidders/{bidderAccountId}`.

96

97

For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the

98

following:

99

1. The ID of the buyer that is accessing their own creatives.

100

2. The ID of the child seat buyer under a bidder account.

101

So for listing creatives pertaining to the child seat buyer (`456`)

102

under bidder account (`123`), you would use the pattern: `buyers/456`.

103

3. The ID of the bidder itself.

104

So for listing creatives pertaining to bidder (`123`),

105

you would use `buyers/123`.

106

107

If you want to access all creatives pertaining to both the bidder and all

108

of its child seat accounts, you would use `bidders/{bidderAccountId}`,

109

e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`. (required)

110

pageToken: string, A token identifying a page of results the server should return.

111

Typically, this is the value of

112

ListCreativesResponse.nextPageToken

113

returned from the previous call to the 'ListCreatives' method.

114

view: string, Controls the amount of information included in the response.

115

By default only

116

creativeServingDecision

117

is included. To retrieve the entire creative

118

resource (including the declared

119

fields and the creative content) specify the view as "FULL".

120

pageSize: integer, Requested page size. The server may return fewer creatives than requested

121

(due to timeout constraint) even if more are available via another call.

122

If unspecified, server will pick an appropriate default.

123

Acceptable values are 1 to 1000, inclusive.

124

filter: string, Query string to filter creatives. If no filter is specified,

125

all active creatives will be returned.

126

127

Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND

128

disapprovalReason:UNACCEPTABLE_CONTENT) OR

129

declaredAttributes:IS_COOKIE_TARGETED'

130

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

137

138

{ # A response for listing creatives.

139

"nextPageToken": "A String", # A token to retrieve the next page of results.

140

# Pass this value in the

141

# ListCreativesRequest.pageToken

142

# field in the subsequent call to the `ListCreatives` method to retrieve the

143

# next page of results.

144

"creatives": [ # The list of creatives.

145

{ # A creative and its classification data.

146

"creativeServingDecision": { # Top level status and detected attributes of a creative. # Output only. Top level status and detected attributes of a creative (for example domain,

147

# language, advertiser, product category, etc.) that affect whether (status)

148

# and where (context) a creative will be allowed to serve.

149

"detectedSensitiveCategories": [ # Detected sensitive categories, if any.

150

# Can be used to filter the response of the

# creatives.list

# method.

#

# See the ad-sensitive-categories.txt file in the technical documentation

155

# for a list of IDs. You should use these IDs along with the

156

# excluded-sensitive-category field in the bid request to filter your bids.

157

42,

158

],

159

"detectedClickThroughUrls": [ # The set of detected destination URLs for the creative.

160

# 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

166

# used by this creative. See

167

# https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for

168

# possible values.

169

# Can be used to filter the response of the

# creatives.list

# method.

#

# If the `allowed_vendor_type` field of a [bid

174

# request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto)

175

# does not contain one of the vendor type IDs that were declared or

176

# detected for a given creative, and a bid is submitted with that creative,

177

# the bid will be filtered before the auction.

178

42,

179

],

180

"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

181

# Russia and China).

182

"topics": [ # Policy topics related to the serving decision for this transaction type

183

# (e.g., open auction, deals) or region (e.g., China, Russia).

184

# Topics may be present only if status is DISAPPROVED.

185

{ # Each policy topic entry will represent a violation of a policy topic for a

186

# creative, with the policy topic information and optional evidence for the

187

# policy violation.

188

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

189

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

190

{ # Evidence associated with a policy topic entry.

191

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

192

# in a creative.

193

# a creative.

194

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

195

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

196

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

197

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

198

},

199

],

200

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

201

},

202

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

203

"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set,

204

# cookie_names above will be set to the cookie names of top domains with

205

# the largest number of cookies.

206

# This field will only be set for TOO_MANY_COOKIES policy.

207

"cookieNames": [ # Names of cookies that violate Google policies.

208

# For TOO_MANY_COOKIES policy, this will be the cookie names of top domains

209

# with the largest number of cookies. For other policies, this will be all

210

# the cookie names that violate the policy.

"A String",

],

},

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

215

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

216

},

217

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

218

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

223

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

224

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

225

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

226

},

227

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

228

"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not

229

# limited to the number of calls in the top_http_call_domains.

230

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

231

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

232

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

233

"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

238

# incorrectly set up.

239

# having been incorrectly set up.

240

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

241

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

242

"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with

243

# no content or an error page.

244

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

245

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

246

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

247

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

248

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

},

},

],

"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL",

253

# "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible

254

# policy topics is not fixed for a particular API version and may change at

255

# any time.

256

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

262

# deals) or region (e.g., China, Russia).

263

# Can be used to filter the response of the

# creatives.list

# method.

},

"detectedAdvertisers": [ # Detected advertisers and brands.

268

{ # Detected advertiser and brand information.

269

"advertiserId": "A String", # See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt

270

# for the list of possible values.

271

# Can be used to filter the response of the

272

# creatives.list

273

# method.

274

"brandName": "A String", # Brand name.

275

# Can be used to filter the response of the

276

# creatives.list

277

# method.

278

"brandId": "A String", # Detected brand ID or zero if no brand has been detected.

279

# See https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt for

280

# the list of possible values.

281

# Can be used to filter the response of the

282

# creatives.list

283

# method.

284

"advertiserName": "A String", # Advertiser name.

285

# Can be used to filter the response of the

# creatives.list

# method.

},

],

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

291

"detectedProviderIds": [ # The detected ad technology provider IDs for this creative.

292

# See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for

293

# mapping of provider ID to provided name, a privacy policy URL, and a list

294

# of domains which can be attributed to the provider.

295

#

296

# If the creative contains provider IDs that are outside of those listed in

297

# the `BidRequest.adslot.consented_providers_settings.consented_providers`

298

# field on the [Google bid

299

# protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto)

300

# and the

301

# `BidRequest.user.ext.consented_providers_settings.consented_providers`

302

# field on the [OpenRTB

303

# protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto),

304

# and a bid is submitted with that creative for an impression

305

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

310

#

311

# If true for a given creative, any bid submitted with that creative for an

312

# impression that will serve to an EEA user will be filtered before the

313

# auction.

314

},

315

"chinaServingStatus": { # Serving status of the creative for a transaction type or a region. # The serving status of this creative in China.

316

# When approved or disapproved, this status applies to both deals and open

317

# auction in China. When pending review, this creative is allowed to serve

318

# for deals but not for open auction.

319

"topics": [ # Policy topics related to the serving decision for this transaction type

320

# (e.g., open auction, deals) or region (e.g., China, Russia).

321

# Topics may be present only if status is DISAPPROVED.

322

{ # Each policy topic entry will represent a violation of a policy topic for a

323

# creative, with the policy topic information and optional evidence for the

324

# policy violation.

325

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

326

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

327

{ # Evidence associated with a policy topic entry.

328

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

329

# in a creative.

330

# a creative.

331

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

332

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

333

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

334

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

335

},

336

],

337

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

338

},

339

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

340

"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set,

341

# cookie_names above will be set to the cookie names of top domains with

342

# the largest number of cookies.

343

# This field will only be set for TOO_MANY_COOKIES policy.

344

"cookieNames": [ # Names of cookies that violate Google policies.

345

# For TOO_MANY_COOKIES policy, this will be the cookie names of top domains

346

# with the largest number of cookies. For other policies, this will be all

347

# the cookie names that violate the policy.

"A String",

],

},

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

352

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

353

},

354

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

355

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

360

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

361

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

362

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

363

},

364

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

365

"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not

366

# limited to the number of calls in the top_http_call_domains.

367

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

368

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

369

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

370

"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

375

# incorrectly set up.

376

# having been incorrectly set up.

377

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

378

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

379

"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with

380

# no content or an error page.

381

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

382

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

383

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

384

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

385

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

},

},

],

"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL",

390

# "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible

391

# policy topics is not fixed for a particular API version and may change at

392

# any time.

393

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

399

# deals) or region (e.g., China, Russia).

400

# Can be used to filter the response of the

# creatives.list

# method.

},

"detectedProductCategories": [ # Detected product categories, if any.

405

# See the ad-product-categories.txt file in the technical documentation

406

# for a list of IDs.

407

# Can be used to filter the response of the

# creatives.list

# method.

42,

],

"detectedAttributes": [ # Publisher-excludable attributes that were detected for this creative.

413

# Can be used to filter the response of the

# creatives.list

# method.

#

# If the `excluded_attribute` field of a [bid

418

# request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto)

419

# contains one of the attributes that were declared or detected for a given

420

# creative, and a bid is submitted with that creative, the bid will be

421

# filtered before the auction.

422

"A String",

423

],

424

"lastStatusUpdate": "A String", # The last time the creative status was updated.

425

# Can be used to filter the response of the

426

# creatives.list

427

# method.

428

"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

429

# auction packages (outside of Russia and China).

430

"topics": [ # Policy topics related to the serving decision for this transaction type

431

# (e.g., open auction, deals) or region (e.g., China, Russia).

432

# Topics may be present only if status is DISAPPROVED.

433

{ # Each policy topic entry will represent a violation of a policy topic for a

434

# creative, with the policy topic information and optional evidence for the

435

# policy violation.

436

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

437

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

438

{ # Evidence associated with a policy topic entry.

439

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

440

# in a creative.

441

# a creative.

442

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

443

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

444

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

445

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

446

},

447

],

448

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

449

},

450

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

451

"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set,

452

# cookie_names above will be set to the cookie names of top domains with

453

# the largest number of cookies.

454

# This field will only be set for TOO_MANY_COOKIES policy.

455

"cookieNames": [ # Names of cookies that violate Google policies.

456

# For TOO_MANY_COOKIES policy, this will be the cookie names of top domains

457

# with the largest number of cookies. For other policies, this will be all

458

# the cookie names that violate the policy.

"A String",

],

},

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

463

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

464

},

465

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

466

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

471

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

472

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

473

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

474

},

475

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

476

"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not

477

# limited to the number of calls in the top_http_call_domains.

478

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

479

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

480

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

481

"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

486

# incorrectly set up.

487

# having been incorrectly set up.

488

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

489

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

490

"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with

491

# no content or an error page.

492

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

493

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

494

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

495

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

496

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

},

},

],

"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL",

501

# "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible

502

# policy topics is not fixed for a particular API version and may change at

503

# any time.

504

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

510

# deals) or region (e.g., China, Russia).

511

# Can be used to filter the response of the

# creatives.list

# method.

},

"detectedLanguages": [ # The detected languages for this creative. The order is

516

# arbitrary. The codes are 2 or 5 characters and are documented at

517

# https://developers.google.com/adwords/api/docs/appendix/languagecodes.

518

# Can be used to filter the response of the

# creatives.list

# method.

"A String",

],

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

524

"A String",

525

],

526

"russiaServingStatus": { # Serving status of the creative for a transaction type or a region. # The serving status of this creative in Russia.

527

# When approved or disapproved, this status applies to both deals and open

528

# auction in Russia. When pending review, this creative is allowed to serve

529

# for deals but not for open auction.

530

"topics": [ # Policy topics related to the serving decision for this transaction type

531

# (e.g., open auction, deals) or region (e.g., China, Russia).

532

# Topics may be present only if status is DISAPPROVED.

533

{ # Each policy topic entry will represent a violation of a policy topic for a

534

# creative, with the policy topic information and optional evidence for the

535

# policy violation.

536

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

537

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

538

{ # Evidence associated with a policy topic entry.

539

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

540

# in a creative.

541

# a creative.

542

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

543

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

544

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

545

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

546

},

547

],

548

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

549

},

550

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

551

"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set,

552

# cookie_names above will be set to the cookie names of top domains with

553

# the largest number of cookies.

554

# This field will only be set for TOO_MANY_COOKIES policy.

555

"cookieNames": [ # Names of cookies that violate Google policies.

556

# For TOO_MANY_COOKIES policy, this will be the cookie names of top domains

557

# with the largest number of cookies. For other policies, this will be all

558

# the cookie names that violate the policy.

"A String",

],

},

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

563

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

564

},

565

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

566

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

571

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

572

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

573

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

574

},

575

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

576

"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not

577

# limited to the number of calls in the top_http_call_domains.

578

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

579

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

580

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

581

"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

586

# incorrectly set up.

587

# having been incorrectly set up.

588

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

589

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

590

"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with

591

# no content or an error page.

592

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

593

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

594

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

595

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

596

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

},

},

],

"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL",

601

# "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible

602

# policy topics is not fixed for a particular API version and may change at

603

# any time.

604

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

610

# deals) or region (e.g., China, Russia).

611

# Can be used to filter the response of the

# creatives.list

# method.

},

},

"version": 42, # Output only. The version of this creative.

617

# Version for a new creative is 1 and it increments during subsequent

618

# creative updates.

619

"declaredClickThroughUrls": [ # The set of declared destination URLs for the creative.

620

# Can be used to filter the response of the

# creatives.list

# method.

"A String",

],

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

626

"height": 42, # The height of the HTML snippet in pixels.

627

# Can be used to filter the response of the

628

# creatives.list

629

# method.

630

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

631

"width": 42, # The width of the HTML snippet in pixels.

632

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

637

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

638

"A String",

639

],

640

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

641

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

642

"appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.

643

# so long as the aspect ratio is preserved.

644

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

645

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

646

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

647

},

648

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

649

"logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo.

650

# so long as the aspect ratio is preserved.

651

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

652

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

653

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

654

},

655

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

656

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

657

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

658

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

659

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

660

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

661

"image": { # An image resource. You may provide a larger image than was requested, # A large image.

662

# so long as the aspect ratio is preserved.

663

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

664

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

665

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

666

},

667

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

668

},

669

"dealIds": [ # Output only. IDs of all of the deals with which this creative has been used

670

# in bidding.

671

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

677

"A String",

678

],

679

"declaredRestrictedCategories": [ # All declared restricted categories for the ads that may be shown from this

680

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

686

# Can be used to filter the response of the

687

# creatives.list

688

# method.

689

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

690

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

691

"vastVersion": "A String", # The maximum VAST version across all wrapped VAST documents.

692

# Can be used to filter the response of the

693

# creatives.list

694

# method.

695

"mediaFiles": [ # The list of all media files declared in the VAST. If there are multiple

696

# VASTs in a wrapper chain, this includes the media files from the deepest

697

# one in the chain.

698

{ # Information about each media file in the VAST.

699

"bitrate": "A String", # Bitrate of the video file, in Kbps.

700

# Can be used to filter the response of the

701

# creatives.list

702

# method.

703

"mimeType": "A String", # The MIME type of this media file.

704

# Can be used to filter the response of the

# creatives.list

# method.

},

],

"isVpaid": True or False, # Is this a VPAID ad?

710

# Can be used to filter the response of the

711

# creatives.list

712

# method.

713

"duration": "A String", # The duration of the ad.

714

# Can be used to filter the response of the

715

# creatives.list

716

# method.

717

"skipOffset": "A String", # The minimum duration that the user has to watch before being able to

718

# skip this ad. If the field is not set, the ad is not skippable. If

719

# the field is set, the ad is skippable.

720

# Can be used to filter the response of the

721

# creatives.list

722

# method.

723

"isValidVast": True or False, # Is this a valid VAST ad?

724

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

729

# This document should conform to the VAST 2.0 or 3.0 standard.

730

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

731

},

732

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

733

# ads.

734

"creativeId": "A String", # Buyer-specific creative ID that references this creative in bid responses.

735

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

740

"declaredAttributes": [ # All declared attributes for the ads that may be shown from this creative.

741

# Can be used to filter the response of the

# creatives.list

# method.

#

# If the `excluded_attribute` field of a [bid

746

# request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto")

747

# contains one of the attributes that were declared or detected for a given

748

# creative, and a bid is submitted with that creative, the bid will be

749

# filtered before the auction.

750

"A String",

751

],

752

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

753

"accountId": "A String", # Output only. ID of the buyer account that this creative is owned by.

754

# Can be used to filter the response of the

755

# creatives.list

756

# method with equality and inequality check.

757

"declaredVendorIds": [ # IDs for the declared ad technology vendors that may be used by this

758

# creative. See

759

# https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for

760

# possible values.

761

# Can be used to filter the response of the

# creatives.list

# method.

42,

],

"name": "A String", # Output only. Name of the creative.

767

# Follows the pattern `buyers/{buyer}/creatives/{creative}`, where

768

# `{buyer}` represents the account ID of the buyer who owns the creative,

769

# and `{creative}` is the buyer-specific creative ID that references this

770

# creative in the bid response.

771

"creativeFormat": "A String", # Output only. The format of this creative.

772

# Can be used to filter the response of the

# creatives.list

# method.

},

],

}</pre>

</div>

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

782

<pre>Retrieves the next page of results.

783

784

Args:

785

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

786

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

787

788

Returns:

789

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

790

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>

796

<pre>Watches all creatives pertaining to a bidder. It is sufficient to invoke

797

this endpoint once per bidder. A Pub/Sub topic will be created and

798

notifications will be pushed to the topic when any of the bidder's

799

creatives change status. All of the bidder's service accounts will have

800

access to read from the topic.

801

Subsequent invocations of this method will return the existing

802

Pub/Sub configuration.

803

804

Args:

805

parent: string, Required. To watch all creatives pertaining to the bidder and all its child seat

806

accounts, the bidder must follow the pattern `bidders/{bidderAccountId}`. (required)

807

body: object, The request body.

808

The object takes the form of:

809

810

{ # A request to receive push notifications when any of the creatives belonging

811

# to the bidder changes status.

812

}

813

814

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

821

822

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

823

# creatives change status.

824

"subscription": "A String", # The Pub/Sub subscription that can be used to pull creative status

825

# notifications. This would be of the format

826

# `projects/{project_id}/subscriptions/{subscription_id}`.

827

# Subscription is created with pull delivery. All service accounts belonging

828

# to the bidder will have read access to this subscription.

829

# Subscriptions that are inactive for more than 90 days will be disabled.

830

# Please use

831

# watchCreatives to

832

# re-enable the subscription.

833

"topic": "A String", # The Pub/Sub topic that will be used to publish creative serving

834

# status notifications. This would be of the format

835

# `projects/{project_id}/topics/{topic_id}`.

}</pre>

</div>

</body></html>