View Source GoogleApi.DisplayVideo.V1.Api.InventorySources (google_api_display_video v0.35.0)
API calls for all endpoints tagged InventorySources
.
Summary
Functions
Creates a new inventory source. Returns the newly created inventory source if successful.
Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
Gets an inventory source.
Lists inventory sources 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, inventory sources with entity status ENTITY_STATUS_ARCHIVED
will not be included in the results.
Updates an existing inventory source. Returns the updated inventory source if successful.
Functions
displayvideo_inventory_sources_create(connection, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_inventory_sources_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.DisplayVideo.V1.Model.InventorySource.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new inventory source. Returns the newly created inventory source 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.InventorySource.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.InventorySource{}}
on success -
{:error, info}
on failure
displayvideo_inventory_sources_edit_inventory_source_read_write_accessors(connection, inventory_source_id, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_inventory_sources_edit_inventory_source_read_write_accessors( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.InventorySourceAccessors.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
Parameters
-
connection
(type:GoogleApi.DisplayVideo.V1.Connection.t
) - Connection to server -
inventory_source_id
(type:String.t
) - Required. The ID of inventory source to update. -
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.EditInventorySourceReadWriteAccessorsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.InventorySourceAccessors{}}
on success -
{:error, info}
on failure
displayvideo_inventory_sources_get(connection, inventory_source_id, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_inventory_sources_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.InventorySource.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets an inventory source.
Parameters
-
connection
(type:GoogleApi.DisplayVideo.V1.Connection.t
) - Connection to server -
inventory_source_id
(type:String.t
) - Required. The ID of the inventory source 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"). -
:partnerId
(type:String.t
) - Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.InventorySource{}}
on success -
{:error, info}
on failure
displayvideo_inventory_sources_list(connection, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_inventory_sources_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.DisplayVideo.V1.Model.ListInventorySourcesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists inventory sources 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, inventory sources 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 inventory source. -
:filter
(type:String.t
) - Allows filtering by inventory source fields. Supported syntax: 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:status.entityStatus
commitment
deliveryMethod
rateDetails.rateType
exchange
Examples: All active inventory sources:status.entityStatus="ENTITY_STATUS_ACTIVE"
* Inventory sources 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 toListInventorySources
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 inventory source.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.ListInventorySourcesResponse{}}
on success -
{:error, info}
on failure
displayvideo_inventory_sources_patch(connection, inventory_source_id, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_inventory_sources_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.InventorySource.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an existing inventory source. Returns the updated inventory source if successful.
Parameters
-
connection
(type:GoogleApi.DisplayVideo.V1.Connection.t
) - Connection to server -
inventory_source_id
(type:String.t
) - Output only. The unique ID of the inventory source. 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"). -
: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.InventorySource.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.InventorySource{}}
on success -
{:error, info}
on failure