type SegmentPopulationRequest (v202508)

  • SegmentPopulationRequest is a request used to upload identifiers to an AudienceSegment.

  • The request includes fields for a batch upload ID, segment ID, whether it's a deletion, identifier type, the identifiers themselves, and consent type.

  • The batchUploadId can be specified or provided by Google to group requests.

  • The ids field can contain up to 100,000 elements.

  • The identifierType and consentType fields have associated enumerations.
Service
SegmentPopulationService
Dependencies
updateSegmentMemberships()
▼
SegmentPopulationRequest

A request to upload identifiers to an AudienceSegment.

Namespace
https://www.google.com/apis/ads/publisher/v202508

Field

batchUploadId

xsd:long

The ID of the batch that will process identifiers. If not specified, it will be provided by Google. The same ID can be used in subsequent requests to group them together as part of the same batch.

segmentId

xsd:long

The ID of the segment to populate. This segment must be active.

isDeletion

xsd:boolean

Whether the identifiers should be added or removed.

identifierType

IdentifierType

The type of identifier being operated upon.

Enumerations
PUBLISHER_PROVIDED_IDENTIFIER
UNKNOWN

ids

xsd:string[]

The identifiers to upload. This field may have a maximum size of 100,000 elements.

consentType

ConsentType

Consent type gathered for all identifiers in this request.

Enumerations
UNSET
GRANTED
DENIED
UNKNOWN