| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.targetingTypes.html">targetingTypes</a> . <a href="displayvideo_v1.advertisers.targetingTypes.assignedTargetingOptions.html">assignedTargetingOptions</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(advertiserId, targetingType, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(advertiserId, targetingType, assignedTargetingOptionId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes an assigned targeting option from an advertiser.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(advertiserId, targetingType, assignedTargetingOptionId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a single targeting option assigned to an advertiser.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(advertiserId, targetingType, pageSize=None, orderBy=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the targeting options assigned to an advertiser.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(advertiserId, targetingType, body=None, x__xgafv=None)</code> |
| <pre>Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful. |
| |
| Args: |
| advertiserId: string, Required. The ID of the advertiser. (required) |
| targetingType: string, Required. Identifies the type of this assigned targeting option. (required) |
| Allowed values |
| TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. |
| TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). |
| TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games). |
| TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds). |
| TARGETING_TYPE_URL - Target a specific url (for example, quora.com). |
| TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day. |
| TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24). |
| TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list. |
| TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list. |
| TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male). |
| TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads. |
| TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads. |
| TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent). |
| TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll). |
| TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position. |
| TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV). |
| TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time. |
| TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome). |
| TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%). |
| TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. |
| TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). |
| TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). |
| TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). |
| TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). |
| TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). |
| TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). |
| TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung). |
| TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever). |
| TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list. |
| TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable). |
| TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment). |
| TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages. |
| TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese). |
| TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. |
| TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state). |
| TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages. |
| TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges. |
| TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges. |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. |
| "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given line item and targeting type. It may be reused in other contexts. |
| "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 TargetingType 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 line item settings). Line item 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. |
| "contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier. |
| "excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED. |
| }, |
| "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option. |
| "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 TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. |
| "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a line item. |
| "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per line item. |
| "viewability": "A String", # Output only. The predicted viewability percentage. |
| "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). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a line item. No limit on number of positive keywords that can be assigned. |
| "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. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_GEO_REGION`. |
| "geoRegionType": "A String", # Output only. The type of geographic region targeting. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`. |
| "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| "userRewardedContent": "A String", # Output only. User rewarded content status for video ads. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`. |
| "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "displayName": "A String", # Output only. The display name of the operating system. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_DAY_AND_TIME`. |
| "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). |
| "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. |
| "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. |
| "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). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. |
| "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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_DEVICE_TYPE`. |
| "targetingOptionId": "A String", # Required. ID of the device type. |
| "deviceType": "A String", # Output only. The display name of the device type. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. |
| "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 line item 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 line item. |
| "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`. |
| }, |
| "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 TargetingType 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. |
| "displayName": "A String", # Output only. The display name of the category. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType 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 line item settings). Line item settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. |
| "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier. |
| "excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED. |
| }, |
| "name": "A String", # Output only. The resource name for this assigned targeting option. |
| "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 TargetingType is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per line item. |
| "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. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| { # Details of first and third party audience targeting setting. |
| "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. |
| "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. |
| }, |
| ], |
| }, |
| "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. |
| "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. |
| { # Details of custom list targeting setting. |
| "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. |
| }, |
| ], |
| }, |
| "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. |
| { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. |
| "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. |
| { # Details of first and third party audience targeting setting. |
| "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. |
| "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. |
| }, |
| ], |
| }, |
| ], |
| "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. |
| "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. |
| { # Details of combined audience targeting setting. |
| "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. |
| }, |
| ], |
| }, |
| "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. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. |
| }, |
| ], |
| }, |
| }, |
| "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 TargetingType is `TARGETING_TYPE_APP_CATEGORY`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "displayName": "A String", # Output only. The display name of the app category. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`. |
| "parentalStatus": "A String", # Output only. The parental status of the audience. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| "videoPlayerSize": "A String", # Output only. The video player size. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. |
| "adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox. |
| "excludedAdlooxCategories": [ # Adloox's brand safety settings. |
| "A String", |
| ], |
| }, |
| "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. |
| "displayViewability": "A String", # Display Viewability section (applicable to display line items only). |
| "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**. |
| "excludedViolenceRisk": "A String", # Brand Safety - **Violence**. |
| "excludedAdultRisk": "A String", # Brand Safety - **Adult content**. |
| "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**. |
| "excludedAdFraudRisk": "A String", # Ad Fraud settings. |
| "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only). |
| "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**. |
| "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**. |
| "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**. |
| "excludeUnrateable": True or False, # Brand Safety - **Unrateable**. |
| "videoViewability": "A String", # Video Viewability Section (applicable to video line items only). |
| "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**. |
| }, |
| "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify. |
| "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only). |
| "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate. |
| "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size. |
| "videoIab": "A String", # Target web inventory to maximize IAB viewable rate. |
| }, |
| "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings. |
| "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings. |
| "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings. |
| }, |
| "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating. |
| "A String", |
| ], |
| "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls. |
| "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories. |
| "A String", |
| ], |
| "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable. |
| "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories. |
| "A String", |
| ], |
| }, |
| "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates. |
| "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT. |
| "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats. |
| }, |
| "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only). |
| "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration. |
| "iab": "A String", # Target web and app inventory to maximize IAB viewable rate. |
| }, |
| }, |
| }, |
| "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 TargetingType is `TARGETING_TYPE_ENVIRONMENT`. |
| "environment": "A String", # Output only. The serving environment. |
| "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). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_BROWSER`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same line item must have the same value for this field. |
| "displayName": "A String", # Output only. The display name of the browser. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_URL`. |
| "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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`. |
| "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same line item must have the same value for this field. |
| "displayName": "A String", # Output only. The display name of the carrier or ISP. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| "displayName": "A String", # Output only. The display name of the device make and model. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CHANNEL`. |
| "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. |
| "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_GENDER`. |
| "gender": "A String", # Output only. The gender of the audience. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GENDER`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_APP`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "displayName": "A String", # Output only. The display name of the app. |
| "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`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_EXCHANGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_EXCHANGE`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| "householdIncome": "A String", # Output only. The household income of the audience. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_LANGUAGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`. |
| "displayName": "A String", # Output only. The display name of the language (e.g., "French"). |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same line item must have the same value for this field. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per line item. If a line item 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. |
| "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. |
| }, |
| "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option. |
| "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 TargetingType is `TARGETING_TYPE_AGE_RANGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AGE_RANGE`. |
| "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. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| "contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| "onScreenPosition": "A String", # Output only. The on screen position. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| "contentOutstreamPosition": "A String", # Output only. The content outstream position. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. |
| "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given line item and targeting type. It may be reused in other contexts. |
| "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 TargetingType 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 line item settings). Line item 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. |
| "contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier. |
| "excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED. |
| }, |
| "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option. |
| "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 TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. |
| "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a line item. |
| "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per line item. |
| "viewability": "A String", # Output only. The predicted viewability percentage. |
| "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). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a line item. No limit on number of positive keywords that can be assigned. |
| "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. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_GEO_REGION`. |
| "geoRegionType": "A String", # Output only. The type of geographic region targeting. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`. |
| "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| "userRewardedContent": "A String", # Output only. User rewarded content status for video ads. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`. |
| "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "displayName": "A String", # Output only. The display name of the operating system. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_DAY_AND_TIME`. |
| "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). |
| "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. |
| "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. |
| "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). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. |
| "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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_DEVICE_TYPE`. |
| "targetingOptionId": "A String", # Required. ID of the device type. |
| "deviceType": "A String", # Output only. The display name of the device type. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. |
| "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 line item 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 line item. |
| "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`. |
| }, |
| "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 TargetingType 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. |
| "displayName": "A String", # Output only. The display name of the category. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType 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 line item settings). Line item settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. |
| "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier. |
| "excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED. |
| }, |
| "name": "A String", # Output only. The resource name for this assigned targeting option. |
| "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 TargetingType is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per line item. |
| "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. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| { # Details of first and third party audience targeting setting. |
| "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. |
| "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. |
| }, |
| ], |
| }, |
| "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. |
| "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. |
| { # Details of custom list targeting setting. |
| "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. |
| }, |
| ], |
| }, |
| "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. |
| { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. |
| "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. |
| { # Details of first and third party audience targeting setting. |
| "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. |
| "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. |
| }, |
| ], |
| }, |
| ], |
| "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. |
| "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. |
| { # Details of combined audience targeting setting. |
| "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. |
| }, |
| ], |
| }, |
| "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. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. |
| }, |
| ], |
| }, |
| }, |
| "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 TargetingType is `TARGETING_TYPE_APP_CATEGORY`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "displayName": "A String", # Output only. The display name of the app category. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`. |
| "parentalStatus": "A String", # Output only. The parental status of the audience. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| "videoPlayerSize": "A String", # Output only. The video player size. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. |
| "adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox. |
| "excludedAdlooxCategories": [ # Adloox's brand safety settings. |
| "A String", |
| ], |
| }, |
| "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. |
| "displayViewability": "A String", # Display Viewability section (applicable to display line items only). |
| "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**. |
| "excludedViolenceRisk": "A String", # Brand Safety - **Violence**. |
| "excludedAdultRisk": "A String", # Brand Safety - **Adult content**. |
| "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**. |
| "excludedAdFraudRisk": "A String", # Ad Fraud settings. |
| "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only). |
| "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**. |
| "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**. |
| "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**. |
| "excludeUnrateable": True or False, # Brand Safety - **Unrateable**. |
| "videoViewability": "A String", # Video Viewability Section (applicable to video line items only). |
| "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**. |
| }, |
| "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify. |
| "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only). |
| "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate. |
| "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size. |
| "videoIab": "A String", # Target web inventory to maximize IAB viewable rate. |
| }, |
| "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings. |
| "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings. |
| "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings. |
| }, |
| "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating. |
| "A String", |
| ], |
| "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls. |
| "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories. |
| "A String", |
| ], |
| "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable. |
| "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories. |
| "A String", |
| ], |
| }, |
| "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates. |
| "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT. |
| "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats. |
| }, |
| "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only). |
| "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration. |
| "iab": "A String", # Target web and app inventory to maximize IAB viewable rate. |
| }, |
| }, |
| }, |
| "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 TargetingType is `TARGETING_TYPE_ENVIRONMENT`. |
| "environment": "A String", # Output only. The serving environment. |
| "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). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_BROWSER`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same line item must have the same value for this field. |
| "displayName": "A String", # Output only. The display name of the browser. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_URL`. |
| "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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`. |
| "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same line item must have the same value for this field. |
| "displayName": "A String", # Output only. The display name of the carrier or ISP. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| "displayName": "A String", # Output only. The display name of the device make and model. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CHANNEL`. |
| "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. |
| "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_GENDER`. |
| "gender": "A String", # Output only. The gender of the audience. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GENDER`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_APP`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "displayName": "A String", # Output only. The display name of the app. |
| "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`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_EXCHANGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_EXCHANGE`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| "householdIncome": "A String", # Output only. The household income of the audience. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_LANGUAGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`. |
| "displayName": "A String", # Output only. The display name of the language (e.g., "French"). |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same line item must have the same value for this field. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per line item. If a line item 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. |
| "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. |
| }, |
| "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option. |
| "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 TargetingType is `TARGETING_TYPE_AGE_RANGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AGE_RANGE`. |
| "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. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| "contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| "onScreenPosition": "A String", # Output only. The on screen position. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| "contentOutstreamPosition": "A String", # Output only. The content outstream position. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(advertiserId, targetingType, assignedTargetingOptionId, x__xgafv=None)</code> |
| <pre>Deletes an assigned targeting option from an advertiser. |
| |
| Args: |
| advertiserId: string, Required. The ID of the advertiser. (required) |
| targetingType: string, Required. Identifies the type of this assigned targeting option. (required) |
| Allowed values |
| TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. |
| TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). |
| TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games). |
| TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds). |
| TARGETING_TYPE_URL - Target a specific url (for example, quora.com). |
| TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day. |
| TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24). |
| TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list. |
| TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list. |
| TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male). |
| TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads. |
| TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads. |
| TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent). |
| TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll). |
| TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position. |
| TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV). |
| TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time. |
| TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome). |
| TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%). |
| TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. |
| TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). |
| TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). |
| TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). |
| TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). |
| TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). |
| TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). |
| TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung). |
| TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever). |
| TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list. |
| TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable). |
| TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment). |
| TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages. |
| TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese). |
| TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. |
| TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state). |
| TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages. |
| TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges. |
| TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges. |
| assignedTargetingOptionId: string, Required. The ID of the assigned targeting option to delete. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(advertiserId, targetingType, assignedTargetingOptionId, x__xgafv=None)</code> |
| <pre>Gets a single targeting option assigned to an advertiser. |
| |
| Args: |
| advertiserId: string, Required. The ID of the advertiser. (required) |
| targetingType: string, Required. Identifies the type of this assigned targeting option. (required) |
| Allowed values |
| TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. |
| TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). |
| TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games). |
| TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds). |
| TARGETING_TYPE_URL - Target a specific url (for example, quora.com). |
| TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day. |
| TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24). |
| TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list. |
| TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list. |
| TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male). |
| TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads. |
| TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads. |
| TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent). |
| TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll). |
| TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position. |
| TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV). |
| TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time. |
| TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome). |
| TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%). |
| TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. |
| TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). |
| TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). |
| TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). |
| TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). |
| TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). |
| TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). |
| TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung). |
| TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever). |
| TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list. |
| TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable). |
| TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment). |
| TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages. |
| TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese). |
| TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. |
| TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state). |
| TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages. |
| TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges. |
| TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges. |
| assignedTargetingOptionId: string, Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. |
| "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given line item and targeting type. It may be reused in other contexts. |
| "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 TargetingType 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 line item settings). Line item 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. |
| "contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier. |
| "excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED. |
| }, |
| "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option. |
| "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 TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. |
| "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a line item. |
| "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per line item. |
| "viewability": "A String", # Output only. The predicted viewability percentage. |
| "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). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a line item. No limit on number of positive keywords that can be assigned. |
| "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. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_GEO_REGION`. |
| "geoRegionType": "A String", # Output only. The type of geographic region targeting. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`. |
| "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| "userRewardedContent": "A String", # Output only. User rewarded content status for video ads. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`. |
| "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "displayName": "A String", # Output only. The display name of the operating system. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_DAY_AND_TIME`. |
| "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). |
| "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. |
| "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. |
| "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). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. |
| "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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_DEVICE_TYPE`. |
| "targetingOptionId": "A String", # Required. ID of the device type. |
| "deviceType": "A String", # Output only. The display name of the device type. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. |
| "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 line item 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 line item. |
| "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`. |
| }, |
| "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 TargetingType 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. |
| "displayName": "A String", # Output only. The display name of the category. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType 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 line item settings). Line item settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. |
| "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier. |
| "excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED. |
| }, |
| "name": "A String", # Output only. The resource name for this assigned targeting option. |
| "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 TargetingType is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per line item. |
| "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. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| { # Details of first and third party audience targeting setting. |
| "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. |
| "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. |
| }, |
| ], |
| }, |
| "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. |
| "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. |
| { # Details of custom list targeting setting. |
| "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. |
| }, |
| ], |
| }, |
| "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. |
| { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. |
| "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. |
| { # Details of first and third party audience targeting setting. |
| "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. |
| "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. |
| }, |
| ], |
| }, |
| ], |
| "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. |
| "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. |
| { # Details of combined audience targeting setting. |
| "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. |
| }, |
| ], |
| }, |
| "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. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. |
| }, |
| ], |
| }, |
| }, |
| "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 TargetingType is `TARGETING_TYPE_APP_CATEGORY`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "displayName": "A String", # Output only. The display name of the app category. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`. |
| "parentalStatus": "A String", # Output only. The parental status of the audience. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| "videoPlayerSize": "A String", # Output only. The video player size. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. |
| "adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox. |
| "excludedAdlooxCategories": [ # Adloox's brand safety settings. |
| "A String", |
| ], |
| }, |
| "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. |
| "displayViewability": "A String", # Display Viewability section (applicable to display line items only). |
| "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**. |
| "excludedViolenceRisk": "A String", # Brand Safety - **Violence**. |
| "excludedAdultRisk": "A String", # Brand Safety - **Adult content**. |
| "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**. |
| "excludedAdFraudRisk": "A String", # Ad Fraud settings. |
| "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only). |
| "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**. |
| "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**. |
| "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**. |
| "excludeUnrateable": True or False, # Brand Safety - **Unrateable**. |
| "videoViewability": "A String", # Video Viewability Section (applicable to video line items only). |
| "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**. |
| }, |
| "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify. |
| "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only). |
| "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate. |
| "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size. |
| "videoIab": "A String", # Target web inventory to maximize IAB viewable rate. |
| }, |
| "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings. |
| "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings. |
| "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings. |
| }, |
| "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating. |
| "A String", |
| ], |
| "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls. |
| "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories. |
| "A String", |
| ], |
| "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable. |
| "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories. |
| "A String", |
| ], |
| }, |
| "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates. |
| "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT. |
| "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats. |
| }, |
| "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only). |
| "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration. |
| "iab": "A String", # Target web and app inventory to maximize IAB viewable rate. |
| }, |
| }, |
| }, |
| "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 TargetingType is `TARGETING_TYPE_ENVIRONMENT`. |
| "environment": "A String", # Output only. The serving environment. |
| "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). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_BROWSER`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same line item must have the same value for this field. |
| "displayName": "A String", # Output only. The display name of the browser. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_URL`. |
| "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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`. |
| "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same line item must have the same value for this field. |
| "displayName": "A String", # Output only. The display name of the carrier or ISP. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| "displayName": "A String", # Output only. The display name of the device make and model. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CHANNEL`. |
| "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. |
| "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_GENDER`. |
| "gender": "A String", # Output only. The gender of the audience. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GENDER`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_APP`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "displayName": "A String", # Output only. The display name of the app. |
| "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`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_EXCHANGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_EXCHANGE`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| "householdIncome": "A String", # Output only. The household income of the audience. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_LANGUAGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`. |
| "displayName": "A String", # Output only. The display name of the language (e.g., "French"). |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same line item must have the same value for this field. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per line item. If a line item 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. |
| "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. |
| }, |
| "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option. |
| "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 TargetingType is `TARGETING_TYPE_AGE_RANGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AGE_RANGE`. |
| "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. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| "contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| "onScreenPosition": "A String", # Output only. The on screen position. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| "contentOutstreamPosition": "A String", # Output only. The content outstream position. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(advertiserId, targetingType, pageSize=None, orderBy=None, filter=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists the targeting options assigned to an advertiser. |
| |
| Args: |
| advertiserId: string, Required. The ID of the advertiser. (required) |
| targetingType: string, Required. Identifies the type of assigned targeting options to list. (required) |
| Allowed values |
| TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. |
| TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). |
| TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games). |
| TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds). |
| TARGETING_TYPE_URL - Target a specific url (for example, quora.com). |
| TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day. |
| TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24). |
| TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list. |
| TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list. |
| TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male). |
| TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads. |
| TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads. |
| TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent). |
| TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll). |
| TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position. |
| TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV). |
| TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time. |
| TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome). |
| TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%). |
| TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. |
| TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). |
| TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). |
| TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). |
| TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). |
| TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). |
| TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). |
| TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung). |
| TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever). |
| TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list. |
| TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable). |
| TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment). |
| TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages. |
| TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese). |
| TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. |
| TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state). |
| TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages. |
| TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges. |
| TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges. |
| 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. |
| 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`. |
| 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` Examples: * AssignedTargetingOption with ID 123456 `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. |
| 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 `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for ListAdvertiserAssignedTargetingOptions. |
| "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. |
| "assignedTargetingOptions": [ # The list of assigned targeting options. This list will be absent if empty. |
| { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. |
| "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given line item and targeting type. It may be reused in other contexts. |
| "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 TargetingType 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 line item settings). Line item 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. |
| "contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier. |
| "excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED. |
| }, |
| "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option. |
| "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 TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. |
| "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a line item. |
| "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per line item. |
| "viewability": "A String", # Output only. The predicted viewability percentage. |
| "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). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a line item. No limit on number of positive keywords that can be assigned. |
| "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. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_GEO_REGION`. |
| "geoRegionType": "A String", # Output only. The type of geographic region targeting. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`. |
| "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| "userRewardedContent": "A String", # Output only. User rewarded content status for video ads. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`. |
| "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "displayName": "A String", # Output only. The display name of the operating system. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_DAY_AND_TIME`. |
| "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). |
| "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. |
| "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. |
| "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). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. |
| "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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_DEVICE_TYPE`. |
| "targetingOptionId": "A String", # Required. ID of the device type. |
| "deviceType": "A String", # Output only. The display name of the device type. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. |
| "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 line item 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 line item. |
| "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`. |
| }, |
| "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 TargetingType 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. |
| "displayName": "A String", # Output only. The display name of the category. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType 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 line item settings). Line item settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. |
| "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier. |
| "excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED. |
| }, |
| "name": "A String", # Output only. The resource name for this assigned targeting option. |
| "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 TargetingType is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per line item. |
| "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. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| { # Details of first and third party audience targeting setting. |
| "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. |
| "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. |
| }, |
| ], |
| }, |
| "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. |
| "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. |
| { # Details of custom list targeting setting. |
| "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id. |
| }, |
| ], |
| }, |
| "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. |
| { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. |
| "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. |
| { # Details of first and third party audience targeting setting. |
| "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. |
| "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. |
| }, |
| ], |
| }, |
| ], |
| "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. |
| "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. |
| { # Details of combined audience targeting setting. |
| "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. |
| }, |
| ], |
| }, |
| "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. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. |
| }, |
| ], |
| }, |
| }, |
| "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 TargetingType is `TARGETING_TYPE_APP_CATEGORY`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "displayName": "A String", # Output only. The display name of the app category. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`. |
| "parentalStatus": "A String", # Output only. The parental status of the audience. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| "videoPlayerSize": "A String", # Output only. The video player size. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. |
| "adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox. |
| "excludedAdlooxCategories": [ # Adloox's brand safety settings. |
| "A String", |
| ], |
| }, |
| "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. |
| "displayViewability": "A String", # Display Viewability section (applicable to display line items only). |
| "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**. |
| "excludedViolenceRisk": "A String", # Brand Safety - **Violence**. |
| "excludedAdultRisk": "A String", # Brand Safety - **Adult content**. |
| "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**. |
| "excludedAdFraudRisk": "A String", # Ad Fraud settings. |
| "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only). |
| "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**. |
| "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**. |
| "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**. |
| "excludeUnrateable": True or False, # Brand Safety - **Unrateable**. |
| "videoViewability": "A String", # Video Viewability Section (applicable to video line items only). |
| "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**. |
| }, |
| "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify. |
| "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only). |
| "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate. |
| "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size. |
| "videoIab": "A String", # Target web inventory to maximize IAB viewable rate. |
| }, |
| "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings. |
| "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings. |
| "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings. |
| }, |
| "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating. |
| "A String", |
| ], |
| "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls. |
| "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories. |
| "A String", |
| ], |
| "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable. |
| "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories. |
| "A String", |
| ], |
| }, |
| "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates. |
| "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT. |
| "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats. |
| }, |
| "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only). |
| "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration. |
| "iab": "A String", # Target web and app inventory to maximize IAB viewable rate. |
| }, |
| }, |
| }, |
| "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 TargetingType is `TARGETING_TYPE_ENVIRONMENT`. |
| "environment": "A String", # Output only. The serving environment. |
| "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). |
| }, |
| "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 TargetingType is `TARGETING_TYPE_BROWSER`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same line item must have the same value for this field. |
| "displayName": "A String", # Output only. The display name of the browser. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_URL`. |
| "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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`. |
| "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same line item must have the same value for this field. |
| "displayName": "A String", # Output only. The display name of the carrier or ISP. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| "displayName": "A String", # Output only. The display name of the device make and model. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CHANNEL`. |
| "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. |
| "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_GENDER`. |
| "gender": "A String", # Output only. The gender of the audience. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GENDER`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_APP`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "displayName": "A String", # Output only. The display name of the app. |
| "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`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_EXCHANGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_EXCHANGE`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| "householdIncome": "A String", # Output only. The household income of the audience. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_LANGUAGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`. |
| "displayName": "A String", # Output only. The display name of the language (e.g., "French"). |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same line item must have the same value for this field. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per line item. If a line item 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. |
| "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. |
| }, |
| "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option. |
| "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 TargetingType is `TARGETING_TYPE_AGE_RANGE`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AGE_RANGE`. |
| "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. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| "contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| "onScreenPosition": "A String", # Output only. The on screen position. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| }, |
| "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 TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| "contentOutstreamPosition": "A String", # Output only. The content outstream position. |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
