blob: 946f7f54dc3c9845663c54e898729a25187dd3a8 [file] [log] [blame]
<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_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.targetingTypes.html">targetingTypes</a> . <a href="displayvideo_v1.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(previous_request, previous_response)</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(previous_request, previous_response)</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 &amp; 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.
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_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.
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.
&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.
&quot;ageRange&quot;: &quot;A String&quot;, # Output only. The age range of an audience.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The name of the app collection.
},
&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.
&quot;audioContentType&quot;: &quot;A String&quot;, # Output only. The audio content type.
},
&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.
&quot;authorizedSellerStatus&quot;: &quot;A String&quot;, # Output only. The authorized seller status.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the browser.
},
&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.
&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;.
&quot;geoRegion&quot;: &quot;A String&quot;, # Output only. The display name of the geographic region, e.g. &quot;Ontario, Canada&quot;.
&quot;geoRegionType&quot;: &quot;A String&quot;, # Output only. The type of the geographic region.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the carrier or ISP.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type indicating if it&#x27;s carrier or ISP.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the category.
},
&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.
&quot;contentInstreamPosition&quot;: &quot;A String&quot;, # Output only. The content instream position.
},
&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.
&quot;contentOutstreamPosition&quot;: &quot;A String&quot;, # Output only. The content outstream position.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the device make and model.
},
&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.
&quot;deviceType&quot;: &quot;A String&quot;, # Output only. The device type that is used to be targeted.
},
&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.
&quot;contentRatingTier&quot;: &quot;A String&quot;, # Output only. An enum for the content label brand safety tiers.
},
&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.
&quot;environment&quot;: &quot;A String&quot;, # Output only. The serving environment.
},
&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.
&quot;exchange&quot;: &quot;A String&quot;, # Output only. The type of exchange.
},
&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.
&quot;gender&quot;: &quot;A String&quot;, # Output only. The gender of an audience.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the geographic region (e.g., &quot;Ontario, Canada&quot;).
&quot;geoRegionType&quot;: &quot;A String&quot;, # Output only. The type of geographic region targeting.
},
&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.
&quot;householdIncome&quot;: &quot;A String&quot;, # Output only. The household income of an audience.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the language (e.g., &quot;French&quot;).
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this targeting option.
&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.
&quot;contentPosition&quot;: &quot;A String&quot;, # Output only. The content position.
},
&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.
&quot;omid&quot;: &quot;A String&quot;, # Output only. The type of Open Measurement enabled inventory.
},
&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.
&quot;onScreenPosition&quot;: &quot;A String&quot;, # Output only. The on screen position.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the operating system.
},
&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.
&quot;parentalStatus&quot;: &quot;A String&quot;, # Output only. The parental status of an audience.
},
&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.
&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.
&quot;latitude&quot;: 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
&quot;longitude&quot;: 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
},
&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.
&quot;sensitiveCategory&quot;: &quot;A String&quot;, # Output only. An enum for the DV360 Sensitive category content classifier.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the sub-exchange.
},
&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.
&quot;targetingType&quot;: &quot;A String&quot;, # Output only. The type of this targeting option.
&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.
&quot;userRewardedContent&quot;: &quot;A String&quot;, # Output only. User rewarded content status for video ads.
},
&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.
&quot;videoPlayerSize&quot;: &quot;A String&quot;, # Output only. The video player size.
},
&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.
&quot;viewability&quot;: &quot;A String&quot;, # 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 &amp; 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.
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_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.
advertiserId: string, Required. The Advertiser this request is being made in the context of.
filter: string, Allows filtering by targeting option properties. 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}`. * The operator must be &quot;=&quot; (equal sign). * 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.
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`.
pageSize: integer, Requested page size. Must be between `1` and `100`. 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.
&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.
&quot;targetingOptions&quot;: [ # The list of targeting options. This list will be absent if empty.
{ # Represents a single targeting option, which is a targetable concept in DV360.
&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.
&quot;ageRange&quot;: &quot;A String&quot;, # Output only. The age range of an audience.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The name of the app collection.
},
&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.
&quot;audioContentType&quot;: &quot;A String&quot;, # Output only. The audio content type.
},
&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.
&quot;authorizedSellerStatus&quot;: &quot;A String&quot;, # Output only. The authorized seller status.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the browser.
},
&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.
&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;.
&quot;geoRegion&quot;: &quot;A String&quot;, # Output only. The display name of the geographic region, e.g. &quot;Ontario, Canada&quot;.
&quot;geoRegionType&quot;: &quot;A String&quot;, # Output only. The type of the geographic region.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the carrier or ISP.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type indicating if it&#x27;s carrier or ISP.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the category.
},
&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.
&quot;contentInstreamPosition&quot;: &quot;A String&quot;, # Output only. The content instream position.
},
&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.
&quot;contentOutstreamPosition&quot;: &quot;A String&quot;, # Output only. The content outstream position.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the device make and model.
},
&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.
&quot;deviceType&quot;: &quot;A String&quot;, # Output only. The device type that is used to be targeted.
},
&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.
&quot;contentRatingTier&quot;: &quot;A String&quot;, # Output only. An enum for the content label brand safety tiers.
},
&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.
&quot;environment&quot;: &quot;A String&quot;, # Output only. The serving environment.
},
&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.
&quot;exchange&quot;: &quot;A String&quot;, # Output only. The type of exchange.
},
&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.
&quot;gender&quot;: &quot;A String&quot;, # Output only. The gender of an audience.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the geographic region (e.g., &quot;Ontario, Canada&quot;).
&quot;geoRegionType&quot;: &quot;A String&quot;, # Output only. The type of geographic region targeting.
},
&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.
&quot;householdIncome&quot;: &quot;A String&quot;, # Output only. The household income of an audience.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the language (e.g., &quot;French&quot;).
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this targeting option.
&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.
&quot;contentPosition&quot;: &quot;A String&quot;, # Output only. The content position.
},
&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.
&quot;omid&quot;: &quot;A String&quot;, # Output only. The type of Open Measurement enabled inventory.
},
&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.
&quot;onScreenPosition&quot;: &quot;A String&quot;, # Output only. The on screen position.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the operating system.
},
&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.
&quot;parentalStatus&quot;: &quot;A String&quot;, # Output only. The parental status of an audience.
},
&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.
&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.
&quot;latitude&quot;: 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
&quot;longitude&quot;: 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
},
&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.
&quot;sensitiveCategory&quot;: &quot;A String&quot;, # Output only. An enum for the DV360 Sensitive category content classifier.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the sub-exchange.
},
&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.
&quot;targetingType&quot;: &quot;A String&quot;, # Output only. The type of this targeting option.
&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.
&quot;userRewardedContent&quot;: &quot;A String&quot;, # Output only. User rewarded content status for video ads.
},
&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.
&quot;videoPlayerSize&quot;: &quot;A String&quot;, # Output only. The video player size.
},
&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.
&quot;viewability&quot;: &quot;A String&quot;, # Output only. The predicted viewability percentage.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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 &#x27;execute()&#x27; 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 &amp; 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.
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_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.
body: object, The request body.
The object takes the form of:
{ # Request message for SearchTargetingOptions.
&quot;advertiserId&quot;: &quot;A String&quot;, # Required. The Advertiser this request is being made in the context of.
&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`.
&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;.
&quot;regionQuery&quot;: &quot;A String&quot;, # The search query for the desired geo region, e.g. &quot;Seattle&quot;, &quot;United State&quot;.
},
&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`.
&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.
},
&quot;pageSize&quot;: 42, # Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
&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.
&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`.
&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.
},
}
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.
&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.
&quot;targetingOptions&quot;: [ # 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.
&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.
&quot;ageRange&quot;: &quot;A String&quot;, # Output only. The age range of an audience.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The name of the app collection.
},
&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.
&quot;audioContentType&quot;: &quot;A String&quot;, # Output only. The audio content type.
},
&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.
&quot;authorizedSellerStatus&quot;: &quot;A String&quot;, # Output only. The authorized seller status.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the browser.
},
&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.
&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;.
&quot;geoRegion&quot;: &quot;A String&quot;, # Output only. The display name of the geographic region, e.g. &quot;Ontario, Canada&quot;.
&quot;geoRegionType&quot;: &quot;A String&quot;, # Output only. The type of the geographic region.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the carrier or ISP.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type indicating if it&#x27;s carrier or ISP.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the category.
},
&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.
&quot;contentInstreamPosition&quot;: &quot;A String&quot;, # Output only. The content instream position.
},
&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.
&quot;contentOutstreamPosition&quot;: &quot;A String&quot;, # Output only. The content outstream position.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the device make and model.
},
&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.
&quot;deviceType&quot;: &quot;A String&quot;, # Output only. The device type that is used to be targeted.
},
&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.
&quot;contentRatingTier&quot;: &quot;A String&quot;, # Output only. An enum for the content label brand safety tiers.
},
&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.
&quot;environment&quot;: &quot;A String&quot;, # Output only. The serving environment.
},
&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.
&quot;exchange&quot;: &quot;A String&quot;, # Output only. The type of exchange.
},
&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.
&quot;gender&quot;: &quot;A String&quot;, # Output only. The gender of an audience.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the geographic region (e.g., &quot;Ontario, Canada&quot;).
&quot;geoRegionType&quot;: &quot;A String&quot;, # Output only. The type of geographic region targeting.
},
&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.
&quot;householdIncome&quot;: &quot;A String&quot;, # Output only. The household income of an audience.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the language (e.g., &quot;French&quot;).
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this targeting option.
&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.
&quot;contentPosition&quot;: &quot;A String&quot;, # Output only. The content position.
},
&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.
&quot;omid&quot;: &quot;A String&quot;, # Output only. The type of Open Measurement enabled inventory.
},
&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.
&quot;onScreenPosition&quot;: &quot;A String&quot;, # Output only. The on screen position.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the operating system.
},
&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.
&quot;parentalStatus&quot;: &quot;A String&quot;, # Output only. The parental status of an audience.
},
&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.
&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.
&quot;latitude&quot;: 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
&quot;longitude&quot;: 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
},
&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.
&quot;sensitiveCategory&quot;: &quot;A String&quot;, # Output only. An enum for the DV360 Sensitive category content classifier.
},
&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.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the sub-exchange.
},
&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.
&quot;targetingType&quot;: &quot;A String&quot;, # Output only. The type of this targeting option.
&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.
&quot;userRewardedContent&quot;: &quot;A String&quot;, # Output only. User rewarded content status for video ads.
},
&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.
&quot;videoPlayerSize&quot;: &quot;A String&quot;, # Output only. The video player size.
},
&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.
&quot;viewability&quot;: &quot;A String&quot;, # Output only. The predicted viewability percentage.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="search_next">search_next(previous_request, previous_response)</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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>