Display & Video 360 API . targetingTypes . targetingOptions

Instance Methods

get(targetingType, targetingOptionId, advertiserId=None, x__xgafv=None)

Gets a single targeting option.

list(targetingType, pageToken=None, pageSize=None, advertiserId=None, orderBy=None, filter=None, x__xgafv=None)

Lists targeting options of a given type.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(targetingType, targetingOptionId, advertiserId=None, x__xgafv=None)
Gets a single targeting option.

Args:
  targetingType: string, Required. The type of targeting option to retrieve. (required)
  targetingOptionId: string, Required. The ID of the of targeting option to retrieve. (required)
  advertiserId: string, Required. The Advertiser this request is being made in the context of.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a single targeting option, which is a targetable concept in
      # DV360.
    "carrierAndIspDetails": { # Represents a targetable carrier or ISP. This will be populated in the # Carrier and ISP details.
        # carrier_and_isp_details field of
        # a TargetingOption when
        # targeting_type is
        # `TARGETING_TYPE_CARRIER_AND_ISP`.
      "type": "A String", # Output only. The type indicating if it's carrier or ISP.
      "displayName": "A String", # Output only. The display name of the carrier or ISP.
    },
    "viewabilityDetails": { # Represents a targetable viewability. This will be populated in the # Viewability resource details.
        # viewability_details field of a
        # TargetingOption when targeting_type is
        # `TARGETING_TYPE_VIEWABILITY`.
      "viewability": "A String", # Output only. The predicted viewability percentage.
    },
    "parentalStatusDetails": { # Represents a targetable parental status. This will be populated in the # Parental status details.
        # parental_status_details field of a
        # TargetingOption when targeting_type is
        # `TARGETING_TYPE_PARENTAL_STATUS`.
      "parentalStatus": "A String", # Output only. The parental status of an audience.
    },
    "targetingType": "A String", # Output only. The type of this targeting option.
    "onScreenPositionDetails": { # Represents a targetable on screen position, which could be used by display # On screen position details.
        # and video ads. This will be populated in the
        # on_screen_position_details
        # field when
        # targeting_type is
        # `TARGETING_TYPE_ON_SCREEN_POSITION`.
      "onScreenPosition": "A String", # Output only. The on screen position.
    },
    "videoPlayerSizeDetails": { # Represents a targetable video player size. This will be populated in the # Video player size details.
        # video_player_size_details
        # field when targeting_type is
        # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
      "videoPlayerSize": "A String", # Output only. The video player size.
    },
    "operatingSystemDetails": { # Represents a targetable operating system. This will be populated in the # Operating system resources details.
        # operating_system_details field
        # of a TargetingOption when
        # targeting_type is
        # `TARGETING_TYPE_OPERATING_SYSTEM`.
      "displayName": "A String", # Output only. The display name of the operating system.
    },
    "ageRangeDetails": { # Represents a targetable age range. This will be populated in the # Age range details.
        # age_range_details field when
        # targeting_type is
        # `TARGETING_TYPE_AGE_RANGE`.
      "ageRange": "A String", # Output only. The age range of an audience.
    },
    "subExchangeDetails": { # Represents a targetable sub-exchange. This will be populated in the # Sub-exchange details.
        # sub_exchange_details field
        # of a TargetingOption when
        # targeting_type is
        # `TARGETING_TYPE_SUB_EXCHANGE`.
      "displayName": "A String", # Output only. The display name of the sub-exchange.
    },
    "deviceMakeModelDetails": { # Represents a targetable device make and model. This will be populated in the # Device make and model resource details.
        # device_make_model_details
        # field of a TargetingOption when
        # targeting_type is
        # `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
      "displayName": "A String", # Output only. The display name of the device make and model.
    },
    "browserDetails": { # Represents a targetable browser. This will be populated in the # Browser details.
        # browser_details field when
        # targeting_type is
        # `TARGETING_TYPE_BROWSER`.
      "displayName": "A String", # Output only. The display name of the browser.
    },
    "appCategoryDetails": { # Represents a targetable collection of apps. A collection lets you target # App category details.
        # dynamic groups of related apps that are maintained by the platform, for
        # example `All Apps/Google Play/Games`. This will be populated in the
        # app_category_details field when
        # targeting_type is
        # `TARGETING_TYPE_APP_CATEGORY`.
      "displayName": "A String", # Output only. The name of the app collection.
    },
    "contentOutstreamPositionDetails": { # Represents a targetable content outstream position, which could be used by # Content outstream position details.
        # display and video ads. This will be populated in the
        # content_outstream_position_details
        # field when targeting_type is
        # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
      "contentOutstreamPosition": "A String", # Output only. The content outstream position.
    },
    "name": "A String", # Output only. The resource name for this targeting option.
    "genderDetails": { # Represents a targetable gender. This will be populated in the # Gender details.
        # gender_details field of a TargetingOption
        # when targeting_type is
        # `TARGETING_TYPE_GENDER`.
      "gender": "A String", # Output only. The gender of an audience.
    },
    "languageDetails": { # Represents a targetable language. This will be populated in the # Language resource details.
        # language_details field when
        # targeting_type is
        # `TARGETING_TYPE_LANGUAGE`.
      "displayName": "A String", # Output only. The display name of the language (e.g., "French").
    },
    "userRewardedContentDetails": { # Represents a targetable user rewarded content status for video ads only. This # User rewarded content details.
        # will be populated in the
        # user_rewarded_content_details
        # field when
        # targeting_type is
        # `TARGETING_TYPE_USER_REWARDED_CONTENT`.
      "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
    },
    "authorizedSellerStatusDetails": { # Represents a targetable authorized seller status. This will be populated in # Authorized seller status resource details.
        # the
        # authorized_seller_status_details
        # field when targeting_type is
        # `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
      "authorizedSellerStatus": "A String", # Output only. The authorized seller status.
    },
    "digitalContentLabelDetails": { # Represents a targetable digital content label rating tier. This will be # Digital content label details.
        # populated in the
        # digital_content_label_details
        # field of the TargetingOption when
        # targeting_type is
        # `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.
      "contentRatingTier": "A String", # Output only. An enum for the content label brand safety tiers.
    },
    "environmentDetails": { # Represents a targetable environment. This will be populated in the # Environment details.
        # environment_details field of a
        # TargetingOption when targeting_type is
        # `TARGETING_TYPE_ENVIRONMENT`.
      "environment": "A String", # Output only. The serving environment.
    },
    "geoRegionDetails": { # Represents a targetable geographic region. This will be populated in the # Geographic region resource details.
        # geo_region_details field when
        # targeting_type is
        # `TARGETING_TYPE_GEO_REGION`.
      "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
      "geoRegionType": "A String", # Output only. The type of geographic region targeting.
    },
    "deviceTypeDetails": { # Represents a targetable device type. This will be populated in the # Device type details.
        # device_type_details field of a
        # TargetingOption when targeting_type is
        # `TARGETING_TYPE_DEVICE_TYPE`.
      "deviceType": "A String", # Output only. The device type that is used to be targeted.
    },
    "exchangeDetails": { # Represents a targetable exchange. This will be populated in the # Exchange details.
        # exchange_details field
        # of a TargetingOption when
        # targeting_type is
        # `TARGETING_TYPE_EXCHANGE`.
      "exchange": "A String", # Output only. The type of exchange.
    },
    "householdIncomeDetails": { # Represents a targetable household income. This will be populated in the # Household income details.
        # household_income_details field of
        # a TargetingOption when targeting_type is
        # `TARGETING_TYPE_HOUSEHOLD_INCOME`.
      "householdIncome": "A String", # Output only. The household income of an audience.
    },
    "contentInstreamPositionDetails": { # Represents a targetable content instream position, which could be used by # Content instream position details.
        # video and audio ads. This will be populated in the
        # content_instream_position_details
        # field when targeting_type is
        # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
      "contentInstreamPosition": "A String", # Output only. The content instream position.
    },
    "categoryDetails": { # Represents a targetable category. This will be populated in the # Category resource details.
        # category_details field of a
        # TargetingOption when targeting_type is
        # `TARGETING_TYPE_CATEGORY`.
      "displayName": "A String", # Output only. The display name of the category.
    },
    "sensitiveCategoryDetails": { # Represents a targetable sensitive category. This will be # Sensitive Category details.
        # populated in the
        # sensitive_category_details
        # field of the TargetingOption when
        # targeting_type is
        # `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.
      "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier.
    },
    "targetingOptionId": "A String", # Output only. A unique identifier for this targeting option. The tuple
        # {`targeting_type`, `targeting_option_id`} will be unique.
  }
