Looking for a REST API? The Ad Manager API (Beta) is now available.

SegmentPopulationService (v202402)

Production WSDL


                  https://ads.google.com/apis/ads/publisher/v202402/SegmentPopulationService?wsdl

Namespace

https://www.google.com/apis/ads/publisher/v202402

Operations

getSegmentPopulationResultsByIds
performSegmentPopulationAction
updateSegmentMemberships

Errors

ApiVersionError
AuthenticationError
CollectionSizeError
CommonError
FeatureError
InternalApiError
NotNullError
ParseError
PermissionError
PublisherQueryLanguageContextError
PublisherQueryLanguageSyntaxError
QuotaError
RequiredCollectionError
RequiredError
SegmentPopulationError
ServerError
StringFormatError
StringLengthError

getSegmentPopulationResultsByIds

Returns a list of SegmentPopulationResults for the given batchUploadIds.

Parameters

Field	Type	Description
`batchUploadIds`	`xsd:long[]`

Response

Field	Type	Description
`rval`	`SegmentPopulationResults[]`

performSegmentPopulationAction

Performs an action on the uploads denoted by batchUploadIds.

Parameters

Field	Type	Description
`action`	`SegmentPopulationAction ProcessAction`
`batchUploadIds`	`xsd:long[]`

Response

Field	Type	Description
`rval`	`UpdateResult`

updateSegmentMemberships

Updates identifiers in an audience segment.

The returned SegmentPopulationRequest.batchUploadId can be used in subsequent requests to group them together as part of the same batch. The identifiers associated with a batch will not be processed until performSegmentPopulationAction is called with a ProcessAction. The batch will expire if ProcessAction is not called within the TTL of 5 days.

Parameters

Field	Type	Description
`updateRequest`	`SegmentPopulationRequest`

Response

Field	Type	Description
`rval`	`SegmentPopulationResponse`

Errors

Error	Reasons
`ApiVersionError`	Enumerations `UPDATE_TO_NEWER_VERSION` `UNKNOWN`
`AuthenticationError`	Enumerations `AMBIGUOUS_SOAP_REQUEST_HEADER` `INVALID_EMAIL` `AUTHENTICATION_FAILED` `INVALID_OAUTH_SIGNATURE` `INVALID_SERVICE` `MISSING_SOAP_REQUEST_HEADER` `MISSING_AUTHENTICATION_HTTP_HEADER` `MISSING_AUTHENTICATION` `NETWORK_API_ACCESS_DISABLED` `NO_NETWORKS_TO_ACCESS` `NETWORK_NOT_FOUND` `NETWORK_CODE_REQUIRED` `CONNECTION_ERROR` `GOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK` `UNDER_INVESTIGATION` `UNKNOWN`
`CollectionSizeError`	Enumerations `TOO_LARGE` `UNKNOWN`
`CommonError`	Enumerations `NOT_FOUND` `ALREADY_EXISTS` `NOT_APPLICABLE` `DUPLICATE_OBJECT` `CANNOT_UPDATE` `UNSUPPORTED_OPERATION` `CONCURRENT_MODIFICATION` `UNKNOWN`
`FeatureError`	Enumerations `MISSING_FEATURE` `UNKNOWN`
`InternalApiError`	Enumerations `UNEXPECTED_INTERNAL_API_ERROR` `TRANSIENT_ERROR` `UNKNOWN` `DOWNTIME` `ERROR_GENERATING_RESPONSE`
`NotNullError`	Enumerations `ARG1_NULL` `ARG2_NULL` `ARG3_NULL` `NULL` `UNKNOWN`
`ParseError`	Enumerations `UNPARSABLE` `UNKNOWN`
`PermissionError`	Enumerations `PERMISSION_DENIED` `UNKNOWN`
`PublisherQueryLanguageContextError`	Enumerations `UNEXECUTABLE` `UNKNOWN`
`PublisherQueryLanguageSyntaxError`	Enumerations `UNPARSABLE` `UNKNOWN`
`QuotaError`	Enumerations `EXCEEDED_QUOTA` `UNKNOWN` `REPORT_JOB_LIMIT` `SEGMENT_POPULATION_LIMIT`
`RequiredCollectionError`	Enumerations `REQUIRED` `TOO_LARGE` `TOO_SMALL` `UNKNOWN`
`RequiredError`	Enumerations `REQUIRED`
`SegmentPopulationError`	Enumerations `TOO_MANY_IDENTIFIERS` `INVALID_SEGMENT` `JOB_ALREADY_STARTED` `NO_IDENTIFIERS` `NO_CONSENT` `UNKNOWN`
`ServerError`	Enumerations `SERVER_ERROR` `SERVER_BUSY` `UNKNOWN`
`StringFormatError`	Enumerations `UNKNOWN` `ILLEGAL_CHARS` `INVALID_FORMAT`
`StringLengthError`	Enumerations `TOO_LONG` `TOO_SHORT` `UNKNOWN`