Blame - docs/dyn/displayvideo_v1.advertisers.lineItems.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.lineItems.html">lineItems</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="displayvideo_v1.advertisers.lineItems.targetingTypes.html">targetingTypes()</a></code>

79

</p>

80

<p class="firstline">Returns the targetingTypes Resource.</p>

81

82

83

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

84

<p class="firstline">Bulk edits targeting options under a single line item.</p>

85

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

86

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

87

<p class="firstline">Lists assigned targeting options of a line item across targeting types.</p>

88

89

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

90

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

91

92

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

93

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

94

95

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

96

<p class="firstline">Deletes a line item.</p>

97

98

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

99

100

101

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

102

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

103

104

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

105

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

106

107

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

108

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

109

<h3>Method Details</h3>

110

111

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

112

<pre>Bulk edits targeting options under a single line item.

113

The operation will delete the assigned targeting options provided in

114

BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and

115

then create the assigned targeting options provided in

116

BulkEditLineItemAssignedTargetingOptionsRequest.create_requests .

117

118

Args:

119

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

120

lineItemId: string, Required. The ID of the line item the assigned targeting option will belong to. (required)

121

body: object, The request body.

122

The object takes the form of:

123

124

{ # Request message for

125

# BulkEditLineItemAssignedTargetingOptions.

126

"deleteRequests": [ # The assigned targeting options to delete in batch, specified as a list of

127

# `DeleteAssignedTargetingOptionsRequest`.

128

{ # A request listing which assigned targeting options of a given targeting type

129

# should be deleted.

130

"targetingType": "A String", # Required. Identifies the type of this assigned targeting option.

131

"assignedTargetingOptionIds": [ # Required. The assigned targeting option IDs to delete.

"A String",

],

},

],

"createRequests": [ # The assigned targeting options to create in batch, specified as a list of

137

# `CreateAssignedTargetingOptionsRequest`.

138

{ # A request listing which assigned targeting options of a given targeting type

139

# should be created and added.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

140

"targetingType": "A String", # Required. Identifies the type of this assigned targeting option.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

141

"assignedTargetingOptions": [ # Required. The assigned targeting options to create and add.

142

{ # A single assigned targeting option, which defines the state of a targeting

143

# option for an entity with targeting settings, such as a Line Item or

144

# Insertion Order.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

145

"appDetails": { # Details for assigned app targeting option. This will be populated in the # App details. This field will be populated when the

146

# TargetingType is `TARGETING_TYPE_APP`.

147

# details field of an AssignedTargetingOption when

148

# targeting_type is

149

# `TARGETING_TYPE_APP`.

150

"displayName": "A String", # Output only. The display name of the app.

151

"appId": "A String", # Required. The ID of the app.

152

#

153

# Android's Play store app uses bundle ID, for example

154

# `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for

155

# example `422689480`.

156

"negative": True or False, # Indicates if this option is being negatively targeted.

157

},

158

"parentalStatusDetails": { # Details for assigned parental status targeting option. This will be # Parental status details. This field will be populated when the

159

# TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`.

160

# populated in the details field of an AssignedTargetingOption when

161

# targeting_type is

162

# `TARTGETING_TYPE_PARENTAL_STATUS`.

163

"targetingOptionId": "A String", # Required. The targeting_option_id of a

164

# TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`.

165

"parentalStatus": "A String", # Output only. The parental status of the audience.

166

},

167

"targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.

168

"urlDetails": { # Details for assigned URL targeting option. This will be populated in the # URL details. This field will be populated when the

169

# TargetingType is `TARGETING_TYPE_URL`.

170

# details field of an AssignedTargetingOption when

171

# targeting_type is

172

# `TARGETING_TYPE_URL`.

173

"url": "A String", # Required. The URL, for example `example.com`.

174

#

175

# DV360 supports two levels of subdirectory targeting, for example

176

# `www.example.com/one-subdirectory-level/second-level`, and five levels of

177

# subdomain targeting, for example `five.four.three.two.one.example.com`.

178

"negative": True or False, # Indicates if this option is being negatively targeted.

179

},

180

"onScreenPositionDetails": { # On screen position targeting option details. This will be # On screen position details. This field will be populated when the

181

# TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`.

182

# populated in the

183

# on_screen_position_details

184

# field when

185

# targeting_type is

186

# `TARGETING_TYPE_ON_SCREEN_POSITION`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

187

"targetingOptionId": "A String", # Required. The targeting_option_id field when

188

# targeting_type is

189

# `TARGETING_TYPE_ON_SCREEN_POSITION`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

190

"onScreenPosition": "A String", # Output only. The on screen position.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

191

},

192

"videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the # Video player size details. This field will be populated when the

193

# TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.

194

# video_player_size_details

195

# field when targeting_type is

196

# `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.

197

# Explicitly targeting all options is not supported. Remove all video player

198

# size targeting options to achieve this effect.

199

"videoPlayerSize": "A String", # Output only. The video player size.

200

"targetingOptionId": "A String", # Required. The targeting_option_id field when

201

# targeting_type is

202

# `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.

203

},

204

"channelDetails": { # Details for assigned channel targeting option. This will be populated in # Channel details. This field will be populated when the

205

# TargetingType is `TARGETING_TYPE_CHANNEL`.

206

# the details field of an AssignedTargetingOption when

207

# targeting_type is

208

# `TARGETING_TYPE_CHANNEL`.

209

"channelId": "A String", # Required. ID of the channel. Should refer to the channel ID

210

# field on a

211

# [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or

212

# [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id)

213

# resource.

214

"negative": True or False, # Indicates if this option is being negatively targeted. For advertiser

215

# level assigned targeting option, this field must be true.

216

},

217

"operatingSystemDetails": { # Assigned operating system targeting option details. This will be # Operating system details. This field will be populated when the

218

# TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`.

219

# populated in the

220

# operating_system_details

221

# field when

222

# targeting_type is

223

# `TARGETING_TYPE_OPERATING_SYSTEM`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

224

"displayName": "A String", # Output only. The display name of the operating system.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

225

"negative": True or False, # Indicates if this option is being negatively targeted.

226

"targetingOptionId": "A String", # Required. The targeting option ID populated in

227

# targeting_option_id field when

228

# targeting_type is

229

# `TARGETING_TYPE_OPERATING_SYSTEM`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

230

},

231

"thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be # Third party verification details. This field will be populated when the

232

# TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.

233

# populated in the details field of an AssignedTargetingOption when

234

# targeting_type is

235

# `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

236

"integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

237

"excludedAdFraudRisk": "A String", # Ad Fraud settings.

238

"displayViewability": "A String", # Display Viewability section (applicable to display line items only).

239

"excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.

240

"excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.

241

"excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.

242

"excludedAdultRisk": "A String", # Brand Safety - **Adult content**.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

243

"traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).

244

"videoViewability": "A String", # Video Viewability Section (applicable to video line items only).

245

"excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.

246

"excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.

247

"excludeUnrateable": True or False, # Brand Safety - **Unrateable**.

248

"excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.

249

"excludedViolenceRisk": "A String", # Brand Safety - **Violence**.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

250

},

251

"doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.

252

"videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).

253

"playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player

254

# size.

255

"videoIab": "A String", # Target web inventory to maximize IAB viewable rate.

256

"videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.

257

},

258

"avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.

259

"A String",

260

],

261

"fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.

262

"avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.

263

"avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.

264

},

265

"brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.

266

"avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.

267

"A String",

268

],

269

"avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.

270

"A String",

271

],

272

"avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.

273

},

274

"appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.

275

"avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.

276

"avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.

277

},

278

"displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).

279

"viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.

280

"iab": "A String", # Target web and app inventory to maximize IAB viewable rate.

281

},

282

},

283

"adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox.

284

"excludedAdlooxCategories": [ # Adloox's brand safety settings.

285

"A String",

286

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

287

},

288

},

289

"proximityLocationListDetails": { # Targeting details for proximity location list. This will be # Proximity location list details. This field will be populated when the

290

# TargetingType is

291

# `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.

292

# populated in the details field of an AssignedTargetingOption when

293

# targeting_type is

294

# `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

295

"proximityRadiusRange": "A String", # Required. Radius range for proximity location list.

296

# This represents the size of the area around a chosen location that will be

297

# targeted.

298

#

299

# `All` proximity location targeting under a single line item must have the

300

# same radius range value. Set this value to match any existing targeting.

301

# If updated, this field will change the radius range for all proximity

302

# targeting under the line item.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

303

"proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the

304

# location_list_id field of a

305

# LocationList resource whose type is

306

# `TARGETING_LOCATION_TYPE_PROXIMITY`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

307

},

308

"ageRangeDetails": { # Represents a targetable age range. This will be populated in the details # Age range details. This field will be populated when the

309

# TargetingType is `TARGETING_TYPE_AGE_RANGE`.

310

# field of an AssignedTargetingOption when

311

# targeting_type is

312

# `TARGETING_TYPE_AGE_RANGE`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

313

"targetingOptionId": "A String", # Required. The targeting_option_id of a

314

# TargetingOption of type `TARGETING_TYPE_AGE_RANGE`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

315

"ageRange": "A String", # Output only. The age range of an audience. We only support targeting a continuous age

316

# range of an audience. Thus, the age range represented in this field can be

317

# 1) targeted solely, or, 2) part of a larger continuous age range. The reach

318

# of a continuous age range targeting can be expanded by also targeting an

319

# audience of an unknown age.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

320

},

321

"subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in # Sub-exchange details. This field will be populated when the

322

# TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`.

323

# the details field of an AssignedTargetingOption when

324

# targeting_type is

325

# `TARGETING_TYPE_SUB_EXCHANGE`.

326

"targetingOptionId": "A String", # Required. The targeting_option_id of a

327

# TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.

328

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

329

"keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the # Keyword details. This field will be populated when the TargetingType is

330

# `TARGETING_TYPE_KEYWORD`.

331

#

332

# A maximum of 5000 direct negative keywords can be assigned to a

333

# line item. No limit on number of positive keywords that can be assigned.

334

# details field of an AssignedTargetingOption when

335

# targeting_type is

336

# `TARGETING_TYPE_KEYWORD`.

337

"negative": True or False, # Indicates if this option is being negatively targeted.

338

"keyword": "A String", # Required. The keyword, for example `car insurance`.

339

#

340

# Positive keyword cannot be offensive word.

341

# Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number

342

# of characters is 80. Maximum number of words is 10.

343

},

344

"deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be # Device make and model details. This field will be populated when the

345

# TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.

346

# populated in the

347

# device_make_model_details

348

# field when

349

# targeting_type is

350

# `TARGETING_TYPE_DEVICE_MAKE_MODEL`.

351

"negative": True or False, # Indicates if this option is being negatively targeted.

352

"targetingOptionId": "A String", # Required. The targeting_option_id field when

353

# targeting_type is

354

# `TARGETING_TYPE_DEVICE_MAKE_MODEL`.

355

"displayName": "A String", # Output only. The display name of the device make and model.

356

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

357

"digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be # Digital content label details. This field will be populated when the

358

# TargetingType is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.

359

#

360

# Digital content labels are targeting exclusions. Advertiser level digital

361

# content label exclusions, if set, are always applied in serving (even

362

# though they aren't visible in line item settings). Line item settings can

363

# exclude content labels in addition to advertiser exclusions, but can't

364

# override them. A line item won't serve if all the digital content labels

365

# are excluded.

366

# populated in the details field of an AssignedTargetingOption when

367

# targeting_type is

368

# `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.

369

"excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED.

370

"contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier.

371

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

372

"browserDetails": { # Details for assigned browser targeting option. This will be populated in # Browser details. This field will be populated when the

373

# TargetingType is `TARGETING_TYPE_BROWSER`.

374

# the details field of an AssignedTargetingOption when

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

375

# targeting_type is

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

376

# `TARGETING_TYPE_BROWSER`.

377

"targetingOptionId": "A String", # Required. The targeting_option_id of a

378

# TargetingOption of type `TARGETING_TYPE_BROWSER`.

379

"displayName": "A String", # Output only. The display name of the browser.

380

"negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser

381

# targeting options on the same line item must have the same value for this

382

# field.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

383

},

384

"appCategoryDetails": { # Details for assigned app category targeting option. This will be # App category details. This field will be populated when the

385

# TargetingType is `TARGETING_TYPE_APP_CATEGORY`.

386

# populated in the

387

# app_category_details field of

388

# an AssignedTargetingOption when

389

# targeting_type

390

# is `TARGETING_TYPE_APP_CATEGORY`.

391

"negative": True or False, # Indicates if this option is being negatively targeted.

392

"targetingOptionId": "A String", # Required. The targeting_option_id field when

393

# targeting_type is

394

# `TARGETING_TYPE_APP_CATEGORY`.

395

"displayName": "A String", # Output only. The display name of the app category.

396

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

397

"contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be # Content outstream position details. This field will be populated when the

398

# TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.

399

# populated in the

400

# content_outstream_position_details

401

# field when

402

# targeting_type is

403

# `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.

404

"targetingOptionId": "A String", # Required. The targeting_option_id field when

405

# targeting_type is

406

# `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.

407

"contentOutstreamPosition": "A String", # Output only. The content outstream position.

408

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

409

"negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the # Keyword details. This field will be populated when the

410

# TargetingType is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.

411

#

412

# A maximum of 4 negative keyword lists can be assigned to a line item.

413

# details field of an AssignedTargetingOption when

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

414

# targeting_type is

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

415

# `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.

416

"negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the

417

# negative_keyword_list_id

418

# field of a NegativeKeywordList resource.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

419

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

420

"genderDetails": { # Details for assigned gender targeting option. This will be populated in # Gender details. This field will be populated when the

421

# TargetingType is `TARGETING_TYPE_GENDER`.

422

# the details field of an AssignedTargetingOption when

423

# targeting_type is

424

# `TARTGETING_TYPE_GENDER`.

425

"targetingOptionId": "A String", # Required. The targeting_option_id of a

426

# TargetingOption of type `TARGETING_TYPE_GENDER`.

427

"gender": "A String", # Output only. The gender of the audience.

428

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

429

"name": "A String", # Output only. The resource name for this assigned targeting option.

430

"inventorySourceDetails": { # Targeting details for inventory source. This will be # Inventory source details. This field will be populated when the

431

# TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`.

432

# populated in the details field of an AssignedTargetingOption when

433

# targeting_type is

434

# `TARGETING_TYPE_INVENTORY_SOURCE`.

435

"inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the

436

# inventory_source_id field of an

437

# InventorySource resource.

438

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

439

"sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the # Sensitive category details. This field will be populated when the

440

# TargetingType is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.

441

#

442

# Sensitive categories are targeting exclusions. Advertiser level sensitive

443

# category exclusions, if set, are always applied in serving (even though

444

# they aren't visible in line item settings). Line item settings can

445

# exclude sensitive categories in addition to advertiser exclusions, but

446

# can't override them.

447

# details field of an AssignedTargetingOption when

448

# targeting_type is

449

# `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.

450

"excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED.

451

"sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier.

452

},

453

"audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in # Audience targeting details. This field will be populated when the

454

# TargetingType is `TARGETING_TYPE_AUDIENCE_GROUP`.

455

# You can only target one audience group option per line item.

456

# the details field of an AssignedTargetingOption when

457

# targeting_type is

458

# `TARGETING_TYPE_AUDIENCE_GROUP`.

459

# The relation between each group is UNION, except for

460

# excluded_first_and_third_party_audience_group and

461

# excluded_google_audience_group, of which COMPLEMENT is UNION'ed with other

462

# groups.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

463

"includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first

464

# and third party audience groups. Each first and third party audience group

465

# contains first and third party audience ids only.

466

# The relation between each first and third party audience group is

467

# INTERSECTION, and the result is UNION'ed with other audience groups.

468

# Repeated groups with same settings will be ignored.

469

{ # Details of first and third party audience group.

470

# All first and third party audience targeting settings are logically ‘OR’ of

471

# each other.

472

"settings": [ # Required. All first and third party audience targeting settings in first and

473

# third party audience group.

474

# Repeated settings with same id are not allowed.

475

{ # Details of first and third party audience targeting setting.

476

"recency": "A String", # The recency of the first and third party audience targeting setting.

477

# Only applicable to first party audiences, otherwise

478

# will be ignored. For more info, refer to

479

# https://support.google.com/displayvideo/answer/2949947#recency

480

# When unspecified, no recency limit will be used.

481

"firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience

482

# targeting setting. This id is

483

# first_and_third_party_audience_id.

},

],

},

],

"includedCombinedAudienceGroup": { # Details of combined audience group. # The combined audience ids of the included combined audience group.

489

# Contains combined audience ids only.

490

# All combined audience targeting settings are logically ‘OR’ of each other.

491

"settings": [ # Required. All combined audience targeting settings in combined audience group.

492

# Repeated settings with same id will be ignored.

493

# The number of combined audience settings should be no more than five, error

494

# will be thrown otherwise.

495

{ # Details of combined audience targeting setting.

496

"combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting.

497

# This id is combined_audience_id.

498

},

499

],

500

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

501

"includedCustomListGroup": { # Details of custom list group. # The custom list ids of the included custom list group.

502

# Contains custom list ids only.

503

# All custom list targeting settings are logically ‘OR’ of each other.

504

"settings": [ # Required. All custom list targeting settings in custom list group.

505

# Repeated settings with same id will be ignored.

506

{ # Details of custom list targeting setting.

507

"customListId": "A String", # Required. Custom id of custom list targeting setting.

508

# This id is custom_list_id.

},

],

},

"excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. # The first and third party audience ids and recencies of the excluded

513

# first and third party audience group. Used for negative targeting. Its

514

# COMPLEMENT is used to UNION other audience groups.

515

# All first and third party audience targeting settings are logically ‘OR’ of

516

# each other.

517

"settings": [ # Required. All first and third party audience targeting settings in first and

518

# third party audience group.

519

# Repeated settings with same id are not allowed.

520

{ # Details of first and third party audience targeting setting.

521

"recency": "A String", # The recency of the first and third party audience targeting setting.

522

# Only applicable to first party audiences, otherwise

523

# will be ignored. For more info, refer to

524

# https://support.google.com/displayvideo/answer/2949947#recency

525

# When unspecified, no recency limit will be used.

526

"firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience

527

# targeting setting. This id is

528

# first_and_third_party_audience_id.

},

],

},

"includedGoogleAudienceGroup": { # Details of Google audience group. # The Google audience ids of the included Google audience group.

533

# Contains Google audience ids only.

534

# All Google audience targeting settings are logically ‘OR’ of each other.

535

"settings": [ # Required. All Google audience targeting settings in Google audience group.

536

# Repeated settings with same id will be ignored.

537

{ # Details of Google audience targeting setting.

538

"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting.

539

# This id is google_audience_id.

},

],

},

"excludedGoogleAudienceGroup": { # Details of Google audience group. # The Google audience ids of the excluded Google audience group.

544

# Used for negative targeting. It's COMPLEMENT is used to UNION other

545

# audience groups.

546

# Only contains Affinity, In-market and Installed-apps type Google audiences.

547

# All items are logically ‘OR’ of each other.

548

# All Google audience targeting settings are logically ‘OR’ of each other.

549

"settings": [ # Required. All Google audience targeting settings in Google audience group.

550

# Repeated settings with same id will be ignored.

551

{ # Details of Google audience targeting setting.

552

"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting.

553

# This id is google_audience_id.

554

},

555

],

556

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

557

},

558

"userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in # User rewarded content details. This field will be populated when the

559

# TargetingType is

560

# `TARGETING_TYPE_USER_REWARDED_CONTENT`.

561

# the

562

# user_rewarded_content_details

563

# field when

564

# targeting_type is

565

# `TARGETING_TYPE_USER_REWARDED_CONTENT`.

566

"userRewardedContent": "A String", # Output only. User rewarded content status for video ads.

567

"targetingOptionId": "A String", # Required. The targeting_option_id field when

568

# targeting_type is

569

# `TARGETING_TYPE_USER_REWARDED_CONTENT`.

570

},

