Method: firstAndThirdPartyAudiences.editCustomerMatchMembers

  • This document details how to update the member list of a Customer Match audience using the Display & Video 360 API v3, which has been sunset in favor of v4.

  • This functionality is only supported for CUSTOMER_MATCH_CONTACT_INFO and CUSTOMER_MATCH_DEVICE_ID audience types.

  • The HTTP request is a POST to a specific endpoint that includes the audience ID in the path.

  • The request body contains the advertiserId and lists of members to be added or removed, using either contact information or mobile device IDs.

  • A successful response returns the ID of the updated Customer Match FirstAndThirdPartyAudience.

Updates the member list of a Customer Match audience.

Only supported for the following audienceType:

  • CUSTOMER_MATCH_CONTACT_INFO
  • CUSTOMER_MATCH_DEVICE_ID

HTTP request

POST https://displayvideo.googleapis.com/v3/firstAndThirdPartyAudiences/{firstAndThirdPartyAudienceId}:editCustomerMatchMembers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
firstAndThirdPartyAudienceId

string (int64 format)

Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "advertiserId": string,

  // Union field added_members can be only one of the following:
  "addedContactInfoList": {
    object (ContactInfoList)
  },
  "addedMobileDeviceIdList": {
    object (MobileDeviceIdList)
  }
  // End of list of possible types for union field added_members.

  // Union field removed_members can be only one of the following:
  "removedContactInfoList": {
    object (ContactInfoList)
  },
  "removedMobileDeviceIdList": {
    object (MobileDeviceIdList)
  }
  // End of list of possible types for union field removed_members.
}
Fields
advertiserId

string (int64 format)

Required. The ID of the owner advertiser of the updated Customer Match FirstAndThirdPartyAudience.
Union field added_members. The members to be added to the Customer Match audience. added_members can be only one of the following:
addedContactInfoList

object (ContactInfoList)

Input only. A list of contact information to define the members to be added.
addedMobileDeviceIdList

object (MobileDeviceIdList)

Input only. A list of mobile device IDs to define the members to be added.
Union field removed_members. The members to be removed from the Customer Match audience. removed_members can be only one of the following:
removedContactInfoList

object (ContactInfoList)

Input only. A list of contact information to define the members to be removed.
removedMobileDeviceIdList

object (MobileDeviceIdList)

Input only. A list of mobile device IDs to define the members to be removed.

Response body

The response of FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "firstAndThirdPartyAudienceId": string
}
Fields
firstAndThirdPartyAudienceId

string (int64 format)

Required. The ID of the updated Customer Match FirstAndThirdPartyAudience.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.