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

API calls for all endpoints tagged CreativeGroups.

Summary

Functions

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

Gets one creative group by ID.

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

Inserts a new creative group.

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

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

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

Updates an existing creative group. This method supports patch semantics.

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

Updates an existing creative group.

Functions

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

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

Gets one creative group by ID.

Parameters

connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
profile_id (type: String.t) - User profile ID associated with this request.
id (type: String.t) - Creative group 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.V4.Model.CreativeGroup{}} on success
{:error, info} on failure

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

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

Inserts a new creative group.

Parameters

connection (type: GoogleApi.DFAReporting.V4.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.V4.Model.CreativeGroup.t) -
opts (type: keyword()) - Call options

Returns

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

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

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

Retrieves a list of creative groups, possibly filtered. 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.
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").
- :advertiserIds (type: list(String.t)) - Select only creative groups that belong to these advertisers.
- :groupNumber (type: integer()) - Select only creative groups that belong to this subgroup.
- :ids (type: list(String.t)) - Select only creative groups with these IDs.
- :maxResults (type: integer()) - Maximum number of results to return.
- :pageToken (type: String.t) - Value of the nextPageToken from the previous result page.
- :searchString (type: String.t) - Allows searching for creative groups by name or ID. Wildcards () are allowed. For example, "creativegroup2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".
- :sortField (type: String.t) - Field by which to sort the list.
- :sortOrder (type: String.t) - Order of sorted results.
opts (type: keyword()) - Call options

Returns

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

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

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

Updates an existing creative group. This method supports patch semantics.

Parameters

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

Returns

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

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

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

Updates an existing creative group.

Parameters

connection (type: GoogleApi.DFAReporting.V4.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.V4.Model.CreativeGroup.t) -
opts (type: keyword()) - Call options

Returns

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