Blame - docs/dyn/displayvideo_v1.advertisers.creatives.html - platform/external/python/google-api-python-client

<h1><a href="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.creatives.html">creatives</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

<p class="firstline">Creates a new creative.</p>

80

81

<code><a href="#delete">delete(advertiserId, creativeId, x__xgafv=None)</a></code></p>

82

<p class="firstline">Deletes a creative.</p>

83

84

<code><a href="#get">get(advertiserId, creativeId, x__xgafv=None)</a></code></p>

85

<p class="firstline">Gets a creative.</p>

86

87

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

88

<p class="firstline">Lists creatives in an advertiser.</p>

89

90

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

91

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

92

93

<code><a href="#patch">patch(advertiserId, creativeId, body=None, updateMask=None, x__xgafv=None)</a></code></p>

94

<p class="firstline">Updates an existing creative.</p>

95

<h3>Method Details</h3>

96

97

<code class="details" id="create">create(advertiserId, body=None, x__xgafv=None)</code>

98

<pre>Creates a new creative.

99

Returns the newly created creative if successful.

100

101

Args:

102

advertiserId: string, Output only. The unique ID of the advertiser the creative belongs to. (required)

103

body: object, The request body.

104

The object takes the form of:

105

106

{ # A single Creative.

107

"counterEvents": [ # Counter events for a rich media creative.

108

# Counters track the number of times that a user interacts with any part of a

109

# rich media creative in a specified way (mouse-overs, mouse-outs, clicks,

110

# taps, data loading, keyboard entries, etc.).

111

# Any event that can be captured in the creative can be recorded as a

112

# counter.

113

# Leave it empty or unset for creatives containing image assets only.

114

{ # Counter event of the creative.

115

"reportingName": "A String", # Required. The name used to identify this counter event in reports.

116

"name": "A String", # Required. The name of the counter event.

117

},

118

],

119

"reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.

120

"creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.

121

"exchangeReviewStatuses": [ # Exchange review statuses for the creative.

122

{ # Exchange review status for the creative.

123

"exchange": "A String", # The exchange reviewing the creative.

124

"status": "A String", # Status of the exchange review.

125

},

126

],

127

"contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.

128

"publisherReviewStatuses": [ # Publisher review statuses for the creative.

129

{ # Publisher review status for the creative.

130

"status": "A String", # Status of the publisher review.

131

"publisherName": "A String", # The publisher reviewing the creative.

132

},

133

],

134

"approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving.

135

# Summary of

136

# creative_and_landing_page_review_status

137

# and

138

# content_and_policy_review_status.

139

},

140

"advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.

141

"updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by

142

# the system.

143

"progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view.

144

#

145

# This field is required when skippable is true.

146

#

147

# This field is only supported for the following

148

# creative_type:

149

#

150

# * `CREATIVE_TYPE_VIDEO`

151

"percentage": "A String", # The offset in percentage of the audio or video duration.

152

"seconds": "A String", # The offset in seconds from the start of the audio or video.

153

},

154

"universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique

155

# across all platforms.

156

#

157

# Universal Ad ID is part of the VAST 4.0 standard. It can be modified after

158

# the creative is created.

159

#

160

# This field is only supported for the following

161

# creative_type:

162

#

163

# * `CREATIVE_TYPE_VIDEO`

164

# platforms. This is part of the VAST 4.0 standard.

165

"id": "A String", # The unique creative identifier.

166

"registry": "A String", # The registry provides unique creative identifiers.

167

},

168

"transcodes": [ # Output only. Audio/Video transcodes.

169

#

170

# Display & Video 360 transcodes the main asset into a number of alternative

171

# versions that use different file formats or have different properties

172

# (resolution, audio bit rate, and video bit rate), each designed for

173

# specific video players or bandwidths.

174

#

175

# These transcodes give a publisher's system more options to choose from for

176

# each impression on your video and ensures that the appropriate file serves

177

# based on the viewer’s connection and screen size.

178

#

179

# This field is only supported in following

180

# creative_type:

181

#

182

# * `CREATIVE_TYPE_VIDEO`

183

# * `CREATIVE_TYPE_NATIVE_VIDEO`

184

# * `CREATIVE_TYPE_AUDIO`

185

{ # Represents information about the transcoded audio or video file.

186

"transcoded": True or False, # Indicates if the transcoding was successful.

187

"audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate

188

# for the transcoded audio, in kilobits per second.

189

"fileSizeBytes": "A String", # The size of the transcoded file, in bytes.

190

"name": "A String", # The name of the transcoded file.

191

"mimeType": "A String", # The MIME type of the transcoded file.

192

"bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.

193

"dimensions": { # Dimensions. # The dimensions of the transcoded video.

194

"widthPixels": 42, # The width in pixels.

195

"heightPixels": 42, # The height in pixels.

196

},

197

"frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.

198

"audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample

199

# rate for the transcoded audio, in hertz.

200

},

201

],

202

"cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative.

203

#

204

# Optional for the following creative_type when

205

# created by an advertiser that uses both Campaign Manager and third-party ad

206

# serving:

207

#

208

# * `CREATIVE_TYPE_NATIVE`

209

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

210

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

211

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

212

#

213

# Output only for other cases.

214

"cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad.

215

"cmAdId": "A String", # The ad ID of the campaign manager tracking Ad.

216

"cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad.

217

},

218

"html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support.

219

#

220

# Output only and only valid for third-party VAST tag creatives.

221

#

222

# Third-party VAST tag creatives are creatives with following

223

# hosting_source:

224

#

225

# * `HOSTING_SOURCE_THIRD_PARTY`

226

#

227

# combined with following creative_type:

228

#

229

# * `CREATIVE_TYPE_VIDEO`

230

"requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution.

231

#

232

# Only valid when using a Campaign Manager tracking ad with a third-party ad

233

# server parameter and the ${DC_DBM_TOKEN} macro.

234

#

235

# Optional and only valid for third-party tag creatives or third-party VAST

236

# tag creatives.

237

#

238

# Third-party tag creatives are creatives with following

239

# hosting_source:

240

#

241

# * `HOSTING_SOURCE_THIRD_PARTY`

242

#

243

# combined with following creative_type:

244

#

245

# * `CREATIVE_TYPE_STANDARD`

246

# * `CREATIVE_TYPE_EXPANDABLE`

247

#

248

# Third-party VAST tag creatives are creatives with following

249

# hosting_source:

250

#

251

# * `HOSTING_SOURCE_THIRD_PARTY`

252

#

253

# combined with following creative_type:

254

#

255

# * `CREATIVE_TYPE_VIDEO`

256

"dimensions": { # Dimensions. # Required. Primary dimensions of the creative.

257

# Applicable to all creative types. The value of

258

# width_pixels and

259

# height_pixels defaults to `0`

260

# when creative_type is one of:

261

#

262

# * `CREATIVE_TYPE_VIDEO`

263

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL`

264

# * `CREATIVE_TYPE_AUDIO`

265

# * `CREATIVE_TYPE_NATIVE_VIDEO`

266

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`

267

"widthPixels": 42, # The width in pixels.

268

"heightPixels": 42, # The height in pixels.

269

},

270

"appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag.

271

"creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.

272

"A String",

273

],

274

"creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.

275

"entityStatus": "A String", # Required. Controls whether or not the creative can serve.

276

#

277

# Accepted values are:

278

#

279

# * `ENTITY_STATUS_ACTIVE`

280

# * `ENTITY_STATUS_ARCHIVED`

281

# * `ENTITY_STATUS_PAUSED`

282

"skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.

283

#

284

# This field is required when skippable is true.

285

#

286

# This field is only supported for the following

287

# creative_type:

288

#

289

# * `CREATIVE_TYPE_VIDEO`

290

"percentage": "A String", # The offset in percentage of the audio or video duration.

291

"seconds": "A String", # The offset in seconds from the start of the audio or video.

292

},

293

"requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly.

294

#

295

# Optional and only valid for third-party tag creatives.

296

# Third-party tag creatives are creatives with following

297

# hosting_source:

298

#

299

# * `HOSTING_SOURCE_THIRD_PARTY`

300

#

301

# combined with following creative_type:

302

#

303

# * `CREATIVE_TYPE_STANDARD`

304

# * `CREATIVE_TYPE_EXPANDABLE`

305

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

306

"skippable": True or False, # Whether the user can choose to skip a video creative.

307

#

308

# This field is only supported for the following

309

# creative_type:

310

#

311

# * `CREATIVE_TYPE_VIDEO`

312

"jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification

313

# providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not

314

# supported.

315

#

316

# This field is only supported in following

317

# creative_type:

318

#

319

# * `CREATIVE_TYPE_NATIVE`

320

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

321

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

322

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

323

# * `CREATIVE_TYPE_NATIVE_VIDEO`

324

"thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video

325

# creative.

326

#

327

# This field is only supported for the following

328

# creative_type:

329

#

330

# * `CREATIVE_TYPE_AUDIO`

331

# * `CREATIVE_TYPE_VIDEO`

332

# * `CREATIVE_TYPE_NATIVE_VIDEO`

333

{ # Tracking URLs from third parties to track interactions with an audio or a

334

# video creative.

335

"url": "A String", # Tracking URL used to track the interaction.

336

#

337

# Provide a URL with optional path or query string, beginning with `https:`.

338

# For example, https://www.example.com/path

339

"type": "A String", # The type of interaction needs to be tracked by the tracking URL

340

},

341

],

342

"expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover.

343

#

344

# Optional and only valid for third-party expandable creatives.

345

# Third-party expandable creatives are creatives with following hosting

346

# source:

347

#

348

# * `HOSTING_SOURCE_THIRD_PARTY`

349

#

350

# combined with following creative_type:

351

#

352

# * `CREATIVE_TYPE_EXPANDABLE`

353

"trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors.

354

#

355

# The URLs must start with https (except on inventory that doesn't require

356

# SSL compliance).

357

# If using macros in your URL, use only macros supported by Display & Video

358

# 360.

359

#

360

# Standard URLs only, no IMG or SCRIPT tags.

361

#

362

# This field is only supported in following

363

# creative_type:

364

#

365

# * `CREATIVE_TYPE_NATIVE`

366

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

367

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

368

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

369

# * `CREATIVE_TYPE_NATIVE_VIDEO`

370

"A String",

371

],

372

"createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by

373

# the system.

374

