google_api_ad_exchange_buyer v0.7.0 GoogleApi.AdExchangeBuyer.V14.Api.Creatives View Source

API calls for all endpoints tagged Creatives.

Link to this section Summary

Link to this section Functions

Link to this function

adexchangebuyer_creatives_add_deal(connection, account_id, buyer_creative_id, deal_id, optional_params \\ [], opts \\ []) View Source

Add a deal id association for the creative.

Parameters

  • connection (GoogleApi.AdExchangeBuyer.V14.Connection): Connection to server
  • account_id (integer()): The id for the account that will serve this creative.
  • buyer_creative_id (String.t): The buyer-specific id for this creative.
  • deal_id (String.t): The id of the deal id to associate with this creative.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

adexchangebuyer_creatives_get(connection, account_id, buyer_creative_id, optional_params \\ [], opts \\ []) View Source

Gets the status for a single creative. A creative will be available 30-40 minutes after submission.

Parameters

  • connection (GoogleApi.AdExchangeBuyer.V14.Connection): Connection to server
  • account_id (integer()): The id for the account that will serve this creative.
  • buyer_creative_id (String.t): The buyer-specific id for this creative.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %GoogleApi.AdExchangeBuyer.V14.Model.Creative{}} on success {:error, info} on failure

Link to this function

adexchangebuyer_creatives_insert(connection, optional_params \\ [], opts \\ []) View Source

Submit a new creative.

Parameters

  • connection (GoogleApi.AdExchangeBuyer.V14.Connection): Connection to server
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (Creative):

Returns

{:ok, %GoogleApi.AdExchangeBuyer.V14.Model.Creative{}} on success {:error, info} on failure

Link to this function

adexchangebuyer_creatives_list(connection, optional_params \\ [], opts \\ []) View Source

Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.

Parameters

  • connection (GoogleApi.AdExchangeBuyer.V14.Connection): Connection to server
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :accountId ([integer()]): When specified, only creatives for the given account ids are returned.
    • :buyerCreativeId ([String.t]): When specified, only creatives for the given buyer creative ids are returned.
    • :dealsStatusFilter (String.t): When specified, only creatives having the given deals status are returned.
    • :maxResults (integer()): Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
    • :openAuctionStatusFilter (String.t): When specified, only creatives having the given open auction status are returned.
    • :pageToken (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.

Returns

{:ok, %GoogleApi.AdExchangeBuyer.V14.Model.CreativesList{}} on success {:error, info} on failure

Link to this function

adexchangebuyer_creatives_list_deals(connection, account_id, buyer_creative_id, optional_params \\ [], opts \\ []) View Source

Lists the external deal ids associated with the creative.

Parameters

  • connection (GoogleApi.AdExchangeBuyer.V14.Connection): Connection to server
  • account_id (integer()): The id for the account that will serve this creative.
  • buyer_creative_id (String.t): The buyer-specific id for this creative.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %GoogleApi.AdExchangeBuyer.V14.Model.CreativeDealIds{}} on success {:error, info} on failure

Link to this function

adexchangebuyer_creatives_remove_deal(connection, account_id, buyer_creative_id, deal_id, optional_params \\ [], opts \\ []) View Source

Remove a deal id associated with the creative.

Parameters

  • connection (GoogleApi.AdExchangeBuyer.V14.Connection): Connection to server
  • account_id (integer()): The id for the account that will serve this creative.
  • buyer_creative_id (String.t): The buyer-specific id for this creative.
  • deal_id (String.t): The id of the deal id to disassociate with this creative.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure