GoogleApi.DisplayVideo.V1.Api.Advertisers.displayvideo_advertisers_list
You're seeing just the function
displayvideo_advertisers_list
, go back to GoogleApi.DisplayVideo.V1.Api.Advertisers module for more information.
Link to this function
displayvideo_advertisers_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
displayvideo_advertisers_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.DisplayVideo.V1.Model.ListAdvertisersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.
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"). -
:filter
(type:String.t
) - Allows filtering by advertiser properties. 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}
. The operator used onupdateTime
must beGREATER THAN OR EQUAL TO (>=)
orLESS THAN OR EQUAL TO (<=)
. The operator must beEQUALS (=)
. Supported fields: -advertiserId
-displayName
-entityStatus
-updateTime
(input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: All active advertisers under a partner:entityStatus="ENTITY_STATUS_ACTIVE"
All advertisers with an update time less than or equal to2020-11-04T18:54:47Z (format of ISO 8601)
:updateTime<="2020-11-04T18:54:47Z"
* All advertisers with an update time greater than or equal to2020-11-04T18:54:47Z (format of ISO 8601)
:updateTime>="2020-11-04T18:54:47Z"
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)entityStatus
*updateTime
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 toListAdvertisers
method. If not specified, the first page of results will be returned. -
:partnerId
(type:String.t
) - Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.ListAdvertisersResponse{}}
on success -
{:error, info}
on failure