"additionalDimensions": [ # Additional dimensions.

375

# Applicable when creative_type is one of:

376

#

377

# * `CREATIVE_TYPE_STANDARD`

378

# * `CREATIVE_TYPE_EXPANDABLE`

379

# * `CREATIVE_TYPE_NATIVE`

380

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`

381

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

382

# * `CREATIVE_TYPE_LIGHTBOX`

383

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

384

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

385

# * `CREATIVE_TYPE_PUBLISHER_HOSTED`

386

#

387

# If this field is specified, width_pixels and

388

# height_pixels are both required and must be

389

# greater than or equal to 0.

390

{ # Dimensions.

391

"widthPixels": 42, # The width in pixels.

392

"heightPixels": 42, # The height in pixels.

393

},

394

],

395

"exitEvents": [ # Required. Exit events for this creative.

396

# An exit (also known as a click tag) is any area in your creative that

397

# someone can click or tap to open an advertiser's landing page.

398

# Every creative must include at least one exit.

399

# You can add an exit to your creative in any of the following ways:

400

#

401

# * Use Google Web Designer's tap area.

402

# * Define a JavaScript variable called "clickTag".

403

# * Use the Enabler (Enabler.exit()) to track exits in rich media formats.

404

{ # Exit event of the creative.

405

"name": "A String", # The name of the click tag of the exit event.

406

#

407

# The name must be unique within one creative.

408

#

409

# Leave it empty or unset for creatives containing image assets only.

410

"type": "A String", # Required. The type of the exit event.

411

"reportingName": "A String", # The name used to identify this event in reports.

412

# Leave it empty or unset for creatives containing image assets only.

413

"url": "A String", # Required. The click through URL of the exit event.

414

# This is required when type is:

415

#

416

# * `EXIT_EVENT_TYPE_DEFAULT`

417

# * `EXIT_EVENT_TYPE_BACKUP`

418

},

419

],

420

"iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled.

421

# To enable this for the creative, make sure the

422

# Advertiser.creative_config.ias_client_id

423

# has been set to your IAS client ID.

424

"integrationCode": "A String", # ID information used to link this creative to an external system.

425

# Must be UTF-8 encoded with a length of no more than 10,000 characters.

426

"cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the

427

# creative.

428

# This field is only applicable for creatives that are synced from Campaign

429

# Manager.

430

"requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface

431

# Definitions system).

432

#

433

# Set this if the creative relies on mobile gestures for interactivity, such

434

# as swiping or tapping.

435

#

436

# Optional and only valid for third-party tag creatives.

437

#

438

# Third-party tag creatives are creatives with following

439

# hosting_source:

440

#

441

# * `HOSTING_SOURCE_THIRD_PARTY`

442

#

443

# combined with following creative_type:

444

#

445

# * `CREATIVE_TYPE_STANDARD`

446

# * `CREATIVE_TYPE_EXPANDABLE`

447

"companionCreativeIds": [ # The IDs of companion creatives for a video creative.

448

#

449

# You can assign existing display creatives (with image or HTML5 assets)

450

# to serve surrounding the publisher's video player. Companions display

451

# around the video player while the video is playing and remain after the

452

# video has completed.

453

#

454

# Creatives contain additional dimensions

455

# can not be companion creatives.

456

#

457

# This field is only supported for following

458

# creative_type:

459

#

460

# * `CREATIVE_TYPE_AUDIO`

461

# * `CREATIVE_TYPE_VIDEO`

462

"A String",

463

],

464

"creativeType": "A String", # Required. Immutable. The type of the creative.

465

"obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.

466

#

467

# This field is only supported in following

468

# creative_type:

469

#

470

# * `CREATIVE_TYPE_VIDEO`

471

"viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon.

472

#

473

# Only URLs of the following domains are allowed:

474

#

475

# * https://info.evidon.com

476

# * https://l.betrad.com

477

"position": "A String", # The position of the OBA icon on the creative.

478

"clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon.

479

#

480

# Only URLs of the following domains are allowed:

481

#

482

# * https://info.evidon.com

483

# * https://l.betrad.com

484

"resourceUrl": "A String", # The URL of the OBA icon resource.

485

"landingPageUrl": "A String", # Required. The landing page URL of the OBA icon.

486

#

487

# Only URLs of the following domains are allowed:

488

#

489

# * https://info.evidon.com

490

# * https://l.betrad.com

491

"program": "A String", # The program of the OBA icon. For example: “AdChoices”.

492

"resourceMimeType": "A String", # The MIME type of the OBA icon resource.

493

"dimensions": { # Dimensions. # The dimensions of the OBA icon.

494

"widthPixels": 42, # The width in pixels.

495

"heightPixels": 42, # The height in pixels.

496

},

497

},

498

"timerEvents": [ # Timer custom events for a rich media creative.

499

# Timers track the time during which a user views and interacts with a

500

# specified part of a rich media creative.

501

# A creative can have multiple timer events, each timed independently.

502

# Leave it empty or unset for creatives containing image assets only.

503

{ # Timer event of the creative.

504

"reportingName": "A String", # Required. The name used to identify this timer event in reports.

505

"name": "A String", # Required. The name of the timer event.

506

},

507

],

508

"notes": "A String", # User notes for this creative.

509

# Must be UTF-8 encoded with a length of no more than 20,000 characters.

510

"dynamic": True or False, # Output only. Indicates whether the creative is dynamic.

511

"assets": [ # Required. Assets associated to this creative.

512

# Assets can be associated to the creative in one of following roles:

513

#

514

# * `ASSET_ROLE_UNSPECIFIED`

515

# * `ASSET_ROLE_MAIN`

516

# * `ASSET_ROLE_BACKUP`

517

# * `ASSET_ROLE_POLITE_LOAD`

518

{ # Asset association for the creative.

519

"asset": { # A single asset. # The associated asset.

520

"mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.

521

# This ID can be passed to other API calls, e.g.

522

# CreateCreative to associate

523

# the asset with a creative.

524

"content": "A String", # The asset content.

525

# For uploaded assets, the content is the serving path.

526

},

527

"role": "A String", # The role of this asset for the creative.

528

},

529

],

530

"vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video

531

# Player-Ad Interface).

532

#

533

# Output only and only valid for third-party VAST tag creatives.

534

#

535

# Third-party VAST tag creatives are creatives with following

536

# hosting_source:

537

#

538

# * `HOSTING_SOURCE_THIRD_PARTY`

539

#

540

# combined with following creative_type:

541

#

542

# * `CREATIVE_TYPE_VIDEO`

543

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative.

544

#

545

# Required and only valid for third-party expandable creatives.

546

#

547

# Third-party expandable creatives are creatives with following hosting

548

# source:

549

#

550

# * `HOSTING_SOURCE_THIRD_PARTY`

551

#

552

# combined with following creative_type:

553

#

554

# * `CREATIVE_TYPE_EXPANDABLE`

555

"thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative.

556

#

557

# Required and only valid for third-party tag creatives.

558

#

559

# Third-party tag creatives are creatives with following

560

# hosting_source:

561

#

562

# * `HOSTING_SOURCE_THIRD_PARTY`

563

#

564

# combined with following creative_type:

565

#

566

# * `CREATIVE_TYPE_STANDARD`

567

# * `CREATIVE_TYPE_EXPANDABLE`

568

"displayName": "A String", # Required. The display name of the creative.

569

#

570

# Must be UTF-8 encoded with a maximum size of 240 bytes.

571

"hostingSource": "A String", # Required. Indicates where the creative is hosted.

572

"vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative.

573

#

574

# Required and only valid for third-party VAST tag creatives.

575

#

576

# Third-party VAST tag creatives are creatives with following

577

# hosting_source:

578

#

579

# * `HOSTING_SOURCE_THIRD_PARTY`

580

#

581

# combined with following creative_type:

582

#

583

# * `CREATIVE_TYPE_VIDEO`

584

"mediaDuration": "A String", # Output only. Media duration of the creative.

585

# Applicable when creative_type

586

# is one of:

587

#

588

# * `CREATIVE_TYPE_VIDEO`

589

# * `CREATIVE_TYPE_AUDIO`

590

# * `CREATIVE_TYPE_NATIVE_VIDEO`

591

# * `CREATIVE_TYPE_PUBLISHER_HOSTED`

592

}

593

594

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

601

602

{ # A single Creative.

603

"counterEvents": [ # Counter events for a rich media creative.

604

# Counters track the number of times that a user interacts with any part of a

605

# rich media creative in a specified way (mouse-overs, mouse-outs, clicks,

606

# taps, data loading, keyboard entries, etc.).

607

# Any event that can be captured in the creative can be recorded as a

608

# counter.

609

# Leave it empty or unset for creatives containing image assets only.

610

{ # Counter event of the creative.

611

"reportingName": "A String", # Required. The name used to identify this counter event in reports.

612

"name": "A String", # Required. The name of the counter event.

613

},

614

],

615

"reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.

616

"creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.

617

"exchangeReviewStatuses": [ # Exchange review statuses for the creative.

618

{ # Exchange review status for the creative.

619

"exchange": "A String", # The exchange reviewing the creative.

620

"status": "A String", # Status of the exchange review.

621

},

622

],

623

"contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.

624

"publisherReviewStatuses": [ # Publisher review statuses for the creative.

625

{ # Publisher review status for the creative.

626

"status": "A String", # Status of the publisher review.

627

"publisherName": "A String", # The publisher reviewing the creative.

628

},

629

],

630

"approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving.

631

# Summary of

632

# creative_and_landing_page_review_status

633

# and

634

# content_and_policy_review_status.

635

},

636

"advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.

637

"updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by

638

# the system.

639

"progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view.

640

#

641

# This field is required when skippable is true.

642

#

643

# This field is only supported for the following

644

# creative_type:

645

#

646

# * `CREATIVE_TYPE_VIDEO`

647

"percentage": "A String", # The offset in percentage of the audio or video duration.

648

"seconds": "A String", # The offset in seconds from the start of the audio or video.

649

},

650

"universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique

651

# across all platforms.

652

#

653

# Universal Ad ID is part of the VAST 4.0 standard. It can be modified after

654

# the creative is created.

655

#

656

# This field is only supported for the following

657

# creative_type:

658

#

659

# * `CREATIVE_TYPE_VIDEO`

660

# platforms. This is part of the VAST 4.0 standard.

661

"id": "A String", # The unique creative identifier.

662

"registry": "A String", # The registry provides unique creative identifiers.

663

},

664

"transcodes": [ # Output only. Audio/Video transcodes.

665

#

666

# Display & Video 360 transcodes the main asset into a number of alternative

667

# versions that use different file formats or have different properties

668

# (resolution, audio bit rate, and video bit rate), each designed for

669

# specific video players or bandwidths.

670

#

671

# These transcodes give a publisher's system more options to choose from for

672

# each impression on your video and ensures that the appropriate file serves

673

# based on the viewer’s connection and screen size.

674

#

675

# This field is only supported in following

676

# creative_type:

677

#

678

# * `CREATIVE_TYPE_VIDEO`

679

# * `CREATIVE_TYPE_NATIVE_VIDEO`

680

# * `CREATIVE_TYPE_AUDIO`

681

{ # Represents information about the transcoded audio or video file.

682

"transcoded": True or False, # Indicates if the transcoding was successful.

683

"audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate

684

# for the transcoded audio, in kilobits per second.

685

"fileSizeBytes": "A String", # The size of the transcoded file, in bytes.

686

"name": "A String", # The name of the transcoded file.

687

"mimeType": "A String", # The MIME type of the transcoded file.

688

"bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.

689

"dimensions": { # Dimensions. # The dimensions of the transcoded video.

690

"widthPixels": 42, # The width in pixels.

691

"heightPixels": 42, # The height in pixels.

692

},

693

"frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.

694

"audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample

695

# rate for the transcoded audio, in hertz.

696

},

697

],

698

"cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative.

699

#

700

# Optional for the following creative_type when

701

# created by an advertiser that uses both Campaign Manager and third-party ad

702

# serving:

703

#

704

# * `CREATIVE_TYPE_NATIVE`

705

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

706

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

707

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

708

#

709

# Output only for other cases.

710

"cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad.

711

"cmAdId": "A String", # The ad ID of the campaign manager tracking Ad.

712

"cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad.

713

},

714

"html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support.

715

#

716

# Output only and only valid for third-party VAST tag creatives.

717

#

718

# Third-party VAST tag creatives are creatives with following

719

# hosting_source:

720

#

721

# * `HOSTING_SOURCE_THIRD_PARTY`

722

#

723

# combined with following creative_type:

724

#

725

# * `CREATIVE_TYPE_VIDEO`

726

"requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution.

727

#

728

# Only valid when using a Campaign Manager tracking ad with a third-party ad

729

# server parameter and the ${DC_DBM_TOKEN} macro.

730

#

731

# Optional and only valid for third-party tag creatives or third-party VAST

732

# tag creatives.

733

#

734

# Third-party tag creatives are creatives with following

735

# hosting_source:

736

#

737

# * `HOSTING_SOURCE_THIRD_PARTY`

738

#

739

# combined with following creative_type:

740

#

741

# * `CREATIVE_TYPE_STANDARD`

742

# * `CREATIVE_TYPE_EXPANDABLE`

743

#

744

# Third-party VAST tag creatives are creatives with following

745

# hosting_source:

746

#

747

# * `HOSTING_SOURCE_THIRD_PARTY`

748

#

749

# combined with following creative_type:

750

#

751

# * `CREATIVE_TYPE_VIDEO`

752

"dimensions": { # Dimensions. # Required. Primary dimensions of the creative.

753

# Applicable to all creative types. The value of

754

# width_pixels and

755

# height_pixels defaults to `0`

756

# when creative_type is one of:

757

#

758

# * `CREATIVE_TYPE_VIDEO`

759

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL`

760

# * `CREATIVE_TYPE_AUDIO`

761

# * `CREATIVE_TYPE_NATIVE_VIDEO`

762

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`

763

"widthPixels": 42, # The width in pixels.

764

"heightPixels": 42, # The height in pixels.

765

},

766

"appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag.

767

"creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.

768

"A String",

769

],

770

"creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.

771

"entityStatus": "A String", # Required. Controls whether or not the creative can serve.

772

#

773

# Accepted values are:

774

#

775

# * `ENTITY_STATUS_ACTIVE`

776

# * `ENTITY_STATUS_ARCHIVED`

777

# * `ENTITY_STATUS_PAUSED`

778

"skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.

779

#

780

# This field is required when skippable is true.

781

#

782

# This field is only supported for the following

783

# creative_type:

784

#

785

# * `CREATIVE_TYPE_VIDEO`

786

"percentage": "A String", # The offset in percentage of the audio or video duration.

787

"seconds": "A String", # The offset in seconds from the start of the audio or video.

788

},

789

"requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly.

790

#

791

# Optional and only valid for third-party tag creatives.

792

# Third-party tag creatives are creatives with following

793

# hosting_source:

794

#

795

# * `HOSTING_SOURCE_THIRD_PARTY`

796

#

797

# combined with following creative_type:

798

#

799

# * `CREATIVE_TYPE_STANDARD`

800

# * `CREATIVE_TYPE_EXPANDABLE`

801

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

802

"skippable": True or False, # Whether the user can choose to skip a video creative.

803

#

804

# This field is only supported for the following

805

# creative_type:

806

#

807

# * `CREATIVE_TYPE_VIDEO`

808

"jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification

809

# providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not

810

# supported.

811

#

812

# This field is only supported in following

813

# creative_type:

814

#

815

# * `CREATIVE_TYPE_NATIVE`

816

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

817

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

818

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

819

# * `CREATIVE_TYPE_NATIVE_VIDEO`

820

"thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video

821

# creative.

822

#

823

# This field is only supported for the following

824

# creative_type:

825

#

826

# * `CREATIVE_TYPE_AUDIO`

827

# * `CREATIVE_TYPE_VIDEO`

828

# * `CREATIVE_TYPE_NATIVE_VIDEO`

829

{ # Tracking URLs from third parties to track interactions with an audio or a

830

# video creative.

831

"url": "A String", # Tracking URL used to track the interaction.

832

#

833

# Provide a URL with optional path or query string, beginning with `https:`.

834

# For example, https://www.example.com/path

835

"type": "A String", # The type of interaction needs to be tracked by the tracking URL

836

},

837

],

838

"expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover.

839

#

840

# Optional and only valid for third-party expandable creatives.

841

# Third-party expandable creatives are creatives with following hosting

842

# source:

843

#

844

# * `HOSTING_SOURCE_THIRD_PARTY`

845

#

846

# combined with following creative_type:

847

#

848

# * `CREATIVE_TYPE_EXPANDABLE`

849

"trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors.

850

#

851

# The URLs must start with https (except on inventory that doesn't require

852

# SSL compliance).

853

# If using macros in your URL, use only macros supported by Display & Video

854

# 360.

855

#

856

# Standard URLs only, no IMG or SCRIPT tags.

857

#

858

# This field is only supported in following

859

# creative_type:

860

#

861

# * `CREATIVE_TYPE_NATIVE`

862

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

863

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

864

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

865

# * `CREATIVE_TYPE_NATIVE_VIDEO`

866

"A String",

867

],

868

"createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by

869

# the system.

870

"additionalDimensions": [ # Additional dimensions.

871

# Applicable when creative_type is one of:

872

#

873

# * `CREATIVE_TYPE_STANDARD`

874

# * `CREATIVE_TYPE_EXPANDABLE`

875

# * `CREATIVE_TYPE_NATIVE`

876

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`

877

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

878

# * `CREATIVE_TYPE_LIGHTBOX`

879

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

880

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

881

# * `CREATIVE_TYPE_PUBLISHER_HOSTED`

882

#

883

# If this field is specified, width_pixels and

884

# height_pixels are both required and must be

885

# greater than or equal to 0.

886

{ # Dimensions.

887

"widthPixels": 42, # The width in pixels.

888

"heightPixels": 42, # The height in pixels.

889

},

890

],

891

"exitEvents": [ # Required. Exit events for this creative.

892

# An exit (also known as a click tag) is any area in your creative that

893

# someone can click or tap to open an advertiser's landing page.

894

# Every creative must include at least one exit.

895

# You can add an exit to your creative in any of the following ways:

896

#

897

# * Use Google Web Designer's tap area.

898

# * Define a JavaScript variable called "clickTag".

899

# * Use the Enabler (Enabler.exit()) to track exits in rich media formats.

900

{ # Exit event of the creative.

901

"name": "A String", # The name of the click tag of the exit event.

902

#

903

# The name must be unique within one creative.

904

#

905

# Leave it empty or unset for creatives containing image assets only.

906

"type": "A String", # Required. The type of the exit event.

907

"reportingName": "A String", # The name used to identify this event in reports.

908

# Leave it empty or unset for creatives containing image assets only.

909

"url": "A String", # Required. The click through URL of the exit event.

910

# This is required when type is:

911

#

912

# * `EXIT_EVENT_TYPE_DEFAULT`

913

# * `EXIT_EVENT_TYPE_BACKUP`

914

},

915

],

916

"iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled.

917

# To enable this for the creative, make sure the

918

# Advertiser.creative_config.ias_client_id

919

# has been set to your IAS client ID.

920

"integrationCode": "A String", # ID information used to link this creative to an external system.

921

# Must be UTF-8 encoded with a length of no more than 10,000 characters.

922

"cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the

923

# creative.

924

# This field is only applicable for creatives that are synced from Campaign

925

# Manager.

926

"requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface

927

# Definitions system).

928

#

929

# Set this if the creative relies on mobile gestures for interactivity, such

930

# as swiping or tapping.

931

#

932

# Optional and only valid for third-party tag creatives.

933

#

934

# Third-party tag creatives are creatives with following

935

# hosting_source:

936

#

937

# * `HOSTING_SOURCE_THIRD_PARTY`

938

#

939

# combined with following creative_type:

940

#

941

# * `CREATIVE_TYPE_STANDARD`

942

# * `CREATIVE_TYPE_EXPANDABLE`

943

"companionCreativeIds": [ # The IDs of companion creatives for a video creative.

944

#

945

# You can assign existing display creatives (with image or HTML5 assets)

946

# to serve surrounding the publisher's video player. Companions display

947

# around the video player while the video is playing and remain after the

948

# video has completed.

949

#

950

# Creatives contain additional dimensions

951

# can not be companion creatives.

952

#

953

# This field is only supported for following

954

# creative_type:

955

#

956

# * `CREATIVE_TYPE_AUDIO`

957

# * `CREATIVE_TYPE_VIDEO`

958

"A String",

959

],

960

"creativeType": "A String", # Required. Immutable. The type of the creative.

961

"obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.

962

#

963

# This field is only supported in following

964

# creative_type:

965

#

966

# * `CREATIVE_TYPE_VIDEO`

967

"viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon.

968

#

969

# Only URLs of the following domains are allowed:

970

#

971

# * https://info.evidon.com

972

# * https://l.betrad.com

973

"position": "A String", # The position of the OBA icon on the creative.

974

"clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon.

975

#

976

# Only URLs of the following domains are allowed:

977

#

978

# * https://info.evidon.com

979

# * https://l.betrad.com

980

"resourceUrl": "A String", # The URL of the OBA icon resource.

981

"landingPageUrl": "A String", # Required. The landing page URL of the OBA icon.

982

#

983

# Only URLs of the following domains are allowed:

984

#

985

# * https://info.evidon.com

986

# * https://l.betrad.com

987

"program": "A String", # The program of the OBA icon. For example: “AdChoices”.

988

"resourceMimeType": "A String", # The MIME type of the OBA icon resource.

989

"dimensions": { # Dimensions. # The dimensions of the OBA icon.

990

"widthPixels": 42, # The width in pixels.

991

"heightPixels": 42, # The height in pixels.

992

},

993

},

994

"timerEvents": [ # Timer custom events for a rich media creative.

995

# Timers track the time during which a user views and interacts with a

996

# specified part of a rich media creative.

997

# A creative can have multiple timer events, each timed independently.

998

# Leave it empty or unset for creatives containing image assets only.

999

{ # Timer event of the creative.

1000

"reportingName": "A String", # Required. The name used to identify this timer event in reports.

1001

"name": "A String", # Required. The name of the timer event.

1002

},

1003

],

1004

"notes": "A String", # User notes for this creative.

1005

# Must be UTF-8 encoded with a length of no more than 20,000 characters.

1006

"dynamic": True or False, # Output only. Indicates whether the creative is dynamic.

1007

"assets": [ # Required. Assets associated to this creative.

1008

# Assets can be associated to the creative in one of following roles:

1009

#

1010

# * `ASSET_ROLE_UNSPECIFIED`

1011

# * `ASSET_ROLE_MAIN`

1012

# * `ASSET_ROLE_BACKUP`

1013

# * `ASSET_ROLE_POLITE_LOAD`

1014

{ # Asset association for the creative.

1015

"asset": { # A single asset. # The associated asset.

1016

"mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.

1017

# This ID can be passed to other API calls, e.g.

1018

# CreateCreative to associate

1019

# the asset with a creative.

1020

"content": "A String", # The asset content.

1021

# For uploaded assets, the content is the serving path.

1022

},

1023

"role": "A String", # The role of this asset for the creative.

1024

},

1025

],

1026

"vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video

1027

# Player-Ad Interface).

1028

#

1029

# Output only and only valid for third-party VAST tag creatives.

1030

#

1031

# Third-party VAST tag creatives are creatives with following

1032

# hosting_source:

1033

#

1034

# * `HOSTING_SOURCE_THIRD_PARTY`

1035

#

1036

# combined with following creative_type:

1037

#

1038

# * `CREATIVE_TYPE_VIDEO`

1039

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative.

1040

#

1041

# Required and only valid for third-party expandable creatives.

1042

#

1043

# Third-party expandable creatives are creatives with following hosting

1044

# source:

1045

#

1046

# * `HOSTING_SOURCE_THIRD_PARTY`

1047

#

1048

# combined with following creative_type:

1049

#

1050

# * `CREATIVE_TYPE_EXPANDABLE`

1051

"thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative.

1052

#

1053

# Required and only valid for third-party tag creatives.

1054

#

1055

# Third-party tag creatives are creatives with following

1056

# hosting_source:

1057

#

1058

# * `HOSTING_SOURCE_THIRD_PARTY`

1059

#

1060

# combined with following creative_type:

1061

#

1062

# * `CREATIVE_TYPE_STANDARD`

1063

# * `CREATIVE_TYPE_EXPANDABLE`

1064

"displayName": "A String", # Required. The display name of the creative.

1065

#

1066

# Must be UTF-8 encoded with a maximum size of 240 bytes.

1067

"hostingSource": "A String", # Required. Indicates where the creative is hosted.

1068

"vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative.

1069

#

1070

# Required and only valid for third-party VAST tag creatives.

1071

#

1072

# Third-party VAST tag creatives are creatives with following

1073

# hosting_source:

1074

#

1075

# * `HOSTING_SOURCE_THIRD_PARTY`

1076

#

1077

# combined with following creative_type:

1078

#

1079

# * `CREATIVE_TYPE_VIDEO`

1080

"mediaDuration": "A String", # Output only. Media duration of the creative.

1081

# Applicable when creative_type

1082

# is one of:

1083

#

1084

# * `CREATIVE_TYPE_VIDEO`

1085

# * `CREATIVE_TYPE_AUDIO`

1086

# * `CREATIVE_TYPE_NATIVE_VIDEO`

1087

# * `CREATIVE_TYPE_PUBLISHER_HOSTED`

}</pre>

</div>

<code class="details" id="delete">delete(advertiserId, creativeId, x__xgafv=None)</code>

1093

<pre>Deletes a creative.

1094

Returns error code `NOT_FOUND` if the creative does not exist.

1095

The creative should be archived first, i.e. set

1096

entity_status to `ENTITY_STATUS_ARCHIVED`, before

it can be deleted.

Args:

advertiserId: string, The ID of the advertiser this creative belongs to. (required)

1101

creativeId: string, The ID of the creative to be deleted. (required)

1102

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1109

1110

{ # A generic empty message that you can re-use to avoid defining duplicated

1111

# empty messages in your APIs. A typical example is to use it as the request

1112

# or the response type of an API method. For instance:

1113

#

1114

# service Foo {

1115

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

1116

# }

1117

#

1118

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="get">get(advertiserId, creativeId, x__xgafv=None)</code>

1124

<pre>Gets a creative.

1125

1126

Args:

1127

advertiserId: string, Required. The ID of the advertiser this creative belongs to. (required)

1128

creativeId: string, Required. The ID of the creative to fetch. (required)

1129

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1136

1137

{ # A single Creative.

1138

"counterEvents": [ # Counter events for a rich media creative.

1139

# Counters track the number of times that a user interacts with any part of a

1140

# rich media creative in a specified way (mouse-overs, mouse-outs, clicks,

1141

# taps, data loading, keyboard entries, etc.).

1142

# Any event that can be captured in the creative can be recorded as a

1143

# counter.

1144

# Leave it empty or unset for creatives containing image assets only.

1145

{ # Counter event of the creative.

1146

"reportingName": "A String", # Required. The name used to identify this counter event in reports.

1147

"name": "A String", # Required. The name of the counter event.

1148

},

1149

],

1150

"reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.

1151

"creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.

1152

"exchangeReviewStatuses": [ # Exchange review statuses for the creative.

1153

{ # Exchange review status for the creative.

1154

"exchange": "A String", # The exchange reviewing the creative.

1155

"status": "A String", # Status of the exchange review.

1156

},

1157

],

1158

"contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.

1159

"publisherReviewStatuses": [ # Publisher review statuses for the creative.

1160

{ # Publisher review status for the creative.

1161

"status": "A String", # Status of the publisher review.

1162

"publisherName": "A String", # The publisher reviewing the creative.

1163

},

1164

],

1165

"approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving.

1166

# Summary of

1167

# creative_and_landing_page_review_status

1168

# and

1169

# content_and_policy_review_status.

1170

},

1171

"advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.

1172

"updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by

1173

# the system.

1174

"progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view.

1175

#

1176

# This field is required when skippable is true.

1177

#

1178

# This field is only supported for the following

1179

# creative_type:

1180

#

1181

# * `CREATIVE_TYPE_VIDEO`

1182

"percentage": "A String", # The offset in percentage of the audio or video duration.

1183

"seconds": "A String", # The offset in seconds from the start of the audio or video.

1184

},

1185

"universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique

1186

# across all platforms.

1187

#

1188

# Universal Ad ID is part of the VAST 4.0 standard. It can be modified after

1189

# the creative is created.

1190

#

1191

# This field is only supported for the following

1192

# creative_type:

1193

#

1194

# * `CREATIVE_TYPE_VIDEO`

1195

# platforms. This is part of the VAST 4.0 standard.

1196

"id": "A String", # The unique creative identifier.

1197

"registry": "A String", # The registry provides unique creative identifiers.

1198

},

1199

"transcodes": [ # Output only. Audio/Video transcodes.

1200

#

1201

# Display & Video 360 transcodes the main asset into a number of alternative

1202

# versions that use different file formats or have different properties

1203

# (resolution, audio bit rate, and video bit rate), each designed for

1204

# specific video players or bandwidths.

1205

#

1206

# These transcodes give a publisher's system more options to choose from for

1207

# each impression on your video and ensures that the appropriate file serves

1208

# based on the viewer’s connection and screen size.

1209

#

1210

# This field is only supported in following

1211

# creative_type:

1212

#

1213

# * `CREATIVE_TYPE_VIDEO`

1214

# * `CREATIVE_TYPE_NATIVE_VIDEO`

1215

# * `CREATIVE_TYPE_AUDIO`

1216

{ # Represents information about the transcoded audio or video file.

1217

"transcoded": True or False, # Indicates if the transcoding was successful.

1218

"audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate

1219

# for the transcoded audio, in kilobits per second.

1220

"fileSizeBytes": "A String", # The size of the transcoded file, in bytes.

1221

"name": "A String", # The name of the transcoded file.

1222

"mimeType": "A String", # The MIME type of the transcoded file.

1223

"bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.

1224

"dimensions": { # Dimensions. # The dimensions of the transcoded video.

1225

"widthPixels": 42, # The width in pixels.

1226

"heightPixels": 42, # The height in pixels.

1227

},

1228

"frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.

1229

"audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample

1230

# rate for the transcoded audio, in hertz.

1231

},

1232

],

1233

"cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative.

1234

#

1235

# Optional for the following creative_type when

1236

# created by an advertiser that uses both Campaign Manager and third-party ad

1237

# serving:

1238

#

1239

# * `CREATIVE_TYPE_NATIVE`

1240

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

1241

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

1242

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

1243

#

1244

# Output only for other cases.

1245

"cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad.

1246

"cmAdId": "A String", # The ad ID of the campaign manager tracking Ad.

1247

"cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad.

1248

},

1249

"html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support.

1250

#

1251

# Output only and only valid for third-party VAST tag creatives.

1252

#

1253

# Third-party VAST tag creatives are creatives with following

1254

# hosting_source:

1255

#

1256

# * `HOSTING_SOURCE_THIRD_PARTY`

1257

#

1258

# combined with following creative_type:

1259

#

1260

# * `CREATIVE_TYPE_VIDEO`

1261

"requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution.

1262

#

1263

# Only valid when using a Campaign Manager tracking ad with a third-party ad

1264

# server parameter and the ${DC_DBM_TOKEN} macro.

1265

#

1266

# Optional and only valid for third-party tag creatives or third-party VAST

1267

# tag creatives.

1268

#

1269

# Third-party tag creatives are creatives with following

1270

# hosting_source:

1271

#

1272

# * `HOSTING_SOURCE_THIRD_PARTY`

1273

#

1274

# combined with following creative_type:

1275

#

1276

# * `CREATIVE_TYPE_STANDARD`

1277

# * `CREATIVE_TYPE_EXPANDABLE`

1278

#

1279

# Third-party VAST tag creatives are creatives with following

1280

# hosting_source:

1281

#

1282

# * `HOSTING_SOURCE_THIRD_PARTY`

1283

#

1284

# combined with following creative_type:

1285

#

1286

# * `CREATIVE_TYPE_VIDEO`

1287

"dimensions": { # Dimensions. # Required. Primary dimensions of the creative.

1288

# Applicable to all creative types. The value of

1289

# width_pixels and

1290

# height_pixels defaults to `0`

1291

# when creative_type is one of:

1292

#

1293

# * `CREATIVE_TYPE_VIDEO`

1294

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL`

1295

# * `CREATIVE_TYPE_AUDIO`

1296

# * `CREATIVE_TYPE_NATIVE_VIDEO`

1297

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`

1298

"widthPixels": 42, # The width in pixels.

1299

"heightPixels": 42, # The height in pixels.

1300

},

