View Source GoogleApi.DisplayVideo.V1.Api.CustomBiddingAlgorithms (google_api_display_video v0.35.0)

API calls for all endpoints tagged CustomBiddingAlgorithms.

Summary

Functions

displayvideo_custom_bidding_algorithms_create(connection, optional_params \\ [], opts \\ [])

Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.

displayvideo_custom_bidding_algorithms_get(connection, custom_bidding_algorithm_id, optional_params \\ [], opts \\ [])

Gets a custom bidding algorithm.

displayvideo_custom_bidding_algorithms_list(connection, optional_params \\ [], opts \\ [])

Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.

displayvideo_custom_bidding_algorithms_patch(connection, custom_bidding_algorithm_id, optional_params \\ [], opts \\ [])

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.

displayvideo_custom_bidding_algorithms_scripts_create(connection, custom_bidding_algorithm_id, optional_params \\ [], opts \\ [])

Creates a new custom bidding script. Returns the newly created script if successful.

displayvideo_custom_bidding_algorithms_scripts_get(connection, custom_bidding_algorithm_id, custom_bidding_script_id, optional_params \\ [], opts \\ [])

Gets a custom bidding script.

displayvideo_custom_bidding_algorithms_scripts_list(connection, custom_bidding_algorithm_id, optional_params \\ [], opts \\ [])

Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.

displayvideo_custom_bidding_algorithms_upload_script(connection, custom_bidding_algorithm_id, optional_params \\ [], opts \\ [])

Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.

Functions

Link to this function

displayvideo_custom_bidding_algorithms_create(connection, optional_params \\ [], opts \\ [])

View Source 
@spec displayvideo_custom_bidding_algorithms_create(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.CustomBiddingAlgorithm.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • 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.CustomBiddingAlgorithm.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.CustomBiddingAlgorithm{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_custom_bidding_algorithms_get(connection, custom_bidding_algorithm_id, optional_params \\ [], opts \\ [])

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

Gets a custom bidding algorithm.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • custom_bidding_algorithm_id (type: String.t) - Required. The ID of the custom bidding algorithm to fetch.
  • 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) - The ID of the DV360 partner that has access to the custom bidding algorithm.
    • :partnerId (type: String.t) - The ID of the DV360 partner that has access to the custom bidding algorithm.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.CustomBiddingAlgorithm{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_custom_bidding_algorithms_list(connection, optional_params \\ [], opts \\ [])

View Source 
@spec displayvideo_custom_bidding_algorithms_list(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListCustomBiddingAlgorithmsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • 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) - The ID of the DV360 advertiser that has access to the custom bidding algorithm.
    • :filter (type: String.t) - Allows filtering by custom bidding algorithm fields. Supported syntax: Filter expressions are made up of one or more restrictions. Restrictions can be combined by AND. A sequence of restrictions implicitly uses AND. A restriction has the form of {field} {operator} {value}. The customBiddingAlgorithmType field must use the EQUALS (=) operator. The displayName field must use the HAS (:) operator. Supported fields: customBiddingAlgorithmType displayName Examples: All custom bidding algorithms for which the display name contains "politics": displayName:"politics". * All custom bidding algorithms for which the type is "SCRIPT_BASED": customBiddingAlgorithmType=SCRIPT_BASED 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: * displayName (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: displayName 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 ListCustomBiddingAlgorithms method. If not specified, the first page of results will be returned.
    • :partnerId (type: String.t) - The ID of the DV360 partner that has access to the custom bidding algorithm.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.ListCustomBiddingAlgorithmsResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_custom_bidding_algorithms_patch(connection, custom_bidding_algorithm_id, optional_params \\ [], opts \\ [])

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

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • custom_bidding_algorithm_id (type: String.t) - Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
  • 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").
    • :updateMask (type: String.t) - Required. The mask to control which fields to update.
    • :body (type: GoogleApi.DisplayVideo.V1.Model.CustomBiddingAlgorithm.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.CustomBiddingAlgorithm{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_custom_bidding_algorithms_scripts_create(connection, custom_bidding_algorithm_id, optional_params \\ [], opts \\ [])

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

Creates a new custom bidding script. Returns the newly created script if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • custom_bidding_algorithm_id (type: String.t) - Required. The ID of the custom bidding algorithm that owns the script.
  • 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) - The ID of the advertiser that owns the parent custom bidding algorithm.
    • :partnerId (type: String.t) - The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
    • :body (type: GoogleApi.DisplayVideo.V1.Model.CustomBiddingScript.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.CustomBiddingScript{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_custom_bidding_algorithms_scripts_get(connection, custom_bidding_algorithm_id, custom_bidding_script_id, optional_params \\ [], opts \\ [])

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

Gets a custom bidding script.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • custom_bidding_algorithm_id (type: String.t) - Required. The ID of the custom bidding algorithm owns the script.
  • custom_bidding_script_id (type: String.t) - Required. The ID of the custom bidding script to fetch.
  • 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) - The ID of the advertiser that owns the parent custom bidding algorithm.
    • :partnerId (type: String.t) - The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.CustomBiddingScript{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_custom_bidding_algorithms_scripts_list(connection, custom_bidding_algorithm_id, optional_params \\ [], opts \\ [])

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

Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • custom_bidding_algorithm_id (type: String.t) - Required. The ID of the custom bidding algorithm owns the script.
  • 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) - The ID of the advertiser that owns the parent custom bidding algorithm.
    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are: * createTime desc (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: createTime.
    • :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 ListCustomBiddingScripts method. If not specified, the first page of results will be returned.
    • :partnerId (type: String.t) - The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.ListCustomBiddingScriptsResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_custom_bidding_algorithms_upload_script(connection, custom_bidding_algorithm_id, optional_params \\ [], opts \\ [])

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

Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • custom_bidding_algorithm_id (type: String.t) - Required. The ID of the custom bidding algorithm owns the script.
  • 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) - The ID of the advertiser that owns the parent custom bidding algorithm.
    • :partnerId (type: String.t) - The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
  • opts (type: keyword()) - Call options

Returns

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