GoogleApi.DisplayVideo.V1.Api.TargetingTypes (google_api_display_video v0.39.0)

API calls for all endpoints tagged TargetingTypes.

Summary

Functions

displayvideo_targeting_types_targeting_options_get(connection, targeting_type, targeting_option_id, optional_params \\ [], opts \\ [])

Gets a single targeting option.

displayvideo_targeting_types_targeting_options_list(connection, targeting_type, optional_params \\ [], opts \\ [])

Lists targeting options of a given type.

displayvideo_targeting_types_targeting_options_search(connection, targeting_type, optional_params \\ [], opts \\ [])

Searches for targeting options of a given type based on the given search terms.

Functions

displayvideo_targeting_types_targeting_options_get(connection, targeting_type, targeting_option_id, optional_params \\ [], opts \\ [])

@spec displayvideo_targeting_types_targeting_options_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.TargetingOption.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a single targeting option.

Parameters

connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
targeting_type (type: String.t) - Required. The type of targeting option to retrieve. Accepted values are: TARGETING_TYPE_APP_CATEGORY TARGETING_TYPE_AGE_RANGE TARGETING_TYPE_GENDER TARGETING_TYPE_VIDEO_PLAYER_SIZE TARGETING_TYPE_USER_REWARDED_CONTENT TARGETING_TYPE_PARENTAL_STATUS TARGETING_TYPE_CONTENT_INSTREAM_POSITION TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION TARGETING_TYPE_DEVICE_TYPE TARGETING_TYPE_BROWSER TARGETING_TYPE_HOUSEHOLD_INCOME TARGETING_TYPE_ON_SCREEN_POSITION TARGETING_TYPE_CARRIER_AND_ISP TARGETING_TYPE_OPERATING_SYSTEM TARGETING_TYPE_DEVICE_MAKE_MODEL TARGETING_TYPE_ENVIRONMENT TARGETING_TYPE_CATEGORY TARGETING_TYPE_VIEWABILITY TARGETING_TYPE_AUTHORIZED_SELLER_STATUS TARGETING_TYPE_LANGUAGE TARGETING_TYPE_GEO_REGION TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION TARGETING_TYPE_EXCHANGE TARGETING_TYPE_SUB_EXCHANGE TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_OMID
targeting_option_id (type: String.t) - Required. The ID of the of targeting option to retrieve.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :advertiserId (type: String.t) - Required. The Advertiser this request is being made in the context of.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DisplayVideo.V1.Model.TargetingOption{}} on success
{:error, info} on failure

displayvideo_targeting_types_targeting_options_list(connection, targeting_type, optional_params \\ [], opts \\ [])

@spec displayvideo_targeting_types_targeting_options_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListTargetingOptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists targeting options of a given type.

Parameters

connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
targeting_type (type: String.t) - Required. The type of targeting option to be listed. Accepted values are: TARGETING_TYPE_APP_CATEGORY TARGETING_TYPE_AGE_RANGE TARGETING_TYPE_GENDER TARGETING_TYPE_VIDEO_PLAYER_SIZE TARGETING_TYPE_USER_REWARDED_CONTENT TARGETING_TYPE_PARENTAL_STATUS TARGETING_TYPE_CONTENT_INSTREAM_POSITION TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION TARGETING_TYPE_DEVICE_TYPE TARGETING_TYPE_BROWSER TARGETING_TYPE_HOUSEHOLD_INCOME TARGETING_TYPE_ON_SCREEN_POSITION TARGETING_TYPE_CARRIER_AND_ISP TARGETING_TYPE_OPERATING_SYSTEM TARGETING_TYPE_DEVICE_MAKE_MODEL TARGETING_TYPE_ENVIRONMENT TARGETING_TYPE_CATEGORY TARGETING_TYPE_VIEWABILITY TARGETING_TYPE_AUTHORIZED_SELLER_STATUS TARGETING_TYPE_LANGUAGE TARGETING_TYPE_GEO_REGION TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION TARGETING_TYPE_EXCHANGE TARGETING_TYPE_SUB_EXCHANGE TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_OMID
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :advertiserId (type: String.t) - Required. The Advertiser this request is being made in the context of.
- :filter (type: String.t) - Allows filtering by targeting option fields. Supported syntax: Filter expressions are made up of one or more restrictions. Restrictions can be combined by OR logical operators. A restriction has the form of {field} {operator} {value}. All fields must use the EQUALS (=) operator. Supported fields: carrierAndIspDetails.type geoRegionDetails.geoRegionType targetingOptionId Examples: All GEO REGION targeting options that belong to sub type GEO_REGION_TYPE_COUNTRY or GEO_REGION_TYPE_STATE: geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE" * All CARRIER AND ISP targeting options that belong to sub type CARRIER_AND_ISP_TYPE_CARRIER: carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.
- :orderBy (type: String.t) - 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.
- :pageSize (type: integer()) - Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
- :pageToken (type: String.t) - 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.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DisplayVideo.V1.Model.ListTargetingOptionsResponse{}} on success
{:error, info} on failure

displayvideo_targeting_types_targeting_options_search(connection, targeting_type, optional_params \\ [], opts \\ [])

@spec displayvideo_targeting_types_targeting_options_search(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.SearchTargetingOptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Searches for targeting options of a given type based on the given search terms.

Parameters

connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
targeting_type (type: String.t) - Required. The type of targeting options to retrieve. Accepted values are: TARGETING_TYPE_GEO_REGION TARGETING_TYPE_POI * TARGETING_TYPE_BUSINESS_CHAIN
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.DisplayVideo.V1.Model.SearchTargetingOptionsRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DisplayVideo.V1.Model.SearchTargetingOptionsResponse{}} on success
{:error, info} on failure