1301

"appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag.

1302

"creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.

1303

"A String",

1304

],

1305

"creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.

1306

"entityStatus": "A String", # Required. Controls whether or not the creative can serve.

1307

#

1308

# Accepted values are:

1309

#

1310

# * `ENTITY_STATUS_ACTIVE`

1311

# * `ENTITY_STATUS_ARCHIVED`

1312

# * `ENTITY_STATUS_PAUSED`

1313

"skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.

1314

#

1315

# This field is required when skippable is true.

1316

#

1317

# This field is only supported for the following

1318

# creative_type:

1319

#

1320

# * `CREATIVE_TYPE_VIDEO`

1321

"percentage": "A String", # The offset in percentage of the audio or video duration.

1322

"seconds": "A String", # The offset in seconds from the start of the audio or video.

1323

},

1324

"requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly.

1325

#

1326

# Optional and only valid for third-party tag creatives.

1327

# Third-party tag creatives are creatives with following

1328

# hosting_source:

1329

#

1330

# * `HOSTING_SOURCE_THIRD_PARTY`

1331

#

1332

# combined with following creative_type:

1333

#

1334

# * `CREATIVE_TYPE_STANDARD`

1335

# * `CREATIVE_TYPE_EXPANDABLE`

1336

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

1337

"skippable": True or False, # Whether the user can choose to skip a video creative.

1338

#

1339

# This field is only supported for the following

1340

# creative_type:

1341

#

1342

# * `CREATIVE_TYPE_VIDEO`

1343

"jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification

1344

# providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not

1345

# supported.

1346

#

1347

# This field is only supported in following

1348

# creative_type:

1349

#

1350

# * `CREATIVE_TYPE_NATIVE`

1351

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

1352

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

1353

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

1354

# * `CREATIVE_TYPE_NATIVE_VIDEO`

1355

"thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video

1356

# creative.

1357

#

1358

# This field is only supported for the following

1359

# creative_type:

1360

#

1361

# * `CREATIVE_TYPE_AUDIO`

1362

# * `CREATIVE_TYPE_VIDEO`

1363

# * `CREATIVE_TYPE_NATIVE_VIDEO`

1364

{ # Tracking URLs from third parties to track interactions with an audio or a

1365

# video creative.

1366

"url": "A String", # Tracking URL used to track the interaction.

1367

#

1368

# Provide a URL with optional path or query string, beginning with `https:`.

1369

# For example, https://www.example.com/path

1370

"type": "A String", # The type of interaction needs to be tracked by the tracking URL

1371

},

1372

],

1373

"expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover.

1374

#

1375

# Optional and only valid for third-party expandable creatives.

1376

# Third-party expandable creatives are creatives with following hosting

1377

# source:

1378

#

1379

# * `HOSTING_SOURCE_THIRD_PARTY`

1380

#

1381

# combined with following creative_type:

1382

#

1383

# * `CREATIVE_TYPE_EXPANDABLE`

1384

"trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors.

1385

#

1386

# The URLs must start with https (except on inventory that doesn't require

1387

# SSL compliance).

1388

# If using macros in your URL, use only macros supported by Display & Video

1389

# 360.

1390

#

1391

# Standard URLs only, no IMG or SCRIPT tags.

1392

#

1393

# This field is only supported in following

1394

# creative_type:

1395

#

1396

# * `CREATIVE_TYPE_NATIVE`

1397

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

1398

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

1399

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

1400

# * `CREATIVE_TYPE_NATIVE_VIDEO`

1401

"A String",

1402

],

1403

"createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by

1404

# the system.

1405

"additionalDimensions": [ # Additional dimensions.

1406

# Applicable when creative_type is one of:

1407

#

1408

# * `CREATIVE_TYPE_STANDARD`

1409

# * `CREATIVE_TYPE_EXPANDABLE`

1410

# * `CREATIVE_TYPE_NATIVE`

1411

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`

1412

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

1413

# * `CREATIVE_TYPE_LIGHTBOX`

1414

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

1415

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

1416

# * `CREATIVE_TYPE_PUBLISHER_HOSTED`

1417

#

1418

# If this field is specified, width_pixels and

1419

# height_pixels are both required and must be

1420

# greater than or equal to 0.

1421

{ # Dimensions.

1422

"widthPixels": 42, # The width in pixels.

1423

"heightPixels": 42, # The height in pixels.

1424

},

1425

],

1426

"exitEvents": [ # Required. Exit events for this creative.

1427

# An exit (also known as a click tag) is any area in your creative that

1428

# someone can click or tap to open an advertiser's landing page.

1429

# Every creative must include at least one exit.

1430

# You can add an exit to your creative in any of the following ways:

1431

#

1432

# * Use Google Web Designer's tap area.

1433

# * Define a JavaScript variable called "clickTag".

1434

# * Use the Enabler (Enabler.exit()) to track exits in rich media formats.

1435

{ # Exit event of the creative.

1436

"name": "A String", # The name of the click tag of the exit event.

1437

#

1438

# The name must be unique within one creative.

1439

#

1440

# Leave it empty or unset for creatives containing image assets only.

1441

"type": "A String", # Required. The type of the exit event.

1442

"reportingName": "A String", # The name used to identify this event in reports.

1443

# Leave it empty or unset for creatives containing image assets only.

1444

"url": "A String", # Required. The click through URL of the exit event.

1445

# This is required when type is:

1446

#

1447

# * `EXIT_EVENT_TYPE_DEFAULT`

1448

# * `EXIT_EVENT_TYPE_BACKUP`

1449

},

1450

],

1451

"iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled.

1452

# To enable this for the creative, make sure the

1453

# Advertiser.creative_config.ias_client_id

1454

# has been set to your IAS client ID.

1455

"integrationCode": "A String", # ID information used to link this creative to an external system.

1456

# Must be UTF-8 encoded with a length of no more than 10,000 characters.

1457

"cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the

1458

# creative.

1459

# This field is only applicable for creatives that are synced from Campaign

1460

# Manager.

1461

"requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface

1462

# Definitions system).

1463

#

1464

# Set this if the creative relies on mobile gestures for interactivity, such

1465

# as swiping or tapping.

1466

#

1467

# Optional and only valid for third-party tag creatives.

1468

#

1469

# Third-party tag creatives are creatives with following

1470

# hosting_source:

1471

#

1472

# * `HOSTING_SOURCE_THIRD_PARTY`

1473

#

1474

# combined with following creative_type:

1475

#

1476

# * `CREATIVE_TYPE_STANDARD`

1477

# * `CREATIVE_TYPE_EXPANDABLE`

1478

"companionCreativeIds": [ # The IDs of companion creatives for a video creative.

1479

#

1480

# You can assign existing display creatives (with image or HTML5 assets)

1481

# to serve surrounding the publisher's video player. Companions display

1482

# around the video player while the video is playing and remain after the

1483

# video has completed.

1484

#

1485

# Creatives contain additional dimensions

1486

# can not be companion creatives.

1487

#

1488

# This field is only supported for following

1489

# creative_type:

1490

#

1491

# * `CREATIVE_TYPE_AUDIO`

1492

# * `CREATIVE_TYPE_VIDEO`

1493

"A String",

1494

],

1495

"creativeType": "A String", # Required. Immutable. The type of the creative.

1496

"obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.

1497

#

1498

# This field is only supported in following

1499

# creative_type:

1500

#

1501

# * `CREATIVE_TYPE_VIDEO`

1502

"viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon.

1503

#

1504

# Only URLs of the following domains are allowed:

1505

#

1506

# * https://info.evidon.com

1507

# * https://l.betrad.com

1508

"position": "A String", # The position of the OBA icon on the creative.

1509

"clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon.

1510

#

1511

# Only URLs of the following domains are allowed:

1512

#

1513

# * https://info.evidon.com

1514

# * https://l.betrad.com

1515

"resourceUrl": "A String", # The URL of the OBA icon resource.

1516

"landingPageUrl": "A String", # Required. The landing page URL of the OBA icon.

1517

#

1518

# Only URLs of the following domains are allowed:

1519

#

1520

# * https://info.evidon.com

1521

# * https://l.betrad.com

1522

"program": "A String", # The program of the OBA icon. For example: “AdChoices”.

1523

"resourceMimeType": "A String", # The MIME type of the OBA icon resource.

1524

"dimensions": { # Dimensions. # The dimensions of the OBA icon.

1525

"widthPixels": 42, # The width in pixels.

1526

"heightPixels": 42, # The height in pixels.

1527

},

1528

},

1529

"timerEvents": [ # Timer custom events for a rich media creative.

1530

# Timers track the time during which a user views and interacts with a

1531

# specified part of a rich media creative.

1532

# A creative can have multiple timer events, each timed independently.

1533

# Leave it empty or unset for creatives containing image assets only.

1534

{ # Timer event of the creative.

1535

"reportingName": "A String", # Required. The name used to identify this timer event in reports.

1536

"name": "A String", # Required. The name of the timer event.

1537

},

1538

],

1539

"notes": "A String", # User notes for this creative.

1540

# Must be UTF-8 encoded with a length of no more than 20,000 characters.

1541

"dynamic": True or False, # Output only. Indicates whether the creative is dynamic.

1542

"assets": [ # Required. Assets associated to this creative.

1543

# Assets can be associated to the creative in one of following roles:

1544

#

1545

# * `ASSET_ROLE_UNSPECIFIED`

1546

# * `ASSET_ROLE_MAIN`

1547

# * `ASSET_ROLE_BACKUP`

1548

# * `ASSET_ROLE_POLITE_LOAD`

1549

{ # Asset association for the creative.

1550

"asset": { # A single asset. # The associated asset.

1551

"mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.

1552

# This ID can be passed to other API calls, e.g.

1553

# CreateCreative to associate

1554

# the asset with a creative.

1555

"content": "A String", # The asset content.

1556

# For uploaded assets, the content is the serving path.

1557

},

1558

"role": "A String", # The role of this asset for the creative.

1559

},

1560

],

1561

"vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video

1562

# Player-Ad Interface).

1563

#

1564

# Output only and only valid for third-party VAST tag creatives.

1565

#

1566

# Third-party VAST tag creatives are creatives with following

1567

# hosting_source:

1568

#

1569

# * `HOSTING_SOURCE_THIRD_PARTY`

1570

#

1571

# combined with following creative_type:

1572

#

1573

# * `CREATIVE_TYPE_VIDEO`

1574

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative.

1575

#

1576

# Required and only valid for third-party expandable creatives.

1577

#

1578

# Third-party expandable creatives are creatives with following hosting

1579

# source:

1580

#

1581

# * `HOSTING_SOURCE_THIRD_PARTY`

1582

#

1583

# combined with following creative_type:

1584

#

1585

# * `CREATIVE_TYPE_EXPANDABLE`

1586

"thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative.

1587

#

1588

# Required and only valid for third-party tag creatives.

1589

#

1590

# Third-party tag creatives are creatives with following

1591

# hosting_source:

1592

#

1593

# * `HOSTING_SOURCE_THIRD_PARTY`

1594

#

1595

# combined with following creative_type:

1596

#

1597

# * `CREATIVE_TYPE_STANDARD`

1598

# * `CREATIVE_TYPE_EXPANDABLE`

1599

"displayName": "A String", # Required. The display name of the creative.

1600

#

1601

# Must be UTF-8 encoded with a maximum size of 240 bytes.

1602

"hostingSource": "A String", # Required. Indicates where the creative is hosted.

1603

"vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative.

1604

#

1605

# Required and only valid for third-party VAST tag creatives.

1606

#

1607

# Third-party VAST tag creatives are creatives with following

1608

# hosting_source:

1609

#

1610

# * `HOSTING_SOURCE_THIRD_PARTY`

1611

#

1612

# combined with following creative_type:

1613

#

1614

# * `CREATIVE_TYPE_VIDEO`

1615

"mediaDuration": "A String", # Output only. Media duration of the creative.

1616

# Applicable when creative_type

1617

# is one of:

1618

#

1619

# * `CREATIVE_TYPE_VIDEO`

1620

# * `CREATIVE_TYPE_AUDIO`

1621

# * `CREATIVE_TYPE_NATIVE_VIDEO`

1622

# * `CREATIVE_TYPE_PUBLISHER_HOSTED`

}</pre>

</div>

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

1628

<pre>Lists creatives in an advertiser.

1629

1630

The order is defined by the order_by

1631

parameter.

1632

If a filter by

1633

entity_status is not specified, creatives with

1634

`ENTITY_STATUS_ARCHIVED` will not be included in the results.

1635

1636

Args:

1637

advertiserId: string, Required. The ID of the advertiser to list creatives for. (required)

1638

filter: string, Allows filtering by creative properties.

Supported syntax:

* Filter expressions are made up of one or more restrictions.

1643

* Restriction for the same field must be combined by `OR`.

1644

* Restriction for different fields must be combined by `AND`.

1645

* Between `(` and `)` there can only be restrictions combined by `OR`

1646

for the same field.

1647

* A restriction has the form of `{field} {operator} {value}`.

1648

* The operator must be `EQUALS (=)` for the following fields:

- `entityStatus`

- `creativeType`.

- `dimensions`

- `minDuration`

- `maxDuration`

- `approvalStatus`

- `exchangeReviewStatus`

1656

- `dynamic`

1657

* The operator must be `HAS (:)` for the following fields:

1658

- `lineItemIds`

1659

* For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may

1660

be at most one restriction.

1661

* For `dimensions`, the value is in the form of `"{width}x{height}"`.

1662

* For `exchangeReviewStatus`, the value is in the form of

1663

`{exchange}-{reviewStatus}`.

1664

* For `minDuration` and `maxDuration`, the value is in the form of

1665

`"{duration}s"`. Only seconds are supported with millisecond granularity.

1666

* There may be multiple `lineItemIds` restrictions in order to search

1667

against multiple possible line item IDs.

Examples:

* All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"`

1672

* All active creatives with 300x400 or 50x100 dimensions:

1673

`entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400"

1674

OR dimensions="50x100")`

1675

* All dynamic creatives that are approved by AdX or

1676

AppNexus, with a minimum duration of 5 seconds and 200ms.

1677

`dynamic="true" AND minDuration="5.2s" AND

1678

(exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED"

1679

OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")`

1680

* All video creatives that are associated with line item ID 1 or 2:

1681

creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)