571

"languageDetails": { # Details for assigned language targeting option. This will be populated in the # Language details. This field will be populated when the TargetingType is

572

# `TARGETING_TYPE_LANGUAGE`.

573

# details field of an AssignedTargetingOption when

574

# targeting_type is

575

# `TARGETING_TYPE_LANGUAGE`.

576

"targetingOptionId": "A String", # Required. The targeting_option_id of a

577

# TargetingOption of type `TARGETING_TYPE_LANGUAGE`.

578

"displayName": "A String", # Output only. The display name of the language (e.g., "French").

579

"negative": True or False, # Indicates if this option is being negatively targeted. All assigned

580

# language targeting options on the same line item must have the same value

581

# for this field.

582

},

583

"authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in # Authorized seller status details. This field will be populated when the

584

# TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.

585

#

586

# You can only target one authorized seller status option per line item.

587

#

588

# If a line item doesn't have an authorized seller status option, all

589

# authorized sellers indicated as DIRECT or RESELLER in the ads.txt file

590

# are targeted by default.

591

# the details field of an AssignedTargetingOption when

592

# targeting_type is

593

# `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

594

"authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

595

"targetingOptionId": "A String", # Required. The targeting_option_id of a

596

# TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

597

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

598

"dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and # Day and time details. This field will be populated when the

599

# TargetingType is `TARGETING_TYPE_DAY_AND_TIME`.

600

# with a start and end time.

601

# The time represented by `start_hour` must be before the time represented by

602

# `end_hour`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

603

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.

604

"startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day)

605

# and 23 (1 hour before end of day).

606

"endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after

607

# start of day) and 24 (end of day).

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

608

"timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time

609

# targeting setting.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

610

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

611

"inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

612

"environmentDetails": { # Assigned environment targeting option details. This will be populated # Environment details. This field will be populated when the

613

# TargetingType is `TARGETING_TYPE_ENVIRONMENT`.

614

# in the details field of an AssignedTargetingOption when

615

# targeting_type is

616

# `TARGETING_TYPE_ENVIRONMENT`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

617

"targetingOptionId": "A String", # Required. The targeting_option_id of a

618

# TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., "508010"

619

# for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option).

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

620

"environment": "A String", # Output only. The serving environment.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

621

},

622

"geoRegionDetails": { # Details for assigned geographic region targeting option. This will be # Geographic region details. This field will be populated when the

623

# TargetingType is `TARGETING_TYPE_GEO_REGION`.

624

# populated in the details field of an AssignedTargetingOption when

625

# targeting_type is

626

# `TARGETING_TYPE_GEO_REGION`.

627

"targetingOptionId": "A String", # Required. The targeting_option_id of a

628

# TargetingOption of type `TARGETING_TYPE_GEO_REGION`.

629

"displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").

630

"geoRegionType": "A String", # Output only. The type of geographic region targeting.

631

"negative": True or False, # Indicates if this option is being negatively targeted.

632

},

633

"deviceTypeDetails": { # Targeting details for device type. This will be # Device Type details. This field will be populated when the

634

# TargetingType is

635

# `TARGETING_TYPE_DEVICE_TYPE`.

636

# populated in the details field of an AssignedTargetingOption when

637

# targeting_type is

638

# `TARGETING_TYPE_DEVICE_TYPE`.

639

"targetingOptionId": "A String", # Required. ID of the device type.

640

"deviceType": "A String", # Output only. The display name of the device type.

641

},

642

"exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in # Exchange details. This field will be populated when the

643

# TargetingType is `TARGETING_TYPE_EXCHANGE`.

644

# the details field of an AssignedTargetingOption when

645

# targeting_type is

646

# `TARGETING_TYPE_EXCHANGE`.

647

"targetingOptionId": "A String", # Required. The targeting_option_id of a

648

# TargetingOption of type `TARGETING_TYPE_EXCHANGE`.

649

},

650

"assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique

651

# within a given line item and targeting type. It may be reused in other

652

# contexts.

653

"householdIncomeDetails": { # Details for assigned household income targeting option. This will be # Household income details. This field will be populated when the

654

# TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`.

655

# populated in the details field of an AssignedTargetingOption when

656

# targeting_type is

657

# `TARGETING_TYPE_HOUSEHOLD_INCOME`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

658

"householdIncome": "A String", # Output only. The household income of the audience.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

659

"targetingOptionId": "A String", # Required. The targeting_option_id of a

660

# TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

661

},

662

"contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be # Content instream position details. This field will be populated when the

663

# TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.

664

# populated in the

665

# content_instream_position_details

666

# field when

667

# targeting_type is

668

# `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

669

"targetingOptionId": "A String", # Required. The targeting_option_id field when

670

# targeting_type is

671

# `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

672

"contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

673

},

674

"categoryDetails": { # Assigned category targeting option details. This will be populated in the # Category details. This field will be populated when the TargetingType is

675

# `TARGETING_TYPE_CATEGORY`.

676

#

677

# Targeting a category will also target its subcategories. If a category is

678

# excluded from targeting and a subcategory is included, the exclusion will

679

# take precedence.

680

# category_details field when

681

# targeting_type is

682

# `TARGETING_TYPE_CATEGORY`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

683

"targetingOptionId": "A String", # Required. The targeting_option_id field when

684

# targeting_type is

685

# `TARGETING_TYPE_CATEGORY`.

686

"displayName": "A String", # Output only. The display name of the category.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

687

"negative": True or False, # Indicates if this option is being negatively targeted.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

688

},

689

"inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be # Inventory source group details. This field will be populated when the

690

# TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.

691

# populated in the details field of an AssignedTargetingOption when

692

# targeting_type is

693

# `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.

694

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the

695

# inventory_source_group_id

696

# field of an InventorySourceGroup resource.

697

},

698

"regionalLocationListDetails": { # Targeting details for regional location list. This will be # Regional location list details. This field will be populated when the

699

# TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.

700

# populated in the details field of an AssignedTargetingOption when

701

# targeting_type is

702

# `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.

703

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the

704

# location_list_id field of a

705

# LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.

706

"negative": True or False, # Indicates if this option is being negatively targeted.

707

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

708

"carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated # Carrier and ISP details. This field will be populated when the

709

# TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`.

710

# in the details field of an AssignedTargetingOption when

711

# targeting_type is

712

# `TARGETING_TYPE_CARRIER_AND_ISP`.

713

"negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier

714

# and ISP targeting options on the same line item must have the same value

715

# for this field.

716

"targetingOptionId": "A String", # Required. The targeting_option_id of a

717

# TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.

718

"displayName": "A String", # Output only. The display name of the carrier or ISP.

719

},

720

"viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the # Viewability details. This field will be populated when the TargetingType

721

# is `TARGETING_TYPE_VIEWABILITY`.

722

#

723

# You can only target one viewability option per line item.

724

# viewability_details field of

725

# an AssignedTargetingOption when

726

# targeting_type is

727

# `TARGETING_TYPE_VIEWABILITY`.

728

"viewability": "A String", # Output only. The predicted viewability percentage.

729

"targetingOptionId": "A String", # Required. The targeting_option_id of a

730

# TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., "509010"

731

# for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option).

732

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

733

},

734

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

746

747

{

748

"createdAssignedTargetingOptions": [ # The list of assigned targeting options that have been successfully created.

749

#

750

# This list will be absent if empty.

751

{ # A single assigned targeting option, which defines the state of a targeting

752

# option for an entity with targeting settings, such as a Line Item or

753

# Insertion Order.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

754

"appDetails": { # Details for assigned app targeting option. This will be populated in the # App details. This field will be populated when the

755

# TargetingType is `TARGETING_TYPE_APP`.

756

# details field of an AssignedTargetingOption when

757

# targeting_type is

758

# `TARGETING_TYPE_APP`.

759

"displayName": "A String", # Output only. The display name of the app.

760

"appId": "A String", # Required. The ID of the app.

761

#

762

# Android's Play store app uses bundle ID, for example

763

# `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for

764

# example `422689480`.

765

"negative": True or False, # Indicates if this option is being negatively targeted.

766

},

767

"parentalStatusDetails": { # Details for assigned parental status targeting option. This will be # Parental status details. This field will be populated when the

768

# TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`.

769

# populated in the details field of an AssignedTargetingOption when

770

# targeting_type is

771

# `TARTGETING_TYPE_PARENTAL_STATUS`.

772

"targetingOptionId": "A String", # Required. The targeting_option_id of a

773

# TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`.

774

"parentalStatus": "A String", # Output only. The parental status of the audience.

775

},

776

"targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.

777

"urlDetails": { # Details for assigned URL targeting option. This will be populated in the # URL details. This field will be populated when the

778

# TargetingType is `TARGETING_TYPE_URL`.

779

# details field of an AssignedTargetingOption when

780

# targeting_type is

781

# `TARGETING_TYPE_URL`.

782

"url": "A String", # Required. The URL, for example `example.com`.

783

#

784

# DV360 supports two levels of subdirectory targeting, for example

785

# `www.example.com/one-subdirectory-level/second-level`, and five levels of

786

# subdomain targeting, for example `five.four.three.two.one.example.com`.

787

"negative": True or False, # Indicates if this option is being negatively targeted.

788

},

789

"onScreenPositionDetails": { # On screen position targeting option details. This will be # On screen position details. This field will be populated when the

790

# TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`.

791

# populated in the

792

# on_screen_position_details

793

# field when

794

# targeting_type is

795

# `TARGETING_TYPE_ON_SCREEN_POSITION`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

796

"targetingOptionId": "A String", # Required. The targeting_option_id field when

797

# targeting_type is

798

# `TARGETING_TYPE_ON_SCREEN_POSITION`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

799

"onScreenPosition": "A String", # Output only. The on screen position.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

800

},

801

"videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the # Video player size details. This field will be populated when the

802

# TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.

803

# video_player_size_details

804

# field when targeting_type is

805

# `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.

806

# Explicitly targeting all options is not supported. Remove all video player

807

# size targeting options to achieve this effect.

808

"videoPlayerSize": "A String", # Output only. The video player size.

809

"targetingOptionId": "A String", # Required. The targeting_option_id field when

810

# targeting_type is

811

# `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.

812

},

813

"channelDetails": { # Details for assigned channel targeting option. This will be populated in # Channel details. This field will be populated when the

814

# TargetingType is `TARGETING_TYPE_CHANNEL`.

815

# the details field of an AssignedTargetingOption when

816

# targeting_type is

817

# `TARGETING_TYPE_CHANNEL`.

818

"channelId": "A String", # Required. ID of the channel. Should refer to the channel ID

819

# field on a

820

# [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or

821

# [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id)

822

# resource.

823

"negative": True or False, # Indicates if this option is being negatively targeted. For advertiser

824

# level assigned targeting option, this field must be true.

825

},

826

"operatingSystemDetails": { # Assigned operating system targeting option details. This will be # Operating system details. This field will be populated when the

827

# TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`.

828

# populated in the

829

# operating_system_details

830

# field when

831

# targeting_type is

832

# `TARGETING_TYPE_OPERATING_SYSTEM`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

833

"displayName": "A String", # Output only. The display name of the operating system.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

834

"negative": True or False, # Indicates if this option is being negatively targeted.

835

"targetingOptionId": "A String", # Required. The targeting option ID populated in

836

# targeting_option_id field when

837

# targeting_type is

838

# `TARGETING_TYPE_OPERATING_SYSTEM`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

839

},

840

"thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be # Third party verification details. This field will be populated when the

841

# TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.

842

# populated in the details field of an AssignedTargetingOption when

843

# targeting_type is

844

# `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

845

"integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

846

"excludedAdFraudRisk": "A String", # Ad Fraud settings.

847

"displayViewability": "A String", # Display Viewability section (applicable to display line items only).

848

"excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.

849

"excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.

850

"excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.

851

"excludedAdultRisk": "A String", # Brand Safety - **Adult content**.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

852

"traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).

853

"videoViewability": "A String", # Video Viewability Section (applicable to video line items only).

854

"excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.

855

"excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.

856

"excludeUnrateable": True or False, # Brand Safety - **Unrateable**.

857

"excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.

858

"excludedViolenceRisk": "A String", # Brand Safety - **Violence**.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

859

},

860

"doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.

861

"videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).

862

"playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player

863

# size.

864

"videoIab": "A String", # Target web inventory to maximize IAB viewable rate.

865

"videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.

866

},

867

"avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.

868

"A String",

869

],

870

"fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.

871

"avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.

872

"avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.

873

},

874

"brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.

875

"avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.

876

"A String",

877

],

878

"avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.

879

"A String",

880

],

881

"avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.

882

},

883

"appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.

884

"avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.

885

"avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.

886

},

887

"displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).

888

"viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.

889

"iab": "A String", # Target web and app inventory to maximize IAB viewable rate.

890

},

891

},

892

"adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox.

893

"excludedAdlooxCategories": [ # Adloox's brand safety settings.

894

"A String",

895

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

896

},

897

},

898

"proximityLocationListDetails": { # Targeting details for proximity location list. This will be # Proximity location list details. This field will be populated when the

899

# TargetingType is

900

# `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.

901

# populated in the details field of an AssignedTargetingOption when

902

# targeting_type is

903

# `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

904

"proximityRadiusRange": "A String", # Required. Radius range for proximity location list.

905

# This represents the size of the area around a chosen location that will be

906

# targeted.

907

#

908

# `All` proximity location targeting under a single line item must have the

909

# same radius range value. Set this value to match any existing targeting.

910

# If updated, this field will change the radius range for all proximity

911

# targeting under the line item.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

912

"proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the

913

# location_list_id field of a

914

# LocationList resource whose type is

915

# `TARGETING_LOCATION_TYPE_PROXIMITY`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

916

},

917

"ageRangeDetails": { # Represents a targetable age range. This will be populated in the details # Age range details. This field will be populated when the

918

# TargetingType is `TARGETING_TYPE_AGE_RANGE`.

919

# field of an AssignedTargetingOption when

920

# targeting_type is

921

# `TARGETING_TYPE_AGE_RANGE`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

922

"targetingOptionId": "A String", # Required. The targeting_option_id of a

923

# TargetingOption of type `TARGETING_TYPE_AGE_RANGE`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

924

"ageRange": "A String", # Output only. The age range of an audience. We only support targeting a continuous age

925

# range of an audience. Thus, the age range represented in this field can be

926

# 1) targeted solely, or, 2) part of a larger continuous age range. The reach

927

# of a continuous age range targeting can be expanded by also targeting an

928

# audience of an unknown age.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

929

},

930

"subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in # Sub-exchange details. This field will be populated when the

931

# TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`.

932

# the details field of an AssignedTargetingOption when

933

# targeting_type is

934

# `TARGETING_TYPE_SUB_EXCHANGE`.

935

"targetingOptionId": "A String", # Required. The targeting_option_id of a

936

# TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.

937

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

938

"keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the # Keyword details. This field will be populated when the TargetingType is

939

# `TARGETING_TYPE_KEYWORD`.

940

#

941

# A maximum of 5000 direct negative keywords can be assigned to a

942

# line item. No limit on number of positive keywords that can be assigned.

943

# details field of an AssignedTargetingOption when

944

# targeting_type is

945

# `TARGETING_TYPE_KEYWORD`.

946

"negative": True or False, # Indicates if this option is being negatively targeted.

947

"keyword": "A String", # Required. The keyword, for example `car insurance`.

948

#

949

# Positive keyword cannot be offensive word.

950

# Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number

951

# of characters is 80. Maximum number of words is 10.

952

},

953

"deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be # Device make and model details. This field will be populated when the

954

# TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.

955

# populated in the

956

# device_make_model_details

957

# field when

958

# targeting_type is

959

# `TARGETING_TYPE_DEVICE_MAKE_MODEL`.

960

"negative": True or False, # Indicates if this option is being negatively targeted.

961

"targetingOptionId": "A String", # Required. The targeting_option_id field when

962

# targeting_type is

963

# `TARGETING_TYPE_DEVICE_MAKE_MODEL`.

964

"displayName": "A String", # Output only. The display name of the device make and model.

965

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

966

"digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be # Digital content label details. This field will be populated when the

967

# TargetingType is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.

968

#

969

# Digital content labels are targeting exclusions. Advertiser level digital

970

# content label exclusions, if set, are always applied in serving (even

971

# though they aren't visible in line item settings). Line item settings can

972

# exclude content labels in addition to advertiser exclusions, but can't

973

# override them. A line item won't serve if all the digital content labels

974

# are excluded.

975

# populated in the details field of an AssignedTargetingOption when

976

# targeting_type is

977

# `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.

978

"excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED.

979

"contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier.

980

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

981

"browserDetails": { # Details for assigned browser targeting option. This will be populated in # Browser details. This field will be populated when the

982

# TargetingType is `TARGETING_TYPE_BROWSER`.

983

# the details field of an AssignedTargetingOption when

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

984

# targeting_type is

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

985

# `TARGETING_TYPE_BROWSER`.

986

"targetingOptionId": "A String", # Required. The targeting_option_id of a

987

# TargetingOption of type `TARGETING_TYPE_BROWSER`.

988

"displayName": "A String", # Output only. The display name of the browser.

989

"negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser

990

# targeting options on the same line item must have the same value for this

991

# field.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

992

},

993

"appCategoryDetails": { # Details for assigned app category targeting option. This will be # App category details. This field will be populated when the

994

# TargetingType is `TARGETING_TYPE_APP_CATEGORY`.

995

# populated in the

996

# app_category_details field of

997

# an AssignedTargetingOption when

998

# targeting_type

999

# is `TARGETING_TYPE_APP_CATEGORY`.

1000

"negative": True or False, # Indicates if this option is being negatively targeted.

1001

"targetingOptionId": "A String", # Required. The targeting_option_id field when

1002

# targeting_type is

1003

# `TARGETING_TYPE_APP_CATEGORY`.

1004

"displayName": "A String", # Output only. The display name of the app category.

1005

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1006

"contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be # Content outstream position details. This field will be populated when the

1007

# TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.

1008

# populated in the

1009

# content_outstream_position_details

1010

# field when

1011

# targeting_type is

1012

# `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.

1013

"targetingOptionId": "A String", # Required. The targeting_option_id field when

1014

# targeting_type is

1015

# `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.

1016

"contentOutstreamPosition": "A String", # Output only. The content outstream position.

1017

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1018

"negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the # Keyword details. This field will be populated when the

1019

# TargetingType is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.

1020

#

1021

# A maximum of 4 negative keyword lists can be assigned to a line item.

1022

# details field of an AssignedTargetingOption when

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1023

# targeting_type is

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1024

# `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.

1025

"negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the

1026

# negative_keyword_list_id

1027

# field of a NegativeKeywordList resource.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1028

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1029

"genderDetails": { # Details for assigned gender targeting option. This will be populated in # Gender details. This field will be populated when the

1030

# TargetingType is `TARGETING_TYPE_GENDER`.

1031

# the details field of an AssignedTargetingOption when

1032

# targeting_type is

1033

# `TARTGETING_TYPE_GENDER`.

1034

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1035

# TargetingOption of type `TARGETING_TYPE_GENDER`.

1036

"gender": "A String", # Output only. The gender of the audience.

1037

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1038

"name": "A String", # Output only. The resource name for this assigned targeting option.

1039

"inventorySourceDetails": { # Targeting details for inventory source. This will be # Inventory source details. This field will be populated when the

1040

# TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`.

1041

# populated in the details field of an AssignedTargetingOption when

1042

# targeting_type is

1043

# `TARGETING_TYPE_INVENTORY_SOURCE`.

1044

"inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the

1045

# inventory_source_id field of an

1046

# InventorySource resource.

1047

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1048

"sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the # Sensitive category details. This field will be populated when the

1049

# TargetingType is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.

1050

#

1051

# Sensitive categories are targeting exclusions. Advertiser level sensitive

1052

# category exclusions, if set, are always applied in serving (even though

1053

# they aren't visible in line item settings). Line item settings can

1054

# exclude sensitive categories in addition to advertiser exclusions, but

1055

# can't override them.

1056

# details field of an AssignedTargetingOption when

1057

# targeting_type is

1058

# `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.

1059

"excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED.

1060

"sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier.

1061

},

1062

"audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in # Audience targeting details. This field will be populated when the

1063

# TargetingType is `TARGETING_TYPE_AUDIENCE_GROUP`.

1064

# You can only target one audience group option per line item.

1065

# the details field of an AssignedTargetingOption when

1066

# targeting_type is

1067

# `TARGETING_TYPE_AUDIENCE_GROUP`.

1068

# The relation between each group is UNION, except for

1069

# excluded_first_and_third_party_audience_group and

1070

# excluded_google_audience_group, of which COMPLEMENT is UNION'ed with other

1071

# groups.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1072

"includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first

1073

# and third party audience groups. Each first and third party audience group

1074

# contains first and third party audience ids only.

1075

# The relation between each first and third party audience group is

1076

# INTERSECTION, and the result is UNION'ed with other audience groups.

1077

# Repeated groups with same settings will be ignored.

1078

{ # Details of first and third party audience group.

1079

# All first and third party audience targeting settings are logically ‘OR’ of

1080

# each other.

1081

"settings": [ # Required. All first and third party audience targeting settings in first and

1082

# third party audience group.

1083

# Repeated settings with same id are not allowed.

1084

{ # Details of first and third party audience targeting setting.

1085

"recency": "A String", # The recency of the first and third party audience targeting setting.

1086

# Only applicable to first party audiences, otherwise

1087

# will be ignored. For more info, refer to

1088

# https://support.google.com/displayvideo/answer/2949947#recency

1089

# When unspecified, no recency limit will be used.

1090

"firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience

1091

# targeting setting. This id is

1092

# first_and_third_party_audience_id.

},

],

},

],

"includedCombinedAudienceGroup": { # Details of combined audience group. # The combined audience ids of the included combined audience group.

1098

# Contains combined audience ids only.

1099

# All combined audience targeting settings are logically ‘OR’ of each other.

1100

"settings": [ # Required. All combined audience targeting settings in combined audience group.

1101

# Repeated settings with same id will be ignored.

1102

# The number of combined audience settings should be no more than five, error

1103

# will be thrown otherwise.

1104

{ # Details of combined audience targeting setting.

1105

"combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting.

1106

# This id is combined_audience_id.

1107

},

1108

],

1109

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1110

"includedCustomListGroup": { # Details of custom list group. # The custom list ids of the included custom list group.

1111

# Contains custom list ids only.

1112

# All custom list targeting settings are logically ‘OR’ of each other.

1113

"settings": [ # Required. All custom list targeting settings in custom list group.

1114

# Repeated settings with same id will be ignored.

1115

{ # Details of custom list targeting setting.

1116

"customListId": "A String", # Required. Custom id of custom list targeting setting.

1117

# This id is custom_list_id.

},

],

},

"excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. # The first and third party audience ids and recencies of the excluded

1122

# first and third party audience group. Used for negative targeting. Its

1123

# COMPLEMENT is used to UNION other audience groups.

1124

# All first and third party audience targeting settings are logically ‘OR’ of

1125

# each other.

1126

"settings": [ # Required. All first and third party audience targeting settings in first and

1127

# third party audience group.

1128

# Repeated settings with same id are not allowed.

1129

{ # Details of first and third party audience targeting setting.

1130

"recency": "A String", # The recency of the first and third party audience targeting setting.

1131

# Only applicable to first party audiences, otherwise

1132

# will be ignored. For more info, refer to

1133

# https://support.google.com/displayvideo/answer/2949947#recency

1134

# When unspecified, no recency limit will be used.

1135

"firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience

1136

# targeting setting. This id is

1137

# first_and_third_party_audience_id.

},

],

},

"includedGoogleAudienceGroup": { # Details of Google audience group. # The Google audience ids of the included Google audience group.

1142

# Contains Google audience ids only.

1143

# All Google audience targeting settings are logically ‘OR’ of each other.

1144

"settings": [ # Required. All Google audience targeting settings in Google audience group.

1145

# Repeated settings with same id will be ignored.

1146

{ # Details of Google audience targeting setting.

1147

"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting.

1148

# This id is google_audience_id.

},

],

},

"excludedGoogleAudienceGroup": { # Details of Google audience group. # The Google audience ids of the excluded Google audience group.

1153

# Used for negative targeting. It's COMPLEMENT is used to UNION other

1154

# audience groups.

1155

# Only contains Affinity, In-market and Installed-apps type Google audiences.

1156

# All items are logically ‘OR’ of each other.

1157

# All Google audience targeting settings are logically ‘OR’ of each other.

1158

"settings": [ # Required. All Google audience targeting settings in Google audience group.

1159

# Repeated settings with same id will be ignored.

1160

{ # Details of Google audience targeting setting.

1161

"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting.

1162

# This id is google_audience_id.

1163

},

1164

],

1165

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1166

},

1167

"userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in # User rewarded content details. This field will be populated when the

1168

# TargetingType is

1169

# `TARGETING_TYPE_USER_REWARDED_CONTENT`.

1170

# the

1171

# user_rewarded_content_details

1172

# field when

1173

# targeting_type is

1174

# `TARGETING_TYPE_USER_REWARDED_CONTENT`.

1175

"userRewardedContent": "A String", # Output only. User rewarded content status for video ads.

1176

"targetingOptionId": "A String", # Required. The targeting_option_id field when

1177

# targeting_type is

1178

# `TARGETING_TYPE_USER_REWARDED_CONTENT`.

1179

},

1180

"languageDetails": { # Details for assigned language targeting option. This will be populated in the # Language details. This field will be populated when the TargetingType is

1181

# `TARGETING_TYPE_LANGUAGE`.

1182

# details field of an AssignedTargetingOption when

1183

# targeting_type is

1184

# `TARGETING_TYPE_LANGUAGE`.

1185

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1186

# TargetingOption of type `TARGETING_TYPE_LANGUAGE`.

1187

"displayName": "A String", # Output only. The display name of the language (e.g., "French").

1188

"negative": True or False, # Indicates if this option is being negatively targeted. All assigned

1189

# language targeting options on the same line item must have the same value

1190

# for this field.

1191

},

1192

"authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in # Authorized seller status details. This field will be populated when the

1193

# TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.

1194

#

1195

# You can only target one authorized seller status option per line item.

1196

#

1197

# If a line item doesn't have an authorized seller status option, all

1198

# authorized sellers indicated as DIRECT or RESELLER in the ads.txt file

1199

# are targeted by default.

1200

# the details field of an AssignedTargetingOption when

1201

# targeting_type is

1202

# `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1203

"authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1204

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1205

# TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1206

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1207

"dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and # Day and time details. This field will be populated when the

1208

# TargetingType is `TARGETING_TYPE_DAY_AND_TIME`.

1209

# with a start and end time.

1210

# The time represented by `start_hour` must be before the time represented by

1211

# `end_hour`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1212

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.

1213

"startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day)

1214

# and 23 (1 hour before end of day).

1215

"endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after

1216

# start of day) and 24 (end of day).

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1217

"timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time

1218

# targeting setting.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1219

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1220

"inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1221

"environmentDetails": { # Assigned environment targeting option details. This will be populated # Environment details. This field will be populated when the

1222

# TargetingType is `TARGETING_TYPE_ENVIRONMENT`.

1223

# in the details field of an AssignedTargetingOption when

1224

# targeting_type is

1225

# `TARGETING_TYPE_ENVIRONMENT`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1226

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1227

# TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., "508010"

1228

# for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option).

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1229

"environment": "A String", # Output only. The serving environment.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1230

},

1231

"geoRegionDetails": { # Details for assigned geographic region targeting option. This will be # Geographic region details. This field will be populated when the

1232

# TargetingType is `TARGETING_TYPE_GEO_REGION`.

1233

# populated in the details field of an AssignedTargetingOption when

1234

# targeting_type is

1235

# `TARGETING_TYPE_GEO_REGION`.

1236

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1237

# TargetingOption of type `TARGETING_TYPE_GEO_REGION`.

1238

"displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").

1239

"geoRegionType": "A String", # Output only. The type of geographic region targeting.

1240

"negative": True or False, # Indicates if this option is being negatively targeted.

1241

},

1242

"deviceTypeDetails": { # Targeting details for device type. This will be # Device Type details. This field will be populated when the

1243

# TargetingType is

1244

# `TARGETING_TYPE_DEVICE_TYPE`.

1245

# populated in the details field of an AssignedTargetingOption when

1246

# targeting_type is

1247

# `TARGETING_TYPE_DEVICE_TYPE`.

1248

"targetingOptionId": "A String", # Required. ID of the device type.

1249

"deviceType": "A String", # Output only. The display name of the device type.

1250

},

1251

"exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in # Exchange details. This field will be populated when the

1252

# TargetingType is `TARGETING_TYPE_EXCHANGE`.

1253

# the details field of an AssignedTargetingOption when

1254

# targeting_type is

1255

# `TARGETING_TYPE_EXCHANGE`.

1256

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1257

# TargetingOption of type `TARGETING_TYPE_EXCHANGE`.

1258

},

1259

"assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique

1260

# within a given line item and targeting type. It may be reused in other

1261

# contexts.

1262

"householdIncomeDetails": { # Details for assigned household income targeting option. This will be # Household income details. This field will be populated when the

1263

# TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`.

1264

# populated in the details field of an AssignedTargetingOption when

1265

# targeting_type is

1266

# `TARGETING_TYPE_HOUSEHOLD_INCOME`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1267

"householdIncome": "A String", # Output only. The household income of the audience.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1268

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1269

# TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1270

},

1271

"contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be # Content instream position details. This field will be populated when the

1272

# TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.

1273

# populated in the

1274

# content_instream_position_details

1275

# field when

1276

# targeting_type is

1277

# `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1278

"targetingOptionId": "A String", # Required. The targeting_option_id field when

1279

# targeting_type is

1280

# `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1281

"contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1282

},

1283

"categoryDetails": { # Assigned category targeting option details. This will be populated in the # Category details. This field will be populated when the TargetingType is

1284

# `TARGETING_TYPE_CATEGORY`.

1285

#

1286

# Targeting a category will also target its subcategories. If a category is

1287

# excluded from targeting and a subcategory is included, the exclusion will

1288

# take precedence.

1289

# category_details field when

1290

# targeting_type is

1291

# `TARGETING_TYPE_CATEGORY`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1292

"targetingOptionId": "A String", # Required. The targeting_option_id field when

1293

# targeting_type is

1294

# `TARGETING_TYPE_CATEGORY`.

1295

"displayName": "A String", # Output only. The display name of the category.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1296

"negative": True or False, # Indicates if this option is being negatively targeted.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1297

},

1298

"inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be # Inventory source group details. This field will be populated when the

1299

# TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.

1300

# populated in the details field of an AssignedTargetingOption when

1301

# targeting_type is

1302

# `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.

1303

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the

1304

# inventory_source_group_id

1305

# field of an InventorySourceGroup resource.

1306

},

1307

"regionalLocationListDetails": { # Targeting details for regional location list. This will be # Regional location list details. This field will be populated when the

1308

# TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.

1309

# populated in the details field of an AssignedTargetingOption when

1310

# targeting_type is

1311

# `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.

1312

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the

1313

# location_list_id field of a

1314

# LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.

1315

"negative": True or False, # Indicates if this option is being negatively targeted.

1316

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1317

"carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated # Carrier and ISP details. This field will be populated when the

1318

# TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`.

1319

# in the details field of an AssignedTargetingOption when

1320

# targeting_type is

1321

# `TARGETING_TYPE_CARRIER_AND_ISP`.

1322

"negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier

1323

# and ISP targeting options on the same line item must have the same value

1324

# for this field.

1325

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1326

# TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.

1327

"displayName": "A String", # Output only. The display name of the carrier or ISP.

1328

},

1329

"viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the # Viewability details. This field will be populated when the TargetingType

1330

# is `TARGETING_TYPE_VIEWABILITY`.

1331

#

1332

# You can only target one viewability option per line item.

1333

# viewability_details field of

1334

# an AssignedTargetingOption when

1335

# targeting_type is

1336

# `TARGETING_TYPE_VIEWABILITY`.

1337

"viewability": "A String", # Output only. The predicted viewability percentage.

1338

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1339

# TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., "509010"

1340

# for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option).

1341

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1348

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1349

<pre>Lists assigned targeting options of a line item across targeting types.

1350

1351

Args:

1352

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

1353

lineItemId: string, Required. The ID of the line item to list assigned targeting options for. (required)

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1354

filter: string, Allows filtering by assigned targeting option properties.

1355

Supported syntax:

1356

1357

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

1358

* Restrictions can be combined by the logical operator `OR` on the same

1359

field.

1360

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

1361

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

* Supported fields:

- `targetingType`

- `inheritance`

Examples:

* AssignedTargetingOptions of targeting type

1369

TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL

1370

`targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR

1371

targetingType="TARGETING_TYPE_CHANNEL"`

1372

* AssignedTargetingOptions with inheritance status of NOT_INHERITED or

1373

INHERITED_FROM_PARTNER

1374

`inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"`

1375

1376

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1377

pageToken: string, A token that lets the client fetch the next page of results.

1378

Typically, this is the value of

1379

next_page_token

1380

returned from the previous call to

1381

