2025-01-14
▼ ▲ displayvideo.firstAndThirdPartyAudiences.get
Path : v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}
Flat Path : v2/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}
HTTP Method : GET
Parameters :
firstAndThirdPartyAudienceId
Description : Required. The ID of the first and third party audience to fetch.
Pattern : ^[^/]+$
Location : path
Required : Yes
Type : string
Format : int64
partnerId
Description : The ID of the partner that has access to the fetched first and third party audience.
Location : query
Type : string
Format : int64
advertiserId
Description : The ID of the advertiser that has access to the fetched first and third party audience.
Location : query
Type : string
Format : int64
Parameter Order : firstAndThirdPartyAudienceId
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets a first and third party audience.
▼ ▲ displayvideo.firstAndThirdPartyAudiences.list
Path : v2/firstAndThirdPartyAudiences
Flat Path : v2/firstAndThirdPartyAudiences
HTTP Method : GET
Parameters :
partnerId
Description : The ID of the partner that has access to the fetched first and third party audiences.
Location : query
Type : string
Format : int64
advertiserId
Description : The ID of the advertiser that has access to the fetched first and third party audiences.
Location : query
Type : string
Format : int64
pageSize
Description : Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location : query
Type : integer
Format : int32
pageToken
Description : 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 `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned.
Location : query
Type : string
orderBy
Description : 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`.
Location : query
Type : string
filter
Description : 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 the `HAS (:)` 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 [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists first and third party audiences. The order is defined by the order_by parameter.
▼ ▲ displayvideo.firstAndThirdPartyAudiences.create
Path : v2/firstAndThirdPartyAudiences
Flat Path : v2/firstAndThirdPartyAudiences
HTTP Method : POST
Parameters :
advertiserId
Description : Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created.
Location : query
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Description : Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
▼ ▲ displayvideo.firstAndThirdPartyAudiences.patch
Path : v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}
Flat Path : v2/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}
HTTP Method : PATCH
Parameters :
firstAndThirdPartyAudienceId
Description : Output only. The unique ID of the first and third party audience. Assigned by the system.
Pattern : ^[^/]+$
Location : path
Required : Yes
Type : string
Format : int64
updateMask
Description : Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`
Location : query
Type : string
Format : google-fieldmask
advertiserId
Description : Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.
Location : query
Type : string
Format : int64
Parameter Order : firstAndThirdPartyAudienceId
Scopes : https://www.googleapis.com/auth/display-video
Description : Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
▼ ▲ displayvideo.firstAndThirdPartyAudiences.editCustomerMatchMembers
Path : v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}:editCustomerMatchMembers
Flat Path : v2/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}:editCustomerMatchMembers
HTTP Method : POST
Parameters :
firstAndThirdPartyAudienceId
Description : Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited.
Pattern : ^[^/]+$
Location : path
Required : Yes
Type : string
Format : int64
Parameter Order : firstAndThirdPartyAudienceId
Scopes : https://www.googleapis.com/auth/display-video
Description : Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`