Method: firstPartyAndPartnerAudiences.patch

  • This page details how to update an existing FirstPartyAndPartnerAudience.

  • Updating an audience is only supported for CUSTOMER_MATCH_CONTACT_INFO and CUSTOMER_MATCH_DEVICE_ID audience types.

  • The HTTP request uses the PATCH method with a specific URL format and path parameters including the audience ID.

  • Required query parameters include updateMask to specify fields to update and advertiserId.

  • The request and response bodies contain an instance of FirstPartyAndPartnerAudience, and authorization requires the https://www.googleapis.com/auth/display-video scope.

Updates an existing FirstPartyAndPartnerAudience.

Only supported for the following audienceType:

  • CUSTOMER_MATCH_CONTACT_INFO
  • CUSTOMER_MATCH_DEVICE_ID

HTTP request

PATCH https://displayvideo.googleapis.com/v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudience.firstPartyAndPartnerAudienceId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
firstPartyAndPartnerAudience.firstPartyAndPartnerAudienceId

string (int64 format)

Identifier. The unique ID of the first party and partner audience. Assigned by the system.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The mask to control which fields to update.

Updates are only supported for the following fields:

  • displayName
  • description
  • membershipDurationDays

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
advertiserId

string (int64 format)

Required. The ID of the owner advertiser of the updated FirstPartyAndPartnerAudience.

Request body

The request body contains an instance of FirstPartyAndPartnerAudience.

Response body

If successful, the response body contains an instance of FirstPartyAndPartnerAudience.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.