GoogleApi.DFAReporting.V33.Api.CreativeFields (google_api_dfa_reporting v0.31.0)

API calls for all endpoints tagged CreativeFields.

Summary

Functions

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

Deletes an existing creative field.

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

Gets one creative field by ID.

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

Inserts a new creative field.

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

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

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

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

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

Updates an existing creative field.

Functions

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

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

Deletes an existing creative field.

Parameters

connection (type: GoogleApi.DFAReporting.V33.Connection.t) - Connection to server
profile_id (type: String.t) - User profile ID associated with this request.
id (type: String.t) - Creative Field 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_fields_get(connection, profile_id, id, optional_params \\ [], opts \\ [])

@spec dfareporting_creative_fields_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.CreativeField.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets one creative field by ID.

Parameters

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

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

@spec dfareporting_creative_fields_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.CreativeField.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Inserts a new creative field.

Parameters

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

Returns

{:ok, %GoogleApi.DFAReporting.V33.Model.CreativeField{}} on success
{:error, info} on failure

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

@spec dfareporting_creative_fields_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.CreativeFieldsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

connection (type: GoogleApi.DFAReporting.V33.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 fields that belong to these advertisers.
- :ids (type: list(String.t)) - Select only creative fields 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 fields by name or ID. Wildcards () are allowed. For example, "creativefield2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 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 "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".
- :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.V33.Model.CreativeFieldsListResponse{}} on success
{:error, info} on failure

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

@spec dfareporting_creative_fields_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.CreativeField.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

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

Returns

{:ok, %GoogleApi.DFAReporting.V33.Model.CreativeField{}} on success
{:error, info} on failure

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

@spec dfareporting_creative_fields_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.CreativeField.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing creative field.

Parameters

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

Returns

{:ok, %GoogleApi.DFAReporting.V33.Model.CreativeField{}} on success
{:error, info} on failure