Blame - docs/dyn/displayvideo_v1.advertisers.campaigns.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.campaigns.html">campaigns</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 campaign.</p>

80

81

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

82

<p class="firstline">Permanently deletes a campaign. A deleted campaign cannot be recovered.</p>

83

84

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

85

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

86

87

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

88

<p class="firstline">Lists campaigns 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, campaignId, body=None, updateMask=None, x__xgafv=None)</a></code></p>

94

<p class="firstline">Updates an existing campaign.</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 campaign.

99

Returns the newly created campaign if successful.

100

101

Args:

102

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

103

body: object, The request body.

104

The object takes the form of:

105

106

{ # A single campaign.

107

"campaignFlight": { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.

108

"plannedDates": { # A date range. # Required. The dates that the campaign is expected to run. They are resolved

109

# relative to the parent advertiser's time zone.

110

#

111

# * The dates specified here will not affect serving. They are used to

112

# generate alerts and warnings. For example, if the flight date of any child

113

# insertion order is outside the range of these dates, the user interface

114

# will show a warning.

115

# * `start_date` is required and must be the current date or later.

116

# * `end_date` is optional. If specified, it must be the `start_date` or

117

# later.

118

# * Any specified date must be before the year 2037.

119

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value

120

# for `year`, `month`, and `day`.

121

# and time zone are either specified elsewhere or are not significant. The date

122

# is relative to the Proleptic Gregorian Calendar. This can represent:

123

#

124

# * A full date, with non-zero year, month and day values

125

# * A month and day value, with a zero year, e.g. an anniversary

126

# * A year on its own, with zero month and day values

127

# * A year and month value, with a zero day, e.g. a credit card expiration date

128

#

129

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

130

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

131

# a year.

132

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

133

# if specifying a year by itself or a year and month where the day is not

134

# significant.

135

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

136

# month and day.

137

},

138

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value

139

# for `year`, `month`, and `day`.

140

# and time zone are either specified elsewhere or are not significant. The date

141

# is relative to the Proleptic Gregorian Calendar. This can represent:

142

#

143

# * A full date, with non-zero year, month and day values

144

# * A month and day value, with a zero year, e.g. an anniversary

145

# * A year on its own, with zero month and day values

146

# * A year and month value, with a zero day, e.g. a credit card expiration date

147

#

148

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

149

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

150

# a year.

151

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

152

# if specifying a year by itself or a year and month where the day is not

153

# significant.

154

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

# month and day.

},

},

"plannedSpendAmountMicros": "A String", # The amount the campaign is expected to spend for its given

159

# planned_dates. This will not limit serving,

160

# but will be used for tracking spend in the DV360 UI.

161

#

162

# The amount is in micros. Must be greater than or equal to 0. For example,

163

# 500000000 represents 500 standard units of the currency.

164

},

165

"frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency cap setting of the campaign.

166

# ad during a given time period.

167

"timeUnit": "A String", # The time unit in which the frequency cap will be applied.

168

#

169

# Applicable when unlimited is `false`.

170

"timeUnitCount": 42, # The number of time_unit the frequency cap will

171

# last.

172

#

173

# Applicable when unlimited is `false`.

174

# The following restrictions apply based on the value of

175

# time_unit:

176

#

177

# * `TIME_UNIT_LIFETIME` - this field is output only and will

178

# default to 1

179

# * `TIME_UNIT_MONTHS` - must be between 1 and 2

180

# * `TIME_UNIT_WEEKS` - must be between 1 and 4

181

# * `TIME_UNIT_DAYS` - must be between 1 and 6

182

# * `TIME_UNIT_HOURS` - must be between 1 and 23

183

# * `TIME_UNIT_MINUTES` - must be between 1 and 59

184

"unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to

185

# `true`, the remaining frequency cap fields are not applicable.

186

"maxImpressions": 42, # The maximum number of times a user may be shown with the same ad

187

# during this period. Must be greater than 0.

188

#

189

# Applicable when unlimited is `false`.

190

},

191

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

192

#

193

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

194

"entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign

195

# can spend their budgets and bid on inventory.

196

#

197

# * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and

198

# `ENTITY_STATUS_PAUSED`.

199

# * For

200

# CreateCampaign method,

201

# `ENTITY_STATUS_ARCHIVED` is not allowed.

202

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

203

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

204

"campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.

205

"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign.

206

#

207

# Acceptable values for

208

# performance_goal_type are:

209

#

210

# * `PERFORMANCE_GOAL_TYPE_CPM`

