google_api_display_video v0.4.1 GoogleApi.DisplayVideo.V1.Api.InventorySourceGroups View Source
API calls for all endpoints tagged InventorySourceGroups
.
Link to this section Summary
Functions
Gets an inventory source group.
Lists inventory source groups that are accessible to the current user.
Link to this section Functions
displayvideo_inventory_source_groups_get(connection, inventory_source_group_id, optional_params \\ [], opts \\ [])
View SourceSpecs
displayvideo_inventory_source_groups_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.InventorySourceGroup.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets an inventory source group.
Parameters
connection
(type:GoogleApi.DisplayVideo.V1.Connection.t
) - Connection to serverinventory_source_group_id
(type:String.t
) - Required. The ID of the inventory source group 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 has access to the inventory source group.If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
:partnerId
(type:String.t
) - The ID of the partner that has access to the inventory source group.A partner cannot access an advertiser-owned inventory source group.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DisplayVideo.V1.Model.InventorySourceGroup{}}
on success{:error, info}
on failure
displayvideo_inventory_source_groups_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
displayvideo_inventory_source_groups_list( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.ListInventorySourceGroupsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists inventory source groups that are accessible to the current user.
The order is defined by the order_by parameter.
Parameters
connection
(type:GoogleApi.DisplayVideo.V1.Connection.t
) - Connection to serveroptional_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 group.If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
:filter
(type:String.t
) - Allows filtering by inventory source group properties.Supported syntax:
- Filter expressions are made up of one or more restrictions.
- Restrictions can be combined by the logical operator
OR
. - A restriction has the form of
{field} {operator} {value}
. - The operator must be
EQUALS (=)
. Supported fields:
inventorySourceGroupId
The length of this field should be no more than 500 characters.
:orderBy
(type:String.t
) - Field by which to sort the list. Acceptable values are:displayName
(default)inventorySourceGroupId
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
and100
. 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 group.A partner cannot access advertiser-owned inventory source groups.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DisplayVideo.V1.Model.ListInventorySourceGroupsResponse{}}
on success{:error, info}
on failure