Debian Codegraph @

docs/dyn/displayvideo_v3.targetingTypes.targetingOptions.html

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