1682

1683

The length of this field should be no more than 500 characters.

1684

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

1685

Typically, this is the value of

1686

next_page_token

1687

returned from the previous call to `ListCreatives` method.

1688

If not specified, the first page of results will be returned.

1689

orderBy: string, Field by which to sort the list.

1690

Acceptable values are:

1691

1692

* `creativeId` (default)

1693

* `createTime`

1694

* `mediaDuration`

1695

* `dimensions` (sorts by width first, then by height)

1696

1697

The default sorting order is ascending. To specify descending order for

1698

a field, a suffix "desc" should be added to the field name.

1699

Example: `createTime desc`.

1700

pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will

1701

default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value

1702

is specified.

1703

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1710

1711

{

1712

"creatives": [ # The list of creatives.

1713

#

1714

# This list will be absent if empty.

1715

{ # A single Creative.

1716

"counterEvents": [ # Counter events for a rich media creative.

1717

# Counters track the number of times that a user interacts with any part of a

1718

# rich media creative in a specified way (mouse-overs, mouse-outs, clicks,

1719

# taps, data loading, keyboard entries, etc.).

1720

# Any event that can be captured in the creative can be recorded as a

1721

# counter.

1722

# Leave it empty or unset for creatives containing image assets only.

1723

{ # Counter event of the creative.

1724

"reportingName": "A String", # Required. The name used to identify this counter event in reports.

1725

"name": "A String", # Required. The name of the counter event.

1726

},

1727

],

1728

"reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.

1729

"creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.

1730

"exchangeReviewStatuses": [ # Exchange review statuses for the creative.

1731

{ # Exchange review status for the creative.

1732

"exchange": "A String", # The exchange reviewing the creative.

1733

"status": "A String", # Status of the exchange review.

1734

},

1735

],

1736

"contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.

1737

"publisherReviewStatuses": [ # Publisher review statuses for the creative.

1738

{ # Publisher review status for the creative.

1739

"status": "A String", # Status of the publisher review.

1740

"publisherName": "A String", # The publisher reviewing the creative.

1741

},

1742

],

1743

"approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving.

1744

# Summary of

1745

# creative_and_landing_page_review_status

1746

# and

1747

# content_and_policy_review_status.

1748

},

1749

"advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.

1750

"updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by

1751

# the system.

1752

"progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view.

1753

#

1754

# This field is required when skippable is true.

1755

#

1756

# This field is only supported for the following

1757

# creative_type:

1758

#

1759

# * `CREATIVE_TYPE_VIDEO`

1760

"percentage": "A String", # The offset in percentage of the audio or video duration.

1761

"seconds": "A String", # The offset in seconds from the start of the audio or video.

1762

},

1763

"universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique

1764

# across all platforms.

1765

#

1766

# Universal Ad ID is part of the VAST 4.0 standard. It can be modified after

1767

# the creative is created.

1768

#

1769

# This field is only supported for the following

1770

# creative_type:

1771

#

1772

# * `CREATIVE_TYPE_VIDEO`

1773

# platforms. This is part of the VAST 4.0 standard.

1774

"id": "A String", # The unique creative identifier.

1775

"registry": "A String", # The registry provides unique creative identifiers.

1776

},

1777

"transcodes": [ # Output only. Audio/Video transcodes.

1778

#

1779

# Display & Video 360 transcodes the main asset into a number of alternative

1780

# versions that use different file formats or have different properties

1781

# (resolution, audio bit rate, and video bit rate), each designed for

1782

# specific video players or bandwidths.

1783

#

1784

# These transcodes give a publisher's system more options to choose from for

1785

# each impression on your video and ensures that the appropriate file serves

1786

# based on the viewer’s connection and screen size.

1787

#

1788

# This field is only supported in following

1789

# creative_type:

1790

#

1791

# * `CREATIVE_TYPE_VIDEO`

1792

# * `CREATIVE_TYPE_NATIVE_VIDEO`

1793

# * `CREATIVE_TYPE_AUDIO`

1794

{ # Represents information about the transcoded audio or video file.

1795

"transcoded": True or False, # Indicates if the transcoding was successful.

1796

"audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate

1797

# for the transcoded audio, in kilobits per second.

1798

"fileSizeBytes": "A String", # The size of the transcoded file, in bytes.

1799

"name": "A String", # The name of the transcoded file.

1800

"mimeType": "A String", # The MIME type of the transcoded file.

1801

"bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.

1802

"dimensions": { # Dimensions. # The dimensions of the transcoded video.

1803

"widthPixels": 42, # The width in pixels.

1804

"heightPixels": 42, # The height in pixels.

1805

},

1806

"frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.

1807

"audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample

1808

# rate for the transcoded audio, in hertz.

1809

},

1810

],

1811

"cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative.

1812

#

1813

# Optional for the following creative_type when

1814

# created by an advertiser that uses both Campaign Manager and third-party ad

1815

# serving:

1816

#

1817

# * `CREATIVE_TYPE_NATIVE`

1818

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

1819

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

1820

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

1821

#

1822

# Output only for other cases.

1823

"cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad.

1824

"cmAdId": "A String", # The ad ID of the campaign manager tracking Ad.

1825

"cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad.

1826

},

1827

"html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support.

1828

#

1829

# Output only and only valid for third-party VAST tag creatives.

1830

#

1831

# Third-party VAST tag creatives are creatives with following

1832

# hosting_source:

1833

#

1834

# * `HOSTING_SOURCE_THIRD_PARTY`

1835

#

1836

# combined with following creative_type:

1837

#

1838

# * `CREATIVE_TYPE_VIDEO`

1839

"requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution.

1840

#

1841

# Only valid when using a Campaign Manager tracking ad with a third-party ad

1842

# server parameter and the ${DC_DBM_TOKEN} macro.

1843

#

1844

# Optional and only valid for third-party tag creatives or third-party VAST

1845

# tag creatives.

1846

#

1847

# Third-party tag creatives are creatives with following

1848

# hosting_source:

1849

#

1850

# * `HOSTING_SOURCE_THIRD_PARTY`

1851

#

1852

# combined with following creative_type:

1853

#

1854

# * `CREATIVE_TYPE_STANDARD`

1855

# * `CREATIVE_TYPE_EXPANDABLE`

1856

#

1857

# Third-party VAST tag creatives are creatives with following

1858

# hosting_source:

1859

#

1860

# * `HOSTING_SOURCE_THIRD_PARTY`

1861

#

1862

# combined with following creative_type:

1863

#

1864

# * `CREATIVE_TYPE_VIDEO`

1865

"dimensions": { # Dimensions. # Required. Primary dimensions of the creative.

1866

# Applicable to all creative types. The value of

1867

# width_pixels and

1868

# height_pixels defaults to `0`

1869

# when creative_type is one of:

1870

#

1871

# * `CREATIVE_TYPE_VIDEO`

1872

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL`

1873

# * `CREATIVE_TYPE_AUDIO`

1874

# * `CREATIVE_TYPE_NATIVE_VIDEO`

1875

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`

1876

"widthPixels": 42, # The width in pixels.

1877

"heightPixels": 42, # The height in pixels.

1878

},

1879

"appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag.

1880

"creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.

1881

"A String",

1882

],

1883

"creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.

1884

"entityStatus": "A String", # Required. Controls whether or not the creative can serve.

1885

#

1886

# Accepted values are:

1887

#

1888

# * `ENTITY_STATUS_ACTIVE`

1889

# * `ENTITY_STATUS_ARCHIVED`

1890

# * `ENTITY_STATUS_PAUSED`

1891

"skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.

1892

#

1893

# This field is required when skippable is true.

1894

#

1895

# This field is only supported for the following

1896

# creative_type:

1897

#

1898

# * `CREATIVE_TYPE_VIDEO`

1899

"percentage": "A String", # The offset in percentage of the audio or video duration.

1900

"seconds": "A String", # The offset in seconds from the start of the audio or video.

1901

},

1902

"requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly.

1903

#

1904

# Optional and only valid for third-party tag creatives.

1905

# Third-party tag creatives are creatives with following

1906

# hosting_source:

1907

#

1908

# * `HOSTING_SOURCE_THIRD_PARTY`

1909

#

1910

# combined with following creative_type:

1911

#

1912

# * `CREATIVE_TYPE_STANDARD`

1913

# * `CREATIVE_TYPE_EXPANDABLE`

1914

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

1915

"skippable": True or False, # Whether the user can choose to skip a video creative.

1916

#

1917

# This field is only supported for the following

1918

# creative_type:

1919

#

1920

# * `CREATIVE_TYPE_VIDEO`

1921

"jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification

1922

# providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not

1923

# supported.

1924

#

1925

# This field is only supported in following

1926

# creative_type:

1927

#

1928

# * `CREATIVE_TYPE_NATIVE`

1929

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

1930

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

1931

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

1932

# * `CREATIVE_TYPE_NATIVE_VIDEO`

1933

"thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video

1934

# creative.

1935

#

1936

# This field is only supported for the following

1937

# creative_type:

1938

#

1939

# * `CREATIVE_TYPE_AUDIO`

1940

# * `CREATIVE_TYPE_VIDEO`

1941

# * `CREATIVE_TYPE_NATIVE_VIDEO`

1942

{ # Tracking URLs from third parties to track interactions with an audio or a

1943

# video creative.

1944

"url": "A String", # Tracking URL used to track the interaction.

1945

#

1946

# Provide a URL with optional path or query string, beginning with `https:`.

1947

# For example, https://www.example.com/path

1948

"type": "A String", # The type of interaction needs to be tracked by the tracking URL

1949

},

1950

],

1951

"expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover.

1952

#

1953

# Optional and only valid for third-party expandable creatives.

1954

# Third-party expandable creatives are creatives with following hosting

1955

# source:

1956

#

1957

# * `HOSTING_SOURCE_THIRD_PARTY`

1958

#

1959

# combined with following creative_type:

1960

#

1961

# * `CREATIVE_TYPE_EXPANDABLE`

1962

"trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors.

1963

#

1964

# The URLs must start with https (except on inventory that doesn't require

1965

# SSL compliance).

1966

# If using macros in your URL, use only macros supported by Display & Video

1967

# 360.

1968

#

1969

# Standard URLs only, no IMG or SCRIPT tags.

1970

#

1971

# This field is only supported in following

1972

# creative_type:

1973

#

1974

# * `CREATIVE_TYPE_NATIVE`

1975

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

1976

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

1977

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

1978

# * `CREATIVE_TYPE_NATIVE_VIDEO`

1979

"A String",

1980

],

1981

"createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by

1982

# the system.

1983

