View Source GoogleApi.DisplayVideo.V1.Api.GuaranteedOrders (google_api_display_video v0.37.2)
API calls for all endpoints tagged GuaranteedOrders
.
Summary
Functions
Creates a new guaranteed order. Returns the newly created guaranteed order if successful.
Edits read advertisers of a guaranteed order.
Gets a guaranteed order.
Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status ENTITY_STATUS_ARCHIVED
will not be included in the results.
Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
Functions
displayvideo_guaranteed_orders_create(connection, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_guaranteed_orders_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.DisplayVideo.V1.Model.GuaranteedOrder.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new guaranteed order. Returns the newly created guaranteed order 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"). -
:advertiserId
(type:String.t
) - The ID of the advertiser that the request is being made within. -
:partnerId
(type:String.t
) - The ID of the partner that the request is being made within. -
:body
(type:GoogleApi.DisplayVideo.V1.Model.GuaranteedOrder.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.GuaranteedOrder{}}
on success -
{:error, info}
on failure
displayvideo_guaranteed_orders_edit_guaranteed_order_read_accessors(connection, guaranteed_order_id, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_guaranteed_orders_edit_guaranteed_order_read_accessors( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.EditGuaranteedOrderReadAccessorsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Edits read advertisers of a guaranteed order.
Parameters
-
connection
(type:GoogleApi.DisplayVideo.V1.Connection.t
) - Connection to server -
guaranteed_order_id
(type:String.t
) - Required. The ID of the guaranteed order to edit. The ID is of the format{exchange}-{legacy_guaranteed_order_id}
-
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.EditGuaranteedOrderReadAccessorsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.EditGuaranteedOrderReadAccessorsResponse{}}
on success -
{:error, info}
on failure
displayvideo_guaranteed_orders_get(connection, guaranteed_order_id, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_guaranteed_orders_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.GuaranteedOrder.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a guaranteed order.
Parameters
-
connection
(type:GoogleApi.DisplayVideo.V1.Connection.t
) - Connection to server -
guaranteed_order_id
(type:String.t
) - Required. The ID of the guaranteed order to fetch. The ID is of the format{exchange}-{legacy_guaranteed_order_id}
-
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 has access to the guaranteed order. -
:partnerId
(type:String.t
) - The ID of the partner that has access to the guaranteed order.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.GuaranteedOrder{}}
on success -
{:error, info}
on failure
displayvideo_guaranteed_orders_list(connection, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_guaranteed_orders_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.DisplayVideo.V1.Model.ListGuaranteedOrdersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status ENTITY_STATUS_ARCHIVED
will not be included in the results.
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 advertiser that has access to the guaranteed order. -
:filter
(type:String.t
) - Allows filtering by guaranteed order fields. Filter expressions are made up of one or more restrictions. Restrictions can be combined byAND
orOR
logical operators. A sequence of restrictions implicitly usesAND
. A restriction has the form of{field} {operator} {value}
. All fields must use theEQUALS (=)
operator. Supported fields:guaranteed_order_id
exchange
display_name
status.entityStatus
Examples: All active guaranteed orders:status.entityStatus="ENTITY_STATUS_ACTIVE"
Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges:exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"
The length of this field should be no more than 500 characters. Reference our filterLIST
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. For example,displayName desc
. -
:pageSize
(type:integer()
) - Requested page size. Must be between1
and200
. If unspecified will default to100
. -
: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 toListGuaranteedOrders
method. If not specified, the first page of results will be returned. -
:partnerId
(type:String.t
) - The ID of the partner that has access to the guaranteed order.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.ListGuaranteedOrdersResponse{}}
on success -
{:error, info}
on failure
displayvideo_guaranteed_orders_patch(connection, guaranteed_order_id, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_guaranteed_orders_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.GuaranteedOrder.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
Parameters
-
connection
(type:GoogleApi.DisplayVideo.V1.Connection.t
) - Connection to server -
guaranteed_order_id
(type:String.t
) - Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format{exchange}-{legacy_guaranteed_order_id}
. -
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 the request is being made within. -
:partnerId
(type:String.t
) - The ID of the partner that the request is being made within. -
:updateMask
(type:String.t
) - Required. The mask to control which fields to update. -
:body
(type:GoogleApi.DisplayVideo.V1.Model.GuaranteedOrder.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.GuaranteedOrder{}}
on success -
{:error, info}
on failure