GoogleApi.AdExchangeBuyer.V14.Api.Creatives (google_api_ad_exchange_buyer v0.40.0) View Source
API calls for all endpoints tagged Creatives
.
Link to this section Summary
Functions
Add a deal id association for the creative.
Gets the status for a single creative. A creative will be available 30-40 minutes after submission.
Submit a new creative.
Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
Lists the external deal ids associated with the creative.
Remove a deal id associated with the creative.
Link to this section Functions
adexchangebuyer_creatives_add_deal(connection, account_id, buyer_creative_id, deal_id, optional_params \\ [], opts \\ [])
View SourceSpecs
adexchangebuyer_creatives_add_deal( Tesla.Env.client(), integer(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Add a deal id association for the creative.
Parameters
-
connection
(type:GoogleApi.AdExchangeBuyer.V14.Connection.t
) - Connection to server -
account_id
(type:integer()
) - The id for the account that will serve this creative. -
buyer_creative_id
(type:String.t
) - The buyer-specific id for this creative. -
deal_id
(type:String.t
) - The id of the deal id to associate with this creative. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
adexchangebuyer_creatives_get(connection, account_id, buyer_creative_id, optional_params \\ [], opts \\ [])
View SourceSpecs
adexchangebuyer_creatives_get( Tesla.Env.client(), integer(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdExchangeBuyer.V14.Model.Creative.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the status for a single creative. A creative will be available 30-40 minutes after submission.
Parameters
-
connection
(type:GoogleApi.AdExchangeBuyer.V14.Connection.t
) - Connection to server -
account_id
(type:integer()
) - The id for the account that will serve this creative. -
buyer_creative_id
(type:String.t
) - The buyer-specific id for this creative. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdExchangeBuyer.V14.Model.Creative{}}
on success -
{:error, info}
on failure
adexchangebuyer_creatives_insert(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
adexchangebuyer_creatives_insert(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.AdExchangeBuyer.V14.Model.Creative.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Submit a new creative.
Parameters
-
connection
(type:GoogleApi.AdExchangeBuyer.V14.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:body
(type:GoogleApi.AdExchangeBuyer.V14.Model.Creative.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdExchangeBuyer.V14.Model.Creative{}}
on success -
{:error, info}
on failure
adexchangebuyer_creatives_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
adexchangebuyer_creatives_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.AdExchangeBuyer.V14.Model.CreativesList.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
Parameters
-
connection
(type:GoogleApi.AdExchangeBuyer.V14.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:accountId
(type:list(integer())
) - When specified, only creatives for the given account ids are returned. -
:buyerCreativeId
(type:list(String.t)
) - When specified, only creatives for the given buyer creative ids are returned. -
:dealsStatusFilter
(type:String.t
) - When specified, only creatives having the given deals status are returned. -
:maxResults
(type:integer()
) - Maximum number of entries returned on one result page. If not set, the default is 100. Optional. -
:openAuctionStatusFilter
(type:String.t
) - When specified, only creatives having the given open auction status are returned. -
:pageToken
(type:String.t
) - A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdExchangeBuyer.V14.Model.CreativesList{}}
on success -
{:error, info}
on failure
adexchangebuyer_creatives_list_deals(connection, account_id, buyer_creative_id, optional_params \\ [], opts \\ [])
View SourceSpecs
adexchangebuyer_creatives_list_deals( Tesla.Env.client(), integer(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdExchangeBuyer.V14.Model.CreativeDealIds.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the external deal ids associated with the creative.
Parameters
-
connection
(type:GoogleApi.AdExchangeBuyer.V14.Connection.t
) - Connection to server -
account_id
(type:integer()
) - The id for the account that will serve this creative. -
buyer_creative_id
(type:String.t
) - The buyer-specific id for this creative. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdExchangeBuyer.V14.Model.CreativeDealIds{}}
on success -
{:error, info}
on failure
adexchangebuyer_creatives_remove_deal(connection, account_id, buyer_creative_id, deal_id, optional_params \\ [], opts \\ [])
View SourceSpecs
adexchangebuyer_creatives_remove_deal( Tesla.Env.client(), integer(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Remove a deal id associated with the creative.
Parameters
-
connection
(type:GoogleApi.AdExchangeBuyer.V14.Connection.t
) - Connection to server -
account_id
(type:integer()
) - The id for the account that will serve this creative. -
buyer_creative_id
(type:String.t
) - The buyer-specific id for this creative. -
deal_id
(type:String.t
) - The id of the deal id to disassociate with this creative. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure