type SegmentPopulationRequest (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
Service
SegmentPopulationService
- Namespace
-
https://www.google.com/apis/ads/publisher/v202411
Field
|
batchUploadId
|
xsd:long
|
segmentId
|
xsd:long
|
isDeletion
|
xsd:boolean
|
identifierType
|
IdentifierType
Enumerations
-
PUBLISHER_PROVIDED_IDENTIFIER
-
UNKNOWN
|
ids
|
xsd:string[]
|
consentType
|
ConsentType
Enumerations
-
UNSET
-
GRANTED
-
DENIED
-
UNKNOWN
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eSegmentPopulationRequest\u003c/code\u003e object is used to manage segment memberships within Google Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003eIt allows for batch updates, specifying segment IDs, deletion flags, identifier types, user IDs, and consent information.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eIdentifierType\u003c/code\u003e and \u003ccode\u003eConsentType\u003c/code\u003e are enumerations providing options for user identification and consent status.\u003c/p\u003e\n"],["\u003cp\u003eThis functionality resides within the \u003ccode\u003eSegmentPopulationService\u003c/code\u003e and is accessed via the \u003ccode\u003eupdateSegmentMemberships\u003c/code\u003e method.\u003c/p\u003e\n"]]],["The `SegmentPopulationService`'s `updateSegmentMemberships` function uses a `SegmentPopulationRequest` to manage segment memberships. This request requires a `batchUploadId` and `segmentId`. It specifies if the action is a deletion (`isDeletion`) and the type of identifiers used (`identifierType`), which can be `PUBLISHER_PROVIDED_IDENTIFIER` or `UNKNOWN`. It includes a list of `ids` and the user consent related to it through the field `consentType`, which can be `UNSET`, `GRANTED`, `DENIED`, or `UNKNOWN`.\n"],null,["# type SegmentPopulationRequest (v202411)\n\n**Service** \n**SegmentPopulationService** **Dependencies** \n[updateSegmentMemberships()](/ad-manager/api/reference/v202411/SegmentPopulationService#updateSegmentMemberships) \n▼\n**SegmentPopulationRequest**\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\n\n| Field ----- ||\n|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `batchUploadId` | ` `xsd:`long` \u003cbr /\u003e |\n| ### `segmentId` | ` `xsd:`long` \u003cbr /\u003e |\n| ### `isDeletion` | ` `xsd:`boolean` \u003cbr /\u003e |\n| ### `identifierType` | ` `[IdentifierType](/ad-manager/api/reference/v202411/SegmentPopulationService.IdentifierType)` ` *** ** * ** *** **Enumerations** `PUBLISHER_PROVIDED_IDENTIFIER` : `UNKNOWN` : \u003cbr /\u003e |\n| ### `ids` | ` `xsd:`string[]` \u003cbr /\u003e |\n| ### `consentType` | ` `[ConsentType](/ad-manager/api/reference/v202411/SegmentPopulationService.ConsentType)` ` *** ** * ** *** **Enumerations** `UNSET` : `GRANTED` : `DENIED` : `UNKNOWN` : \u003cbr /\u003e |"]]