211

# * `PERFORMANCE_GOAL_TYPE_CPC`

212

# * `PERFORMANCE_GOAL_TYPE_CPA`

213

# * `PERFORMANCE_GOAL_TYPE_CPIAVC`

214

# * `PERFORMANCE_GOAL_TYPE_CTR`

215

# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`

216

# * `PERFORMANCE_GOAL_TYPE_OTHER`

217

"performanceGoalType": "A String", # Required. The type of the performance goal.

218

"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.

219

#

220

# Applicable when

221

# performance_goal_type is one of:

222

#

223

# * `PERFORMANCE_GOAL_TYPE_CPM`

224

# * `PERFORMANCE_GOAL_TYPE_CPC`

225

# * `PERFORMANCE_GOAL_TYPE_CPA`

226

# * `PERFORMANCE_GOAL_TYPE_CPIAVC`

227

#

228

# For example 1500000 represents 1.5 standard units of the currency.

229

"performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros.

230

#

231

# Applicable when

232

# performance_goal_type is one of:

233

#

234

# * `PERFORMANCE_GOAL_TYPE_CTR`

235

# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`

236

#

237

# For example, 70000 represents 7% (decimal 0.07).

238

"performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty.

239

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

240

#

241

# Applicable when

242

# performance_goal_type is set to

243

# `PERFORMANCE_GOAL_TYPE_OTHER`.

244

},

245

"campaignGoalType": "A String", # Required. The type of the campaign goal.

246

},

247

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

248

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

249

}

250

251

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

258

259

{ # A single campaign.

260

"campaignFlight": { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.

261

"plannedDates": { # A date range. # Required. The dates that the campaign is expected to run. They are resolved

262

# relative to the parent advertiser's time zone.

263

#

264

# * The dates specified here will not affect serving. They are used to

265

# generate alerts and warnings. For example, if the flight date of any child

266

# insertion order is outside the range of these dates, the user interface

267

# will show a warning.

268

# * `start_date` is required and must be the current date or later.

269

# * `end_date` is optional. If specified, it must be the `start_date` or

270

# later.

271

# * Any specified date must be before the year 2037.

272

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value

273

# for `year`, `month`, and `day`.

274

# and time zone are either specified elsewhere or are not significant. The date

275

# is relative to the Proleptic Gregorian Calendar. This can represent:

276

#

277

# * A full date, with non-zero year, month and day values

278

# * A month and day value, with a zero year, e.g. an anniversary

279

# * A year on its own, with zero month and day values

280

# * A year and month value, with a zero day, e.g. a credit card expiration date

281

#

282

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

283

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

284

# a year.

285

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

286

# if specifying a year by itself or a year and month where the day is not

287

# significant.

288

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

289

# month and day.

290

},

291

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value

292

# for `year`, `month`, and `day`.

293

# and time zone are either specified elsewhere or are not significant. The date

294

# is relative to the Proleptic Gregorian Calendar. This can represent:

295

#

296

# * A full date, with non-zero year, month and day values

297

# * A month and day value, with a zero year, e.g. an anniversary

298

# * A year on its own, with zero month and day values

299

# * A year and month value, with a zero day, e.g. a credit card expiration date

300

#

301

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

302

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

303

# a year.

304

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

305

# if specifying a year by itself or a year and month where the day is not

306

# significant.

307

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

# month and day.

},

},

"plannedSpendAmountMicros": "A String", # The amount the campaign is expected to spend for its given

312

# planned_dates. This will not limit serving,

313

# but will be used for tracking spend in the DV360 UI.

314

#

315

# The amount is in micros. Must be greater than or equal to 0. For example,

316

# 500000000 represents 500 standard units of the currency.

317

},

318

"frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency cap setting of the campaign.

319

# ad during a given time period.

320

"timeUnit": "A String", # The time unit in which the frequency cap will be applied.

321

#

322

# Applicable when unlimited is `false`.

323

"timeUnitCount": 42, # The number of time_unit the frequency cap will

324

# last.

325

#

326

# Applicable when unlimited is `false`.

327

# The following restrictions apply based on the value of

328

# time_unit:

329

#

330

# * `TIME_UNIT_LIFETIME` - this field is output only and will

331

# default to 1

332

# * `TIME_UNIT_MONTHS` - must be between 1 and 2

333

# * `TIME_UNIT_WEEKS` - must be between 1 and 4

334

# * `TIME_UNIT_DAYS` - must be between 1 and 6

