GoogleApi.DFAReporting.V34.Api.TargetableRemarketingLists (google_api_dfa_reporting v0.31.0)

API calls for all endpoints tagged TargetableRemarketingLists.

Summary

Functions

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

Gets one remarketing list by ID.

dfareporting_targetable_remarketing_lists_list(connection, profile_id, advertiser_id, optional_params \\ [], opts \\ [])

Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.

Functions

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

@spec dfareporting_targetable_remarketing_lists_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.TargetableRemarketingList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets one remarketing list 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) - Remarketing list 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.V34.Model.TargetableRemarketingList{}} on success
{:error, info} on failure

dfareporting_targetable_remarketing_lists_list(connection, profile_id, advertiser_id, optional_params \\ [], opts \\ [])

@spec dfareporting_targetable_remarketing_lists_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DFAReporting.V34.Model.TargetableRemarketingListsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a list of targetable remarketing lists, 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.
advertiser_id (type: String.t) - Select only targetable remarketing lists targetable by these advertisers.
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 or only inactive targetable remarketing lists.
- :maxResults (type: integer()) - Maximum number of results to return.
- :name (type: String.t) - Allows searching for objects by name or ID. Wildcards () are allowed. For example, "remarketing list2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 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 "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
- :pageToken (type: String.t) - Value of the nextPageToken from the previous result page.
- :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.TargetableRemarketingListsListResponse{}} on success
{:error, info} on failure