1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="displayvideo_v2.html">Display & Video 360 API</a> . <a href="displayvideo_v2.targetingTypes.html">targetingTypes</a> . <a href="displayvideo_v2.targetingTypes.targetingOptions.html">targetingOptions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(targetingType, targetingOptionId, advertiserId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a single targeting option.</p>
<p class="toc_element">
<code><a href="#list">list(targetingType, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists targeting options of a given type.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#search">search(targetingType, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches for targeting options of a given type based on the given search terms.</p>
<p class="toc_element">
<code><a href="#search_next">search_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(targetingType, targetingOptionId, advertiserId=None, x__xgafv=None)</code>
<pre>Gets a single targeting option.
Args:
targetingType: string, Required. The type of targeting option to retrieve. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` (required)
Allowed values
TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
targetingOptionId: string, Required. The ID of the of targeting option to retrieve. (required)
advertiserId: string, Required. The Advertiser this request is being made in the context of.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a single targeting option, which is a targetable concept in DV360.
"ageRangeDetails": { # Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details.
"ageRange": "A String", # Output only. The age range of an audience.
},
"appCategoryDetails": { # Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example `All Apps/Google Play/Games`. This will be populated in the app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details.
"displayName": "A String", # Output only. The name of the app collection.
},
"audioContentTypeDetails": { # Represents a targetable audio content type. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. # Audio content type details.
"audioContentType": "A String", # Output only. The audio content type.
},
"authorizedSellerStatusDetails": { # Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Authorized seller status resource details.
"authorizedSellerStatus": "A String", # Output only. The authorized seller status.
},
"browserDetails": { # Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details.
"displayName": "A String", # Output only. The display name of the browser.
},
"businessChainDetails": { # Represents a targetable business chain within a geo region. This will be populated in the business_chain_details field when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain resource details.
"businessChain": "A String", # Output only. The display name of the business chain, e.g. "KFC", "Chase Bank".
"geoRegion": "A String", # Output only. The display name of the geographic region, e.g. "Ontario, Canada".
"geoRegionType": "A String", # Output only. The type of the geographic region.
},
"carrierAndIspDetails": { # Represents a targetable carrier or ISP. This will be populated in the carrier_and_isp_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details.
"displayName": "A String", # Output only. The display name of the carrier or ISP.
"type": "A String", # Output only. The type indicating if it's carrier or ISP.
},
"categoryDetails": { # Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category resource details.
"displayName": "A String", # Output only. The display name of the category.
},
"contentDurationDetails": { # Represents a targetable content duration. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. # Content duration resource details.
"contentDuration": "A String", # Output only. The content duration.
},
"contentGenreDetails": { # Represents a targetable content genre. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. # Content genre resource details.
"displayName": "A String", # Output only. The display name of the content genre
},
"contentInstreamPositionDetails": { # Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details.
"contentInstreamPosition": "A String", # Output only. The content instream position.
},
"contentOutstreamPositionDetails": { # Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details.
"contentOutstreamPosition": "A String", # Output only. The content outstream position.
},
"contentStreamTypeDetails": { # Represents a targetable content stream type. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. # Content stream type resource details.
"contentStreamType": "A String", # Output only. The content stream type.
},
"deviceMakeModelDetails": { # Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model resource details.
"displayName": "A String", # Output only. The display name of the device make and model.
},
"deviceTypeDetails": { # Represents a targetable device type. This will be populated in the device_type_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device type details.
"deviceType": "A String", # Output only. The device type that is used to be targeted.
},
"digitalContentLabelDetails": { # Represents a targetable digital content label rating tier. This will be populated in the digital_content_label_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details.
"contentRatingTier": "A String", # Output only. An enum for the content label brand safety tiers.
},
"environmentDetails": { # Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details.
"environment": "A String", # Output only. The serving environment.
},
"exchangeDetails": { # Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details.
"exchange": "A String", # Output only. The type of exchange.
},
"genderDetails": { # Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details.
"gender": "A String", # Output only. The gender of an audience.
},
"geoRegionDetails": { # Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region resource details.
"displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
"geoRegionType": "A String", # Output only. The type of geographic region targeting.
},
"householdIncomeDetails": { # Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details.
"householdIncome": "A String", # Output only. The household income of an audience.
},
"languageDetails": { # Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language resource details.
"displayName": "A String", # Output only. The display name of the language (e.g., "French").
},
"name": "A String", # Output only. The resource name for this targeting option.
"nativeContentPositionDetails": { # Represents a targetable native content position. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. # Native content position details.
"contentPosition": "A String", # Output only. The content position.
},
"omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the omid_details field when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details.
"omid": "A String", # Output only. The type of Open Measurement enabled inventory.
},
"onScreenPositionDetails": { # Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details.
"onScreenPosition": "A String", # Output only. The on screen position.
},
"operatingSystemDetails": { # Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system resources details.
"displayName": "A String", # Output only. The display name of the operating system.
},
"parentalStatusDetails": { # Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details.
"parentalStatus": "A String", # Output only. The parental status of an audience.
},
"poiDetails": { # Represents a targetable point of interest(POI). This will be populated in the poi_details field when targeting_type is `TARGETING_TYPE_POI`. # POI resource details.
"displayName": "A String", # Output only. The display name of a POI(e.g. "Times Square", "Space Needle"), followed by its full address if available.
"latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
"longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
},
"sensitiveCategoryDetails": { # Represents a targetable sensitive category. This will be populated in the sensitive_category_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive Category details.
"sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier.
},
"subExchangeDetails": { # Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details.
"displayName": "A String", # Output only. The display name of the sub-exchange.
},
"targetingOptionId": "A String", # Output only. A unique identifier for this targeting option. The tuple {`targeting_type`, `targeting_option_id`} will be unique.
"targetingType": "A String", # Output only. The type of this targeting option.
"userRewardedContentDetails": { # Represents a targetable user rewarded content status for video ads only. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details.
"userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
},
"videoPlayerSizeDetails": { # Represents a targetable video player size. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. # Video player size details.
"videoPlayerSize": "A String", # Output only. The video player size.
},
"viewabilityDetails": { # Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability resource details.
"viewability": "A String", # Output only. The predicted viewability percentage.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(targetingType, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists targeting options of a given type.
Args:
targetingType: string, Required. The type of targeting option to be listed. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` (required)
Allowed values
TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
advertiserId: string, Required. The Advertiser this request is being made in the context of.
filter: string, Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy: string, Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingOptionId desc`.
pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListTargetingOptions` method. If not specified, the first page of results will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ListTargetingOptions.
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListTargetingOptions` method to retrieve the next page of results.
"targetingOptions": [ # The list of targeting options. This list will be absent if empty.
{ # Represents a single targeting option, which is a targetable concept in DV360.
"ageRangeDetails": { # Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details.
"ageRange": "A String", # Output only. The age range of an audience.
},
"appCategoryDetails": { # Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example `All Apps/Google Play/Games`. This will be populated in the app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details.
"displayName": "A String", # Output only. The name of the app collection.
},
"audioContentTypeDetails": { # Represents a targetable audio content type. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. # Audio content type details.
"audioContentType": "A String", # Output only. The audio content type.
},
"authorizedSellerStatusDetails": { # Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Authorized seller status resource details.
"authorizedSellerStatus": "A String", # Output only. The authorized seller status.
},
"browserDetails": { # Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details.
"displayName": "A String", # Output only. The display name of the browser.
},
"businessChainDetails": { # Represents a targetable business chain within a geo region. This will be populated in the business_chain_details field when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain resource details.
"businessChain": "A String", # Output only. The display name of the business chain, e.g. "KFC", "Chase Bank".
"geoRegion": "A String", # Output only. The display name of the geographic region, e.g. "Ontario, Canada".
"geoRegionType": "A String", # Output only. The type of the geographic region.
},
"carrierAndIspDetails": { # Represents a targetable carrier or ISP. This will be populated in the carrier_and_isp_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details.
"displayName": "A String", # Output only. The display name of the carrier or ISP.
"type": "A String", # Output only. The type indicating if it's carrier or ISP.
},
"categoryDetails": { # Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category resource details.
"displayName": "A String", # Output only. The display name of the category.
},
"contentDurationDetails": { # Represents a targetable content duration. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. # Content duration resource details.
"contentDuration": "A String", # Output only. The content duration.
},
"contentGenreDetails": { # Represents a targetable content genre. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. # Content genre resource details.
"displayName": "A String", # Output only. The display name of the content genre
},
"contentInstreamPositionDetails": { # Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details.
"contentInstreamPosition": "A String", # Output only. The content instream position.
},
"contentOutstreamPositionDetails": { # Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details.
"contentOutstreamPosition": "A String", # Output only. The content outstream position.
},
"contentStreamTypeDetails": { # Represents a targetable content stream type. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. # Content stream type resource details.
"contentStreamType": "A String", # Output only. The content stream type.
},
"deviceMakeModelDetails": { # Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model resource details.
"displayName": "A String", # Output only. The display name of the device make and model.
},
"deviceTypeDetails": { # Represents a targetable device type. This will be populated in the device_type_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device type details.
"deviceType": "A String", # Output only. The device type that is used to be targeted.
},
"digitalContentLabelDetails": { # Represents a targetable digital content label rating tier. This will be populated in the digital_content_label_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details.
"contentRatingTier": "A String", # Output only. An enum for the content label brand safety tiers.
},
"environmentDetails": { # Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details.
"environment": "A String", # Output only. The serving environment.
},
"exchangeDetails": { # Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details.
"exchange": "A String", # Output only. The type of exchange.
},
"genderDetails": { # Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details.
"gender": "A String", # Output only. The gender of an audience.
},
"geoRegionDetails": { # Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region resource details.
"displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
"geoRegionType": "A String", # Output only. The type of geographic region targeting.
},
"householdIncomeDetails": { # Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details.
"householdIncome": "A String", # Output only. The household income of an audience.
},
"languageDetails": { # Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language resource details.
"displayName": "A String", # Output only. The display name of the language (e.g., "French").
},
"name": "A String", # Output only. The resource name for this targeting option.
"nativeContentPositionDetails": { # Represents a targetable native content position. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. # Native content position details.
"contentPosition": "A String", # Output only. The content position.
},
"omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the omid_details field when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details.
"omid": "A String", # Output only. The type of Open Measurement enabled inventory.
},
"onScreenPositionDetails": { # Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details.
"onScreenPosition": "A String", # Output only. The on screen position.
},
"operatingSystemDetails": { # Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system resources details.
"displayName": "A String", # Output only. The display name of the operating system.
},
"parentalStatusDetails": { # Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details.
"parentalStatus": "A String", # Output only. The parental status of an audience.
},
"poiDetails": { # Represents a targetable point of interest(POI). This will be populated in the poi_details field when targeting_type is `TARGETING_TYPE_POI`. # POI resource details.
"displayName": "A String", # Output only. The display name of a POI(e.g. "Times Square", "Space Needle"), followed by its full address if available.
"latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
"longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
},
"sensitiveCategoryDetails": { # Represents a targetable sensitive category. This will be populated in the sensitive_category_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive Category details.
"sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier.
},
"subExchangeDetails": { # Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details.
"displayName": "A String", # Output only. The display name of the sub-exchange.
},
"targetingOptionId": "A String", # Output only. A unique identifier for this targeting option. The tuple {`targeting_type`, `targeting_option_id`} will be unique.
"targetingType": "A String", # Output only. The type of this targeting option.
"userRewardedContentDetails": { # Represents a targetable user rewarded content status for video ads only. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details.
"userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
},
"videoPlayerSizeDetails": { # Represents a targetable video player size. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. # Video player size details.
"videoPlayerSize": "A String", # Output only. The video player size.
},
"viewabilityDetails": { # Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability resource details.
"viewability": "A String", # Output only. The predicted viewability percentage.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="search">search(targetingType, body=None, x__xgafv=None)</code>
<pre>Searches for targeting options of a given type based on the given search terms.
Args:
targetingType: string, Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN` (required)
Allowed values
TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
body: object, The request body.
The object takes the form of:
{ # Request message for SearchTargetingOptions.
"advertiserId": "A String", # Required. The Advertiser this request is being made in the context of.
"businessChainSearchTerms": { # Search terms for Business Chain targeting options. At least one of the field should be populated. # Search terms for Business Chain targeting options. Can only be used when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
"businessChainQuery": "A String", # The search query for the desired business chain. The query must be the full name of the business, e.g. "KFC", "mercedes-benz".
"regionQuery": "A String", # The search query for the desired geo region, e.g. "Seattle", "United State".
},
"geoRegionSearchTerms": { # Search terms for geo region targeting options. # Search terms for geo region targeting options. Can only be used when targeting_type is `TARGETING_TYPE_GEO_REGION`.
"geoRegionQuery": "A String", # The search query for the desired geo region. The query can be a prefix, e.g. "New Yor", "Seattle", "USA", etc.
},
"pageSize": 42, # Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
"pageToken": "A String", # A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `SearchTargetingOptions` method. If not specified, the first page of results will be returned.
"poiSearchTerms": { # Search terms for POI targeting options. # Search terms for POI targeting options. Can only be used when targeting_type is `TARGETING_TYPE_POI`.
"poiQuery": "A String", # The search query for the desired POI name, street address, or coordinate of the desired POI. The query can be a prefix, e.g. "Times squar", "40.7505045,-73.99562", "315 W 44th St", etc.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for SearchTargetingOptions.
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `SearchTargetingOptions` method to retrieve the next page of results.
"targetingOptions": [ # The list of targeting options that match the search criteria. This list will be absent if empty.
{ # Represents a single targeting option, which is a targetable concept in DV360.
"ageRangeDetails": { # Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details.
"ageRange": "A String", # Output only. The age range of an audience.
},
"appCategoryDetails": { # Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example `All Apps/Google Play/Games`. This will be populated in the app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details.
"displayName": "A String", # Output only. The name of the app collection.
},
"audioContentTypeDetails": { # Represents a targetable audio content type. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. # Audio content type details.
"audioContentType": "A String", # Output only. The audio content type.
},
"authorizedSellerStatusDetails": { # Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Authorized seller status resource details.
"authorizedSellerStatus": "A String", # Output only. The authorized seller status.
},
"browserDetails": { # Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details.
"displayName": "A String", # Output only. The display name of the browser.
},
"businessChainDetails": { # Represents a targetable business chain within a geo region. This will be populated in the business_chain_details field when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain resource details.
"businessChain": "A String", # Output only. The display name of the business chain, e.g. "KFC", "Chase Bank".
"geoRegion": "A String", # Output only. The display name of the geographic region, e.g. "Ontario, Canada".
"geoRegionType": "A String", # Output only. The type of the geographic region.
},
"carrierAndIspDetails": { # Represents a targetable carrier or ISP. This will be populated in the carrier_and_isp_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details.
"displayName": "A String", # Output only. The display name of the carrier or ISP.
"type": "A String", # Output only. The type indicating if it's carrier or ISP.
},
"categoryDetails": { # Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category resource details.
"displayName": "A String", # Output only. The display name of the category.
},
"contentDurationDetails": { # Represents a targetable content duration. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. # Content duration resource details.
"contentDuration": "A String", # Output only. The content duration.
},
"contentGenreDetails": { # Represents a targetable content genre. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. # Content genre resource details.
"displayName": "A String", # Output only. The display name of the content genre
},
"contentInstreamPositionDetails": { # Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details.
"contentInstreamPosition": "A String", # Output only. The content instream position.
},
"contentOutstreamPositionDetails": { # Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details.
"contentOutstreamPosition": "A String", # Output only. The content outstream position.
},
"contentStreamTypeDetails": { # Represents a targetable content stream type. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. # Content stream type resource details.
"contentStreamType": "A String", # Output only. The content stream type.
},
"deviceMakeModelDetails": { # Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model resource details.
"displayName": "A String", # Output only. The display name of the device make and model.
},
"deviceTypeDetails": { # Represents a targetable device type. This will be populated in the device_type_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device type details.
"deviceType": "A String", # Output only. The device type that is used to be targeted.
},
"digitalContentLabelDetails": { # Represents a targetable digital content label rating tier. This will be populated in the digital_content_label_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details.
"contentRatingTier": "A String", # Output only. An enum for the content label brand safety tiers.
},
"environmentDetails": { # Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details.
"environment": "A String", # Output only. The serving environment.
},
"exchangeDetails": { # Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details.
"exchange": "A String", # Output only. The type of exchange.
},
"genderDetails": { # Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details.
"gender": "A String", # Output only. The gender of an audience.
},
"geoRegionDetails": { # Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region resource details.
"displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
"geoRegionType": "A String", # Output only. The type of geographic region targeting.
},
"householdIncomeDetails": { # Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details.
"householdIncome": "A String", # Output only. The household income of an audience.
},
"languageDetails": { # Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language resource details.
"displayName": "A String", # Output only. The display name of the language (e.g., "French").
},
"name": "A String", # Output only. The resource name for this targeting option.
"nativeContentPositionDetails": { # Represents a targetable native content position. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. # Native content position details.
"contentPosition": "A String", # Output only. The content position.
},
"omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the omid_details field when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details.
"omid": "A String", # Output only. The type of Open Measurement enabled inventory.
},
"onScreenPositionDetails": { # Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details.
"onScreenPosition": "A String", # Output only. The on screen position.
},
"operatingSystemDetails": { # Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system resources details.
"displayName": "A String", # Output only. The display name of the operating system.
},
"parentalStatusDetails": { # Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details.
"parentalStatus": "A String", # Output only. The parental status of an audience.
},
"poiDetails": { # Represents a targetable point of interest(POI). This will be populated in the poi_details field when targeting_type is `TARGETING_TYPE_POI`. # POI resource details.
"displayName": "A String", # Output only. The display name of a POI(e.g. "Times Square", "Space Needle"), followed by its full address if available.
"latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
"longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
},
"sensitiveCategoryDetails": { # Represents a targetable sensitive category. This will be populated in the sensitive_category_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive Category details.
"sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier.
},
"subExchangeDetails": { # Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details.
"displayName": "A String", # Output only. The display name of the sub-exchange.
},
"targetingOptionId": "A String", # Output only. A unique identifier for this targeting option. The tuple {`targeting_type`, `targeting_option_id`} will be unique.
"targetingType": "A String", # Output only. The type of this targeting option.
"userRewardedContentDetails": { # Represents a targetable user rewarded content status for video ads only. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details.
"userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
},
"videoPlayerSizeDetails": { # Represents a targetable video player size. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. # Video player size details.
"videoPlayerSize": "A String", # Output only. The video player size.
},
"viewabilityDetails": { # Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability resource details.
"viewability": "A String", # Output only. The predicted viewability percentage.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="search_next">search_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