335

# * `TIME_UNIT_HOURS` - must be between 1 and 23

336

# * `TIME_UNIT_MINUTES` - must be between 1 and 59

337

"unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to

338

# `true`, the remaining frequency cap fields are not applicable.

339

"maxImpressions": 42, # The maximum number of times a user may be shown with the same ad

340

# during this period. Must be greater than 0.

341

#

342

# Applicable when unlimited is `false`.

343

},

344

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

345

#

346

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

347

"entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign

348

# can spend their budgets and bid on inventory.

349

#

350

# * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and

351

# `ENTITY_STATUS_PAUSED`.

352

# * For

353

# CreateCampaign method,

354

# `ENTITY_STATUS_ARCHIVED` is not allowed.

355

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

356

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

357

"campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.

358

"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign.

359

#

360

# Acceptable values for

361

# performance_goal_type are:

362

#

363

# * `PERFORMANCE_GOAL_TYPE_CPM`

364

# * `PERFORMANCE_GOAL_TYPE_CPC`

365

# * `PERFORMANCE_GOAL_TYPE_CPA`

366

# * `PERFORMANCE_GOAL_TYPE_CPIAVC`

367

# * `PERFORMANCE_GOAL_TYPE_CTR`

368

# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`

369

# * `PERFORMANCE_GOAL_TYPE_OTHER`

370

"performanceGoalType": "A String", # Required. The type of the performance goal.

371

"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.

372

#

373

# Applicable when

374

# performance_goal_type is one of:

375

#

376

# * `PERFORMANCE_GOAL_TYPE_CPM`

377

# * `PERFORMANCE_GOAL_TYPE_CPC`

378

# * `PERFORMANCE_GOAL_TYPE_CPA`

379

# * `PERFORMANCE_GOAL_TYPE_CPIAVC`

380

#

381

# For example 1500000 represents 1.5 standard units of the currency.

382

"performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros.

383

#

384

# Applicable when

385

# performance_goal_type is one of:

386

#

387

# * `PERFORMANCE_GOAL_TYPE_CTR`

388

# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`

389

#

390

# For example, 70000 represents 7% (decimal 0.07).

391

"performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty.

392

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

393

#

394

# Applicable when

395

# performance_goal_type is set to

396

# `PERFORMANCE_GOAL_TYPE_OTHER`.

397

},

398

"campaignGoalType": "A String", # Required. The type of the campaign goal.

399

},

400

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

401

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

}</pre>

</div>

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

407

<pre>Permanently deletes a campaign. A deleted campaign cannot be recovered.

408

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

409

entity_status to `ENTITY_STATUS_ARCHIVED`, to be

able to delete it.

Args:

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

414

campaignId: string, The ID of the campaign we need to delete. (required)

415

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

422

423

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

424

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

425

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

426

#

427

# service Foo {

428

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

429

# }

430

#

431

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

}</pre>

</div>

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

437

<pre>Gets a campaign.

438

439

Args:

440

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

441

campaignId: string, Required. The ID of the campaign to fetch. (required)

442

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

449

450

{ # A single campaign.

451

"campaignFlight": { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.

452

"plannedDates": { # A date range. # Required. The dates that the campaign is expected to run. They are resolved

453

# relative to the parent advertiser's time zone.

454

#

455

# * The dates specified here will not affect serving. They are used to

456

# generate alerts and warnings. For example, if the flight date of any child

457

# insertion order is outside the range of these dates, the user interface

458

# will show a warning.

459

# * `start_date` is required and must be the current date or later.

460

# * `end_date` is optional. If specified, it must be the `start_date` or

461

# later.

462

# * Any specified date must be before the year 2037.

463

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value

464

# for `year`, `month`, and `day`.

465

# and time zone are either specified elsewhere or are not significant. The date

466

# is relative to the Proleptic Gregorian Calendar. This can represent:

467

#

468

# * A full date, with non-zero year, month and day values

469

# * A month and day value, with a zero year, e.g. an anniversary

470

# * A year on its own, with zero month and day values

471

# * A year and month value, with a zero day, e.g. a credit card expiration date

472

#

473

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

474

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

475

# a year.

476

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

477

# if specifying a year by itself or a year and month where the day is not

478

# significant.

479

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

480

# month and day.

481

},

482

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value

483

# for `year`, `month`, and `day`.

484

# and time zone are either specified elsewhere or are not significant. The date

485

# is relative to the Proleptic Gregorian Calendar. This can represent:

486

#

487

# * A full date, with non-zero year, month and day values

488

# * A month and day value, with a zero year, e.g. an anniversary

489

# * A year on its own, with zero month and day values

490

# * A year and month value, with a zero day, e.g. a credit card expiration date

491

#

492

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

493

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

494

# a year.

495

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

496

# if specifying a year by itself or a year and month where the day is not

497

# significant.

498

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

# month and day.

},

},

