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

API calls for all endpoints tagged Creatives.

Summary

Functions

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

Gets one creative by ID.

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

Inserts a new creative.

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

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

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

Updates an existing creative. This method supports patch semantics.

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

Updates an existing creative.

Functions

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

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

Gets one creative 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 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.Creative{}} on success
{:error, info} on failure

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

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

Inserts a new creative.

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.Creative.t) -
opts (type: keyword()) - Call options

Returns

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

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

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

Retrieves a list of creatives, 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").
- :active (type: boolean()) - Select only active creatives. Leave blank to select active and inactive creatives.
- :advertiserId (type: String.t) - Select only creatives with this advertiser ID.
- :archived (type: boolean()) - Select only archived creatives. Leave blank to select archived and unarchived creatives.
- :campaignId (type: String.t) - Select only creatives with this campaign ID.
- :companionCreativeIds (type: list(String.t)) - Select only in-stream video creatives with these companion IDs.
- :creativeFieldIds (type: list(String.t)) - Select only creatives with these creative field IDs.
- :ids (type: list(String.t)) - Select only creatives 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.
- :renderingIds (type: list(String.t)) - Select only creatives with these rendering IDs.
- :searchString (type: String.t) - Allows searching for objects by name or ID. Wildcards () are allowed. For example, "creative2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 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 "creative" will match objects with name "my creative", "creative 2015", or simply "creative".
- :sizeIds (type: list(String.t)) - Select only creatives with these size IDs.
- :sortField (type: String.t) - Field by which to sort the list.
- :sortOrder (type: String.t) - Order of sorted results.
- :studioCreativeId (type: String.t) - Select only creatives corresponding to this Studio creative ID.
- :types (type: list(String.t)) - Select only creatives with these creative types.
opts (type: keyword()) - Call options

Returns

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

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

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

Updates an existing creative. 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 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.Creative.t) -
opts (type: keyword()) - Call options

Returns

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

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

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

Updates an existing creative.

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.Creative.t) -
opts (type: keyword()) - Call options

Returns

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