"additionalDimensions": [ # Additional dimensions.

1984

# Applicable when creative_type is one of:

1985

#

1986

# * `CREATIVE_TYPE_STANDARD`

1987

# * `CREATIVE_TYPE_EXPANDABLE`

1988

# * `CREATIVE_TYPE_NATIVE`

1989

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`

1990

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

1991

# * `CREATIVE_TYPE_LIGHTBOX`

1992

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

1993

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

1994

# * `CREATIVE_TYPE_PUBLISHER_HOSTED`

1995

#

1996

# If this field is specified, width_pixels and

1997

# height_pixels are both required and must be

1998

# greater than or equal to 0.

1999

{ # Dimensions.

2000

"widthPixels": 42, # The width in pixels.

2001

"heightPixels": 42, # The height in pixels.

2002

},

2003

],

2004

"exitEvents": [ # Required. Exit events for this creative.

2005

# An exit (also known as a click tag) is any area in your creative that

2006

# someone can click or tap to open an advertiser's landing page.

2007

# Every creative must include at least one exit.

2008

# You can add an exit to your creative in any of the following ways:

2009

#

2010

# * Use Google Web Designer's tap area.

2011

# * Define a JavaScript variable called "clickTag".

2012

# * Use the Enabler (Enabler.exit()) to track exits in rich media formats.

2013

{ # Exit event of the creative.

2014

"name": "A String", # The name of the click tag of the exit event.

2015

#

2016

# The name must be unique within one creative.

2017

#

2018

# Leave it empty or unset for creatives containing image assets only.

2019

"type": "A String", # Required. The type of the exit event.

2020

"reportingName": "A String", # The name used to identify this event in reports.

2021

# Leave it empty or unset for creatives containing image assets only.

2022

"url": "A String", # Required. The click through URL of the exit event.

2023

# This is required when type is:

2024

#

2025

# * `EXIT_EVENT_TYPE_DEFAULT`

2026

# * `EXIT_EVENT_TYPE_BACKUP`

2027

},

2028

],

2029

"iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled.

2030

# To enable this for the creative, make sure the

2031

# Advertiser.creative_config.ias_client_id

2032

# has been set to your IAS client ID.

2033

"integrationCode": "A String", # ID information used to link this creative to an external system.

2034

# Must be UTF-8 encoded with a length of no more than 10,000 characters.

2035

"cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the

2036

# creative.

2037

# This field is only applicable for creatives that are synced from Campaign

2038

# Manager.

2039

"requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface

2040

# Definitions system).

2041

#

2042

# Set this if the creative relies on mobile gestures for interactivity, such

2043

# as swiping or tapping.

2044

#

2045

# Optional and only valid for third-party tag creatives.

2046

#

2047

# Third-party tag creatives are creatives with following

2048

# hosting_source:

2049

#

2050

# * `HOSTING_SOURCE_THIRD_PARTY`

2051

#

2052

# combined with following creative_type:

2053

#

2054

# * `CREATIVE_TYPE_STANDARD`

2055

# * `CREATIVE_TYPE_EXPANDABLE`

2056

"companionCreativeIds": [ # The IDs of companion creatives for a video creative.

2057

#

2058

# You can assign existing display creatives (with image or HTML5 assets)

2059

# to serve surrounding the publisher's video player. Companions display

2060

# around the video player while the video is playing and remain after the

2061

# video has completed.

2062

#

2063

# Creatives contain additional dimensions

2064

# can not be companion creatives.

2065

#

2066

# This field is only supported for following

2067

# creative_type:

2068

#

2069

# * `CREATIVE_TYPE_AUDIO`

2070

# * `CREATIVE_TYPE_VIDEO`

2071

"A String",

2072

],

2073

"creativeType": "A String", # Required. Immutable. The type of the creative.

2074

"obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.

2075

#

2076

# This field is only supported in following

2077

# creative_type:

2078

#

2079

# * `CREATIVE_TYPE_VIDEO`

2080

"viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon.

2081

#

2082

# Only URLs of the following domains are allowed:

2083

#

2084

# * https://info.evidon.com

2085

# * https://l.betrad.com

2086

"position": "A String", # The position of the OBA icon on the creative.

2087

"clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon.

2088

#

2089

# Only URLs of the following domains are allowed:

2090

#

2091

# * https://info.evidon.com

2092

# * https://l.betrad.com

2093

"resourceUrl": "A String", # The URL of the OBA icon resource.

2094

"landingPageUrl": "A String", # Required. The landing page URL of the OBA icon.

2095

#

2096

# Only URLs of the following domains are allowed:

2097

#

2098

# * https://info.evidon.com

2099

# * https://l.betrad.com

2100

"program": "A String", # The program of the OBA icon. For example: “AdChoices”.

2101

"resourceMimeType": "A String", # The MIME type of the OBA icon resource.

2102

"dimensions": { # Dimensions. # The dimensions of the OBA icon.

2103

"widthPixels": 42, # The width in pixels.

2104

"heightPixels": 42, # The height in pixels.

2105

},

2106

},

2107

"timerEvents": [ # Timer custom events for a rich media creative.

2108

# Timers track the time during which a user views and interacts with a

2109

# specified part of a rich media creative.

2110

# A creative can have multiple timer events, each timed independently.

2111

# Leave it empty or unset for creatives containing image assets only.

2112

{ # Timer event of the creative.

2113

"reportingName": "A String", # Required. The name used to identify this timer event in reports.

2114

"name": "A String", # Required. The name of the timer event.

2115

},

2116

],

2117

"notes": "A String", # User notes for this creative.

2118

# Must be UTF-8 encoded with a length of no more than 20,000 characters.

2119

"dynamic": True or False, # Output only. Indicates whether the creative is dynamic.

2120

"assets": [ # Required. Assets associated to this creative.

2121

# Assets can be associated to the creative in one of following roles:

2122

#

2123

# * `ASSET_ROLE_UNSPECIFIED`

2124

# * `ASSET_ROLE_MAIN`

2125

# * `ASSET_ROLE_BACKUP`

2126

# * `ASSET_ROLE_POLITE_LOAD`

2127

{ # Asset association for the creative.

2128

"asset": { # A single asset. # The associated asset.

2129

"mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.

2130

# This ID can be passed to other API calls, e.g.

2131

# CreateCreative to associate

2132

# the asset with a creative.

2133

"content": "A String", # The asset content.

2134

# For uploaded assets, the content is the serving path.

2135

},

2136

"role": "A String", # The role of this asset for the creative.

2137

},

2138

],

2139

"vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video

2140

# Player-Ad Interface).

2141

#

2142

# Output only and only valid for third-party VAST tag creatives.

2143

#

2144

# Third-party VAST tag creatives are creatives with following

2145

# hosting_source:

2146

#

2147

# * `HOSTING_SOURCE_THIRD_PARTY`

2148

#

2149

# combined with following creative_type:

2150

#

2151

# * `CREATIVE_TYPE_VIDEO`

2152

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative.

2153

#

2154

# Required and only valid for third-party expandable creatives.

2155

#

2156

# Third-party expandable creatives are creatives with following hosting

2157

# source:

2158

#

2159

# * `HOSTING_SOURCE_THIRD_PARTY`

2160

#

2161

# combined with following creative_type:

2162

#

2163

# * `CREATIVE_TYPE_EXPANDABLE`

2164

"thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative.

2165

#

2166

# Required and only valid for third-party tag creatives.

2167

#

2168

# Third-party tag creatives are creatives with following

2169

# hosting_source:

2170

#

2171

# * `HOSTING_SOURCE_THIRD_PARTY`

2172

#

2173

# combined with following creative_type:

2174

#

2175

# * `CREATIVE_TYPE_STANDARD`

2176

# * `CREATIVE_TYPE_EXPANDABLE`

2177

"displayName": "A String", # Required. The display name of the creative.

2178

#

2179

# Must be UTF-8 encoded with a maximum size of 240 bytes.

2180

"hostingSource": "A String", # Required. Indicates where the creative is hosted.

2181

"vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative.

2182

#

2183

# Required and only valid for third-party VAST tag creatives.

2184

#

2185

# Third-party VAST tag creatives are creatives with following

2186

# hosting_source:

2187

#

2188

# * `HOSTING_SOURCE_THIRD_PARTY`

2189

#

2190

# combined with following creative_type:

2191

#

2192

# * `CREATIVE_TYPE_VIDEO`

2193

"mediaDuration": "A String", # Output only. Media duration of the creative.

2194

# Applicable when creative_type

2195

# is one of:

2196

#

2197

# * `CREATIVE_TYPE_VIDEO`

2198

# * `CREATIVE_TYPE_AUDIO`

2199

# * `CREATIVE_TYPE_NATIVE_VIDEO`

2200

# * `CREATIVE_TYPE_PUBLISHER_HOSTED`

2201

},

2202

],

2203

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

2204

# Pass this value in the page_token field

2205

# in the subsequent call to `ListCreativesRequest` method to retrieve the

2206

# next page of results.

2207

# If this field is null, it means this is the last page.

}</pre>

</div>

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

2213

<pre>Retrieves the next page of results.

2214

2215

Args:

2216

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

2217

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

2218

2219

Returns:

2220

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

2221

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

</pre>

</div>

<code class="details" id="patch">patch(advertiserId, creativeId, body=None, updateMask=None, x__xgafv=None)</code>

2227

<pre>Updates an existing creative.

2228

Returns the updated creative if successful.

2229

2230

Args:

2231

advertiserId: string, Output only. The unique ID of the advertiser the creative belongs to. (required)

2232

creativeId: string, Output only. The unique ID of the creative. Assigned by the system. (required)

2233

body: object, The request body.

2234

The object takes the form of:

2235

2236

{ # A single Creative.

2237

"counterEvents": [ # Counter events for a rich media creative.

2238

# Counters track the number of times that a user interacts with any part of a

2239

# rich media creative in a specified way (mouse-overs, mouse-outs, clicks,

2240

# taps, data loading, keyboard entries, etc.).

2241

# Any event that can be captured in the creative can be recorded as a

2242

# counter.

2243

# Leave it empty or unset for creatives containing image assets only.

2244

{ # Counter event of the creative.

2245

"reportingName": "A String", # Required. The name used to identify this counter event in reports.

2246

"name": "A String", # Required. The name of the counter event.

2247

},

2248

],

2249

"reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.

2250

"creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.

2251

"exchangeReviewStatuses": [ # Exchange review statuses for the creative.

2252

{ # Exchange review status for the creative.

2253

"exchange": "A String", # The exchange reviewing the creative.

2254

"status": "A String", # Status of the exchange review.

2255

},

2256

],

2257

"contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.

2258

"publisherReviewStatuses": [ # Publisher review statuses for the creative.

2259

{ # Publisher review status for the creative.

2260

"status": "A String", # Status of the publisher review.

2261

"publisherName": "A String", # The publisher reviewing the creative.

2262

},

2263

],

2264

"approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving.

2265

# Summary of

2266

# creative_and_landing_page_review_status

2267

# and

2268

# content_and_policy_review_status.

2269

},

2270

"advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.

2271

"updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by

2272

# the system.

2273

"progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view.

2274

#

2275

# This field is required when skippable is true.

2276

#

2277

# This field is only supported for the following

2278

# creative_type:

2279

#

2280

# * `CREATIVE_TYPE_VIDEO`

2281

"percentage": "A String", # The offset in percentage of the audio or video duration.

2282

"seconds": "A String", # The offset in seconds from the start of the audio or video.

2283

},

2284

"universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique

2285

# across all platforms.

2286

#

2287

# Universal Ad ID is part of the VAST 4.0 standard. It can be modified after

2288

# the creative is created.

2289

#

2290

# This field is only supported for the following

2291

# creative_type:

2292

#

2293

# * `CREATIVE_TYPE_VIDEO`

2294

# platforms. This is part of the VAST 4.0 standard.

2295

"id": "A String", # The unique creative identifier.

2296

"registry": "A String", # The registry provides unique creative identifiers.

2297

},

2298

"transcodes": [ # Output only. Audio/Video transcodes.

2299

#

2300

# Display & Video 360 transcodes the main asset into a number of alternative

2301

# versions that use different file formats or have different properties

2302

# (resolution, audio bit rate, and video bit rate), each designed for

2303

# specific video players or bandwidths.

2304

#

2305

# These transcodes give a publisher's system more options to choose from for

2306

# each impression on your video and ensures that the appropriate file serves

2307

# based on the viewer’s connection and screen size.

2308

#

2309

# This field is only supported in following

2310

# creative_type:

2311

#

2312

# * `CREATIVE_TYPE_VIDEO`

2313

# * `CREATIVE_TYPE_NATIVE_VIDEO`

2314

# * `CREATIVE_TYPE_AUDIO`

2315

{ # Represents information about the transcoded audio or video file.

2316

"transcoded": True or False, # Indicates if the transcoding was successful.

2317

"audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate

2318

# for the transcoded audio, in kilobits per second.

2319

"fileSizeBytes": "A String", # The size of the transcoded file, in bytes.

2320

"name": "A String", # The name of the transcoded file.

2321

"mimeType": "A String", # The MIME type of the transcoded file.

2322

"bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.

2323

"dimensions": { # Dimensions. # The dimensions of the transcoded video.

2324

"widthPixels": 42, # The width in pixels.

2325

"heightPixels": 42, # The height in pixels.

2326

},

2327

"frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.

2328

"audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample

2329

# rate for the transcoded audio, in hertz.

2330

},

2331

],

2332

"cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative.

2333

#

2334

# Optional for the following creative_type when

2335

# created by an advertiser that uses both Campaign Manager and third-party ad

2336

# serving:

2337

#

2338

# * `CREATIVE_TYPE_NATIVE`

2339

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

2340

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

2341

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

2342

#

2343

# Output only for other cases.

2344

"cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad.

2345

"cmAdId": "A String", # The ad ID of the campaign manager tracking Ad.

2346

"cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad.

2347

},

2348

"html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support.

2349

#

2350

# Output only and only valid for third-party VAST tag creatives.

2351

#

2352

# Third-party VAST tag creatives are creatives with following

2353

# hosting_source:

2354

#

2355

# * `HOSTING_SOURCE_THIRD_PARTY`

2356

#

2357

# combined with following creative_type:

2358

#

2359

# * `CREATIVE_TYPE_VIDEO`

2360

"requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution.

2361

#

2362

# Only valid when using a Campaign Manager tracking ad with a third-party ad

2363

# server parameter and the ${DC_DBM_TOKEN} macro.

2364

#

2365

# Optional and only valid for third-party tag creatives or third-party VAST

2366

# tag creatives.

2367

#

2368

# Third-party tag creatives are creatives with following

2369

# hosting_source:

2370

#

2371

# * `HOSTING_SOURCE_THIRD_PARTY`

2372

#

2373

# combined with following creative_type:

2374

#

2375

# * `CREATIVE_TYPE_STANDARD`

2376

# * `CREATIVE_TYPE_EXPANDABLE`

2377

#

2378

# Third-party VAST tag creatives are creatives with following

2379

# hosting_source:

2380

#

2381

# * `HOSTING_SOURCE_THIRD_PARTY`

2382

#

2383

# combined with following creative_type:

2384

#

2385

# * `CREATIVE_TYPE_VIDEO`

2386

"dimensions": { # Dimensions. # Required. Primary dimensions of the creative.

2387

# Applicable to all creative types. The value of

2388

# width_pixels and

2389

# height_pixels defaults to `0`

2390

# when creative_type is one of:

2391

#

2392

# * `CREATIVE_TYPE_VIDEO`

2393

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL`

2394

# * `CREATIVE_TYPE_AUDIO`

2395

# * `CREATIVE_TYPE_NATIVE_VIDEO`

2396

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`

2397

"widthPixels": 42, # The width in pixels.

2398

"heightPixels": 42, # The height in pixels.

2399

},

2400

"appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag.

2401

"creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.

2402

"A String",

2403

],

2404

"creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.

2405

"entityStatus": "A String", # Required. Controls whether or not the creative can serve.

2406

#

2407

# Accepted values are:

2408

#

2409

# * `ENTITY_STATUS_ACTIVE`

2410

# * `ENTITY_STATUS_ARCHIVED`

2411

# * `ENTITY_STATUS_PAUSED`

2412

"skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.

2413

#

2414

# This field is required when skippable is true.

2415

#

2416

# This field is only supported for the following

2417

# creative_type:

2418

#

2419

# * `CREATIVE_TYPE_VIDEO`

2420

"percentage": "A String", # The offset in percentage of the audio or video duration.

2421

"seconds": "A String", # The offset in seconds from the start of the audio or video.

2422

},

2423

"requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly.

2424

#

2425

# Optional and only valid for third-party tag creatives.

2426

# Third-party tag creatives are creatives with following

2427

# hosting_source:

2428

#

2429

# * `HOSTING_SOURCE_THIRD_PARTY`

2430

#

2431

# combined with following creative_type:

2432

#

2433

# * `CREATIVE_TYPE_STANDARD`

2434

# * `CREATIVE_TYPE_EXPANDABLE`

2435

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

2436

"skippable": True or False, # Whether the user can choose to skip a video creative.

2437

#

2438

# This field is only supported for the following

2439

# creative_type:

2440

#

2441

# * `CREATIVE_TYPE_VIDEO`

2442

"jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification

2443

# providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not

2444

# supported.

2445

#

2446

# This field is only supported in following

2447

# creative_type:

2448

#

2449

# * `CREATIVE_TYPE_NATIVE`

2450

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

2451

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

2452

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

2453

# * `CREATIVE_TYPE_NATIVE_VIDEO`

2454

"thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video

2455

# creative.

2456

#

2457

# This field is only supported for the following

2458

# creative_type:

2459

#

2460

# * `CREATIVE_TYPE_AUDIO`

2461

# * `CREATIVE_TYPE_VIDEO`

2462

# * `CREATIVE_TYPE_NATIVE_VIDEO`

2463

{ # Tracking URLs from third parties to track interactions with an audio or a

2464

# video creative.

2465

"url": "A String", # Tracking URL used to track the interaction.

2466

#

2467

# Provide a URL with optional path or query string, beginning with `https:`.

2468

# For example, https://www.example.com/path

2469

"type": "A String", # The type of interaction needs to be tracked by the tracking URL

2470

},

2471

],

2472

"expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover.

2473

#

2474

# Optional and only valid for third-party expandable creatives.

2475

# Third-party expandable creatives are creatives with following hosting

2476

# source:

2477

#

2478

# * `HOSTING_SOURCE_THIRD_PARTY`

2479

#

2480

# combined with following creative_type:

2481

#

2482

# * `CREATIVE_TYPE_EXPANDABLE`

2483

"trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors.

2484

#

2485

# The URLs must start with https (except on inventory that doesn't require

2486

# SSL compliance).

2487

# If using macros in your URL, use only macros supported by Display & Video

2488

# 360.

2489

#

2490

# Standard URLs only, no IMG or SCRIPT tags.

2491

#

2492

# This field is only supported in following

2493

# creative_type:

2494

#

2495

# * `CREATIVE_TYPE_NATIVE`

2496

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

2497

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

2498

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

2499

# * `CREATIVE_TYPE_NATIVE_VIDEO`

2500

"A String",

2501

],

2502

"createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by

2503

# the system.

2504

"additionalDimensions": [ # Additional dimensions.

2505

# Applicable when creative_type is one of:

2506

#

2507

# * `CREATIVE_TYPE_STANDARD`

2508

# * `CREATIVE_TYPE_EXPANDABLE`

2509

# * `CREATIVE_TYPE_NATIVE`

2510

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`

2511

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

2512

# * `CREATIVE_TYPE_LIGHTBOX`

2513

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

2514

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

2515

# * `CREATIVE_TYPE_PUBLISHER_HOSTED`

2516

#

2517

# If this field is specified, width_pixels and

2518

# height_pixels are both required and must be

2519

# greater than or equal to 0.

2520

{ # Dimensions.

2521

"widthPixels": 42, # The width in pixels.

2522

"heightPixels": 42, # The height in pixels.

2523

},

2524

],