"plannedSpendAmountMicros": "A String", # The amount the campaign is expected to spend for its given

503

# planned_dates. This will not limit serving,

504

# but will be used for tracking spend in the DV360 UI.

505

#

506

# The amount is in micros. Must be greater than or equal to 0. For example,

507

# 500000000 represents 500 standard units of the currency.

508

},

509

"frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency cap setting of the campaign.

510

# ad during a given time period.

511

"timeUnit": "A String", # The time unit in which the frequency cap will be applied.

512

#

513

# Applicable when unlimited is `false`.

514

"timeUnitCount": 42, # The number of time_unit the frequency cap will

515

# last.

516

#

517

# Applicable when unlimited is `false`.

518

# The following restrictions apply based on the value of

519

# time_unit:

520

#

521

# * `TIME_UNIT_LIFETIME` - this field is output only and will

522

# default to 1

523

# * `TIME_UNIT_MONTHS` - must be between 1 and 2

524

# * `TIME_UNIT_WEEKS` - must be between 1 and 4

525

# * `TIME_UNIT_DAYS` - must be between 1 and 6

526

# * `TIME_UNIT_HOURS` - must be between 1 and 23

527

# * `TIME_UNIT_MINUTES` - must be between 1 and 59

528

"unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to

529

# `true`, the remaining frequency cap fields are not applicable.

530

"maxImpressions": 42, # The maximum number of times a user may be shown with the same ad

531

# during this period. Must be greater than 0.

532

#

533

# Applicable when unlimited is `false`.

534

},

535

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

536

#

537

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

538

"entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign

539

# can spend their budgets and bid on inventory.

540

#

541

# * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and

542

# `ENTITY_STATUS_PAUSED`.

543

# * For

544

# CreateCampaign method,

545

# `ENTITY_STATUS_ARCHIVED` is not allowed.

546

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

547

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

548

"campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.

549

"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign.

550

#

551

# Acceptable values for

552

# performance_goal_type are:

553

#

554

# * `PERFORMANCE_GOAL_TYPE_CPM`

555

# * `PERFORMANCE_GOAL_TYPE_CPC`

556

# * `PERFORMANCE_GOAL_TYPE_CPA`

557

# * `PERFORMANCE_GOAL_TYPE_CPIAVC`

558

# * `PERFORMANCE_GOAL_TYPE_CTR`

559

# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`

560

# * `PERFORMANCE_GOAL_TYPE_OTHER`

561

"performanceGoalType": "A String", # Required. The type of the performance goal.

562

"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.

563

#

564

# Applicable when

565

# performance_goal_type is one of:

566

#

567

# * `PERFORMANCE_GOAL_TYPE_CPM`

568

# * `PERFORMANCE_GOAL_TYPE_CPC`

569

# * `PERFORMANCE_GOAL_TYPE_CPA`

570

# * `PERFORMANCE_GOAL_TYPE_CPIAVC`

571

#

572

# For example 1500000 represents 1.5 standard units of the currency.

573

"performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros.

574

#

575

# Applicable when

576

# performance_goal_type is one of:

577

#

578

# * `PERFORMANCE_GOAL_TYPE_CTR`

579

# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`

580

#

581

# For example, 70000 represents 7% (decimal 0.07).

582

"performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty.

583

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

584

#

585

# Applicable when

586

# performance_goal_type is set to

587

# `PERFORMANCE_GOAL_TYPE_OTHER`.

588

},

589

"campaignGoalType": "A String", # Required. The type of the campaign goal.

590

},

591

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

592

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

}</pre>

</div>

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

598

<pre>Lists campaigns in an advertiser.

599

600

The order is defined by the order_by

601

parameter.

602

If a filter by

603

entity_status is not specified, campaigns with

604

`ENTITY_STATUS_ARCHIVED` will not be included in the results.

605

606

Args:

607

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

608

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

609

Typically, this is the value of

610

next_page_token returned from the

611

previous call to `ListCampaigns` method. If not specified, the first page

612

of results will be returned.

613

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

614

Acceptable values are:

615

616

