| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 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_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.insertionOrders.html">insertionOrders</a> . <a href="displayvideo_v1.advertisers.insertionOrders.targetingTypes.html">targetingTypes</a> . <a href="displayvideo_v1.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html">assignedTargetingOptions</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(advertiserId, insertionOrderId, targetingType, assignedTargetingOptionId, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Gets a single targeting option assigned to an insertion order.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list">list(advertiserId, insertionOrderId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Lists the targeting options assigned to an insertion order.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
| 96 | <code class="details" id="get">get(advertiserId, insertionOrderId, targetingType, assignedTargetingOptionId, x__xgafv=None)</code> |
| 97 | <pre>Gets a single targeting option assigned to an insertion order. |
| 98 | |
| 99 | Args: |
| 100 | advertiserId: string, Required. The ID of the advertiser the insertion order belongs to. (required) |
| 101 | insertionOrderId: string, Required. The ID of the insertion order the assigned targeting option belongs to. (required) |
| 102 | targetingType: string, Required. Identifies the type of this assigned targeting option. (required) |
| 103 | Allowed values |
| 104 | TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. |
| 105 | TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). |
| 106 | TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games). |
| 107 | TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds). |
| 108 | TARGETING_TYPE_URL - Target a specific url (for example, quora.com). |
| 109 | TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day. |
| 110 | TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24). |
| 111 | TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list. |
| 112 | TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list. |
| 113 | TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male). |
| 114 | TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads. |
| 115 | TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads. |
| 116 | TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent). |
| 117 | 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). |
| 118 | TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position. |
| 119 | TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV). |
| 120 | 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. |
| 121 | TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome). |
| 122 | TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%). |
| 123 | TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. |
| 124 | TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). |
| 125 | TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). |
| 126 | TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). |
| 127 | TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). |
| 128 | TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). |
| 129 | TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). |
| 130 | TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung). |
| 131 | TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever). |
| 132 | TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list. |
| 133 | TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable). |
| 134 | TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment). |
| 135 | TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages. |
| 136 | TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese). |
| 137 | TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. |
| 138 | TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state). |
| 139 | TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages. |
| 140 | TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges. |
| 141 | TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 142 | TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 143 | assignedTargetingOptionId: string, Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested. (required) |
| 144 | x__xgafv: string, V1 error format. |
| 145 | Allowed values |
| 146 | 1 - v1 error format |
| 147 | 2 - v2 error format |
| 148 | |
| 149 | Returns: |
| 150 | An object of the form: |
| 151 | |
| 152 | { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. |
| 153 | "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`. |
| 154 | "ageRange": "A String", # Output only. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age. |
| 155 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AGE_RANGE`. |
| 156 | }, |
| 157 | "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`. |
| 158 | "displayName": "A String", # Output only. The display name of the app category. |
| 159 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 160 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. |
| 161 | }, |
| 162 | "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`. |
| 163 | "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 164 | "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 165 | "displayName": "A String", # Output only. The display name of the app. |
| 166 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 167 | }, |
| 168 | "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. |
| 169 | "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is UNION'ed with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. |
| 170 | "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. Its COMPLEMENT is used to UNION other audience groups. |
| 171 | "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. |
| 172 | { # Details of first and third party audience targeting setting. |
| 173 | "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. |
| 174 | "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. |
| 175 | }, |
| 176 | ], |
| 177 | }, |
| 178 | "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. It's COMPLEMENT is used to UNION other audience groups. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. |
| 179 | "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. |
| 180 | { # Details of Google audience targeting setting. |
| 181 | "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. |
| 182 | }, |
| 183 | ], |
| 184 | }, |
| 185 | "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. |
| 186 | "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. |
| 187 | { # Details of combined audience targeting setting. |
| 188 | "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. |
| 189 | }, |
| 190 | ], |
| 191 | }, |
| 192 | "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. |
| 193 | "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. |
| 194 | { # Details of custom list targeting setting. |
| 195 | "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. |
| 196 | }, |
| 197 | ], |
| 198 | }, |
| 199 | "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. |
| 200 | { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. |
| 201 | "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. |
| 202 | { # Details of first and third party audience targeting setting. |
| 203 | "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. |
| 204 | "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. |
| 205 | }, |
| 206 | ], |
| 207 | }, |
| 208 | ], |
| 209 | "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. |
| 210 | "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. |
| 211 | { # Details of Google audience targeting setting. |
| 212 | "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. |
| 213 | }, |
| 214 | ], |
| 215 | }, |
| 216 | }, |
| 217 | "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default. |
| 218 | "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target. |
| 219 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. |
| 220 | }, |
| 221 | "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`. |
| 222 | "displayName": "A String", # Output only. The display name of the browser. |
| 223 | "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field. |
| 224 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`. |
| 225 | }, |
| 226 | "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. |
| 227 | "displayName": "A String", # Output only. The display name of the carrier or ISP. |
| 228 | "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field. |
| 229 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. |
| 230 | }, |
| 231 | "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence. |
| 232 | "displayName": "A String", # Output only. The display name of the category. |
| 233 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 234 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`. |
| 235 | }, |
| 236 | "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`. |
| 237 | "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource. |
| 238 | "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true. |
| 239 | }, |
| 240 | "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| 241 | "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`. |
| 242 | "contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads. |
| 243 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| 244 | }, |
| 245 | "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| 246 | "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. |
| 247 | "contentOutstreamPosition": "A String", # Output only. The content outstream position. |
| 248 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| 249 | }, |
| 250 | "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`. |
| 251 | "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. |
| 252 | "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). |
| 253 | "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). |
| 254 | "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. |
| 255 | }, |
| 256 | "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| 257 | "displayName": "A String", # Output only. The display name of the device make and model. |
| 258 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 259 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| 260 | }, |
| 261 | "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. |
| 262 | "deviceType": "A String", # Output only. The display name of the device type. |
| 263 | "targetingOptionId": "A String", # Required. ID of the device type. |
| 264 | }, |
| 265 | "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. |
| 266 | "contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier. |
| 267 | "excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED. |
| 268 | }, |
| 269 | "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. |
| 270 | "environment": "A String", # Output only. The serving environment. |
| 271 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., "508010" for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option). |
| 272 | }, |
| 273 | "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`. |
| 274 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_EXCHANGE`. |
| 275 | }, |
| 276 | "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`. |
| 277 | "gender": "A String", # Output only. The gender of the audience. |
| 278 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GENDER`. |
| 279 | }, |
| 280 | "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`. |
| 281 | "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
| 282 | "geoRegionType": "A String", # Output only. The type of geographic region targeting. |
| 283 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 284 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`. |
| 285 | }, |
| 286 | "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| 287 | "householdIncome": "A String", # Output only. The household income of the audience. |
| 288 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| 289 | }, |
| 290 | "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option. |
| 291 | "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. |
| 292 | "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. |
| 293 | }, |
| 294 | "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. |
| 295 | "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. |
| 296 | }, |
| 297 | "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. |
| 298 | "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. |
| 299 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 300 | }, |
| 301 | "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`. |
| 302 | "displayName": "A String", # Output only. The display name of the language (e.g., "French"). |
| 303 | "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field. |
| 304 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`. |
| 305 | }, |
| 306 | "name": "A String", # Output only. The resource name for this assigned targeting option. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 307 | "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. |
| 308 | "contentPosition": "A String", # Output only. The content position. |
| 309 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. |
| 310 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 311 | "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource. |
| 312 | "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. |
| 313 | }, |
| 314 | "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| 315 | "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. |
| 316 | "onScreenPosition": "A String", # Output only. The on screen position. |
| 317 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| 318 | }, |
| 319 | "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. |
| 320 | "displayName": "A String", # Output only. The display name of the operating system. |
| 321 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 322 | "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. |
| 323 | }, |
| 324 | "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. |
| 325 | "parentalStatus": "A String", # Output only. The parental status of the audience. |
| 326 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`. |
| 327 | }, |
| 328 | "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. |
| 329 | "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`. |
| 330 | "proximityRadiusRange": "A String", # Required. Radius range for proximity location list. This represents the size of the area around a chosen location that will be targeted. `All` proximity location targeting under a single resource must have the same radius range value. Set this value to match any existing targeting. If updated, this field will change the radius range for all proximity targeting under the resource. |
| 331 | }, |
| 332 | "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. |
| 333 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 334 | "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. |
| 335 | }, |
| 336 | "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. |
| 337 | "excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED. |
| 338 | "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier. |
| 339 | }, |
| 340 | "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. |
| 341 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. |
| 342 | }, |
| 343 | "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option. |
| 344 | "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. |
| 345 | "adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox. |
| 346 | "excludedAdlooxCategories": [ # Adloox's brand safety settings. |
| 347 | "A String", |
| 348 | ], |
| 349 | }, |
| 350 | "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify. |
| 351 | "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings. |
| 352 | "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings. |
| 353 | "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings. |
| 354 | }, |
| 355 | "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating. |
| 356 | "A String", |
| 357 | ], |
| 358 | "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls. |
| 359 | "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable. |
| 360 | "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories. |
| 361 | "A String", |
| 362 | ], |
| 363 | "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories. |
| 364 | "A String", |
| 365 | ], |
| 366 | }, |
| 367 | "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic |
| 368 | "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only). |
| 369 | "iab": "A String", # Target web and app inventory to maximize IAB viewable rate. |
| 370 | "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration. |
| 371 | }, |
| 372 | "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates. |
| 373 | "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats. |
| 374 | "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT. |
| 375 | }, |
| 376 | "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only). |
| 377 | "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size. |
| 378 | "videoIab": "A String", # Target web inventory to maximize IAB viewable rate. |
| 379 | "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate. |
| 380 | }, |
| 381 | }, |
| 382 | "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. |
| 383 | "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. |
| 384 | "A String", |
| 385 | ], |
| 386 | "displayViewability": "A String", # Display Viewability section (applicable to display line items only). |
| 387 | "excludeUnrateable": True or False, # Brand Safety - **Unrateable**. |
| 388 | "excludedAdFraudRisk": "A String", # Ad Fraud settings. |
| 389 | "excludedAdultRisk": "A String", # Brand Safety - **Adult content**. |
| 390 | "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**. |
| 391 | "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**. |
| 392 | "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**. |
| 393 | "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**. |
| 394 | "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**. |
| 395 | "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**. |
| 396 | "excludedViolenceRisk": "A String", # Brand Safety - **Violence**. |
| 397 | "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only). |
| 398 | "videoViewability": "A String", # Video Viewability Section (applicable to video line items only). |
| 399 | }, |
| 400 | }, |
| 401 | "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`. |
| 402 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 403 | "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`. |
| 404 | }, |
| 405 | "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| 406 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| 407 | "userRewardedContent": "A String", # Output only. User rewarded content status for video ads. |
| 408 | }, |
| 409 | "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| 410 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| 411 | "videoPlayerSize": "A String", # Output only. The video player size. |
| 412 | }, |
| 413 | "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource. |
| 414 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., "509010" for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option). |
| 415 | "viewability": "A String", # Output only. The predicted viewability percentage. |
| 416 | }, |
| 417 | }</pre> |
| 418 | </div> |
| 419 | |
| 420 | <div class="method"> |
| 421 | <code class="details" id="list">list(advertiserId, insertionOrderId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 422 | <pre>Lists the targeting options assigned to an insertion order. |
| 423 | |
| 424 | Args: |
| 425 | advertiserId: string, Required. The ID of the advertiser the insertion order belongs to. (required) |
| 426 | insertionOrderId: string, Required. The ID of the insertion order to list assigned targeting options for. (required) |
| 427 | targetingType: string, Required. Identifies the type of assigned targeting options to list. (required) |
| 428 | Allowed values |
| 429 | TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. |
| 430 | TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). |
| 431 | TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games). |
| 432 | TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds). |
| 433 | TARGETING_TYPE_URL - Target a specific url (for example, quora.com). |
| 434 | TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day. |
| 435 | TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24). |
| 436 | TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list. |
| 437 | TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list. |
| 438 | TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male). |
| 439 | TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads. |
| 440 | TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads. |
| 441 | TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent). |
| 442 | 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). |
| 443 | TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position. |
| 444 | TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV). |
| 445 | 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. |
| 446 | TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome). |
| 447 | TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%). |
| 448 | TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. |
| 449 | TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). |
| 450 | TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). |
| 451 | TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). |
| 452 | TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). |
| 453 | TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). |
| 454 | TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). |
| 455 | TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung). |
| 456 | TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever). |
| 457 | TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list. |
| 458 | TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable). |
| 459 | TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment). |
| 460 | TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages. |
| 461 | TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese). |
| 462 | TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. |
| 463 | TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state). |
| 464 | TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages. |
| 465 | TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges. |
| 466 | TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 467 | TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 468 | filter: string, Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. |
| 469 | orderBy: string, Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (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: `assignedTargetingOptionId desc`. |
| 470 | 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. |
| 471 | 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 `ListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned. |
| 472 | x__xgafv: string, V1 error format. |
| 473 | Allowed values |
| 474 | 1 - v1 error format |
| 475 | 2 - v2 error format |
| 476 | |
| 477 | Returns: |
| 478 | An object of the form: |
| 479 | |
| 480 | { # Response message for ListInsertionOrderAssignedTargetingOptions. |
| 481 | "assignedTargetingOptions": [ # The list of assigned targeting options. This list will be absent if empty. |
| 482 | { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. |
| 483 | "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`. |
| 484 | "ageRange": "A String", # Output only. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age. |
| 485 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AGE_RANGE`. |
| 486 | }, |
| 487 | "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`. |
| 488 | "displayName": "A String", # Output only. The display name of the app category. |
| 489 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 490 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. |
| 491 | }, |
| 492 | "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`. |
| 493 | "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 494 | "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 495 | "displayName": "A String", # Output only. The display name of the app. |
| 496 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 497 | }, |
| 498 | "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. |
| 499 | "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is UNION'ed with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. |
| 500 | "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. Its COMPLEMENT is used to UNION other audience groups. |
| 501 | "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. |
| 502 | { # Details of first and third party audience targeting setting. |
| 503 | "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. |
| 504 | "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. |
| 505 | }, |
| 506 | ], |
| 507 | }, |
| 508 | "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. It's COMPLEMENT is used to UNION other audience groups. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. |
| 509 | "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. |
| 510 | { # Details of Google audience targeting setting. |
| 511 | "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. |
| 512 | }, |
| 513 | ], |
| 514 | }, |
| 515 | "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only. |
| 516 | "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. |
| 517 | { # Details of combined audience targeting setting. |
| 518 | "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. |
| 519 | }, |
| 520 | ], |
| 521 | }, |
| 522 | "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only. |
| 523 | "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. |
| 524 | { # Details of custom list targeting setting. |
| 525 | "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. |
| 526 | }, |
| 527 | ], |
| 528 | }, |
| 529 | "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. |
| 530 | { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. |
| 531 | "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. |
| 532 | { # Details of first and third party audience targeting setting. |
| 533 | "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. |
| 534 | "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. |
| 535 | }, |
| 536 | ], |
| 537 | }, |
| 538 | ], |
| 539 | "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only. |
| 540 | "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. |
| 541 | { # Details of Google audience targeting setting. |
| 542 | "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. |
| 543 | }, |
| 544 | ], |
| 545 | }, |
| 546 | }, |
| 547 | "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default. |
| 548 | "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target. |
| 549 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. |
| 550 | }, |
| 551 | "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`. |
| 552 | "displayName": "A String", # Output only. The display name of the browser. |
| 553 | "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field. |
| 554 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`. |
| 555 | }, |
| 556 | "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. |
| 557 | "displayName": "A String", # Output only. The display name of the carrier or ISP. |
| 558 | "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field. |
| 559 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. |
| 560 | }, |
| 561 | "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence. |
| 562 | "displayName": "A String", # Output only. The display name of the category. |
| 563 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 564 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`. |
| 565 | }, |
| 566 | "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`. |
| 567 | "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource. |
| 568 | "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true. |
| 569 | }, |
| 570 | "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| 571 | "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`. |
| 572 | "contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads. |
| 573 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| 574 | }, |
| 575 | "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| 576 | "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. |
| 577 | "contentOutstreamPosition": "A String", # Output only. The content outstream position. |
| 578 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| 579 | }, |
| 580 | "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`. |
| 581 | "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. |
| 582 | "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). |
| 583 | "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). |
| 584 | "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. |
| 585 | }, |
| 586 | "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| 587 | "displayName": "A String", # Output only. The display name of the device make and model. |
| 588 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 589 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| 590 | }, |
| 591 | "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. |
| 592 | "deviceType": "A String", # Output only. The display name of the device type. |
| 593 | "targetingOptionId": "A String", # Required. ID of the device type. |
| 594 | }, |
| 595 | "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. |
| 596 | "contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier. |
| 597 | "excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED. |
| 598 | }, |
| 599 | "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. |
| 600 | "environment": "A String", # Output only. The serving environment. |
| 601 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., "508010" for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option). |
| 602 | }, |
| 603 | "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`. |
| 604 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_EXCHANGE`. |
| 605 | }, |
| 606 | "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`. |
| 607 | "gender": "A String", # Output only. The gender of the audience. |
| 608 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GENDER`. |
| 609 | }, |
| 610 | "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`. |
| 611 | "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
| 612 | "geoRegionType": "A String", # Output only. The type of geographic region targeting. |
| 613 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 614 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`. |
| 615 | }, |
| 616 | "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| 617 | "householdIncome": "A String", # Output only. The household income of the audience. |
| 618 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| 619 | }, |
| 620 | "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option. |
| 621 | "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. |
| 622 | "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. |
| 623 | }, |
| 624 | "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. |
| 625 | "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. |
| 626 | }, |
| 627 | "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. |
| 628 | "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. |
| 629 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 630 | }, |
| 631 | "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`. |
| 632 | "displayName": "A String", # Output only. The display name of the language (e.g., "French"). |
| 633 | "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field. |
| 634 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`. |
| 635 | }, |
| 636 | "name": "A String", # Output only. The resource name for this assigned targeting option. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 637 | "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. |
| 638 | "contentPosition": "A String", # Output only. The content position. |
| 639 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. |
| 640 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 641 | "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource. |
| 642 | "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. |
| 643 | }, |
| 644 | "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| 645 | "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. |
| 646 | "onScreenPosition": "A String", # Output only. The on screen position. |
| 647 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| 648 | }, |
| 649 | "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. |
| 650 | "displayName": "A String", # Output only. The display name of the operating system. |
| 651 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 652 | "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. |
| 653 | }, |
| 654 | "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. |
| 655 | "parentalStatus": "A String", # Output only. The parental status of the audience. |
| 656 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`. |
| 657 | }, |
| 658 | "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. |
| 659 | "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`. |
| 660 | "proximityRadiusRange": "A String", # Required. Radius range for proximity location list. This represents the size of the area around a chosen location that will be targeted. `All` proximity location targeting under a single resource must have the same radius range value. Set this value to match any existing targeting. If updated, this field will change the radius range for all proximity targeting under the resource. |
| 661 | }, |
| 662 | "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. |
| 663 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 664 | "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. |
| 665 | }, |
| 666 | "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. |
| 667 | "excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED. |
| 668 | "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier. |
| 669 | }, |
| 670 | "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. |
| 671 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. |
| 672 | }, |
| 673 | "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option. |
| 674 | "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. |
| 675 | "adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox. |
| 676 | "excludedAdlooxCategories": [ # Adloox's brand safety settings. |
| 677 | "A String", |
| 678 | ], |
| 679 | }, |
| 680 | "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify. |
| 681 | "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings. |
| 682 | "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings. |
| 683 | "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings. |
| 684 | }, |
| 685 | "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating. |
| 686 | "A String", |
| 687 | ], |
| 688 | "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls. |
| 689 | "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable. |
| 690 | "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories. |
| 691 | "A String", |
| 692 | ], |
| 693 | "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories. |
| 694 | "A String", |
| 695 | ], |
| 696 | }, |
| 697 | "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic |
| 698 | "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only). |
| 699 | "iab": "A String", # Target web and app inventory to maximize IAB viewable rate. |
| 700 | "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration. |
| 701 | }, |
| 702 | "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates. |
| 703 | "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats. |
| 704 | "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT. |
| 705 | }, |
| 706 | "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only). |
| 707 | "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size. |
| 708 | "videoIab": "A String", # Target web inventory to maximize IAB viewable rate. |
| 709 | "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate. |
| 710 | }, |
| 711 | }, |
| 712 | "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. |
| 713 | "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. |
| 714 | "A String", |
| 715 | ], |
| 716 | "displayViewability": "A String", # Display Viewability section (applicable to display line items only). |
| 717 | "excludeUnrateable": True or False, # Brand Safety - **Unrateable**. |
| 718 | "excludedAdFraudRisk": "A String", # Ad Fraud settings. |
| 719 | "excludedAdultRisk": "A String", # Brand Safety - **Adult content**. |
| 720 | "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**. |
| 721 | "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**. |
| 722 | "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**. |
| 723 | "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**. |
| 724 | "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**. |
| 725 | "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**. |
| 726 | "excludedViolenceRisk": "A String", # Brand Safety - **Violence**. |
| 727 | "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only). |
| 728 | "videoViewability": "A String", # Video Viewability Section (applicable to video line items only). |
| 729 | }, |
| 730 | }, |
| 731 | "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`. |
| 732 | "negative": True or False, # Indicates if this option is being negatively targeted. |
| 733 | "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`. |
| 734 | }, |
| 735 | "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| 736 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| 737 | "userRewardedContent": "A String", # Output only. User rewarded content status for video ads. |
| 738 | }, |
| 739 | "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| 740 | "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| 741 | "videoPlayerSize": "A String", # Output only. The video player size. |
| 742 | }, |
| 743 | "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource. |
| 744 | "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., "509010" for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option). |
| 745 | "viewability": "A String", # Output only. The predicted viewability percentage. |
| 746 | }, |
| 747 | }, |
| 748 | ], |
| 749 | "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListInsertionOrderAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. |
| 750 | }</pre> |
| 751 | </div> |
| 752 | |
| 753 | <div class="method"> |
| 754 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 755 | <pre>Retrieves the next page of results. |
| 756 | |
| 757 | Args: |
| 758 | previous_request: The request for the previous page. (required) |
| 759 | previous_response: The response from the request for the previous page. (required) |
| 760 | |
| 761 | Returns: |
| 762 | A request object that you can call 'execute()' on to request the next |
| 763 | page. Returns None if there are no more items in the collection. |
| 764 | </pre> |
| 765 | </div> |
| 766 | |
| 767 | </body></html> |