Method: audienceMembers.ingest

  • The content provides reference information for the audienceMembers:ingest method, which is used to upload a list of AudienceMember resources to specified Destinations.

  • The HTTP request method is POST to the specified endpoint using gRPC Transcoding syntax.

  • The request body requires destinations and audienceMembers, with optional fields like consent, validateOnly, encoding, encryptionInfo, and termsOfService.

  • A successful response body contains the auto-generated requestId.

  • The method requires the https://www.googleapis.com/auth/datamanager OAuth scope for authorization.

Uploads a list of AudienceMember resources to the provided Destination.

HTTP request

POST https://datamanager.googleapis.com/v1/audienceMembers:ingest

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "audienceMembers": [
    {
      object (AudienceMember)
    }
  ],
  "consent": {
    object (Consent)
  },
  "validateOnly": boolean,
  "encoding": enum (Encoding),
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "termsOfService": {
    object (TermsOfService)
  }
}
Fields
destinations[]

object (Destination)

Required. The list of destinations to send the audience members to.
audienceMembers[]

object (AudienceMember)

Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.
consent

object (Consent)

Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each AudienceMember.
validateOnly

boolean

Optional. For testing purposes. If true, the request is validated but not executed. Only errors are returned, not results.
encoding

enum (Encoding)

Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non UserData uploads, this field is ignored.
encryptionInfo

object (EncryptionInfo)

Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.
termsOfService

object (TermsOfService)

Optional. The terms of service that the user has accepted/rejected.

Response body

Response from the IngestAudienceMembersRequest.

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

JSON representation 
{
  "requestId": string
}
Fields
requestId

string

The auto-generated ID of the request.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/datamanager

TermsOfService

The terms of service that the user has accepted/rejected.

JSON representation 
{
  "customerMatchTermsOfServiceStatus": enum (TermsOfServiceStatus)
}
Fields
customerMatchTermsOfServiceStatus

enum (TermsOfServiceStatus)

Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717. This must be accepted when ingesting UserData or MobileData. This field is not required for Partner Match User list.

TermsOfServiceStatus

Represents the caller's decision to accept or reject the terms of service.

Enums
TERMS_OF_SERVICE_STATUS_UNSPECIFIED Not specified.
ACCEPTED Status indicating the caller has chosen to accept the terms of service.
REJECTED Status indicating the caller has chosen to reject the terms of service.