`BulkListLineItemAssignedTargetingOptions` method.

1382

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

1383

pageSize: integer, Requested page size.

1384

The size must be an integer between `1` and `5000`. If unspecified,

1385

the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid

1386

value is specified.

1387

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

1388

Acceptable values are:

1389

1390

* `targetingType` (default)

1391

1392

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

1393

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

1394

`targetingType desc`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1395

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1402

1403

{

1404

"nextPageToken": "A String", # A token identifying the next page of results. This value should be

1405

# specified as the

1406

# pageToken in

1407

# a subsequent BulkListLineItemAssignedTargetingOptionsRequest to fetch

1408

# the next page of results. This token will be absent if there are no more

1409

# assigned_targeting_options

1410

# to return.

1411

"assignedTargetingOptions": [ # The list of assigned targeting options.

1412

#

1413

# This list will be absent if empty.

1414

{ # A single assigned targeting option, which defines the state of a targeting

1415

# option for an entity with targeting settings, such as a Line Item or

1416

# Insertion Order.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1417

"appDetails": { # Details for assigned app targeting option. This will be populated in the # App details. This field will be populated when the

1418

# TargetingType is `TARGETING_TYPE_APP`.

1419

# details field of an AssignedTargetingOption when

1420

# targeting_type is

1421

# `TARGETING_TYPE_APP`.

1422

"displayName": "A String", # Output only. The display name of the app.

1423

"appId": "A String", # Required. The ID of the app.

1424

#

1425

# Android's Play store app uses bundle ID, for example

1426

# `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for

1427

# example `422689480`.

1428

"negative": True or False, # Indicates if this option is being negatively targeted.

1429

},

1430

"parentalStatusDetails": { # Details for assigned parental status targeting option. This will be # Parental status details. This field will be populated when the

1431

# TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`.

1432

# populated in the details field of an AssignedTargetingOption when

1433

# targeting_type is

1434

# `TARTGETING_TYPE_PARENTAL_STATUS`.

1435

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1436

# TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`.

1437

"parentalStatus": "A String", # Output only. The parental status of the audience.

1438

},

1439

"targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.

1440

"urlDetails": { # Details for assigned URL targeting option. This will be populated in the # URL details. This field will be populated when the

1441

# TargetingType is `TARGETING_TYPE_URL`.

1442

# details field of an AssignedTargetingOption when

1443

# targeting_type is

1444

# `TARGETING_TYPE_URL`.

1445

"url": "A String", # Required. The URL, for example `example.com`.

1446

#

1447

# DV360 supports two levels of subdirectory targeting, for example

1448

# `www.example.com/one-subdirectory-level/second-level`, and five levels of

1449

# subdomain targeting, for example `five.four.three.two.one.example.com`.

1450

"negative": True or False, # Indicates if this option is being negatively targeted.

1451

},

1452

"onScreenPositionDetails": { # On screen position targeting option details. This will be # On screen position details. This field will be populated when the

1453

# TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`.

1454

# populated in the

1455

# on_screen_position_details

1456

# field when

1457

# targeting_type is

1458

# `TARGETING_TYPE_ON_SCREEN_POSITION`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1459

"targetingOptionId": "A String", # Required. The targeting_option_id field when

1460

# targeting_type is

1461

# `TARGETING_TYPE_ON_SCREEN_POSITION`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1462

"onScreenPosition": "A String", # Output only. The on screen position.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1463

},

1464

"videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the # Video player size details. This field will be populated when the

1465

# TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.

1466

# video_player_size_details

1467

# field when targeting_type is

1468

# `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.

1469

# Explicitly targeting all options is not supported. Remove all video player

1470

# size targeting options to achieve this effect.

1471

"videoPlayerSize": "A String", # Output only. The video player size.

1472

"targetingOptionId": "A String", # Required. The targeting_option_id field when

1473

# targeting_type is

1474

# `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.

1475

},

1476

"channelDetails": { # Details for assigned channel targeting option. This will be populated in # Channel details. This field will be populated when the

1477

# TargetingType is `TARGETING_TYPE_CHANNEL`.

1478

# the details field of an AssignedTargetingOption when

1479

# targeting_type is

1480

# `TARGETING_TYPE_CHANNEL`.

1481

"channelId": "A String", # Required. ID of the channel. Should refer to the channel ID

1482

# field on a

1483

# [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or

1484

# [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id)

1485

# resource.

1486

"negative": True or False, # Indicates if this option is being negatively targeted. For advertiser

1487

# level assigned targeting option, this field must be true.

1488

},

1489

"operatingSystemDetails": { # Assigned operating system targeting option details. This will be # Operating system details. This field will be populated when the

1490

# TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`.

1491

# populated in the

1492

# operating_system_details

1493

# field when

1494

# targeting_type is

1495

# `TARGETING_TYPE_OPERATING_SYSTEM`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1496

"displayName": "A String", # Output only. The display name of the operating system.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1497

"negative": True or False, # Indicates if this option is being negatively targeted.

1498

"targetingOptionId": "A String", # Required. The targeting option ID populated in

1499

# targeting_option_id field when

1500

# targeting_type is

1501

# `TARGETING_TYPE_OPERATING_SYSTEM`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1502

},

1503

"thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be # Third party verification details. This field will be populated when the

1504

# TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.

1505

# populated in the details field of an AssignedTargetingOption when

1506

# targeting_type is

1507

# `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1508

"integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1509

"excludedAdFraudRisk": "A String", # Ad Fraud settings.

1510

"displayViewability": "A String", # Display Viewability section (applicable to display line items only).

1511

"excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.

1512

"excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.

1513

"excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.

1514

"excludedAdultRisk": "A String", # Brand Safety - **Adult content**.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1515

"traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).

1516

"videoViewability": "A String", # Video Viewability Section (applicable to video line items only).

1517

"excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.

1518

"excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.

1519

"excludeUnrateable": True or False, # Brand Safety - **Unrateable**.

1520

"excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.

1521

"excludedViolenceRisk": "A String", # Brand Safety - **Violence**.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1522

},

1523

"doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.

1524

"videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).

1525

"playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player

1526

# size.

1527

"videoIab": "A String", # Target web inventory to maximize IAB viewable rate.

1528

"videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.

1529

},

1530

"avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.

1531

"A String",

1532

],

1533

"fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.

1534

"avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.

1535

"avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.

1536

},

1537

"brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.

1538

"avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.

1539

"A String",

1540

],

1541

"avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.

1542

"A String",

1543

],

1544

"avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.

1545

},

1546

"appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.

1547

"avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.

1548

"avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.

1549

},

1550

"displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).

1551

"viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.

1552

"iab": "A String", # Target web and app inventory to maximize IAB viewable rate.

1553

},

1554

},

1555

"adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox.

1556

"excludedAdlooxCategories": [ # Adloox's brand safety settings.

1557

"A String",

1558

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1559

},

1560

},

1561

"proximityLocationListDetails": { # Targeting details for proximity location list. This will be # Proximity location list details. This field will be populated when the

1562

# TargetingType is

1563

# `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.

1564

# populated in the details field of an AssignedTargetingOption when

1565

# targeting_type is

1566

# `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1567

"proximityRadiusRange": "A String", # Required. Radius range for proximity location list.

1568

# This represents the size of the area around a chosen location that will be

1569

# targeted.

1570

#

1571

# `All` proximity location targeting under a single line item must have the

1572

# same radius range value. Set this value to match any existing targeting.

1573

# If updated, this field will change the radius range for all proximity

1574

# targeting under the line item.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1575

"proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the

1576

# location_list_id field of a

1577

# LocationList resource whose type is

1578

# `TARGETING_LOCATION_TYPE_PROXIMITY`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1579

},

1580

"ageRangeDetails": { # Represents a targetable age range. This will be populated in the details # Age range details. This field will be populated when the

1581

# TargetingType is `TARGETING_TYPE_AGE_RANGE`.

1582

# field of an AssignedTargetingOption when

1583

# targeting_type is

1584

# `TARGETING_TYPE_AGE_RANGE`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1585

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1586

# TargetingOption of type `TARGETING_TYPE_AGE_RANGE`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1587

"ageRange": "A String", # Output only. The age range of an audience. We only support targeting a continuous age

1588

# range of an audience. Thus, the age range represented in this field can be

1589

# 1) targeted solely, or, 2) part of a larger continuous age range. The reach

1590

# of a continuous age range targeting can be expanded by also targeting an

1591

# audience of an unknown age.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1592

},

1593

"subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in # Sub-exchange details. This field will be populated when the

1594

# TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`.

1595

# the details field of an AssignedTargetingOption when

1596

# targeting_type is

1597

# `TARGETING_TYPE_SUB_EXCHANGE`.

1598

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1599

# TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.

1600

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1601

"keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the # Keyword details. This field will be populated when the TargetingType is

1602

# `TARGETING_TYPE_KEYWORD`.

1603

#

1604

# A maximum of 5000 direct negative keywords can be assigned to a

1605

# line item. No limit on number of positive keywords that can be assigned.

1606

# details field of an AssignedTargetingOption when

1607

# targeting_type is

1608

# `TARGETING_TYPE_KEYWORD`.

1609

"negative": True or False, # Indicates if this option is being negatively targeted.

1610

"keyword": "A String", # Required. The keyword, for example `car insurance`.

1611

#

1612

# Positive keyword cannot be offensive word.

1613

# Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number

1614

# of characters is 80. Maximum number of words is 10.

1615

},

1616

"deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be # Device make and model details. This field will be populated when the

1617

# TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.

1618

# populated in the

1619

# device_make_model_details

1620

# field when

1621

# targeting_type is

1622

# `TARGETING_TYPE_DEVICE_MAKE_MODEL`.

1623

"negative": True or False, # Indicates if this option is being negatively targeted.

1624

"targetingOptionId": "A String", # Required. The targeting_option_id field when

1625

# targeting_type is

1626

# `TARGETING_TYPE_DEVICE_MAKE_MODEL`.

1627

"displayName": "A String", # Output only. The display name of the device make and model.

1628

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1629

"digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be # Digital content label details. This field will be populated when the

1630

# TargetingType is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.

1631

#

1632

# Digital content labels are targeting exclusions. Advertiser level digital

1633

# content label exclusions, if set, are always applied in serving (even

1634

# though they aren't visible in line item settings). Line item settings can

1635

# exclude content labels in addition to advertiser exclusions, but can't

1636

# override them. A line item won't serve if all the digital content labels

1637

# are excluded.

1638

# populated in the details field of an AssignedTargetingOption when

1639

# targeting_type is

1640

# `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.

1641

"excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED.

1642

"contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier.

1643

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1644

"browserDetails": { # Details for assigned browser targeting option. This will be populated in # Browser details. This field will be populated when the

1645

# TargetingType is `TARGETING_TYPE_BROWSER`.

1646

# the details field of an AssignedTargetingOption when

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1647

# targeting_type is

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1648

# `TARGETING_TYPE_BROWSER`.

1649

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1650

# TargetingOption of type `TARGETING_TYPE_BROWSER`.

1651

"displayName": "A String", # Output only. The display name of the browser.

1652

"negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser

1653

# targeting options on the same line item must have the same value for this

1654

# field.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1655

},

1656

"appCategoryDetails": { # Details for assigned app category targeting option. This will be # App category details. This field will be populated when the

1657

# TargetingType is `TARGETING_TYPE_APP_CATEGORY`.

1658

# populated in the

1659

# app_category_details field of

1660

# an AssignedTargetingOption when

1661

# targeting_type

1662

# is `TARGETING_TYPE_APP_CATEGORY`.

1663

"negative": True or False, # Indicates if this option is being negatively targeted.

1664

"targetingOptionId": "A String", # Required. The targeting_option_id field when

1665

# targeting_type is

1666

# `TARGETING_TYPE_APP_CATEGORY`.

1667

"displayName": "A String", # Output only. The display name of the app category.

1668

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1669

"contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be # Content outstream position details. This field will be populated when the

1670

# TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.

1671

# populated in the

1672

# content_outstream_position_details

1673

# field when

1674

# targeting_type is

1675

# `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.

1676

"targetingOptionId": "A String", # Required. The targeting_option_id field when

1677

# targeting_type is

1678

# `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.

1679

"contentOutstreamPosition": "A String", # Output only. The content outstream position.

1680

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1681

"negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the # Keyword details. This field will be populated when the

1682

# TargetingType is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.

1683

#

1684

# A maximum of 4 negative keyword lists can be assigned to a line item.

1685

# details field of an AssignedTargetingOption when

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1686

# targeting_type is

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1687

# `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.

1688

"negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the

1689

# negative_keyword_list_id

1690

# field of a NegativeKeywordList resource.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1691

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1692

"genderDetails": { # Details for assigned gender targeting option. This will be populated in # Gender details. This field will be populated when the

1693

# TargetingType is `TARGETING_TYPE_GENDER`.

1694

# the details field of an AssignedTargetingOption when

1695

# targeting_type is

1696

# `TARTGETING_TYPE_GENDER`.

1697

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1698

# TargetingOption of type `TARGETING_TYPE_GENDER`.

1699

"gender": "A String", # Output only. The gender of the audience.

1700

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1701

"name": "A String", # Output only. The resource name for this assigned targeting option.

1702

"inventorySourceDetails": { # Targeting details for inventory source. This will be # Inventory source details. This field will be populated when the

1703

# TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`.

1704

# populated in the details field of an AssignedTargetingOption when

1705

# targeting_type is

1706

# `TARGETING_TYPE_INVENTORY_SOURCE`.

1707

"inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the

1708

# inventory_source_id field of an

1709

# InventorySource resource.

1710

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1711

"sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the # Sensitive category details. This field will be populated when the

1712

# TargetingType is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.

1713

#

1714

# Sensitive categories are targeting exclusions. Advertiser level sensitive

1715

# category exclusions, if set, are always applied in serving (even though

1716

# they aren't visible in line item settings). Line item settings can

1717

# exclude sensitive categories in addition to advertiser exclusions, but

1718

# can't override them.

1719

# details field of an AssignedTargetingOption when

1720

# targeting_type is

1721

# `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.

1722

"excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED.

1723

"sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier.

1724

},

1725

"audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in # Audience targeting details. This field will be populated when the

1726

# TargetingType is `TARGETING_TYPE_AUDIENCE_GROUP`.

1727

# You can only target one audience group option per line item.

1728

# the details field of an AssignedTargetingOption when

1729

# targeting_type is

1730

# `TARGETING_TYPE_AUDIENCE_GROUP`.

1731

# The relation between each group is UNION, except for

1732

# excluded_first_and_third_party_audience_group and

1733

# excluded_google_audience_group, of which COMPLEMENT is UNION'ed with other

1734

# groups.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1735

"includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first

1736

# and third party audience groups. Each first and third party audience group

1737

# contains first and third party audience ids only.

1738

# The relation between each first and third party audience group is

1739

# INTERSECTION, and the result is UNION'ed with other audience groups.

1740

# Repeated groups with same settings will be ignored.

1741

{ # Details of first and third party audience group.

1742

# All first and third party audience targeting settings are logically ‘OR’ of

1743

# each other.

1744

"settings": [ # Required. All first and third party audience targeting settings in first and

1745

# third party audience group.

1746

# Repeated settings with same id are not allowed.

1747

{ # Details of first and third party audience targeting setting.

1748

"recency": "A String", # The recency of the first and third party audience targeting setting.

1749

# Only applicable to first party audiences, otherwise

1750

# will be ignored. For more info, refer to

1751

# https://support.google.com/displayvideo/answer/2949947#recency

1752

# When unspecified, no recency limit will be used.

1753

"firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience

1754

# targeting setting. This id is

1755

# first_and_third_party_audience_id.

},

],

},

],

"includedCombinedAudienceGroup": { # Details of combined audience group. # The combined audience ids of the included combined audience group.

1761

# Contains combined audience ids only.

1762

# All combined audience targeting settings are logically ‘OR’ of each other.

1763

"settings": [ # Required. All combined audience targeting settings in combined audience group.

1764

# Repeated settings with same id will be ignored.

1765

# The number of combined audience settings should be no more than five, error

1766

# will be thrown otherwise.

1767

{ # Details of combined audience targeting setting.

1768

"combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting.

1769

# This id is combined_audience_id.

1770

},

1771

],

1772

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1773

"includedCustomListGroup": { # Details of custom list group. # The custom list ids of the included custom list group.

1774

# Contains custom list ids only.

1775

# All custom list targeting settings are logically ‘OR’ of each other.

1776

"settings": [ # Required. All custom list targeting settings in custom list group.

1777

# Repeated settings with same id will be ignored.

1778

{ # Details of custom list targeting setting.

1779

"customListId": "A String", # Required. Custom id of custom list targeting setting.

1780

# This id is custom_list_id.

},

],

},

"excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. # The first and third party audience ids and recencies of the excluded

1785

# first and third party audience group. Used for negative targeting. Its

1786

# COMPLEMENT is used to UNION other audience groups.

1787

# All first and third party audience targeting settings are logically ‘OR’ of

1788

# each other.

1789

"settings": [ # Required. All first and third party audience targeting settings in first and

1790

# third party audience group.

1791

# Repeated settings with same id are not allowed.

1792

{ # Details of first and third party audience targeting setting.

1793

"recency": "A String", # The recency of the first and third party audience targeting setting.

1794

# Only applicable to first party audiences, otherwise

1795

# will be ignored. For more info, refer to

1796

# https://support.google.com/displayvideo/answer/2949947#recency

1797

# When unspecified, no recency limit will be used.

1798

"firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience

1799

# targeting setting. This id is

1800

# first_and_third_party_audience_id.

},

],

},

"includedGoogleAudienceGroup": { # Details of Google audience group. # The Google audience ids of the included Google audience group.

1805

# Contains Google audience ids only.

1806

# All Google audience targeting settings are logically ‘OR’ of each other.

1807

"settings": [ # Required. All Google audience targeting settings in Google audience group.

1808

# Repeated settings with same id will be ignored.

1809

{ # Details of Google audience targeting setting.

1810

"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting.

1811

# This id is google_audience_id.

},

],

},

"excludedGoogleAudienceGroup": { # Details of Google audience group. # The Google audience ids of the excluded Google audience group.

1816

# Used for negative targeting. It's COMPLEMENT is used to UNION other

1817

# audience groups.

1818

# Only contains Affinity, In-market and Installed-apps type Google audiences.

1819

# All items are logically ‘OR’ of each other.

1820

# All Google audience targeting settings are logically ‘OR’ of each other.

1821

"settings": [ # Required. All Google audience targeting settings in Google audience group.

1822

# Repeated settings with same id will be ignored.

1823

{ # Details of Google audience targeting setting.

1824

"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting.

1825

# This id is google_audience_id.

1826

},

1827

],

1828

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1829

},

1830

"userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in # User rewarded content details. This field will be populated when the

1831

# TargetingType is

1832

# `TARGETING_TYPE_USER_REWARDED_CONTENT`.

1833

# the

1834

# user_rewarded_content_details

1835

# field when

1836

# targeting_type is

1837

# `TARGETING_TYPE_USER_REWARDED_CONTENT`.

1838

"userRewardedContent": "A String", # Output only. User rewarded content status for video ads.

1839

"targetingOptionId": "A String", # Required. The targeting_option_id field when

1840

# targeting_type is

1841

# `TARGETING_TYPE_USER_REWARDED_CONTENT`.

1842

},