2525

"exitEvents": [ # Required. Exit events for this creative.

2526

# An exit (also known as a click tag) is any area in your creative that

2527

# someone can click or tap to open an advertiser's landing page.

2528

# Every creative must include at least one exit.

2529

# You can add an exit to your creative in any of the following ways:

2530

#

2531

# * Use Google Web Designer's tap area.

2532

# * Define a JavaScript variable called "clickTag".

2533

# * Use the Enabler (Enabler.exit()) to track exits in rich media formats.

2534

{ # Exit event of the creative.

2535

"name": "A String", # The name of the click tag of the exit event.

2536

#

2537

# The name must be unique within one creative.

2538

#

2539

# Leave it empty or unset for creatives containing image assets only.

2540

"type": "A String", # Required. The type of the exit event.

2541

"reportingName": "A String", # The name used to identify this event in reports.

2542

# Leave it empty or unset for creatives containing image assets only.

2543

"url": "A String", # Required. The click through URL of the exit event.

2544

# This is required when type is:

2545

#

2546

# * `EXIT_EVENT_TYPE_DEFAULT`

2547

# * `EXIT_EVENT_TYPE_BACKUP`

2548

},

2549

],

2550

"iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled.

2551

# To enable this for the creative, make sure the

2552

# Advertiser.creative_config.ias_client_id

2553

# has been set to your IAS client ID.

2554

"integrationCode": "A String", # ID information used to link this creative to an external system.

2555

# Must be UTF-8 encoded with a length of no more than 10,000 characters.

2556

"cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the

2557

# creative.

2558

# This field is only applicable for creatives that are synced from Campaign

2559

# Manager.

2560

"requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface

2561

# Definitions system).

2562

#

2563

# Set this if the creative relies on mobile gestures for interactivity, such

2564

# as swiping or tapping.

2565

#

2566

# Optional and only valid for third-party tag creatives.

2567

#

2568

# Third-party tag creatives are creatives with following

2569

# hosting_source:

2570

#

2571

# * `HOSTING_SOURCE_THIRD_PARTY`

2572

#

2573

# combined with following creative_type:

2574

#

2575

# * `CREATIVE_TYPE_STANDARD`

2576

# * `CREATIVE_TYPE_EXPANDABLE`

2577

"companionCreativeIds": [ # The IDs of companion creatives for a video creative.

2578

#

2579

# You can assign existing display creatives (with image or HTML5 assets)

2580

# to serve surrounding the publisher's video player. Companions display

2581

# around the video player while the video is playing and remain after the

2582

# video has completed.

2583

#

2584

# Creatives contain additional dimensions

2585

# can not be companion creatives.

2586

#

2587

# This field is only supported for following

2588

# creative_type:

2589

#

2590

# * `CREATIVE_TYPE_AUDIO`

2591

# * `CREATIVE_TYPE_VIDEO`

2592

"A String",

2593

],

2594

"creativeType": "A String", # Required. Immutable. The type of the creative.

2595

"obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.

2596

#

2597

# This field is only supported in following

2598

# creative_type:

2599

#

2600

# * `CREATIVE_TYPE_VIDEO`

2601

"viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon.

2602

#

2603

# Only URLs of the following domains are allowed:

2604

#

2605

# * https://info.evidon.com

2606

# * https://l.betrad.com

2607

"position": "A String", # The position of the OBA icon on the creative.

2608

"clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon.

2609

#

2610

# Only URLs of the following domains are allowed:

2611

#

2612

# * https://info.evidon.com

2613

# * https://l.betrad.com

2614

"resourceUrl": "A String", # The URL of the OBA icon resource.

2615

"landingPageUrl": "A String", # Required. The landing page URL of the OBA icon.

2616

#

2617

# Only URLs of the following domains are allowed:

2618

#

2619

# * https://info.evidon.com

2620

# * https://l.betrad.com

2621

"program": "A String", # The program of the OBA icon. For example: “AdChoices”.

2622

"resourceMimeType": "A String", # The MIME type of the OBA icon resource.

2623

"dimensions": { # Dimensions. # The dimensions of the OBA icon.

2624

"widthPixels": 42, # The width in pixels.

2625

"heightPixels": 42, # The height in pixels.

2626

},

2627

},

2628

"timerEvents": [ # Timer custom events for a rich media creative.

2629

# Timers track the time during which a user views and interacts with a

2630

# specified part of a rich media creative.

2631

# A creative can have multiple timer events, each timed independently.

2632

# Leave it empty or unset for creatives containing image assets only.

2633

{ # Timer event of the creative.

2634

"reportingName": "A String", # Required. The name used to identify this timer event in reports.

2635

"name": "A String", # Required. The name of the timer event.

2636

},

2637

],

2638

"notes": "A String", # User notes for this creative.

2639

# Must be UTF-8 encoded with a length of no more than 20,000 characters.

2640

"dynamic": True or False, # Output only. Indicates whether the creative is dynamic.

2641

"assets": [ # Required. Assets associated to this creative.

2642

# Assets can be associated to the creative in one of following roles:

2643

#

2644

# * `ASSET_ROLE_UNSPECIFIED`

2645

# * `ASSET_ROLE_MAIN`

2646

# * `ASSET_ROLE_BACKUP`

2647

# * `ASSET_ROLE_POLITE_LOAD`

2648

{ # Asset association for the creative.

2649

"asset": { # A single asset. # The associated asset.

2650

"mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.

2651

# This ID can be passed to other API calls, e.g.

2652

# CreateCreative to associate

2653

# the asset with a creative.

2654

"content": "A String", # The asset content.

2655

# For uploaded assets, the content is the serving path.

2656

},

2657

"role": "A String", # The role of this asset for the creative.

2658

},

2659

],

2660

"vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video

2661

# Player-Ad Interface).

2662

#

2663

# Output only and only valid for third-party VAST tag creatives.

2664

#

2665

# Third-party VAST tag creatives are creatives with following

2666

# hosting_source:

2667

#

2668

# * `HOSTING_SOURCE_THIRD_PARTY`

2669

#

2670

# combined with following creative_type:

2671

#

2672

# * `CREATIVE_TYPE_VIDEO`

2673

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative.

2674

#

2675

# Required and only valid for third-party expandable creatives.

2676

#

2677

# Third-party expandable creatives are creatives with following hosting

2678

# source:

2679

#

2680

# * `HOSTING_SOURCE_THIRD_PARTY`

2681

#

2682

# combined with following creative_type:

2683

#

2684

# * `CREATIVE_TYPE_EXPANDABLE`

2685

"thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative.

2686

#

2687

# Required and only valid for third-party tag creatives.

2688

#

2689

# Third-party tag creatives are creatives with following

2690

# hosting_source:

2691

#

2692

# * `HOSTING_SOURCE_THIRD_PARTY`

2693

#

2694

# combined with following creative_type:

2695

#

2696

# * `CREATIVE_TYPE_STANDARD`

2697

# * `CREATIVE_TYPE_EXPANDABLE`

2698

"displayName": "A String", # Required. The display name of the creative.

2699

#

2700

# Must be UTF-8 encoded with a maximum size of 240 bytes.

2701

"hostingSource": "A String", # Required. Indicates where the creative is hosted.

2702

"vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative.

2703

#

2704

# Required and only valid for third-party VAST tag creatives.

2705

#

2706

# Third-party VAST tag creatives are creatives with following

2707

# hosting_source:

2708

#

2709

# * `HOSTING_SOURCE_THIRD_PARTY`

2710

#

2711

# combined with following creative_type:

2712

#

2713

# * `CREATIVE_TYPE_VIDEO`

2714

"mediaDuration": "A String", # Output only. Media duration of the creative.

2715

# Applicable when creative_type

2716

# is one of:

2717

#

2718

# * `CREATIVE_TYPE_VIDEO`

2719

# * `CREATIVE_TYPE_AUDIO`

2720

# * `CREATIVE_TYPE_NATIVE_VIDEO`

2721

# * `CREATIVE_TYPE_PUBLISHER_HOSTED`

2722

}

2723

2724

updateMask: string, Required. The mask to control which fields to update.

2725

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2732

2733

{ # A single Creative.

2734

"counterEvents": [ # Counter events for a rich media creative.

2735

# Counters track the number of times that a user interacts with any part of a

2736

# rich media creative in a specified way (mouse-overs, mouse-outs, clicks,

2737

# taps, data loading, keyboard entries, etc.).

2738

# Any event that can be captured in the creative can be recorded as a

2739

# counter.

2740

# Leave it empty or unset for creatives containing image assets only.

2741

{ # Counter event of the creative.

2742

"reportingName": "A String", # Required. The name used to identify this counter event in reports.

2743

"name": "A String", # Required. The name of the counter event.

2744

},

2745

],

2746

"reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.

2747

"creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.

2748

"exchangeReviewStatuses": [ # Exchange review statuses for the creative.

2749

{ # Exchange review status for the creative.

2750

"exchange": "A String", # The exchange reviewing the creative.

2751

"status": "A String", # Status of the exchange review.

2752

},

2753

],

2754

"contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.

2755

"publisherReviewStatuses": [ # Publisher review statuses for the creative.

2756

{ # Publisher review status for the creative.

2757

"status": "A String", # Status of the publisher review.

2758

"publisherName": "A String", # The publisher reviewing the creative.

2759

},

2760

],

2761

"approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving.

2762

# Summary of

2763

# creative_and_landing_page_review_status

2764

# and

2765

# content_and_policy_review_status.

2766

},

2767

"advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.

2768

"updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by

2769

# the system.

2770

"progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view.

2771

#

2772

# This field is required when skippable is true.

2773

#

2774

# This field is only supported for the following

2775

# creative_type:

2776

#

2777

# * `CREATIVE_TYPE_VIDEO`

2778

"percentage": "A String", # The offset in percentage of the audio or video duration.

2779

"seconds": "A String", # The offset in seconds from the start of the audio or video.

2780

},

2781

"universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique

2782

# across all platforms.

2783

#

2784

# Universal Ad ID is part of the VAST 4.0 standard. It can be modified after

2785

# the creative is created.

2786

#

2787

# This field is only supported for the following

2788

# creative_type:

2789

#

2790

# * `CREATIVE_TYPE_VIDEO`

2791

# platforms. This is part of the VAST 4.0 standard.

2792

"id": "A String", # The unique creative identifier.

2793

"registry": "A String", # The registry provides unique creative identifiers.

2794

},

2795

"transcodes": [ # Output only. Audio/Video transcodes.

2796

#

2797

# Display & Video 360 transcodes the main asset into a number of alternative

2798

# versions that use different file formats or have different properties

2799

# (resolution, audio bit rate, and video bit rate), each designed for

2800

# specific video players or bandwidths.

2801

#

2802

# These transcodes give a publisher's system more options to choose from for

2803

# each impression on your video and ensures that the appropriate file serves

2804

# based on the viewer’s connection and screen size.

2805

#

2806

# This field is only supported in following

2807

# creative_type:

2808

#

2809

# * `CREATIVE_TYPE_VIDEO`

2810

# * `CREATIVE_TYPE_NATIVE_VIDEO`

2811

# * `CREATIVE_TYPE_AUDIO`

2812

{ # Represents information about the transcoded audio or video file.

2813

"transcoded": True or False, # Indicates if the transcoding was successful.

2814

"audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate

2815

# for the transcoded audio, in kilobits per second.

2816

"fileSizeBytes": "A String", # The size of the transcoded file, in bytes.

2817

"name": "A String", # The name of the transcoded file.

2818

"mimeType": "A String", # The MIME type of the transcoded file.

2819

"bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.

2820

"dimensions": { # Dimensions. # The dimensions of the transcoded video.

2821

"widthPixels": 42, # The width in pixels.

2822

"heightPixels": 42, # The height in pixels.

2823

},

2824

"frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.

2825

"audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample

2826

# rate for the transcoded audio, in hertz.

2827

},

2828

],

2829

"cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative.

2830

#

2831

# Optional for the following creative_type when

2832

# created by an advertiser that uses both Campaign Manager and third-party ad

2833

# serving:

2834

#

2835

# * `CREATIVE_TYPE_NATIVE`

2836

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

2837

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

2838

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

2839

#

2840

# Output only for other cases.

