GoogleApi.DisplayVideo.V3.Api.CombinedAudiences (google_api_display_video v0.39.0)

API calls for all endpoints tagged CombinedAudiences.

Summary

Functions

displayvideo_combined_audiences_get(connection, combined_audience_id, optional_params \\ [], opts \\ [])

Gets a combined audience.

displayvideo_combined_audiences_list(connection, optional_params \\ [], opts \\ [])

Lists combined audiences. The order is defined by the order_by parameter.

Functions

displayvideo_combined_audiences_get(connection, combined_audience_id, optional_params \\ [], opts \\ [])

@spec displayvideo_combined_audiences_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V3.Model.CombinedAudience.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a combined audience.

Parameters

connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
combined_audience_id (type: String.t) - Required. The ID of the combined audience to fetch.
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").
- :advertiserId (type: String.t) - The ID of the advertiser that has access to the fetched combined audience.
- :partnerId (type: String.t) - The ID of the partner that has access to the fetched combined audience.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DisplayVideo.V3.Model.CombinedAudience{}} on success
{:error, info} on failure

displayvideo_combined_audiences_list(connection, optional_params \\ [], opts \\ [])

@spec displayvideo_combined_audiences_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.DisplayVideo.V3.Model.ListCombinedAudiencesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists combined audiences. The order is defined by the order_by parameter.

Parameters

connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
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").
- :advertiserId (type: String.t) - The ID of the advertiser that has access to the fetched combined audiences.
- :filter (type: String.t) - Allows filtering by combined audience fields. Supported syntax: Filter expressions for combined audiences can only contain at most one restriction. A restriction has the form of {field} {operator} {value}. All fields must use the HAS (:) operator. Supported fields: displayName Examples: * All combined audiences for which the display name contains "Google": displayName : "Google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.
- :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are: combinedAudienceId (default) displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.
- :pageSize (type: integer()) - Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
- :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCombinedAudiences method. If not specified, the first page of results will be returned.
- :partnerId (type: String.t) - The ID of the partner that has access to the fetched combined audiences.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DisplayVideo.V3.Model.ListCombinedAudiencesResponse{}} on success
{:error, info} on failure