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

API calls for all endpoints tagged CreativeFieldValues.

Summary

Functions

dfareporting_creative_field_values_delete(connection, profile_id, creative_field_id, id, optional_params \\ [], opts \\ [])

Deletes an existing creative field value.

dfareporting_creative_field_values_get(connection, profile_id, creative_field_id, id, optional_params \\ [], opts \\ [])

Gets one creative field value by ID.

dfareporting_creative_field_values_insert(connection, profile_id, creative_field_id, optional_params \\ [], opts \\ [])

Inserts a new creative field value.

dfareporting_creative_field_values_list(connection, profile_id, creative_field_id, optional_params \\ [], opts \\ [])

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

dfareporting_creative_field_values_patch(connection, profile_id, creative_field_id, id, optional_params \\ [], opts \\ [])

Updates an existing creative field value. This method supports patch semantics.

dfareporting_creative_field_values_update(connection, profile_id, creative_field_id, optional_params \\ [], opts \\ [])

Updates an existing creative field value.

Functions

dfareporting_creative_field_values_delete(connection, profile_id, creative_field_id, id, optional_params \\ [], opts \\ [])

@spec dfareporting_creative_field_values_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes an existing creative field value.

Parameters

connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
profile_id (type: String.t) - User profile ID associated with this request.
creative_field_id (type: String.t) - Creative field ID for this creative field value.
id (type: String.t) - Creative Field Value 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, %{}} on success
{:error, info} on failure

dfareporting_creative_field_values_get(connection, profile_id, creative_field_id, id, optional_params \\ [], opts \\ [])

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

Gets one creative field value 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.
creative_field_id (type: String.t) - Creative field ID for this creative field value.
id (type: String.t) - Creative Field Value 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.CreativeFieldValue{}} on success
{:error, info} on failure

dfareporting_creative_field_values_insert(connection, profile_id, creative_field_id, optional_params \\ [], opts \\ [])

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

Inserts a new creative field value.

Parameters

connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
profile_id (type: String.t) - User profile ID associated with this request.
creative_field_id (type: String.t) - Creative field ID for this creative field value.
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.CreativeFieldValue.t) -
opts (type: keyword()) - Call options

Returns

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

dfareporting_creative_field_values_list(connection, profile_id, creative_field_id, optional_params \\ [], opts \\ [])

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

Retrieves a list of creative field values, 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.
creative_field_id (type: String.t) - Creative field ID for this creative field value.
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").
- :ids (type: list(String.t)) - Select only creative field values 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 field values by their values. Wildcards (e.g. *) are not allowed.
- :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.CreativeFieldValuesListResponse{}} on success
{:error, info} on failure

dfareporting_creative_field_values_patch(connection, profile_id, creative_field_id, id, optional_params \\ [], opts \\ [])

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

Updates an existing creative field value. 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.
creative_field_id (type: String.t) - CreativeField ID.
id (type: String.t) - CreativeFieldValue 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.CreativeFieldValue.t) -
opts (type: keyword()) - Call options

Returns

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

dfareporting_creative_field_values_update(connection, profile_id, creative_field_id, optional_params \\ [], opts \\ [])

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

Updates an existing creative field value.

Parameters

connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
profile_id (type: String.t) - User profile ID associated with this request.
creative_field_id (type: String.t) - Creative field ID for this creative field value.
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.CreativeFieldValue.t) -
opts (type: keyword()) - Call options

Returns

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