View Source GoogleApi.DisplayVideo.V1.Api.FirstAndThirdPartyAudiences (google_api_display_video v0.35.0)
API calls for all endpoints tagged FirstAndThirdPartyAudiences
.
Summary
Functions
Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: CUSTOMER_MATCH_CONTACT_INFO
CUSTOMER_MATCH_DEVICE_ID
Updates the member list of a Customer Match audience. Only supported for the following audience_type: CUSTOMER_MATCH_CONTACT_INFO
CUSTOMER_MATCH_DEVICE_ID
Gets a first and third party audience.
Lists first and third party audiences. The order is defined by the order_by parameter.
Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: CUSTOMER_MATCH_CONTACT_INFO
CUSTOMER_MATCH_DEVICE_ID
Functions
displayvideo_first_and_third_party_audiences_create(connection, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_first_and_third_party_audiences_create( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.FirstAndThirdPartyAudience.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: CUSTOMER_MATCH_CONTACT_INFO
CUSTOMER_MATCH_DEVICE_ID
Parameters
-
connection
(type:GoogleApi.DisplayVideo.V1.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
) - Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created. -
:body
(type:GoogleApi.DisplayVideo.V1.Model.FirstAndThirdPartyAudience.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.FirstAndThirdPartyAudience{}}
on success -
{:error, info}
on failure
displayvideo_first_and_third_party_audiences_edit_customer_match_members(connection, first_and_third_party_audience_id, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_first_and_third_party_audiences_edit_customer_match_members( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.EditCustomerMatchMembersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the member list of a Customer Match audience. Only supported for the following audience_type: CUSTOMER_MATCH_CONTACT_INFO
CUSTOMER_MATCH_DEVICE_ID
Parameters
-
connection
(type:GoogleApi.DisplayVideo.V1.Connection.t
) - Connection to server -
first_and_third_party_audience_id
(type:String.t
) - Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited. -
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.DisplayVideo.V1.Model.EditCustomerMatchMembersRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.EditCustomerMatchMembersResponse{}}
on success -
{:error, info}
on failure
displayvideo_first_and_third_party_audiences_get(connection, first_and_third_party_audience_id, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_first_and_third_party_audiences_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.FirstAndThirdPartyAudience.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a first and third party audience.
Parameters
-
connection
(type:GoogleApi.DisplayVideo.V1.Connection.t
) - Connection to server -
first_and_third_party_audience_id
(type:String.t
) - Required. The ID of the first and third party 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 first and third party audience. -
:partnerId
(type:String.t
) - The ID of the partner that has access to the fetched first and third party audience.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.FirstAndThirdPartyAudience{}}
on success -
{:error, info}
on failure
displayvideo_first_and_third_party_audiences_list(connection, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_first_and_third_party_audiences_list( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.ListFirstAndThirdPartyAudiencesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists first and third party audiences. The order is defined by the order_by parameter.
Parameters
-
connection
(type:GoogleApi.DisplayVideo.V1.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 first and third party audiences. -
:filter
(type:String.t
) - Allows filtering by first and third party audience fields. Supported syntax: Filter expressions for first and third party audiences can only contain at most one restriction. A restriction has the form of{field} {operator} {value}
. All fields must use theHAS (:)
operator. Supported fields:displayName
Examples: * All first and third party audiences for which the display name contains "Google":displayName:"Google"
. The length of this field should be no more than 500 characters. Reference our filterLIST
requests guide for more information. -
:orderBy
(type:String.t
) - Field by which to sort the list. Acceptable values are:firstAndThirdPartyAudienceId
(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 between1
and200
. If unspecified will default to100
. Returns error codeINVALID_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 toListFirstAndThirdPartyAudiences
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 first and third party audiences.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.ListFirstAndThirdPartyAudiencesResponse{}}
on success -
{:error, info}
on failure
displayvideo_first_and_third_party_audiences_patch(connection, first_and_third_party_audience_id, optional_params \\ [], opts \\ [])
View Source@spec displayvideo_first_and_third_party_audiences_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DisplayVideo.V1.Model.FirstAndThirdPartyAudience.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: CUSTOMER_MATCH_CONTACT_INFO
CUSTOMER_MATCH_DEVICE_ID
Parameters
-
connection
(type:GoogleApi.DisplayVideo.V1.Connection.t
) - Connection to server -
first_and_third_party_audience_id
(type:String.t
) - Output only. The unique ID of the first and third party audience. Assigned by the system. -
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
) - Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience. -
:updateMask
(type:String.t
) - Required. The mask to control which fields to update. Updates are only supported for the following fields:displayName
description
*membershipDurationDays
-
:body
(type:GoogleApi.DisplayVideo.V1.Model.FirstAndThirdPartyAudience.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.FirstAndThirdPartyAudience{}}
on success -
{:error, info}
on failure