2841

"cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad.

2842

"cmAdId": "A String", # The ad ID of the campaign manager tracking Ad.

2843

"cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad.

2844

},

2845

"html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support.

2846

#

2847

# Output only and only valid for third-party VAST tag creatives.

2848

#

2849

# Third-party VAST tag creatives are creatives with following

2850

# hosting_source:

2851

#

2852

# * `HOSTING_SOURCE_THIRD_PARTY`

2853

#

2854

# combined with following creative_type:

2855

#

2856

# * `CREATIVE_TYPE_VIDEO`

2857

"requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution.

2858

#

2859

# Only valid when using a Campaign Manager tracking ad with a third-party ad

2860

# server parameter and the ${DC_DBM_TOKEN} macro.

2861

#

2862

# Optional and only valid for third-party tag creatives or third-party VAST

2863

# tag creatives.

2864

#

2865

# Third-party tag creatives are creatives with following

2866

# hosting_source:

2867

#

2868

# * `HOSTING_SOURCE_THIRD_PARTY`

2869

#

2870

# combined with following creative_type:

2871

#

2872

# * `CREATIVE_TYPE_STANDARD`

2873

# * `CREATIVE_TYPE_EXPANDABLE`

2874

#

2875

# Third-party VAST tag creatives are creatives with following

2876

# hosting_source:

2877

#

2878

# * `HOSTING_SOURCE_THIRD_PARTY`

2879

#

2880

# combined with following creative_type:

2881

#

2882

# * `CREATIVE_TYPE_VIDEO`

2883

"dimensions": { # Dimensions. # Required. Primary dimensions of the creative.

2884

# Applicable to all creative types. The value of

2885

# width_pixels and

2886

# height_pixels defaults to `0`

2887

# when creative_type is one of:

2888

#

2889

# * `CREATIVE_TYPE_VIDEO`

2890

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL`

2891

# * `CREATIVE_TYPE_AUDIO`

2892

# * `CREATIVE_TYPE_NATIVE_VIDEO`

2893

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`

2894

"widthPixels": 42, # The width in pixels.

2895

"heightPixels": 42, # The height in pixels.

2896

},

2897

"appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag.

2898

"creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.

2899

"A String",

2900

],

2901

"creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.

2902

"entityStatus": "A String", # Required. Controls whether or not the creative can serve.

2903

#

2904

# Accepted values are:

2905

#

2906

# * `ENTITY_STATUS_ACTIVE`

2907

# * `ENTITY_STATUS_ARCHIVED`

2908

# * `ENTITY_STATUS_PAUSED`

2909

"skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.

2910

#

2911

# This field is required when skippable is true.

2912

#

2913

# This field is only supported for the following

2914

# creative_type:

2915

#

2916

# * `CREATIVE_TYPE_VIDEO`

2917

"percentage": "A String", # The offset in percentage of the audio or video duration.

2918

"seconds": "A String", # The offset in seconds from the start of the audio or video.

2919

},

2920

"requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly.

2921

#

2922

# Optional and only valid for third-party tag creatives.

2923

# Third-party tag creatives are creatives with following

2924

# hosting_source:

2925

#

2926

# * `HOSTING_SOURCE_THIRD_PARTY`

2927

#

2928

# combined with following creative_type:

2929

#

2930

# * `CREATIVE_TYPE_STANDARD`

2931

# * `CREATIVE_TYPE_EXPANDABLE`

2932

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

2933

"skippable": True or False, # Whether the user can choose to skip a video creative.

2934

#

2935

# This field is only supported for the following

2936

# creative_type:

2937

#

2938

# * `CREATIVE_TYPE_VIDEO`

2939

"jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification

2940

# providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not

2941

# supported.

2942

#

2943

# This field is only supported in following

2944

# creative_type:

2945

#

2946

# * `CREATIVE_TYPE_NATIVE`

2947

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

2948

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

2949

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

2950

# * `CREATIVE_TYPE_NATIVE_VIDEO`

2951

"thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video

2952

# creative.

2953

#

2954

# This field is only supported for the following

2955

# creative_type:

2956

#

2957

# * `CREATIVE_TYPE_AUDIO`

2958

# * `CREATIVE_TYPE_VIDEO`

2959

# * `CREATIVE_TYPE_NATIVE_VIDEO`

2960

{ # Tracking URLs from third parties to track interactions with an audio or a

2961

# video creative.

2962

"url": "A String", # Tracking URL used to track the interaction.

2963

#

2964

# Provide a URL with optional path or query string, beginning with `https:`.

2965

# For example, https://www.example.com/path

2966

"type": "A String", # The type of interaction needs to be tracked by the tracking URL

2967

},

2968

],

2969

"expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover.

2970

#

2971

# Optional and only valid for third-party expandable creatives.

2972

# Third-party expandable creatives are creatives with following hosting

2973

# source:

2974

#

2975

# * `HOSTING_SOURCE_THIRD_PARTY`

2976

#

2977

# combined with following creative_type:

2978

#

2979

# * `CREATIVE_TYPE_EXPANDABLE`

2980

"trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors.

2981

#

2982

# The URLs must start with https (except on inventory that doesn't require

2983

# SSL compliance).

2984

# If using macros in your URL, use only macros supported by Display & Video

2985

# 360.

2986

#

2987

# Standard URLs only, no IMG or SCRIPT tags.

2988

#

2989

# This field is only supported in following

2990

# creative_type:

2991

#

2992

# * `CREATIVE_TYPE_NATIVE`

2993

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

2994

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

2995

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

2996

# * `CREATIVE_TYPE_NATIVE_VIDEO`

2997

"A String",

2998

],

2999

"createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by

3000

# the system.

3001

"additionalDimensions": [ # Additional dimensions.

3002

# Applicable when creative_type is one of:

3003

#

3004

# * `CREATIVE_TYPE_STANDARD`

3005

# * `CREATIVE_TYPE_EXPANDABLE`

3006

# * `CREATIVE_TYPE_NATIVE`

3007

# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`

3008

# * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`

3009

# * `CREATIVE_TYPE_LIGHTBOX`

3010

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL`

3011

# * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`

3012

# * `CREATIVE_TYPE_PUBLISHER_HOSTED`

3013

#

3014

# If this field is specified, width_pixels and

3015

# height_pixels are both required and must be

3016

# greater than or equal to 0.

3017

{ # Dimensions.

3018

"widthPixels": 42, # The width in pixels.

3019

"heightPixels": 42, # The height in pixels.

3020

},

3021

],

3022

"exitEvents": [ # Required. Exit events for this creative.

3023

# An exit (also known as a click tag) is any area in your creative that

3024

# someone can click or tap to open an advertiser's landing page.

3025

# Every creative must include at least one exit.

3026

# You can add an exit to your creative in any of the following ways:

3027

#

3028

# * Use Google Web Designer's tap area.

3029

# * Define a JavaScript variable called "clickTag".

3030

# * Use the Enabler (Enabler.exit()) to track exits in rich media formats.

3031

{ # Exit event of the creative.

3032

"name": "A String", # The name of the click tag of the exit event.

3033

#

3034

# The name must be unique within one creative.

3035

#

3036

# Leave it empty or unset for creatives containing image assets only.

3037

"type": "A String", # Required. The type of the exit event.

3038

"reportingName": "A String", # The name used to identify this event in reports.

3039

# Leave it empty or unset for creatives containing image assets only.

3040

"url": "A String", # Required. The click through URL of the exit event.

3041

# This is required when type is:

3042

#

3043

# * `EXIT_EVENT_TYPE_DEFAULT`

3044

# * `EXIT_EVENT_TYPE_BACKUP`

3045

},

3046

],

3047

"iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled.

3048

# To enable this for the creative, make sure the

3049

# Advertiser.creative_config.ias_client_id

3050

# has been set to your IAS client ID.

3051

"integrationCode": "A String", # ID information used to link this creative to an external system.

3052

# Must be UTF-8 encoded with a length of no more than 10,000 characters.

3053

"cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the

3054

# creative.

3055

# This field is only applicable for creatives that are synced from Campaign

3056

# Manager.

3057

"requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface

3058

# Definitions system).

3059

#

3060

# Set this if the creative relies on mobile gestures for interactivity, such

3061

# as swiping or tapping.

3062

#

3063

# Optional and only valid for third-party tag creatives.

3064

#

3065

# Third-party tag creatives are creatives with following

3066

# hosting_source:

3067

#

3068

# * `HOSTING_SOURCE_THIRD_PARTY`

3069

#

3070

# combined with following creative_type:

3071

#

3072

# * `CREATIVE_TYPE_STANDARD`

3073

# * `CREATIVE_TYPE_EXPANDABLE`

3074

"companionCreativeIds": [ # The IDs of companion creatives for a video creative.

3075

#

3076

# You can assign existing display creatives (with image or HTML5 assets)

3077

# to serve surrounding the publisher's video player. Companions display

3078

# around the video player while the video is playing and remain after the

3079

# video has completed.

3080

#

3081

# Creatives contain additional dimensions

3082

# can not be companion creatives.

3083

#

3084

# This field is only supported for following

3085

# creative_type:

3086

#

3087

# * `CREATIVE_TYPE_AUDIO`

3088

# * `CREATIVE_TYPE_VIDEO`

3089

"A String",

3090

],

3091

"creativeType": "A String", # Required. Immutable. The type of the creative.

3092

"obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.

3093

#

3094

# This field is only supported in following

3095

# creative_type:

3096

#

3097

# * `CREATIVE_TYPE_VIDEO`

3098

"viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon.

3099

#

3100

# Only URLs of the following domains are allowed:

3101

#

3102

# * https://info.evidon.com

3103

# * https://l.betrad.com

3104

"position": "A String", # The position of the OBA icon on the creative.

3105

"clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon.

3106

#

3107

# Only URLs of the following domains are allowed:

3108

#

3109

# * https://info.evidon.com

3110

# * https://l.betrad.com

3111

"resourceUrl": "A String", # The URL of the OBA icon resource.

3112

"landingPageUrl": "A String", # Required. The landing page URL of the OBA icon.

3113

#

3114

# Only URLs of the following domains are allowed:

3115

#

3116

# * https://info.evidon.com

3117

# * https://l.betrad.com

3118

"program": "A String", # The program of the OBA icon. For example: “AdChoices”.

3119

"resourceMimeType": "A String", # The MIME type of the OBA icon resource.

3120

"dimensions": { # Dimensions. # The dimensions of the OBA icon.

3121

"widthPixels": 42, # The width in pixels.

3122

"heightPixels": 42, # The height in pixels.

3123

},

3124

},

3125

"timerEvents": [ # Timer custom events for a rich media creative.

3126

# Timers track the time during which a user views and interacts with a

3127

# specified part of a rich media creative.

3128

# A creative can have multiple timer events, each timed independently.

3129

# Leave it empty or unset for creatives containing image assets only.

3130

{ # Timer event of the creative.

3131

"reportingName": "A String", # Required. The name used to identify this timer event in reports.

3132

"name": "A String", # Required. The name of the timer event.

3133

},

3134

],

3135

"notes": "A String", # User notes for this creative.

3136

# Must be UTF-8 encoded with a length of no more than 20,000 characters.

3137

"dynamic": True or False, # Output only. Indicates whether the creative is dynamic.

3138

"assets": [ # Required. Assets associated to this creative.

3139

# Assets can be associated to the creative in one of following roles:

3140

#

3141

# * `ASSET_ROLE_UNSPECIFIED`

3142

# * `ASSET_ROLE_MAIN`

3143

# * `ASSET_ROLE_BACKUP`

3144

# * `ASSET_ROLE_POLITE_LOAD`

3145

{ # Asset association for the creative.

3146

"asset": { # A single asset. # The associated asset.

3147

"mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.

3148

# This ID can be passed to other API calls, e.g.

3149

# CreateCreative to associate

3150

# the asset with a creative.

3151

"content": "A String", # The asset content.

3152

# For uploaded assets, the content is the serving path.

3153

},

3154

"role": "A String", # The role of this asset for the creative.

3155

},

3156

],

3157

"vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video

3158

# Player-Ad Interface).

3159

#

3160

# Output only and only valid for third-party VAST tag creatives.

3161

#

3162

# Third-party VAST tag creatives are creatives with following

3163

# hosting_source:

3164

#

3165

# * `HOSTING_SOURCE_THIRD_PARTY`

3166

#

3167

# combined with following creative_type:

3168

#

3169

# * `CREATIVE_TYPE_VIDEO`

3170

"expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative.

3171

#

3172

# Required and only valid for third-party expandable creatives.

3173

#

3174

# Third-party expandable creatives are creatives with following hosting

3175

# source:

3176

#

3177

# * `HOSTING_SOURCE_THIRD_PARTY`

3178

#

3179

# combined with following creative_type:

3180

#

3181

# * `CREATIVE_TYPE_EXPANDABLE`

3182

"thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative.

3183

#

3184

# Required and only valid for third-party tag creatives.

3185

#

3186

# Third-party tag creatives are creatives with following

3187

# hosting_source:

3188

#

3189

# * `HOSTING_SOURCE_THIRD_PARTY`

3190

#

3191

# combined with following creative_type:

3192

#

3193

# * `CREATIVE_TYPE_STANDARD`

3194

# * `CREATIVE_TYPE_EXPANDABLE`

3195

"displayName": "A String", # Required. The display name of the creative.

3196

#

3197

# Must be UTF-8 encoded with a maximum size of 240 bytes.

3198

"hostingSource": "A String", # Required. Indicates where the creative is hosted.

3199

"vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative.

3200

#

3201

# Required and only valid for third-party VAST tag creatives.

3202

#

3203

# Third-party VAST tag creatives are creatives with following

3204

# hosting_source:

3205

#

3206

# * `HOSTING_SOURCE_THIRD_PARTY`

3207

#

3208

# combined with following creative_type:

3209

#

3210

# * `CREATIVE_TYPE_VIDEO`

3211

"mediaDuration": "A String", # Output only. Media duration of the creative.

3212

# Applicable when creative_type

3213

# is one of:

3214

#

3215

# * `CREATIVE_TYPE_VIDEO`

3216

# * `CREATIVE_TYPE_AUDIO`

3217

# * `CREATIVE_TYPE_NATIVE_VIDEO`

3218

# * `CREATIVE_TYPE_PUBLISHER_HOSTED`

}</pre>

</div>

</body></html>