GoogleApi.DFAReporting.V34.Api.Campaigns (google_api_dfa_reporting v0.31.0)

API calls for all endpoints tagged Campaigns.

Summary

Functions

dfareporting_campaigns_get(connection, profile_id, id, optional_params \\ [], opts \\ [])

Gets one campaign by ID.

dfareporting_campaigns_insert(connection, profile_id, optional_params \\ [], opts \\ [])

Inserts a new campaign.

dfareporting_campaigns_list(connection, profile_id, optional_params \\ [], opts \\ [])

Retrieves a list of campaigns, possibly filtered. This method supports paging.

dfareporting_campaigns_patch(connection, profile_id, id, optional_params \\ [], opts \\ [])

Updates an existing campaign. This method supports patch semantics.

dfareporting_campaigns_update(connection, profile_id, optional_params \\ [], opts \\ [])

Updates an existing campaign.

Functions

dfareporting_campaigns_get(connection, profile_id, id, optional_params \\ [], opts \\ [])

@spec dfareporting_campaigns_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.Campaign.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets one campaign by ID.

Parameters

connection (type: GoogleApi.DFAReporting.V34.Connection.t) - Connection to server
profile_id (type: String.t) - User profile ID associated with this request.
id (type: String.t) - Campaign ID.
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").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DFAReporting.V34.Model.Campaign{}} on success
{:error, info} on failure

dfareporting_campaigns_insert(connection, profile_id, optional_params \\ [], opts \\ [])

@spec dfareporting_campaigns_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.Campaign.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Inserts a new campaign.

Parameters

connection (type: GoogleApi.DFAReporting.V34.Connection.t) - Connection to server
profile_id (type: String.t) - User profile ID associated with this request.
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.V34.Model.Campaign.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DFAReporting.V34.Model.Campaign{}} on success
{:error, info} on failure

dfareporting_campaigns_list(connection, profile_id, optional_params \\ [], opts \\ [])

@spec dfareporting_campaigns_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.CampaignsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a list of campaigns, possibly filtered. This method supports paging.

Parameters

connection (type: GoogleApi.DFAReporting.V34.Connection.t) - Connection to server
profile_id (type: String.t) - User profile ID associated with this request.
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").
- :advertiserGroupIds (type: list(String.t)) - Select only campaigns whose advertisers belong to these advertiser groups.
- :advertiserIds (type: list(String.t)) - Select only campaigns that belong to these advertisers.
- :archived (type: boolean()) - Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
- :atLeastOneOptimizationActivity (type: boolean()) - Select only campaigns that have at least one optimization activity.
- :excludedIds (type: list(String.t)) - Exclude campaigns with these IDs.
- :ids (type: list(String.t)) - Select only campaigns with these IDs.
- :maxResults (type: integer()) - Maximum number of results to return.
- :overriddenEventTagId (type: String.t) - Select only campaigns that have overridden this event tag ID.
- :pageToken (type: String.t) - Value of the nextPageToken from the previous result page.
- :searchString (type: String.t) - Allows searching for campaigns by name or ID. Wildcards () are allowed. For example, "campaign2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
- :sortField (type: String.t) - Field by which to sort the list.
- :sortOrder (type: String.t) - Order of sorted results.
- :subaccountId (type: String.t) - Select only campaigns that belong to this subaccount.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DFAReporting.V34.Model.CampaignsListResponse{}} on success
{:error, info} on failure

dfareporting_campaigns_patch(connection, profile_id, id, optional_params \\ [], opts \\ [])

@spec dfareporting_campaigns_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.Campaign.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing campaign. This method supports patch semantics.

Parameters

connection (type: GoogleApi.DFAReporting.V34.Connection.t) - Connection to server
profile_id (type: String.t) - User profile ID associated with this request.
id (type: String.t) - Campaign ID.
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.V34.Model.Campaign.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DFAReporting.V34.Model.Campaign{}} on success
{:error, info} on failure

dfareporting_campaigns_update(connection, profile_id, optional_params \\ [], opts \\ [])

@spec dfareporting_campaigns_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.Campaign.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing campaign.

Parameters

connection (type: GoogleApi.DFAReporting.V34.Connection.t) - Connection to server
profile_id (type: String.t) - User profile ID associated with this request.
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.V34.Model.Campaign.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DFAReporting.V34.Model.Campaign{}} on success
{:error, info} on failure