list(targetingType, pageToken=None, pageSize=None, advertiserId=None, orderBy=None, filter=None, x__xgafv=None)
Lists targeting options of a given type.

Args:
  targetingType: string, Required. The type of targeting option to be listed. (required)
  pageToken: string, A token identifying a page of results the server should return.
Typically, this is the value of
next_page_token
returned from the previous call to `ListTargetingOptions` method.
If not specified, the first page of results will be returned.
  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.
  advertiserId: string, Required. The Advertiser this request is being made in the context of.
  orderBy: string, Field by which to sort the list.
Acceptable values are:

* `targetingOptionId` (default)

The default sorting order is ascending. To specify descending order for
a field, a suffix "desc" should be added to the field name.
Example: `targetingOptionId desc`.
  filter: string, Allows filtering by targeting option properties.

Supported syntax:

* Filter expressions are made up of one or more restrictions.
* Restrictions can be combined by `OR` logical operators.
* A restriction has the form of `{field} {operator} {value}`.
* The operator must be "=" (equal sign).
* Supported fields:
    - `targetingOptionId`

The length of this field should be no more than 500 characters.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for
      # ListTargetingOptions.
    "nextPageToken": "A String", # A token to retrieve the next page of results.
        # Pass this value in the
        # page_token
        # field in the subsequent call to `ListTargetingOptions` method to retrieve
        # the next page of results.
    "targetingOptions": [ # The list of targeting options.
        #
        # This list will be absent if empty.
      { # Represents a single targeting option, which is a targetable concept in
          # DV360.
        "carrierAndIspDetails": { # Represents a targetable carrier or ISP. This will be populated in the # Carrier and ISP details.
            # carrier_and_isp_details field of
            # a TargetingOption when
            # targeting_type is
            # `TARGETING_TYPE_CARRIER_AND_ISP`.
          "type": "A String", # Output only. The type indicating if it's carrier or ISP.
          "displayName": "A String", # Output only. The display name of the carrier or ISP.
        },
        "viewabilityDetails": { # Represents a targetable viewability. This will be populated in the # Viewability resource details.
            # viewability_details field of a
            # TargetingOption when targeting_type is
            # `TARGETING_TYPE_VIEWABILITY`.
          "viewability": "A String", # Output only. The predicted viewability percentage.
        },
        "parentalStatusDetails": { # Represents a targetable parental status. This will be populated in the # Parental status details.
            # parental_status_details field of a
            # TargetingOption when targeting_type is
            # `TARGETING_TYPE_PARENTAL_STATUS`.
          "parentalStatus": "A String", # Output only. The parental status of an audience.
        },
        "targetingType": "A String", # Output only. The type of this targeting option.
        "onScreenPositionDetails": { # Represents a targetable on screen position, which could be used by display # On screen position details.
            # and video ads. This will be populated in the
            # on_screen_position_details
            # field when
            # targeting_type is
            # `TARGETING_TYPE_ON_SCREEN_POSITION`.
          "onScreenPosition": "A String", # Output only. The on screen position.
        },
        "videoPlayerSizeDetails": { # Represents a targetable video player size. This will be populated in the # Video player size details.
            # video_player_size_details
            # field when targeting_type is
            # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
          "videoPlayerSize": "A String", # Output only. The video player size.
        },
        "operatingSystemDetails": { # Represents a targetable operating system. This will be populated in the # Operating system resources details.
            # operating_system_details field
            # of a TargetingOption when
            # targeting_type is
            # `TARGETING_TYPE_OPERATING_SYSTEM`.
          "displayName": "A String", # Output only. The display name of the operating system.
        },
        "ageRangeDetails": { # Represents a targetable age range. This will be populated in the # Age range details.
            # age_range_details field when
            # targeting_type is
            # `TARGETING_TYPE_AGE_RANGE`.
          "ageRange": "A String", # Output only. The age range of an audience.
        },
        "subExchangeDetails": { # Represents a targetable sub-exchange. This will be populated in the # Sub-exchange details.
            # sub_exchange_details field
            # of a TargetingOption when
            # targeting_type is
            # `TARGETING_TYPE_SUB_EXCHANGE`.
          "displayName": "A String", # Output only. The display name of the sub-exchange.
        },
        "deviceMakeModelDetails": { # Represents a targetable device make and model. This will be populated in the # Device make and model resource details.
            # device_make_model_details
            # field of a TargetingOption when
            # targeting_type is
            # `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
          "displayName": "A String", # Output only. The display name of the device make and model.
        },
        "browserDetails": { # Represents a targetable browser. This will be populated in the # Browser details.
            # browser_details field when
            # targeting_type is
            # `TARGETING_TYPE_BROWSER`.
          "displayName": "A String", # Output only. The display name of the browser.
        },
        "appCategoryDetails": { # Represents a targetable collection of apps. A collection lets you target # App category details.
            # dynamic groups of related apps that are maintained by the platform, for
            # example `All Apps/Google Play/Games`. This will be populated in the
            # app_category_details field when
            # targeting_type is
            # `TARGETING_TYPE_APP_CATEGORY`.
          "displayName": "A String", # Output only. The name of the app collection.
        },
        "contentOutstreamPositionDetails": { # Represents a targetable content outstream position, which could be used by # Content outstream position details.
            # display and video ads. This will be populated in the
            # content_outstream_position_details
            # field when targeting_type is
            # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
          "contentOutstreamPosition": "A String", # Output only. The content outstream position.
        },
        "name": "A String", # Output only. The resource name for this targeting option.
        "genderDetails": { # Represents a targetable gender. This will be populated in the # Gender details.
            # gender_details field of a TargetingOption
            # when targeting_type is
            # `TARGETING_TYPE_GENDER`.
          "gender": "A String", # Output only. The gender of an audience.
        },
        "languageDetails": { # Represents a targetable language. This will be populated in the # Language resource details.
            # language_details field when
            # targeting_type is
            # `TARGETING_TYPE_LANGUAGE`.
          "displayName": "A String", # Output only. The display name of the language (e.g., "French").
        },
        "userRewardedContentDetails": { # Represents a targetable user rewarded content status for video ads only. This # User rewarded content details.
            # will be populated in the
            # user_rewarded_content_details
            # field when
            # targeting_type is
            # `TARGETING_TYPE_USER_REWARDED_CONTENT`.
          "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
        },
        "authorizedSellerStatusDetails": { # Represents a targetable authorized seller status. This will be populated in # Authorized seller status resource details.
            # the
            # authorized_seller_status_details
            # field when targeting_type is
            # `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
          "authorizedSellerStatus": "A String", # Output only. The authorized seller status.
        },
        "digitalContentLabelDetails": { # Represents a targetable digital content label rating tier. This will be # Digital content label details.
            # populated in the
            # digital_content_label_details
            # field of the TargetingOption when
            # targeting_type is
            # `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.
          "contentRatingTier": "A String", # Output only. An enum for the content label brand safety tiers.
        },
        "environmentDetails": { # Represents a targetable environment. This will be populated in the # Environment details.
            # environment_details field of a
            # TargetingOption when targeting_type is
            # `TARGETING_TYPE_ENVIRONMENT`.
          "environment": "A String", # Output only. The serving environment.
        },
        "geoRegionDetails": { # Represents a targetable geographic region. This will be populated in the # Geographic region resource details.
            # geo_region_details field when
            # targeting_type is
            # `TARGETING_TYPE_GEO_REGION`.
          "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
          "geoRegionType": "A String", # Output only. The type of geographic region targeting.
        },
        "deviceTypeDetails": { # Represents a targetable device type. This will be populated in the # Device type details.
            # device_type_details field of a
            # TargetingOption when targeting_type is
            # `TARGETING_TYPE_DEVICE_TYPE`.
          "deviceType": "A String", # Output only. The device type that is used to be targeted.
        },
        "exchangeDetails": { # Represents a targetable exchange. This will be populated in the # Exchange details.
            # exchange_details field
            # of a TargetingOption when
            # targeting_type is
            # `TARGETING_TYPE_EXCHANGE`.
          "exchange": "A String", # Output only. The type of exchange.
        },
        "householdIncomeDetails": { # Represents a targetable household income. This will be populated in the # Household income details.
            # household_income_details field of
            # a TargetingOption when targeting_type is
            # `TARGETING_TYPE_HOUSEHOLD_INCOME`.
          "householdIncome": "A String", # Output only. The household income of an audience.
        },
        "contentInstreamPositionDetails": { # Represents a targetable content instream position, which could be used by # Content instream position details.
            # video and audio ads. This will be populated in the
            # content_instream_position_details
            # field when targeting_type is
            # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
          "contentInstreamPosition": "A String", # Output only. The content instream position.
        },
        "categoryDetails": { # Represents a targetable category. This will be populated in the # Category resource details.
            # category_details field of a
            # TargetingOption when targeting_type is
            # `TARGETING_TYPE_CATEGORY`.
          "displayName": "A String", # Output only. The display name of the category.
        },
        "sensitiveCategoryDetails": { # Represents a targetable sensitive category. This will be # Sensitive Category details.
            # populated in the
            # sensitive_category_details
            # field of the TargetingOption when
            # targeting_type is
            # `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.
          "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier.
        },
        "targetingOptionId": "A String", # Output only. A unique identifier for this targeting option. The tuple
            # {`targeting_type`, `targeting_option_id`} will be unique.
      },
    ],
  }
list_next(previous_request, previous_response)
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.