GoogleApi.DFAReporting.V4.Api.CampaignCreativeAssociations (google_api_dfa_reporting v0.31.0)

View Source

API calls for all endpoints tagged CampaignCreativeAssociations.

Summary

Functions

Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.

Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.

Functions

dfareporting_campaign_creative_associations_insert(connection, profile_id, campaign_id, optional_params \\ [], opts \\ [])

@spec dfareporting_campaign_creative_associations_insert(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V4.Model.CampaignCreativeAssociation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.

Parameters

  • connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • campaign_id (type: String.t) - Campaign ID in this association.
  • 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").
    • :body (type: GoogleApi.DFAReporting.V4.Model.CampaignCreativeAssociation.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V4.Model.CampaignCreativeAssociation{}} on success
  • {:error, info} on failure

dfareporting_campaign_creative_associations_list(connection, profile_id, campaign_id, optional_params \\ [], opts \\ [])

@spec dfareporting_campaign_creative_associations_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DFAReporting.V4.Model.CampaignCreativeAssociationsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.

Parameters

  • connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • campaign_id (type: String.t) - Campaign ID in this association.
  • 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").
    • :maxResults (type: integer()) - Maximum number of results to return.
    • :pageToken (type: String.t) - Value of the nextPageToken from the previous result page.
    • :sortOrder (type: String.t) - Order of sorted results.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V4.Model.CampaignCreativeAssociationsListResponse{}} on success
  • {:error, info} on failure