1843

"languageDetails": { # Details for assigned language targeting option. This will be populated in the # Language details. This field will be populated when the TargetingType is

1844

# `TARGETING_TYPE_LANGUAGE`.

1845

# details field of an AssignedTargetingOption when

1846

# targeting_type is

1847

# `TARGETING_TYPE_LANGUAGE`.

1848

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1849

# TargetingOption of type `TARGETING_TYPE_LANGUAGE`.

1850

"displayName": "A String", # Output only. The display name of the language (e.g., "French").

1851

"negative": True or False, # Indicates if this option is being negatively targeted. All assigned

1852

# language targeting options on the same line item must have the same value

1853

# for this field.

1854

},

1855

"authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in # Authorized seller status details. This field will be populated when the

1856

# TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.

1857

#

1858

# You can only target one authorized seller status option per line item.

1859

#

1860

# If a line item doesn't have an authorized seller status option, all

1861

# authorized sellers indicated as DIRECT or RESELLER in the ads.txt file

1862

# are targeted by default.

1863

# the details field of an AssignedTargetingOption when

1864

# targeting_type is

1865

# `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1866

"authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1867

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1868

# TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1869

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1870

"dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and # Day and time details. This field will be populated when the

1871

# TargetingType is `TARGETING_TYPE_DAY_AND_TIME`.

1872

# with a start and end time.

1873

# The time represented by `start_hour` must be before the time represented by

1874

# `end_hour`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1875

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.

1876

"startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day)

1877

# and 23 (1 hour before end of day).

1878

"endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after

1879

# start of day) and 24 (end of day).

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1880

"timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time

1881

# targeting setting.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1882

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1883

"inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1884

"environmentDetails": { # Assigned environment targeting option details. This will be populated # Environment details. This field will be populated when the

1885

# TargetingType is `TARGETING_TYPE_ENVIRONMENT`.

1886

# in the details field of an AssignedTargetingOption when

1887

# targeting_type is

1888

# `TARGETING_TYPE_ENVIRONMENT`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1889

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1890

# TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., "508010"

1891

# for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option).

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1892

"environment": "A String", # Output only. The serving environment.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1893

},

1894

"geoRegionDetails": { # Details for assigned geographic region targeting option. This will be # Geographic region details. This field will be populated when the

1895

# TargetingType is `TARGETING_TYPE_GEO_REGION`.

1896

# populated in the details field of an AssignedTargetingOption when

1897

# targeting_type is

1898

# `TARGETING_TYPE_GEO_REGION`.

1899

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1900

# TargetingOption of type `TARGETING_TYPE_GEO_REGION`.

1901

"displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").

1902

"geoRegionType": "A String", # Output only. The type of geographic region targeting.

1903

"negative": True or False, # Indicates if this option is being negatively targeted.

1904

},

1905

"deviceTypeDetails": { # Targeting details for device type. This will be # Device Type details. This field will be populated when the

1906

# TargetingType is

1907

# `TARGETING_TYPE_DEVICE_TYPE`.

1908

# populated in the details field of an AssignedTargetingOption when

1909

# targeting_type is

1910

# `TARGETING_TYPE_DEVICE_TYPE`.

1911

"targetingOptionId": "A String", # Required. ID of the device type.

1912

"deviceType": "A String", # Output only. The display name of the device type.

1913

},

1914

"exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in # Exchange details. This field will be populated when the

1915

# TargetingType is `TARGETING_TYPE_EXCHANGE`.

1916

# the details field of an AssignedTargetingOption when

1917

# targeting_type is

1918

# `TARGETING_TYPE_EXCHANGE`.

1919

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1920

# TargetingOption of type `TARGETING_TYPE_EXCHANGE`.

1921

},

1922

"assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique

1923

# within a given line item and targeting type. It may be reused in other

1924

# contexts.

1925

"householdIncomeDetails": { # Details for assigned household income targeting option. This will be # Household income details. This field will be populated when the

1926

# TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`.

1927

# populated in the details field of an AssignedTargetingOption when

1928

# targeting_type is

1929

# `TARGETING_TYPE_HOUSEHOLD_INCOME`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1930

"householdIncome": "A String", # Output only. The household income of the audience.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1931

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1932

# TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1933

},

1934

"contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be # Content instream position details. This field will be populated when the

1935

# TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.

1936

# populated in the

1937

# content_instream_position_details

1938

# field when

1939

# targeting_type is

1940

# `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1941

"targetingOptionId": "A String", # Required. The targeting_option_id field when

1942

# targeting_type is

1943

# `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1944

"contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1945

},

1946

"categoryDetails": { # Assigned category targeting option details. This will be populated in the # Category details. This field will be populated when the TargetingType is

1947

# `TARGETING_TYPE_CATEGORY`.

1948

#

1949

# Targeting a category will also target its subcategories. If a category is

1950

# excluded from targeting and a subcategory is included, the exclusion will

1951

# take precedence.

1952

# category_details field when

1953

# targeting_type is

1954

# `TARGETING_TYPE_CATEGORY`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1955

"targetingOptionId": "A String", # Required. The targeting_option_id field when

1956

# targeting_type is

1957

# `TARGETING_TYPE_CATEGORY`.

1958

"displayName": "A String", # Output only. The display name of the category.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1959

"negative": True or False, # Indicates if this option is being negatively targeted.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

1960

},

1961

"inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be # Inventory source group details. This field will be populated when the

1962

# TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.

1963

# populated in the details field of an AssignedTargetingOption when

1964

# targeting_type is

1965

# `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.

1966

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the

1967

# inventory_source_group_id

1968

# field of an InventorySourceGroup resource.

1969

},

1970

"regionalLocationListDetails": { # Targeting details for regional location list. This will be # Regional location list details. This field will be populated when the

1971

# TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.

1972

# populated in the details field of an AssignedTargetingOption when

1973

# targeting_type is

1974

# `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.

1975

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the

1976

# location_list_id field of a

1977

# LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.

1978

"negative": True or False, # Indicates if this option is being negatively targeted.

1979

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1980

"carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated # Carrier and ISP details. This field will be populated when the

1981

# TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`.

1982

# in the details field of an AssignedTargetingOption when

1983

# targeting_type is

1984

# `TARGETING_TYPE_CARRIER_AND_ISP`.

1985

"negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier

1986

# and ISP targeting options on the same line item must have the same value

1987

# for this field.

1988

"targetingOptionId": "A String", # Required. The targeting_option_id of a

1989

# TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.

1990

"displayName": "A String", # Output only. The display name of the carrier or ISP.

1991

},

1992

"viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the # Viewability details. This field will be populated when the TargetingType

1993

# is `TARGETING_TYPE_VIEWABILITY`.

1994

#

1995

# You can only target one viewability option per line item.

1996

# viewability_details field of

1997

# an AssignedTargetingOption when

1998

# targeting_type is

1999

# `TARGETING_TYPE_VIEWABILITY`.

2000

"viewability": "A String", # Output only. The predicted viewability percentage.

2001

"targetingOptionId": "A String", # Required. The targeting_option_id of a

2002

# TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., "509010"

2003

# for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option).

2004

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

}</pre>

</div>

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

2012

<pre>Retrieves the next page of results.

2013

2014

Args:

2015

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

2016

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

2017

2018

Returns:

2019

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

2020

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

</pre>

</div>

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

2026

<pre>Creates a new line item.

2027

Returns the newly created line item if successful.

2028

2029

Args:

2030

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

2031

body: object, The request body.

2032

The object takes the form of:

2033

2034

{ # A single line item.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2035

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

2036

# ad during a given time period.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2037

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

2038

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

2039

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

2040

# during this period. Must be greater than 0.

2041

#

2042

# Applicable when unlimited is `false`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2043

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

2044

#

2045

# Applicable when unlimited is `false`.

2046

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

2047

# last.

2048

#

2049

# Applicable when unlimited is `false`.

2050

# The following restrictions apply based on the value of

2051

# time_unit:

2052

#

2053

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

2054

# default to 1

2055

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

2056

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

2057

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

2058

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

2059

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2060

},

2061

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2062

#

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2063

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

2064

"partnerCosts": [ # The partner costs associated with the line item.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2065

#

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2066

# If absent or empty in CreateLineItem

2067

# method, the newly created line item will inherit partner costs from its

2068

# parent insertion order.

2069

{ # Settings that control a partner cost.

2070

#

2071

# A partner cost is any type of expense involved in running a campaign, other

2072

# than the costs of purchasing impressions (which is called the media cost)

2073

# and using third-party audience segment data (data fee). Some examples of

2074

# partner costs include the fees for using DV360, a third-party ad server,

2075

# or a third-party ad serving verification service.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2076

"feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.

2077

#

2078

# Applicable when the fee_type is

2079

# `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.

2080

#

2081

# For example, for 1.5 standard unit of the advertiser's currency, set

2082

# this field to 1500000.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2083

"costType": "A String", # Required. The type of the partner cost.

2084

"feeType": "A String", # Required. The fee type for this partner cost.

2085

"feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).

2086

#

2087

# Applicable when the fee_type is

2088

# `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.

2089

#

2090

# For example: 100 represents 0.1%.

2091

"invoiceType": "A String", # The invoice type for this partner cost.

2092

#

2093

# * Required when cost_type is one of:

2094

# - `PARTNER_COST_TYPE_ADLOOX`

2095

# - `PARTNER_COST_TYPE_DOUBLE_VERIFY`

2096

# - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.

2097

# * Output only for other types.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2098

},

2099

],

2100

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

2101

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2102

"budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.

2103

"budgetAllocationType": "A String", # Required. The type of the budget allocation.

2104

#

2105

# `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when

2106

# automatic budget allocation is enabled for the parent insertion order.

2107

"budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based

2108

# or impression based. This value is inherited from the parent insertion

2109

# order.

2110

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0.

2111

#

2112

# When budget_allocation_type is:

2113

#

2114

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable

2115

# and is set by the system.

2116

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if

2117

# budget_unit is:

2118

# - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount

2119

# to spend, in micros of the advertiser's currency. For example, 1500000

2120

# represents 1.5 standard units of the currency.

2121

# - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number

2122

# of impressions to serve.

2123

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not

2124

# applicable and will be ignored by the system.

2125

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2126

"flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.

2127

"flightDateType": "A String", # Required. The type of the line item's flight dates.

2128

"dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved

2129

# relative to the parent advertiser's time zone.

2130

#

2131

# * Required when

2132

# flight_date_type is

2133

# `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise.

2134

# * When creating a new flight, both `start_date` and `end_date` must be in

2135

# the future.

2136

# * An existing flight with a `start_date` in the past has a mutable

2137

# `end_date` but an immutable `start_date`.

2138

# * `end_date` must be the `start_date` or later, both before the year 2037.

2139

"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

2140

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

2141

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

2142

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

2143

#

2144

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

2145

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

2146

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

2147

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

2148

#

2149

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

2150

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

2151

# a year.

2152

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

2153

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

2154

# significant.

2155

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

2156

# month and day.

2157

},

2158

"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

2159

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

2160

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

2161

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

2162

#

2163

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

2164

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

2165

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

2166

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

2167

#

2168

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

2169

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

2170

# a year.

2171

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

2172

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

2173

# significant.

2174

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

# month and day.

},

},

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2179

"inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item.

2180

"A String",

2181

],

2182

"partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.

2183

"markupType": "A String", # Required. The markup type of the partner revenue model.

2184

"markupAmount": "A String", # Required. The markup amount of the partner revenue model.

2185

# Must be greater than or equal to 0.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2186

#

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2187

# * When the markup_type is set to be

2188

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM

2189

# markup in micros of advertiser's currency. For example, 1500000

2190

# represents 1.5 standard units of the currency.

2191

# * When the markup_type is set to be

2192

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field

2193

# represents the media cost percent markup in millis. For example,

2194

# 100 represents 0.1% (decimal 0.001).

2195

# * When the markup_type is set to be

2196

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field

2197

# represents the total media cost percent markup in millis. For example,

2198

# 100 represents 0.1% (decimal 0.001).

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2199

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2200

"lineItemType": "A String", # Required. Immutable. The type of the line item.

2201

"entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and

2202

# bid on inventory.

2203

#

2204

# * For CreateLineItem method, only

2205

# `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use

2206

# UpdateLineItem method and update the

2207

# status to `ENTITY_STATUS_ACTIVE` after creation.

2208

# * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from

2209

# any other status.

2210

# * If the line item's parent insertion order is not active, the line item

2211

# can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.

2212

"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.

2213

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.

2214

#

2215

# When automatic budget allocation is enabled at the insertion order via

2216

# auto_budget_allocation, this

2217

# field is output only and defaults to `PACING_PERIOD_FLIGHT`.

2218

"pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be

2219

# spent across the pacing_period.

2220

"dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.

2221

#

2222

# Applicable when the budget is impression based. Must be greater than 0.

2223

"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of

2224

# advertiser's currency.

2225

#

2226

# Applicable when the budget is currency based. Must be greater than 0.

2227

# For example, for 1.5 standard unit of the currency, set this field to

2228

# 1500000.

2229

#

2230

# The value assigned will be rounded to whole billable units for the

2231

# relevant currency by the following rules: any positive value less than a

2232

# single billable unit will be rounded up to one billable unit and any

2233

# value larger than a single billable unit will be rounded down to the

2234

# nearest billable value. For example, if the currency's billable unit is

2235

# 0.01, and this field is set to 10257770, it will round down to 10250000,

2236

# a value of 10.25. If set to 505, it will round up to 10000, a value of

2237

# 0.01.

2238

},

2239

"lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.

2240

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

2241

"campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.

2242

"insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.

2243

"integrationDetails": { # Integration details of an entry. # Integration details of the line item.

2244

"details": "A String", # Additional details of the entry in string format.

2245

#

2246

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

2247

"integrationCode": "A String", # An external identifier to be associated with the entry.

2248

# The integration code will show up together with the entry in many

2249

# places in the system, for example, reporting.

2250

#

2251

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

2252

},

2253

"creativeIds": [ # The IDs of the creatives associated with the line item.

2254

"A String",

2255

],

2256

"conversionCounting": { # Settings that control how conversions are counted. # The conversion tracking setting of the line item.

2257

#

2258

# All post-click conversions will be counted. A percentage value can be set

2259

# for post-view conversions counting.

2260

"floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions.

2261

#

2262

# The number of conversions counted is the sum of all of the conversions

2263

# counted by all of the Floodlight activity IDs specified in this field.

2264

{ # Settings that control the behavior of a single Floodlight activity config.

2265

"floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.

2266

"postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a

2267

# conversion may be counted.

2268

# Must be between 0 and 90 inclusive.

2269

"postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a

2270

# conversion may be counted.

2271

# Must be between 0 and 90 inclusive.

2272

},

2273

],

2274

"postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a

2275

# percent). Must be between 0 and 100000 inclusive.

2276

#

2277

# For example, to track 50% of the post-click conversions, set a value of

2278

# 50000.

2279

},

2280

"bidStrategy": { # Settings that control the bid strategy. # Required. The bidding strategy of the line item.

2281

# Bid strategy determines the bid price.

2282

"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.

2283

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.

2284

# For insertion order entity,

2285

# bid_amount_micros should be set as 0.

2286

# For line item entity,

2287

# bid_amount_micros must be greater

2288

# than or equal to billable unit of the given currency and smaller than or

2289

# equal to the upper limit 1000000000.

2290

#

2291

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

2292

},

2293

"maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your

2294

# performance goal while spending the full budget.

2295

#

2296

# At insertion order level, the

2297

# markup_type of line items

2298

# cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,

2299

# when

2300

# performance_goal_type

2301

# is one of:

2302

#

2303

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`

2304

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`

2305

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,

2306

#

2307

# the line_item_type

2308

# of the insertion order line items must be either:

2309

#

2310

# * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`

2311

# * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,

2312

#

2313

# and when

2314

# performance_goal_type

2315

# is either:

2316

#

2317

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`

2318

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`

2319

#

2320

# the line_item_type

2321

# of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.

2322

# performance goal while spending the full budget.

2323

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

2324

# tries to minimize while spending the full budget.

2325

# `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for

2326

# this strategy.

2327

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's

2328

# currency. Must be greater than or equal to a billable unit of the given

2329

# currency.

2330

#

2331

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

2332

},

2333

"performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified

2334

# performance goal. It is to be used only for a line item entity.

2335

# performance goal.

2336

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

2337

# will try to meet or beat.

2338

#

2339

# For line item level usage, the value must be one of:

2340

#

2341

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`

2342

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`

2343

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.

2344

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's

2345

# currency. Must be greater than or equal to a billable unit of the given

2346

# currency. Not applicable when

2347

# performance_goal_type

2348

# is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.

2349

#

2350

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

2351

"performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to

2352

# meet or beat, in micros of the advertiser's currency.

2353

# Must be greater than or equal to a billable unit of the given currency and

2354

# smaller or equal to upper bounds. Each

2355

# performance_goal_type

2356

# has its upper bound:

2357

#

2358

# * when

2359

# performance_goal_type

2360

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,

2361

# upper bound is 10000.00 USD.

2362

# * when

2363

# performance_goal_type

2364

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,

2365

# upper bound is 1000.00 USD.

2366

# * when

2367

# performance_goal_type

2368

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is

# 1000.00 USD.

#

# Example: If set to

# `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will

2373

# be based on the probability that each available impression will be

2374

# viewable. For example, if viewable CPM target is $2 and an impression is

2375

# 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).

2376

#

2377

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

},

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2389

2390

{ # A single line item.

2391

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

2392

# ad during a given time period.

2393

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

2394

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

2395

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

2396

# during this period. Must be greater than 0.

2397

#

2398

# Applicable when unlimited is `false`.

2399

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

2400

#

2401

# Applicable when unlimited is `false`.

2402

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

2403

# last.

2404

#

2405

# Applicable when unlimited is `false`.

2406

# The following restrictions apply based on the value of

2407

# time_unit:

2408

#

2409

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

2410

# default to 1

2411

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

2412

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

2413

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

2414

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

2415

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

2416

},

2417

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

2418

#

2419

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

2420

"partnerCosts": [ # The partner costs associated with the line item.

2421

#

2422

# If absent or empty in CreateLineItem

2423

# method, the newly created line item will inherit partner costs from its

2424

# parent insertion order.

2425

{ # Settings that control a partner cost.

2426

#

2427

# A partner cost is any type of expense involved in running a campaign, other

2428

# than the costs of purchasing impressions (which is called the media cost)

2429

# and using third-party audience segment data (data fee). Some examples of

2430

# partner costs include the fees for using DV360, a third-party ad server,

2431

# or a third-party ad serving verification service.

2432

"feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.

2433

#

2434

# Applicable when the fee_type is

2435

# `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.

2436

#

2437

# For example, for 1.5 standard unit of the advertiser's currency, set

2438

# this field to 1500000.

2439

"costType": "A String", # Required. The type of the partner cost.

2440

"feeType": "A String", # Required. The fee type for this partner cost.

2441

"feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).

2442

#

2443

# Applicable when the fee_type is

2444

# `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.

2445

#

2446

# For example: 100 represents 0.1%.

2447

"invoiceType": "A String", # The invoice type for this partner cost.

2448

#

2449

# * Required when cost_type is one of:

2450

# - `PARTNER_COST_TYPE_ADLOOX`

2451

# - `PARTNER_COST_TYPE_DOUBLE_VERIFY`

2452

# - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.

2453

# * Output only for other types.

2454

},

2455

],

2456

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

2457

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

2458

"budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.

2459

"budgetAllocationType": "A String", # Required. The type of the budget allocation.

2460

#

2461

# `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when

2462

# automatic budget allocation is enabled for the parent insertion order.

2463

"budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based

2464

# or impression based. This value is inherited from the parent insertion

2465

# order.

2466

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0.

2467

#

2468

# When budget_allocation_type is:

2469

#

2470

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable

2471

# and is set by the system.

2472

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if

2473

# budget_unit is:

2474

# - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount

2475

# to spend, in micros of the advertiser's currency. For example, 1500000

2476

# represents 1.5 standard units of the currency.

2477

# - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number

2478

# of impressions to serve.

2479

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not

2480

# applicable and will be ignored by the system.

2481

},

2482

"flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.

2483

"flightDateType": "A String", # Required. The type of the line item's flight dates.

2484

"dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved

2485

# relative to the parent advertiser's time zone.

2486

#

2487

# * Required when

2488

# flight_date_type is

2489

# `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise.

2490

# * When creating a new flight, both `start_date` and `end_date` must be in

2491

# the future.

2492

# * An existing flight with a `start_date` in the past has a mutable

2493

# `end_date` but an immutable `start_date`.

2494

# * `end_date` must be the `start_date` or later, both before the year 2037.

2495

"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

2496

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

2497

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

2498

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

2499

#

2500

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

2501

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

2502

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

2503

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

2504

#

2505

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

2506

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

2507

# a year.

2508

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

2509

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

2510

# significant.

2511

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

2512

# month and day.

2513

},

2514

"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

2515

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

2516

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

2517

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

2518

#

2519

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

2520

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

2521

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

2522

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

2523

#

2524

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

2525

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

2526

# a year.

2527

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

2528

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

2529

# significant.

2530

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

# month and day.

},

},

},

"inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item.

2536

"A String",

2537

],

2538

"partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.

2539

"markupType": "A String", # Required. The markup type of the partner revenue model.

2540

"markupAmount": "A String", # Required. The markup amount of the partner revenue model.

2541

# Must be greater than or equal to 0.

2542

#

2543

# * When the markup_type is set to be

2544

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM

2545

# markup in micros of advertiser's currency. For example, 1500000

2546

# represents 1.5 standard units of the currency.

2547

# * When the markup_type is set to be

2548

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field

2549

# represents the media cost percent markup in millis. For example,

2550

# 100 represents 0.1% (decimal 0.001).

2551

# * When the markup_type is set to be

2552

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field

2553

# represents the total media cost percent markup in millis. For example,

2554

# 100 represents 0.1% (decimal 0.001).

2555

},

2556

"lineItemType": "A String", # Required. Immutable. The type of the line item.

2557

"entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and

2558

# bid on inventory.

2559

#

2560

# * For CreateLineItem method, only

2561

# `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use

2562

# UpdateLineItem method and update the

2563

# status to `ENTITY_STATUS_ACTIVE` after creation.

2564

# * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from

2565

# any other status.

2566

# * If the line item's parent insertion order is not active, the line item

2567

# can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.

2568

"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.

2569

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.

2570

#

2571

# When automatic budget allocation is enabled at the insertion order via

2572

# auto_budget_allocation, this

2573

# field is output only and defaults to `PACING_PERIOD_FLIGHT`.

2574

"pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be

2575

# spent across the pacing_period.

2576

"dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.

2577

#

2578

# Applicable when the budget is impression based. Must be greater than 0.

2579

"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of

2580

# advertiser's currency.

2581

#

2582

# Applicable when the budget is currency based. Must be greater than 0.

2583

# For example, for 1.5 standard unit of the currency, set this field to

2584

# 1500000.

2585

#

2586

# The value assigned will be rounded to whole billable units for the

2587

# relevant currency by the following rules: any positive value less than a

2588

# single billable unit will be rounded up to one billable unit and any

2589

# value larger than a single billable unit will be rounded down to the

2590

# nearest billable value. For example, if the currency's billable unit is

2591

# 0.01, and this field is set to 10257770, it will round down to 10250000,

2592

# a value of 10.25. If set to 505, it will round up to 10000, a value of

2593

# 0.01.

2594

},

2595

"lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.

2596

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

2597

"campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.

2598

"insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.

2599

"integrationDetails": { # Integration details of an entry. # Integration details of the line item.

2600

"details": "A String", # Additional details of the entry in string format.

2601

#

2602

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

2603

"integrationCode": "A String", # An external identifier to be associated with the entry.

2604

# The integration code will show up together with the entry in many

2605

# places in the system, for example, reporting.

2606

#

2607

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

2608

},

2609

"creativeIds": [ # The IDs of the creatives associated with the line item.

2610

"A String",

2611

],

2612

"conversionCounting": { # Settings that control how conversions are counted. # The conversion tracking setting of the line item.

2613

#

2614

# All post-click conversions will be counted. A percentage value can be set

2615

# for post-view conversions counting.

2616

"floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions.

2617

#

2618

# The number of conversions counted is the sum of all of the conversions

2619

# counted by all of the Floodlight activity IDs specified in this field.

2620

{ # Settings that control the behavior of a single Floodlight activity config.

2621

"floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.

2622

"postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a

2623

# conversion may be counted.

2624

# Must be between 0 and 90 inclusive.

2625

"postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a

2626

# conversion may be counted.

2627

# Must be between 0 and 90 inclusive.

2628

},

2629

],

2630

"postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a

2631

# percent). Must be between 0 and 100000 inclusive.

2632

#

2633

# For example, to track 50% of the post-click conversions, set a value of

2634

# 50000.

2635

},

2636

"bidStrategy": { # Settings that control the bid strategy. # Required. The bidding strategy of the line item.

2637

# Bid strategy determines the bid price.

2638

"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.

2639

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.

2640

# For insertion order entity,

2641

# bid_amount_micros should be set as 0.

2642

# For line item entity,

2643

# bid_amount_micros must be greater

2644

# than or equal to billable unit of the given currency and smaller than or

2645

# equal to the upper limit 1000000000.

2646

#

2647

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

2648

},

2649

"maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your

2650

# performance goal while spending the full budget.

2651

#

2652

# At insertion order level, the

2653

# markup_type of line items

2654

# cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,

2655

# when

2656

# performance_goal_type

2657

# is one of:

2658

#

2659

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`

2660

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`

2661

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,

2662

#

2663

# the line_item_type

2664

# of the insertion order line items must be either:

2665

#

2666

# * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`

2667

# * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,

2668

#

2669

# and when

2670

# performance_goal_type

2671

# is either:

2672

#

2673

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`

2674

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`

2675

#

2676

# the line_item_type

2677

# of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.

2678

# performance goal while spending the full budget.

2679

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

2680

# tries to minimize while spending the full budget.

2681

# `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for

2682

# this strategy.

2683

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's

2684

# currency. Must be greater than or equal to a billable unit of the given

2685

# currency.

2686

#

2687

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

2688

},

2689

"performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified

2690

# performance goal. It is to be used only for a line item entity.

2691

# performance goal.

2692

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

2693

# will try to meet or beat.

2694

#

2695

# For line item level usage, the value must be one of:

2696

#

2697

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`

2698

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`

2699

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.

2700

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's

2701

# currency. Must be greater than or equal to a billable unit of the given

2702

# currency. Not applicable when

2703

# performance_goal_type

2704

# is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.

2705

#

2706

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

2707

"performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to

2708

# meet or beat, in micros of the advertiser's currency.

2709

# Must be greater than or equal to a billable unit of the given currency and

2710

# smaller or equal to upper bounds. Each

2711

# performance_goal_type

2712

# has its upper bound:

2713

#

2714

# * when

2715

# performance_goal_type

2716

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,

2717

# upper bound is 10000.00 USD.

2718

# * when

2719

# performance_goal_type

2720

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,

2721

# upper bound is 1000.00 USD.

2722

# * when

2723

# performance_goal_type

2724

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is

# 1000.00 USD.

#

# Example: If set to

# `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will

2729

# be based on the probability that each available impression will be

2730

# viewable. For example, if viewable CPM target is $2 and an impression is

2731

# 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).

2732

#

2733

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

2734

},

2735

},

2736

}</pre>

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

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

2741

<pre>Deletes a line item.

2742

Returns error code `NOT_FOUND` if the line item does not exist.

2743

The line item should be archived first, i.e. set

2744

entity_status to `ENTITY_STATUS_ARCHIVED`, to be

able to delete it.

Args:

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

2749

lineItemId: string, The ID of the line item we need to fetch. (required)

2750

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2757

2758

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

2759

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

2760

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

2761

#

2762

# service Foo {

2763

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

2764

# }

2765

#

2766

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

}</pre>

</div>

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

2772

<pre>Gets a line item.

2773

2774

Args:

2775

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

2776

lineItemId: string, Required. The ID of the line item to fetch. (required)

2777

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2784

2785

{ # A single line item.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2786

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

2787

# ad during a given time period.

2788

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

2789

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

2790

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

2791

# during this period. Must be greater than 0.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2792

#

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2793

# Applicable when unlimited is `false`.

2794

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

2795

#

2796

# Applicable when unlimited is `false`.

2797

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

2798

# last.

2799

#

2800

# Applicable when unlimited is `false`.

2801

# The following restrictions apply based on the value of

2802

# time_unit:

2803

#

2804

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

2805

# default to 1

2806

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

2807

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

2808

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

2809

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

2810

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

2811

},

2812

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

2813

#

2814

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

2815

"partnerCosts": [ # The partner costs associated with the line item.

2816

#

2817

# If absent or empty in CreateLineItem

2818

# method, the newly created line item will inherit partner costs from its

2819

# parent insertion order.

2820

{ # Settings that control a partner cost.

2821

#

2822

# A partner cost is any type of expense involved in running a campaign, other

2823

# than the costs of purchasing impressions (which is called the media cost)

2824

# and using third-party audience segment data (data fee). Some examples of

2825

# partner costs include the fees for using DV360, a third-party ad server,

2826

# or a third-party ad serving verification service.

2827

"feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.

2828

#

2829

# Applicable when the fee_type is

2830

# `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.

2831

#

2832

# For example, for 1.5 standard unit of the advertiser's currency, set

2833

# this field to 1500000.

2834

"costType": "A String", # Required. The type of the partner cost.

2835

"feeType": "A String", # Required. The fee type for this partner cost.

2836

"feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).

2837

#

2838

# Applicable when the fee_type is

2839

# `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.

2840

#

2841

# For example: 100 represents 0.1%.

2842

"invoiceType": "A String", # The invoice type for this partner cost.

2843

#

2844

# * Required when cost_type is one of:

2845

# - `PARTNER_COST_TYPE_ADLOOX`

2846

# - `PARTNER_COST_TYPE_DOUBLE_VERIFY`

2847

# - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.

2848

# * Output only for other types.

2849

},

2850

],

2851

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

2852

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

2853

"budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.

2854

"budgetAllocationType": "A String", # Required. The type of the budget allocation.

2855

#

2856

# `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when

2857

# automatic budget allocation is enabled for the parent insertion order.

2858

"budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based

2859

# or impression based. This value is inherited from the parent insertion

2860

# order.

2861

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0.

2862

#

2863

# When budget_allocation_type is:

2864

#

2865

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable

2866

# and is set by the system.

2867

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if

2868

# budget_unit is:

2869

# - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount

2870

# to spend, in micros of the advertiser's currency. For example, 1500000

2871

# represents 1.5 standard units of the currency.

2872

# - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number

2873

# of impressions to serve.

2874

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not

2875

# applicable and will be ignored by the system.

2876

},

2877

"flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.

2878

"flightDateType": "A String", # Required. The type of the line item's flight dates.

2879

"dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved

2880

# relative to the parent advertiser's time zone.

2881

#

2882

# * Required when

2883

# flight_date_type is

2884

# `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise.

2885

# * When creating a new flight, both `start_date` and `end_date` must be in

2886

# the future.

2887

# * An existing flight with a `start_date` in the past has a mutable

2888

# `end_date` but an immutable `start_date`.

2889

# * `end_date` must be the `start_date` or later, both before the year 2037.

2890

"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

2891

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

2892

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

2893

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

2894

#

2895

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

2896

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

2897

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

2898

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

2899

#

2900

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

2901

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

2902

# a year.

2903

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

2904

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

2905

# significant.

2906

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

2907

# month and day.

2908

},

2909

"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

2910

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

2911

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

2912

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

2913

#

2914

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

2915

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

2916

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

2917

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

2918

#

2919

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

2920

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

2921

# a year.

2922

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

2923

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

2924

# significant.

2925

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

# month and day.

},

},

},

"inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item.

2931

"A String",

2932

],

2933

"partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.

2934

"markupType": "A String", # Required. The markup type of the partner revenue model.

2935

"markupAmount": "A String", # Required. The markup amount of the partner revenue model.

2936

# Must be greater than or equal to 0.

2937

#

2938

# * When the markup_type is set to be

2939

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM

2940

# markup in micros of advertiser's currency. For example, 1500000

2941

# represents 1.5 standard units of the currency.

2942

# * When the markup_type is set to be

2943

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field

2944

# represents the media cost percent markup in millis. For example,

2945

# 100 represents 0.1% (decimal 0.001).

2946

# * When the markup_type is set to be

2947

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field

2948

# represents the total media cost percent markup in millis. For example,

2949

# 100 represents 0.1% (decimal 0.001).

2950

},

2951

"lineItemType": "A String", # Required. Immutable. The type of the line item.

2952

"entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and

2953

# bid on inventory.

2954

#

2955

# * For CreateLineItem method, only

2956

# `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use

2957

# UpdateLineItem method and update the

2958

# status to `ENTITY_STATUS_ACTIVE` after creation.

2959

# * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from

2960

# any other status.

2961

# * If the line item's parent insertion order is not active, the line item

2962

# can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.

2963

"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.

2964

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.

2965

#

2966

# When automatic budget allocation is enabled at the insertion order via

2967

# auto_budget_allocation, this

2968

# field is output only and defaults to `PACING_PERIOD_FLIGHT`.

2969

"pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be

2970

# spent across the pacing_period.

2971

"dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.

2972

#

2973

# Applicable when the budget is impression based. Must be greater than 0.

2974

"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of

2975

# advertiser's currency.

2976

#

2977

# Applicable when the budget is currency based. Must be greater than 0.

2978

# For example, for 1.5 standard unit of the currency, set this field to

2979

# 1500000.

2980

#

2981

# The value assigned will be rounded to whole billable units for the

2982

# relevant currency by the following rules: any positive value less than a

2983

# single billable unit will be rounded up to one billable unit and any

2984

# value larger than a single billable unit will be rounded down to the

2985

# nearest billable value. For example, if the currency's billable unit is

2986

# 0.01, and this field is set to 10257770, it will round down to 10250000,

2987

# a value of 10.25. If set to 505, it will round up to 10000, a value of

2988

# 0.01.

2989

},

2990

"lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.

2991

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

2992

"campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.

2993

"insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.

2994

"integrationDetails": { # Integration details of an entry. # Integration details of the line item.

2995

"details": "A String", # Additional details of the entry in string format.

2996

#

2997

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

2998

"integrationCode": "A String", # An external identifier to be associated with the entry.

2999

# The integration code will show up together with the entry in many

3000

# places in the system, for example, reporting.

3001

#

3002

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

3003

},

3004

"creativeIds": [ # The IDs of the creatives associated with the line item.

3005

"A String",

3006

],

3007

"conversionCounting": { # Settings that control how conversions are counted. # The conversion tracking setting of the line item.

3008

#

3009

# All post-click conversions will be counted. A percentage value can be set

3010

# for post-view conversions counting.

3011

"floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions.

3012

#

3013

# The number of conversions counted is the sum of all of the conversions

3014

# counted by all of the Floodlight activity IDs specified in this field.

3015

{ # Settings that control the behavior of a single Floodlight activity config.

3016

"floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.

3017

"postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a

3018

# conversion may be counted.

3019

# Must be between 0 and 90 inclusive.

3020

"postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a

3021

# conversion may be counted.

3022

# Must be between 0 and 90 inclusive.

3023

},

3024

],

3025

"postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a

3026

# percent). Must be between 0 and 100000 inclusive.

3027

#

3028

# For example, to track 50% of the post-click conversions, set a value of

3029

# 50000.

3030

},

3031

"bidStrategy": { # Settings that control the bid strategy. # Required. The bidding strategy of the line item.

3032

# Bid strategy determines the bid price.

3033

"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.

3034

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.

3035

# For insertion order entity,

3036

# bid_amount_micros should be set as 0.

3037

# For line item entity,

3038

# bid_amount_micros must be greater

3039

# than or equal to billable unit of the given currency and smaller than or

3040

# equal to the upper limit 1000000000.

3041

#

3042

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

3043

},

3044

"maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your

3045

# performance goal while spending the full budget.

3046

#

3047

# At insertion order level, the

3048

# markup_type of line items

3049

# cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,

3050

# when

3051

# performance_goal_type

3052

# is one of:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3053

#

3054

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`

3055

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3056

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,

3057

#

3058

# the line_item_type

3059

# of the insertion order line items must be either:

3060

#

3061

# * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`

3062

# * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,

3063

#

3064

# and when

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3065

# performance_goal_type

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3066

# is either:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3067

#

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3068

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`

3069

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3070

#

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3071

# the line_item_type

3072

# of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.

3073

# performance goal while spending the full budget.

3074

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

3075

# tries to minimize while spending the full budget.

3076

# `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for

3077

# this strategy.

3078

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's

3079

# currency. Must be greater than or equal to a billable unit of the given

3080

# currency.

3081

#

3082

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3083

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3084

"performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified

3085

# performance goal. It is to be used only for a line item entity.

3086

# performance goal.

3087

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

3088

# will try to meet or beat.

3089

#

3090

# For line item level usage, the value must be one of:

3091

#

3092

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`

3093

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`

3094

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.

3095

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's

3096

# currency. Must be greater than or equal to a billable unit of the given

3097

# currency. Not applicable when

3098

# performance_goal_type

3099

# is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.

3100

#

3101

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

3102

"performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to

3103

# meet or beat, in micros of the advertiser's currency.

3104

# Must be greater than or equal to a billable unit of the given currency and

3105

# smaller or equal to upper bounds. Each

3106

# performance_goal_type

3107

# has its upper bound:

3108

#

3109

# * when

3110

# performance_goal_type

3111

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,

3112

# upper bound is 10000.00 USD.

3113

# * when

3114

# performance_goal_type

3115

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,

3116

# upper bound is 1000.00 USD.

3117

# * when

3118

# performance_goal_type

3119

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is

# 1000.00 USD.

#

# Example: If set to

# `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will

3124

# be based on the probability that each available impression will be

3125

# viewable. For example, if viewable CPM target is $2 and an impression is

3126

# 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).

3127

#

3128

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3129

},

3130

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3131

}</pre>

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

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

3136

<pre>Lists line items in an advertiser.

3137

3138

The order is defined by the order_by

3139

parameter.

3140

If a filter by

3141

entity_status is not specified, line items with

3142

`ENTITY_STATUS_ARCHIVED` will not be included in the results.

3143

3144

Args:

3145

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

3146

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

3147

Typically, this is the value of

3148

next_page_token

3149

returned from the previous call to `ListLineItems` method.

3150

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

3151

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

3152

Acceptable values are:

3153

3154

* "displayName" (default)

3155

* "entityStatus"

3156

3157

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

3158

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

3159

`displayName desc`.

3160

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

3161

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

3162

is specified.

3163

filter: string, Allows filtering by line item properties.

Supported syntax:

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

3168

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

3169

sequence of restrictions implicitly uses `AND`.

3170

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

3171

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

* Supported fields:

- `campaignId`

- `insertionOrderId`

- `entityStatus`

- `lineItemType`.

Examples:

* All line items under an insertion order: `insertionOrderId="1234"`

3181

* All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`

3182

and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser:

3183

`(entityStatus="ENTITY_STATUS_ACTIVE" OR

3184

entityStatus="ENTITY_STATUS_PAUSED") AND

3185

lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"`

3186

3187

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

3188

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3195

3196

{

3197

"lineItems": [ # The list of line items.

3198

#

3199

# This list will be absent if empty.

3200

{ # A single line item.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3201

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

3202

# ad during a given time period.

3203

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

3204

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

3205

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

3206

# during this period. Must be greater than 0.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3207

#

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3208

# Applicable when unlimited is `false`.

3209

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

3210

#

3211

# Applicable when unlimited is `false`.

3212

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

3213

# last.

3214

#

3215

# Applicable when unlimited is `false`.

3216

# The following restrictions apply based on the value of

3217

# time_unit:

3218

#

3219

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

3220

# default to 1

3221

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

3222

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

3223

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

3224

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

3225

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

3226

},

3227

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

3228

#

3229

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

3230

"partnerCosts": [ # The partner costs associated with the line item.

3231

#

3232

# If absent or empty in CreateLineItem

3233

# method, the newly created line item will inherit partner costs from its

3234

# parent insertion order.

3235

{ # Settings that control a partner cost.

3236

#

3237

# A partner cost is any type of expense involved in running a campaign, other

3238

# than the costs of purchasing impressions (which is called the media cost)

3239

# and using third-party audience segment data (data fee). Some examples of

3240

# partner costs include the fees for using DV360, a third-party ad server,

3241

# or a third-party ad serving verification service.

3242

"feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.

3243

#

3244

# Applicable when the fee_type is

3245

# `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.

3246

#

3247

# For example, for 1.5 standard unit of the advertiser's currency, set

3248

# this field to 1500000.

3249

"costType": "A String", # Required. The type of the partner cost.

3250

"feeType": "A String", # Required. The fee type for this partner cost.

3251

"feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).

3252

#

3253

# Applicable when the fee_type is

3254

# `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.

3255

#

3256

# For example: 100 represents 0.1%.

3257

"invoiceType": "A String", # The invoice type for this partner cost.

3258

#

3259

# * Required when cost_type is one of:

3260

# - `PARTNER_COST_TYPE_ADLOOX`

3261

# - `PARTNER_COST_TYPE_DOUBLE_VERIFY`

3262

# - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.

3263

# * Output only for other types.

3264

},

3265

],

3266

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

3267

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

3268

"budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.

3269

"budgetAllocationType": "A String", # Required. The type of the budget allocation.

3270

#

3271

# `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when

3272

# automatic budget allocation is enabled for the parent insertion order.

3273

"budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based

3274

# or impression based. This value is inherited from the parent insertion

3275

# order.

3276

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0.

3277

#

3278

# When budget_allocation_type is:

3279

#

3280

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable

3281

# and is set by the system.

3282

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if

3283

# budget_unit is:

3284

# - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount

3285

# to spend, in micros of the advertiser's currency. For example, 1500000

3286

# represents 1.5 standard units of the currency.

3287

# - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number

3288

# of impressions to serve.

3289

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not

3290

# applicable and will be ignored by the system.

3291

},

3292

"flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.

3293

"flightDateType": "A String", # Required. The type of the line item's flight dates.

3294

"dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved

3295

# relative to the parent advertiser's time zone.

3296

#

3297

# * Required when

3298

# flight_date_type is

3299

# `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise.

3300

# * When creating a new flight, both `start_date` and `end_date` must be in

3301

# the future.

3302

# * An existing flight with a `start_date` in the past has a mutable

3303

# `end_date` but an immutable `start_date`.

3304

# * `end_date` must be the `start_date` or later, both before the year 2037.

3305

"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

3306

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

3307

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

3308

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

3309

#

3310

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

3311

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

3312

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

3313

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

3314

#

3315

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

3316

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

3317

# a year.

3318

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

3319

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

3320

# significant.

3321

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

3322

# month and day.

3323

},

3324

"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

3325

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

3326

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

3327

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

3328

#

3329

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

3330

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

3331

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

3332

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

3333

#

3334

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

3335

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

3336

# a year.

3337

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

3338

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

3339

# significant.

3340

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

# month and day.

},

},

},

"inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item.

3346

"A String",

3347

],

3348

"partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.

3349

"markupType": "A String", # Required. The markup type of the partner revenue model.

3350

"markupAmount": "A String", # Required. The markup amount of the partner revenue model.

3351

# Must be greater than or equal to 0.

3352

#

3353

# * When the markup_type is set to be

3354

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM

3355

# markup in micros of advertiser's currency. For example, 1500000

3356

# represents 1.5 standard units of the currency.

3357

# * When the markup_type is set to be

3358

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field

3359

# represents the media cost percent markup in millis. For example,

3360

# 100 represents 0.1% (decimal 0.001).

3361

# * When the markup_type is set to be

3362

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field

3363

# represents the total media cost percent markup in millis. For example,

3364

# 100 represents 0.1% (decimal 0.001).

3365

},

3366

"lineItemType": "A String", # Required. Immutable. The type of the line item.

3367

"entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and

3368

# bid on inventory.

3369

#

3370

# * For CreateLineItem method, only

3371

# `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use

3372

# UpdateLineItem method and update the

3373

# status to `ENTITY_STATUS_ACTIVE` after creation.

3374

# * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from

3375

# any other status.

3376

# * If the line item's parent insertion order is not active, the line item

3377

# can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.

3378

"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.

3379

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.

3380

#

3381

# When automatic budget allocation is enabled at the insertion order via

3382

# auto_budget_allocation, this

3383

# field is output only and defaults to `PACING_PERIOD_FLIGHT`.

3384

"pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be

3385

# spent across the pacing_period.

3386

"dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.

3387

#

3388

# Applicable when the budget is impression based. Must be greater than 0.

3389

"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of

3390

# advertiser's currency.

3391

#

3392

# Applicable when the budget is currency based. Must be greater than 0.

3393

# For example, for 1.5 standard unit of the currency, set this field to

3394

# 1500000.

3395

#

3396

# The value assigned will be rounded to whole billable units for the

3397

# relevant currency by the following rules: any positive value less than a

3398

# single billable unit will be rounded up to one billable unit and any

3399

# value larger than a single billable unit will be rounded down to the

3400

# nearest billable value. For example, if the currency's billable unit is

3401

# 0.01, and this field is set to 10257770, it will round down to 10250000,

3402

# a value of 10.25. If set to 505, it will round up to 10000, a value of

3403

# 0.01.

3404

},

3405

"lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.

3406

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

3407

"campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.

3408

"insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.

3409

"integrationDetails": { # Integration details of an entry. # Integration details of the line item.

3410

"details": "A String", # Additional details of the entry in string format.

3411

#

3412

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

3413

"integrationCode": "A String", # An external identifier to be associated with the entry.

3414

# The integration code will show up together with the entry in many

3415

# places in the system, for example, reporting.

3416

#

3417

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

3418

},

3419

"creativeIds": [ # The IDs of the creatives associated with the line item.

3420

"A String",

3421

],

3422

"conversionCounting": { # Settings that control how conversions are counted. # The conversion tracking setting of the line item.

3423

#

3424

# All post-click conversions will be counted. A percentage value can be set

3425

# for post-view conversions counting.

3426

"floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions.

3427

#

3428

# The number of conversions counted is the sum of all of the conversions

3429

# counted by all of the Floodlight activity IDs specified in this field.

3430

{ # Settings that control the behavior of a single Floodlight activity config.

3431

"floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.

3432

"postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a

3433

# conversion may be counted.

3434

# Must be between 0 and 90 inclusive.

3435

"postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a

3436

# conversion may be counted.

3437

# Must be between 0 and 90 inclusive.

3438

},

3439

],

3440

"postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a

3441

# percent). Must be between 0 and 100000 inclusive.

3442

#

3443

# For example, to track 50% of the post-click conversions, set a value of

3444

# 50000.

3445

},

3446

"bidStrategy": { # Settings that control the bid strategy. # Required. The bidding strategy of the line item.

3447

# Bid strategy determines the bid price.

3448

"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.

3449

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.

3450

# For insertion order entity,

3451

# bid_amount_micros should be set as 0.

3452

# For line item entity,

3453

# bid_amount_micros must be greater

3454

# than or equal to billable unit of the given currency and smaller than or

3455

# equal to the upper limit 1000000000.

3456

#

3457

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

3458

},

3459

"maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your

3460

# performance goal while spending the full budget.

3461

#

3462

# At insertion order level, the

3463

# markup_type of line items

3464

# cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,

3465

# when

3466

# performance_goal_type

3467

# is one of:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3468

#

3469

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`

3470

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3471

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,

3472

#

3473

# the line_item_type

3474

# of the insertion order line items must be either:

3475

#

3476

# * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`

3477

# * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,

3478

#

3479

# and when

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3480

# performance_goal_type

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3481

# is either:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3482

#

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3483

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`

3484

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3485

#

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3486

# the line_item_type

3487

# of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.

3488

# performance goal while spending the full budget.

3489

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

3490

# tries to minimize while spending the full budget.

3491

# `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for

3492

# this strategy.

3493

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's

3494

# currency. Must be greater than or equal to a billable unit of the given

3495

# currency.

3496

#

3497

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3498

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3499

"performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified

3500

# performance goal. It is to be used only for a line item entity.

3501

# performance goal.

3502

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

3503

# will try to meet or beat.

3504

#

3505

# For line item level usage, the value must be one of:

3506

#

3507

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`

3508

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`

3509

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.

3510

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's

3511

# currency. Must be greater than or equal to a billable unit of the given

3512

# currency. Not applicable when

3513

# performance_goal_type

3514

# is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.

3515

#

3516

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

3517

"performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to

3518

# meet or beat, in micros of the advertiser's currency.

3519

# Must be greater than or equal to a billable unit of the given currency and

3520

# smaller or equal to upper bounds. Each

3521

# performance_goal_type

3522

# has its upper bound:

3523

#

3524

# * when

3525

# performance_goal_type

3526

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,

3527

# upper bound is 10000.00 USD.

3528

# * when

3529

# performance_goal_type

3530

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,

3531

# upper bound is 1000.00 USD.

3532

# * when

3533

# performance_goal_type

3534

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is

# 1000.00 USD.

#

# Example: If set to

# `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will

3539

# be based on the probability that each available impression will be

3540

# viewable. For example, if viewable CPM target is $2 and an impression is

3541

# 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).

3542

#

3543

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3544

},

3545

},

3546

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3547

],

3548

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

3549

# Pass this value in the

3550

# page_token

3551

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

3552

# next page of results.

}</pre>

</div>

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

3558

<pre>Retrieves the next page of results.

3559

3560

Args:

3561

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

3562

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

3563

3564

Returns:

3565

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

3566

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

</pre>

</div>

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

3572

<pre>Updates an existing line item.

3573

Returns the updated line item if successful.

3574

3575

Args:

3576

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

3577

lineItemId: string, Output only. The unique ID of the line item. Assigned by the system. (required)

3578

body: object, The request body.

3579

The object takes the form of:

3580

3581

{ # A single line item.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3582

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

3583

# ad during a given time period.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3584

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

3585

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

3586

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

3587

# during this period. Must be greater than 0.

3588

#

3589

# Applicable when unlimited is `false`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3590

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

3591

#

3592

# Applicable when unlimited is `false`.

3593

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

3594

# last.

3595

#

3596

# Applicable when unlimited is `false`.

3597

# The following restrictions apply based on the value of

3598

# time_unit:

3599

#

3600

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

3601

# default to 1

3602

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

3603

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

3604

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

3605

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

3606

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3607

},

3608

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3609

#

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3610

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

3611

"partnerCosts": [ # The partner costs associated with the line item.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3612

#

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3613

# If absent or empty in CreateLineItem

3614

# method, the newly created line item will inherit partner costs from its

3615

# parent insertion order.

3616

{ # Settings that control a partner cost.

3617

#

3618

# A partner cost is any type of expense involved in running a campaign, other

3619

# than the costs of purchasing impressions (which is called the media cost)

3620

# and using third-party audience segment data (data fee). Some examples of

3621

# partner costs include the fees for using DV360, a third-party ad server,

3622

# or a third-party ad serving verification service.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3623

"feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.

3624

#

3625

# Applicable when the fee_type is

3626

# `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.

3627

#

3628

# For example, for 1.5 standard unit of the advertiser's currency, set

3629

# this field to 1500000.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3630

"costType": "A String", # Required. The type of the partner cost.

3631

"feeType": "A String", # Required. The fee type for this partner cost.

3632

"feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).

3633

#

3634

# Applicable when the fee_type is

3635

# `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.

3636

#

3637

# For example: 100 represents 0.1%.

3638

"invoiceType": "A String", # The invoice type for this partner cost.

3639

#

3640

# * Required when cost_type is one of:

3641

# - `PARTNER_COST_TYPE_ADLOOX`

3642

# - `PARTNER_COST_TYPE_DOUBLE_VERIFY`

3643

# - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.

3644

# * Output only for other types.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3645

},

3646

],

3647

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

3648

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3649

"budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.

3650

"budgetAllocationType": "A String", # Required. The type of the budget allocation.

3651

#

3652

# `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when

3653

# automatic budget allocation is enabled for the parent insertion order.

3654

"budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based

3655

# or impression based. This value is inherited from the parent insertion

3656

# order.

3657

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0.

3658

#

3659

# When budget_allocation_type is:

3660

#

3661

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable

3662

# and is set by the system.

3663

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if

3664

# budget_unit is:

3665

# - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount

3666

# to spend, in micros of the advertiser's currency. For example, 1500000

3667

# represents 1.5 standard units of the currency.

3668

# - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number

3669

# of impressions to serve.

3670

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not

3671

# applicable and will be ignored by the system.

3672

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3673

"flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.

3674

"flightDateType": "A String", # Required. The type of the line item's flight dates.

3675

"dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved

3676

# relative to the parent advertiser's time zone.

3677

#

3678

# * Required when

3679

# flight_date_type is

3680

# `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise.

3681

# * When creating a new flight, both `start_date` and `end_date` must be in

3682

# the future.

3683

# * An existing flight with a `start_date` in the past has a mutable

3684

# `end_date` but an immutable `start_date`.

3685

# * `end_date` must be the `start_date` or later, both before the year 2037.

3686

"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

3687

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

3688

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

3689

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

3690

#

3691

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

3692

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

3693

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

3694

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

3695

#

3696

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

3697

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

3698

# a year.

3699

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

3700

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

3701

# significant.

3702

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

3703

# month and day.

3704

},

3705

"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

3706

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

3707

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

3708

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

3709

#

3710

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

3711

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

3712

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

3713

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

3714

#

3715

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

3716

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

3717

# a year.

3718

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

3719

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

3720

# significant.

3721

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

# month and day.

},

},

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3726

"inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item.

3727

"A String",

3728

],

3729

"partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.

3730

"markupType": "A String", # Required. The markup type of the partner revenue model.

3731

"markupAmount": "A String", # Required. The markup amount of the partner revenue model.

3732

# Must be greater than or equal to 0.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3733

#

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3734

# * When the markup_type is set to be

3735

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM

3736

# markup in micros of advertiser's currency. For example, 1500000

3737

# represents 1.5 standard units of the currency.

3738

# * When the markup_type is set to be

3739

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field

3740

# represents the media cost percent markup in millis. For example,

3741

# 100 represents 0.1% (decimal 0.001).

3742

# * When the markup_type is set to be

3743

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field

3744

# represents the total media cost percent markup in millis. For example,

3745

# 100 represents 0.1% (decimal 0.001).

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3746

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3747

"lineItemType": "A String", # Required. Immutable. The type of the line item.

3748

"entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and

3749

# bid on inventory.

3750

#

3751

# * For CreateLineItem method, only

3752

# `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use

3753

# UpdateLineItem method and update the

3754

# status to `ENTITY_STATUS_ACTIVE` after creation.

3755

# * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from

3756

# any other status.

3757

# * If the line item's parent insertion order is not active, the line item

3758

# can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.

3759

"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.

3760

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.

3761

#

3762

# When automatic budget allocation is enabled at the insertion order via

3763

# auto_budget_allocation, this

3764

# field is output only and defaults to `PACING_PERIOD_FLIGHT`.

3765

"pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be

3766

# spent across the pacing_period.

3767

"dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.

3768

#

3769

# Applicable when the budget is impression based. Must be greater than 0.

3770

"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of

3771

# advertiser's currency.

3772

#

3773

# Applicable when the budget is currency based. Must be greater than 0.

3774

# For example, for 1.5 standard unit of the currency, set this field to

3775

# 1500000.

3776

#

3777

# The value assigned will be rounded to whole billable units for the

3778

# relevant currency by the following rules: any positive value less than a

3779

# single billable unit will be rounded up to one billable unit and any

3780

# value larger than a single billable unit will be rounded down to the

3781

# nearest billable value. For example, if the currency's billable unit is

3782

# 0.01, and this field is set to 10257770, it will round down to 10250000,

3783

# a value of 10.25. If set to 505, it will round up to 10000, a value of

3784

# 0.01.

3785

},

3786

"lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.

3787

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

3788

"campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.

3789

"insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.

3790

"integrationDetails": { # Integration details of an entry. # Integration details of the line item.

3791

"details": "A String", # Additional details of the entry in string format.

3792

#

3793

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

3794

"integrationCode": "A String", # An external identifier to be associated with the entry.

3795

# The integration code will show up together with the entry in many

3796

# places in the system, for example, reporting.

3797

#

3798

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

3799

},

3800

"creativeIds": [ # The IDs of the creatives associated with the line item.

3801

"A String",

3802

],

3803

"conversionCounting": { # Settings that control how conversions are counted. # The conversion tracking setting of the line item.

3804

#

3805

# All post-click conversions will be counted. A percentage value can be set

3806

# for post-view conversions counting.

3807

"floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions.

3808

#

3809

# The number of conversions counted is the sum of all of the conversions

3810

# counted by all of the Floodlight activity IDs specified in this field.

3811

{ # Settings that control the behavior of a single Floodlight activity config.

3812

"floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.

3813

"postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a

3814

# conversion may be counted.

3815

# Must be between 0 and 90 inclusive.

3816

"postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a

3817

# conversion may be counted.

3818

# Must be between 0 and 90 inclusive.

3819

},

3820

],

3821

"postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a

3822

# percent). Must be between 0 and 100000 inclusive.

3823

#

3824

# For example, to track 50% of the post-click conversions, set a value of

3825

# 50000.

3826

},

3827

"bidStrategy": { # Settings that control the bid strategy. # Required. The bidding strategy of the line item.

3828

# Bid strategy determines the bid price.

3829

"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.

3830

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.

3831

# For insertion order entity,

3832

# bid_amount_micros should be set as 0.

3833

# For line item entity,

3834

# bid_amount_micros must be greater

3835

# than or equal to billable unit of the given currency and smaller than or

3836

# equal to the upper limit 1000000000.

3837

#

3838

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

3839

},

3840

"maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your

3841

# performance goal while spending the full budget.

3842

#

3843

# At insertion order level, the

3844

# markup_type of line items

3845

# cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,

3846

# when

3847

# performance_goal_type

3848

# is one of:

3849

#

3850

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`

3851

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`

3852

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,

3853

#

3854

# the line_item_type

3855

# of the insertion order line items must be either:

3856

#

3857

# * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`

3858

# * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,

3859

#

3860

# and when

3861

# performance_goal_type

3862

# is either:

3863

#

3864

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`

3865

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`

3866

#

3867

# the line_item_type

3868

# of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.

3869

# performance goal while spending the full budget.

3870

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

3871

# tries to minimize while spending the full budget.

3872

# `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for

3873

# this strategy.

3874

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's

3875

# currency. Must be greater than or equal to a billable unit of the given

3876

# currency.

3877

#

3878

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

3879

},

3880

"performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified

3881

# performance goal. It is to be used only for a line item entity.

3882

# performance goal.

3883

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

3884

# will try to meet or beat.

3885

#

3886

# For line item level usage, the value must be one of:

3887

#

3888

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`

3889

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`

3890

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.

3891

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's

3892

# currency. Must be greater than or equal to a billable unit of the given

3893

# currency. Not applicable when

3894

# performance_goal_type

3895

# is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.

3896

#

3897

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

3898

"performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to

3899

# meet or beat, in micros of the advertiser's currency.

3900

# Must be greater than or equal to a billable unit of the given currency and

3901

# smaller or equal to upper bounds. Each

3902

# performance_goal_type

3903

# has its upper bound:

3904

#

3905

# * when

3906

# performance_goal_type

3907

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,

3908

# upper bound is 10000.00 USD.

3909

# * when

3910

# performance_goal_type

3911

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,

3912

# upper bound is 1000.00 USD.

3913

# * when

3914

# performance_goal_type

3915

# is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is

# 1000.00 USD.

#

# Example: If set to

# `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will

3920

# be based on the probability that each available impression will be

3921

# viewable. For example, if viewable CPM target is $2 and an impression is

3922

# 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).

3923

#

3924

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

},

},

}

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

3930

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3937

3938

{ # A single line item.

3939

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

3940

# ad during a given time period.

3941

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

3942

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

3943

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

3944

# during this period. Must be greater than 0.

3945

#

3946

# Applicable when unlimited is `false`.

3947

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

3948

#

3949

# Applicable when unlimited is `false`.

3950

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

3951

# last.

3952

#

3953

# Applicable when unlimited is `false`.

3954

# The following restrictions apply based on the value of

3955

# time_unit:

3956

#

3957

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

3958

# default to 1

3959

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

3960

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

3961

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

3962

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

3963

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

3964

},

3965

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

3966

#

3967

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

3968

"partnerCosts": [ # The partner costs associated with the line item.

3969

#

3970

# If absent or empty in CreateLineItem

3971

# method, the newly created line item will inherit partner costs from its

3972

# parent insertion order.

3973

{ # Settings that control a partner cost.

3974

#

3975

# A partner cost is any type of expense involved in running a campaign, other

3976

# than the costs of purchasing impressions (which is called the media cost)

3977

# and using third-party audience segment data (data fee). Some examples of

3978

# partner costs include the fees for using DV360, a third-party ad server,

3979

# or a third-party ad serving verification service.

3980

"feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.

3981

#

3982

# Applicable when the fee_type is

3983

# `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.

3984

#

3985

# For example, for 1.5 standard unit of the advertiser's currency, set

3986

# this field to 1500000.

3987

"costType": "A String", # Required. The type of the partner cost.

3988

"feeType": "A String", # Required. The fee type for this partner cost.

3989

"feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).

3990

#

3991

# Applicable when the fee_type is

3992

# `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.

3993

#

3994

# For example: 100 represents 0.1%.

3995

"invoiceType": "A String", # The invoice type for this partner cost.

3996

#

3997

# * Required when cost_type is one of:

3998

# - `PARTNER_COST_TYPE_ADLOOX`

3999

# - `PARTNER_COST_TYPE_DOUBLE_VERIFY`

4000

# - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.

4001

# * Output only for other types.

4002

},

4003

],

4004

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

4005

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

4006

"budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.

4007

"budgetAllocationType": "A String", # Required. The type of the budget allocation.

4008

#

4009

# `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when

4010

# automatic budget allocation is enabled for the parent insertion order.

4011

"budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based

4012

# or impression based. This value is inherited from the parent insertion

4013

# order.

4014

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0.

4015

#

4016

# When budget_allocation_type is:

4017

#

4018

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable

4019

# and is set by the system.

4020

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if

4021

# budget_unit is:

4022

# - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount

4023

# to spend, in micros of the advertiser's currency. For example, 1500000

4024

# represents 1.5 standard units of the currency.

4025

# - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number

4026

# of impressions to serve.

4027

# * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not

4028

# applicable and will be ignored by the system.

4029

},

4030

"flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.

4031

"flightDateType": "A String", # Required. The type of the line item's flight dates.

4032

"dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved

4033

# relative to the parent advertiser's time zone.

4034

#

4035

# * Required when

4036

# flight_date_type is

4037

# `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise.

4038

# * When creating a new flight, both `start_date` and `end_date` must be in

4039

# the future.

4040

# * An existing flight with a `start_date` in the past has a mutable

4041

# `end_date` but an immutable `start_date`.

4042

# * `end_date` must be the `start_date` or later, both before the year 2037.

4043

"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

4044

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

4045

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

4046

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

4047

#

4048

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

4049

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

4050

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

4051

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

4052

#

4053

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

4054

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

4055

# a year.

4056

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

4057

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

4058

# significant.

4059

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

4060

# month and day.

4061

},

4062

"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

4063

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

4064

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

4065

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

4066

#

4067

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

4068

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

4069

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

4070

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

4071

#

4072

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

4073

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

4074

# a year.

4075

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

4076

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

4077

# significant.

4078

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

# month and day.

},

},

},

"inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item.

4084

"A String",

4085

],

4086

"partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.

4087

"markupType": "A String", # Required. The markup type of the partner revenue model.

4088

"markupAmount": "A String", # Required. The markup amount of the partner revenue model.

4089

# Must be greater than or equal to 0.

4090

#

4091

# * When the markup_type is set to be

4092

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM

4093

# markup in micros of advertiser's currency. For example, 1500000

4094

# represents 1.5 standard units of the currency.

4095

# * When the markup_type is set to be

4096

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field

4097

# represents the media cost percent markup in millis. For example,

4098

# 100 represents 0.1% (decimal 0.001).

4099

# * When the markup_type is set to be

4100

# `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field

4101

# represents the total media cost percent markup in millis. For example,

4102

# 100 represents 0.1% (decimal 0.001).

4103

},

4104

"lineItemType": "A String", # Required. Immutable. The type of the line item.

4105

"entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and

4106

# bid on inventory.

4107

#

4108

# * For CreateLineItem method, only

4109

# `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use

4110

# UpdateLineItem method and update the

4111

# status to `ENTITY_STATUS_ACTIVE` after creation.

4112

# * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from

4113

# any other status.

4114

# * If the line item's parent insertion order is not active, the line item

4115

# can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.

4116

"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.

4117

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.

4118

#

4119

# When automatic budget allocation is enabled at the insertion order via

4120

# auto_budget_allocation, this

4121

# field is output only and defaults to `PACING_PERIOD_FLIGHT`.

4122

"pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be

4123

# spent across the pacing_period.

4124

"dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.

4125

#

4126

# Applicable when the budget is impression based. Must be greater than 0.

4127

"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of

4128

# advertiser's currency.

4129

#

4130

# Applicable when the budget is currency based. Must be greater than 0.

4131

# For example, for 1.5 standard unit of the currency, set this field to

4132

# 1500000.

4133

#

4134

# The value assigned will be rounded to whole billable units for the

4135

# relevant currency by the following rules: any positive value less than a

4136

# single billable unit will be rounded up to one billable unit and any

4137

# value larger than a single billable unit will be rounded down to the

4138

# nearest billable value. For example, if the currency's billable unit is

4139

# 0.01, and this field is set to 10257770, it will round down to 10250000,

4140

# a value of 10.25. If set to 505, it will round up to 10000, a value of

4141

# 0.01.

4142

},

4143

"lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.

4144

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

4145

"campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.

4146

"insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.

4147

"integrationDetails": { # Integration details of an entry. # Integration details of the line item.

4148

"details": "A String", # Additional details of the entry in string format.

4149

#

4150

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

4151

"integrationCode": "A String", # An external identifier to be associated with the entry.

4152

# The integration code will show up together with the entry in many

4153

# places in the system, for example, reporting.

4154

#

4155

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

4156

},

4157

"creativeIds": [ # The IDs of the creatives associated with the line item.

4158

"A String",

4159

],

4160

"conversionCounting": { # Settings that control how conversions are counted. # The conversion tracking setting of the line item.

4161

#

4162

# All post-click conversions will be counted. A percentage value can be set

4163

# for post-view conversions counting.

4164

"floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions.

4165

#

4166

# The number of conversions counted is the sum of all of the conversions

4167

# counted by all of the Floodlight activity IDs specified in this field.

4168

{ # Settings that control the behavior of a single Floodlight activity config.

4169

"floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.

4170

"postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a

4171

# conversion may be counted.

4172

# Must be between 0 and 90 inclusive.

4173

"postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a

4174

# conversion may be counted.

4175

# Must be between 0 and 90 inclusive.

4176

},

4177

],

4178

"postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a

4179

# percent). Must be between 0 and 100000 inclusive.

4180

#

4181

# For example, to track 50% of the post-click conversions, set a value of

4182

# 50000.

4183

},

4184

"bidStrategy": { # Settings that control the bid strategy. # Required. The bidding strategy of the line item.

4185

# Bid strategy determines the bid price.

4186

"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.

4187

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.

4188

# For insertion order entity,

4189

# bid_amount_micros should be set as 0.

4190

# For line item entity,

4191

# bid_amount_micros must be greater

4192

# than or equal to billable unit of the given currency and smaller than or

4193

# equal to the upper limit 1000000000.

4194

#

4195

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

4196

},

4197

"maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your

4198

# performance goal while spending the full budget.

4199

#

4200

# At insertion order level, the

4201

# markup_type of line items

4202

# cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,

4203

# when

4204

# performance_goal_type

4205

# is one of:

4206

#

4207

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`

4208

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`

4209

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,

4210

#

4211

# the line_item_type

4212

# of the insertion order line items must be either:

4213

#

4214

# * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`

4215

# * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,

4216

#

4217

# and when

4218

# performance_goal_type

4219

# is either:

4220

#

4221

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`

4222

# * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`

4223

#

4224

# the line_item_type

4225

# of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.

4226

# performance goal while spending the full budget.

4227

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

4228

# tries to minimize while spending the full budget.

4229

# `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for

4230

# this strategy.

4231

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's

4232

# currency. Must be greater than or equal to a billable unit of the given

4233

# currency.

4234

#

4235

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

4236

},

4237

"performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified

4238

# performance goal. It is to be used only for a line item entity.

4239

# performance goal.

4240

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

4241

# will try to meet or beat.

4242

#

4243

# For line item level usage, the value must be one of: