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