* `displayName` (default)

617

* `entityStatus`

618

619

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

620

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

621

`displayName desc`.

622

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

623

default to `100`.

624

filter: string, Allows filtering by campaign properties.

Supported syntax:

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

629

* Restrictions can be combined by `AND` or `OR` logical operators. A

630

sequence of restrictions implicitly uses `AND`.

631

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

632

* The operator must be `EQUALS (=)`.

* Supported fields:

- `entityStatus`

Examples:

* All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an

639

advertiser:

640

`(entityStatus="ENTITY_STATUS_ACTIVE" OR

641

entityStatus="ENTITY_STATUS_PAUSED")`

642

643

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

644

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

651

652

{

653

"campaigns": [ # The list of campaigns.

654

#

655

# This list will be absent if empty.

656

{ # A single campaign.

657

"campaignFlight": { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.

658

"plannedDates": { # A date range. # Required. The dates that the campaign is expected to run. They are resolved

659

# relative to the parent advertiser's time zone.

660

#

661

# * The dates specified here will not affect serving. They are used to

662

# generate alerts and warnings. For example, if the flight date of any child

663

# insertion order is outside the range of these dates, the user interface

664

# will show a warning.

665

# * `start_date` is required and must be the current date or later.

666

# * `end_date` is optional. If specified, it must be the `start_date` or

667

# later.

668

# * Any specified date must be before the year 2037.

669

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value

670

# for `year`, `month`, and `day`.

671

# and time zone are either specified elsewhere or are not significant. The date

672

# is relative to the Proleptic Gregorian Calendar. This can represent:

673

#

674

# * A full date, with non-zero year, month and day values

675

# * A month and day value, with a zero year, e.g. an anniversary

676

# * A year on its own, with zero month and day values

677

# * A year and month value, with a zero day, e.g. a credit card expiration date

678

#

679

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

680

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

681

# a year.

682

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

683

# if specifying a year by itself or a year and month where the day is not

684

# significant.

685

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

686

# month and day.

687

},

688

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value

689

# for `year`, `month`, and `day`.

690

# and time zone are either specified elsewhere or are not significant. The date

691

# is relative to the Proleptic Gregorian Calendar. This can represent:

692

#

693

# * A full date, with non-zero year, month and day values

694

# * A month and day value, with a zero year, e.g. an anniversary

695

# * A year on its own, with zero month and day values

696

# * A year and month value, with a zero day, e.g. a credit card expiration date

697

#

698

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

699

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

700

# a year.

701

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

702

# if specifying a year by itself or a year and month where the day is not

703

# significant.

704

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

# month and day.

},

},

"plannedSpendAmountMicros": "A String", # The amount the campaign is expected to spend for its given

709

# planned_dates. This will not limit serving,

710

# but will be used for tracking spend in the DV360 UI.

711

#

712

# The amount is in micros. Must be greater than or equal to 0. For example,

713

# 500000000 represents 500 standard units of the currency.

714

},

715

"frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency cap setting of the campaign.

716

# ad during a given time period.

717

"timeUnit": "A String", # The time unit in which the frequency cap will be applied.

718

#

719

# Applicable when unlimited is `false`.

720

"timeUnitCount": 42, # The number of time_unit the frequency cap will

721

# last.

722

#

723

# Applicable when unlimited is `false`.

724

# The following restrictions apply based on the value of

725

# time_unit:

726

#

727

# * `TIME_UNIT_LIFETIME` - this field is output only and will

728

# default to 1

729

# * `TIME_UNIT_MONTHS` - must be between 1 and 2

730

# * `TIME_UNIT_WEEKS` - must be between 1 and 4

731

# * `TIME_UNIT_DAYS` - must be between 1 and 6

732

# * `TIME_UNIT_HOURS` - must be between 1 and 23

733

# * `TIME_UNIT_MINUTES` - must be between 1 and 59

734

"unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to

735

# `true`, the remaining frequency cap fields are not applicable.

736

"maxImpressions": 42, # The maximum number of times a user may be shown with the same ad

737

# during this period. Must be greater than 0.

738

#

739

# Applicable when unlimited is `false`.

740

},

741

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

742

#

743

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

744

"entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign

745

# can spend their budgets and bid on inventory.

746

#

747

# * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and

748

# `ENTITY_STATUS_PAUSED`.

749

# * For

750

# CreateCampaign method,

751

# `ENTITY_STATUS_ARCHIVED` is not allowed.

752

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

753

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

754

"campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.

755

"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign.

