google_api_dfa_reporting v0.8.0 GoogleApi.DFAReporting.V34.Api.CreativeGroups View Source

API calls for all endpoints tagged CreativeGroups.

Link to this section Summary

Link to this section Functions

Link to this function

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

View Source
dfareporting_creative_groups_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.CreativeGroup.t()}
  | {:error, Tesla.Env.t()}

Gets one creative group 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) - Creative group ID.
  • 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.DFAReporting.V34.Model.CreativeGroup{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
dfareporting_creative_groups_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.CreativeGroup.t()}
  | {:error, Tesla.Env.t()}

Inserts a new creative group.

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

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

Returns

  • {:ok, %GoogleApi.DFAReporting.V34.Model.CreativeGroup{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
dfareporting_creative_groups_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.CreativeGroupsListResponse.t()}
  | {:error, Tesla.Env.t()}

Retrieves a list of creative groups, 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

    • :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.
    • :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.V34.Model.CreativeGroupsListResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
dfareporting_creative_groups_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.CreativeGroup.t()}
  | {:error, Tesla.Env.t()}

Updates an existing creative group. 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) - Creative group ID.
  • 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.DFAReporting.V34.Model.CreativeGroup.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V34.Model.CreativeGroup{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
dfareporting_creative_groups_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.CreativeGroup.t()}
  | {:error, Tesla.Env.t()}

Updates an existing creative group.

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

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

Returns

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