GoogleApi.DisplayVideo.V1.Api.Advertisers.displayvideo_advertisers_creatives_list
You're seeing just the function
displayvideo_advertisers_creatives_list
, go back to GoogleApi.DisplayVideo.V1.Api.Advertisers module for more information.
Link to this function
displayvideo_advertisers_creatives_list(connection, advertiser_id, optional_params \\ [], opts \\ [])
View SourceSpecs
displayvideo_advertisers_creatives_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.ListCreativesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with ENTITY_STATUS_ARCHIVED
will not be included in the results.
Parameters
-
connection
(type:GoogleApi.DisplayVideo.V1.Connection.t
) - Connection to server -
advertiser_id
(type:String.t
) - Required. The ID of the advertiser to list creatives for. -
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 creative properties. Supported syntax: Filter expressions are made up of one or more restrictions. Restriction for the same field must be combined byOR
. Restriction for different fields must be combined byAND
. Between(
and)
there can only be restrictions combined byOR
for the same field. A restriction has the form of{field} {operator} {value}
. The operator must beEQUALS (=)
for the following fields: -entityStatus
-creativeType
. -dimensions
-minDuration
-maxDuration
-approvalStatus
-exchangeReviewStatus
-dynamic
-creativeId
The operator must beHAS (:)
for the following fields: -lineItemIds
ForentityStatus
,minDuration
,maxDuration
, anddynamic
there may be at most one restriction. Fordimensions
, the value is in the form of"{width}x{height}"
. ForexchangeReviewStatus
, the value is in the form of{exchange}-{reviewStatus}
. ForminDuration
andmaxDuration
, the value is in the form of"{duration}s"
. Only seconds are supported with millisecond granularity. There may be multiplelineItemIds
restrictions in order to search against multiple possible line item IDs. There may be multiplecreativeId
restrictions in order to search against multiple possible creative IDs. Examples: All native creatives:creativeType="CREATIVE_TYPE_NATIVE"
All active creatives with 300x400 or 50x100 dimensions:entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms.dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
All video creatives that are associated with line item ID 1 or 2:creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
Find creatives by multiple creative IDs:creativeId=1 OR creativeId=2
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:creativeId
(default)createTime
mediaDuration
dimensions
(sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example:createTime desc
. -
:pageSize
(type:integer()
) - Requested page size. Must be between1
and100
. If unspecified will default to100
. Returns error codeINVALID_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 toListCreatives
method. If not specified, the first page of results will be returned.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.ListCreativesResponse{}}
on success -
{:error, info}
on failure