756

#

757

# Acceptable values for

758

# performance_goal_type are:

759

#

760

# * `PERFORMANCE_GOAL_TYPE_CPM`

761

# * `PERFORMANCE_GOAL_TYPE_CPC`

762

# * `PERFORMANCE_GOAL_TYPE_CPA`

763

# * `PERFORMANCE_GOAL_TYPE_CPIAVC`

764

# * `PERFORMANCE_GOAL_TYPE_CTR`

765

# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`

766

# * `PERFORMANCE_GOAL_TYPE_OTHER`

767

"performanceGoalType": "A String", # Required. The type of the performance goal.

768

"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.

769

#

770

# Applicable when

771

# performance_goal_type is one of:

772

#

773

# * `PERFORMANCE_GOAL_TYPE_CPM`

774

# * `PERFORMANCE_GOAL_TYPE_CPC`

775

# * `PERFORMANCE_GOAL_TYPE_CPA`

776

# * `PERFORMANCE_GOAL_TYPE_CPIAVC`

777

#

778

# For example 1500000 represents 1.5 standard units of the currency.

779

"performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros.

780

#

781

# Applicable when

782

# performance_goal_type is one of:

783

#

784

# * `PERFORMANCE_GOAL_TYPE_CTR`

785

# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`

786

#

787

# For example, 70000 represents 7% (decimal 0.07).

788

"performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty.

789

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

790

#

791

# Applicable when

792

# performance_goal_type is set to

793

# `PERFORMANCE_GOAL_TYPE_OTHER`.

794

},

795

"campaignGoalType": "A String", # Required. The type of the campaign goal.

796

},

797

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

798

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

799

},

800

],

801

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

802

# Pass this value in the page_token field

803

# in the subsequent call to `ListCampaigns` method to retrieve the next page

# of results.

}</pre>

</div>

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

810

<pre>Retrieves the next page of results.

811

812

Args:

813

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

814

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

815

816

Returns:

817

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

818

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

</pre>

</div>

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

824

<pre>Updates an existing campaign.

825

Returns the updated campaign if successful.

826

827

Args:

828

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

829

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

830

body: object, The request body.

831

The object takes the form of:

832

833

{ # A single campaign.

834

"campaignFlight": { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.

835

"plannedDates": { # A date range. # Required. The dates that the campaign is expected to run. They are resolved

836

# relative to the parent advertiser's time zone.

837

#

838

# * The dates specified here will not affect serving. They are used to

839

# generate alerts and warnings. For example, if the flight date of any child

840

# insertion order is outside the range of these dates, the user interface

841

# will show a warning.

842

# * `start_date` is required and must be the current date or later.

843

# * `end_date` is optional. If specified, it must be the `start_date` or

844

# later.

845

# * Any specified date must be before the year 2037.

846

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value

847

# for `year`, `month`, and `day`.

848

# and time zone are either specified elsewhere or are not significant. The date

849

# is relative to the Proleptic Gregorian Calendar. This can represent:

850

#

851

# * A full date, with non-zero year, month and day values

852

# * A month and day value, with a zero year, e.g. an anniversary

853

# * A year on its own, with zero month and day values

854

# * A year and month value, with a zero day, e.g. a credit card expiration date

855

#

856

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

857

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

858

# a year.

859

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

860

# if specifying a year by itself or a year and month where the day is not

861

# significant.

862

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

863

# month and day.

864

},

865

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value

866

# for `year`, `month`, and `day`.

867

# and time zone are either specified elsewhere or are not significant. The date

868

# is relative to the Proleptic Gregorian Calendar. This can represent:

869

#

870

# * A full date, with non-zero year, month and day values

871

# * A month and day value, with a zero year, e.g. an anniversary

872

# * A year on its own, with zero month and day values

873

# * A year and month value, with a zero day, e.g. a credit card expiration date

874

#

875

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

876

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

877

# a year.

878

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

879

# if specifying a year by itself or a year and month where the day is not

880

# significant.

881

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

# month and day.

},

},

"plannedSpendAmountMicros": "A String", # The amount the campaign is expected to spend for its given

886

# planned_dates. This will not limit serving,

887

# but will be used for tracking spend in the DV360 UI.

888

#

889

# The amount is in micros. Must be greater than or equal to 0. For example,

890

# 500000000 represents 500 standard units of the currency.

891

},

892

"frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency cap setting of the campaign.

893

# ad during a given time period.

894

"timeUnit": "A String", # The time unit in which the frequency cap will be applied.

895

#

896

# Applicable when unlimited is `false`.

897

"timeUnitCount": 42, # The number of time_unit the frequency cap will

898

# last.

899

#

900

# Applicable when unlimited is `false`.

901

# The following restrictions apply based on the value of

902

# time_unit:

903

#

904

# * `TIME_UNIT_LIFETIME` - this field is output only and will

905

# default to 1

906

# * `TIME_UNIT_MONTHS` - must be between 1 and 2

907

# * `TIME_UNIT_WEEKS` - must be between 1 and 4

908

# * `TIME_UNIT_DAYS` - must be between 1 and 6

909

# * `TIME_UNIT_HOURS` - must be between 1 and 23

910

# * `TIME_UNIT_MINUTES` - must be between 1 and 59

911

"unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to

912

# `true`, the remaining frequency cap fields are not applicable.

913

"maxImpressions": 42, # The maximum number of times a user may be shown with the same ad

914

# during this period. Must be greater than 0.

915

#

916

# Applicable when unlimited is `false`.

917

},

918

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

919

#

920

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

921

"entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign

922

# can spend their budgets and bid on inventory.

923

#

924

# * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and

925

# `ENTITY_STATUS_PAUSED`.

926

# * For

927

# CreateCampaign method,

928

# `ENTITY_STATUS_ARCHIVED` is not allowed.

929

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

930

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

931

"campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.

932

"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign.

933

#

934

# Acceptable values for

935

# performance_goal_type are:

936

#

937

# * `PERFORMANCE_GOAL_TYPE_CPM`

938

# * `PERFORMANCE_GOAL_TYPE_CPC`

939

# * `PERFORMANCE_GOAL_TYPE_CPA`

940

# * `PERFORMANCE_GOAL_TYPE_CPIAVC`

941

# * `PERFORMANCE_GOAL_TYPE_CTR`

942

# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`

943

# * `PERFORMANCE_GOAL_TYPE_OTHER`

944

"performanceGoalType": "A String", # Required. The type of the performance goal.

945

"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.

946

#

947

# Applicable when

948

# performance_goal_type is one of:

949

#

950

# * `PERFORMANCE_GOAL_TYPE_CPM`

951

# * `PERFORMANCE_GOAL_TYPE_CPC`

952

# * `PERFORMANCE_GOAL_TYPE_CPA`

953

# * `PERFORMANCE_GOAL_TYPE_CPIAVC`

954

#

955

# For example 1500000 represents 1.5 standard units of the currency.

956

"performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros.

957

#

958

# Applicable when

959

# performance_goal_type is one of:

960

#

961

# * `PERFORMANCE_GOAL_TYPE_CTR`

962

# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`

963

#

964

# For example, 70000 represents 7% (decimal 0.07).

965

"performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty.

966

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

967

#

968

# Applicable when

969

# performance_goal_type is set to

970

# `PERFORMANCE_GOAL_TYPE_OTHER`.

971

},

972

"campaignGoalType": "A String", # Required. The type of the campaign goal.

973

},

974

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

975

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

976

}

977

978

updateMask: string, Required. The mask to control which fields to update.

979

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

986

987

{ # A single campaign.

988

"campaignFlight": { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.

989

"plannedDates": { # A date range. # Required. The dates that the campaign is expected to run. They are resolved

990

# relative to the parent advertiser's time zone.

991

#

992

# * The dates specified here will not affect serving. They are used to

993

# generate alerts and warnings. For example, if the flight date of any child

994

# insertion order is outside the range of these dates, the user interface

995

# will show a warning.

996

# * `start_date` is required and must be the current date or later.

997

# * `end_date` is optional. If specified, it must be the `start_date` or

998

# later.

999

# * Any specified date must be before the year 2037.

1000

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value

1001

# for `year`, `month`, and `day`.

1002

# and time zone are either specified elsewhere or are not significant. The date

1003

# is relative to the Proleptic Gregorian Calendar. This can represent:

1004

#

1005

# * A full date, with non-zero year, month and day values

1006

# * A month and day value, with a zero year, e.g. an anniversary

1007

# * A year on its own, with zero month and day values

1008

# * A year and month value, with a zero day, e.g. a credit card expiration date

1009

#

1010

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

1011

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

1012

# a year.

1013

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

1014

# if specifying a year by itself or a year and month where the day is not

1015

# significant.

1016

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

1017

# month and day.

1018

},

1019

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value

1020

# for `year`, `month`, and `day`.

1021

# and time zone are either specified elsewhere or are not significant. The date

1022

# is relative to the Proleptic Gregorian Calendar. This can represent:

1023

#

1024

# * A full date, with non-zero year, month and day values

1025

# * A month and day value, with a zero year, e.g. an anniversary

1026

# * A year on its own, with zero month and day values

1027

# * A year and month value, with a zero day, e.g. a credit card expiration date

1028

#

1029

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

1030

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

1031

# a year.

1032

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

1033

# if specifying a year by itself or a year and month where the day is not

1034

# significant.

1035

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

# month and day.

},

},

"plannedSpendAmountMicros": "A String", # The amount the campaign is expected to spend for its given

1040

# planned_dates. This will not limit serving,

1041

# but will be used for tracking spend in the DV360 UI.

1042

#

1043

# The amount is in micros. Must be greater than or equal to 0. For example,

1044

# 500000000 represents 500 standard units of the currency.

1045

},

1046

"frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency cap setting of the campaign.

1047

# ad during a given time period.

1048

"timeUnit": "A String", # The time unit in which the frequency cap will be applied.

1049

#

1050

# Applicable when unlimited is `false`.

1051

"timeUnitCount": 42, # The number of time_unit the frequency cap will

1052

# last.

1053

#

1054

# Applicable when unlimited is `false`.

1055

# The following restrictions apply based on the value of

1056

# time_unit:

1057

#

1058

# * `TIME_UNIT_LIFETIME` - this field is output only and will

1059

# default to 1

1060

# * `TIME_UNIT_MONTHS` - must be between 1 and 2

1061

# * `TIME_UNIT_WEEKS` - must be between 1 and 4

1062

# * `TIME_UNIT_DAYS` - must be between 1 and 6

1063

# * `TIME_UNIT_HOURS` - must be between 1 and 23

1064

# * `TIME_UNIT_MINUTES` - must be between 1 and 59

1065

"unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to

1066

# `true`, the remaining frequency cap fields are not applicable.

1067

"maxImpressions": 42, # The maximum number of times a user may be shown with the same ad

1068

# during this period. Must be greater than 0.

1069

#

1070

# Applicable when unlimited is `false`.

1071

},

1072

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

1073

#

1074

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

1075

"entityStatus": "A String", # Required. Controls whether or not the insertion orders under this campaign

1076

# can spend their budgets and bid on inventory.

1077

#

1078

# * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and

1079

# `ENTITY_STATUS_PAUSED`.

1080

# * For

1081

# CreateCampaign method,

1082

# `ENTITY_STATUS_ARCHIVED` is not allowed.

1083

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

1084

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

1085

"campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.

1086

"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign.

1087

#

1088

# Acceptable values for

1089

# performance_goal_type are:

1090

#

1091

# * `PERFORMANCE_GOAL_TYPE_CPM`

1092

# * `PERFORMANCE_GOAL_TYPE_CPC`

1093

# * `PERFORMANCE_GOAL_TYPE_CPA`

1094

# * `PERFORMANCE_GOAL_TYPE_CPIAVC`

1095

# * `PERFORMANCE_GOAL_TYPE_CTR`

1096

# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`

1097

# * `PERFORMANCE_GOAL_TYPE_OTHER`

1098

"performanceGoalType": "A String", # Required. The type of the performance goal.

1099

"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.

1100

#

1101

# Applicable when

1102

# performance_goal_type is one of:

1103

#

1104

# * `PERFORMANCE_GOAL_TYPE_CPM`

1105

# * `PERFORMANCE_GOAL_TYPE_CPC`

1106

# * `PERFORMANCE_GOAL_TYPE_CPA`

1107

# * `PERFORMANCE_GOAL_TYPE_CPIAVC`

1108

#

1109

# For example 1500000 represents 1.5 standard units of the currency.

1110

"performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros.

1111

#

1112

# Applicable when

1113

# performance_goal_type is one of:

1114

#

1115

# * `PERFORMANCE_GOAL_TYPE_CTR`

1116

# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`

1117

#

1118

# For example, 70000 represents 7% (decimal 0.07).

1119

"performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty.

1120

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

1121

#

1122

# Applicable when

1123

# performance_goal_type is set to

1124

# `PERFORMANCE_GOAL_TYPE_OTHER`.

1125

},

1126

"campaignGoalType": "A String", # Required. The type of the campaign goal.

1127

},

1128

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

1129

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

}</pre>

</div>

</body></html>