com.google.api.ads.admanager.axis.v202102

Interface AudienceSegmentServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

AudienceSegmentServiceSoapBindingStub

public interface AudienceSegmentServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
FirstPartyAudienceSegment[]	createAudienceSegments(FirstPartyAudienceSegment[] segments) Creates new RuleBasedFirstPartyAudienceSegment objects.
AudienceSegmentPage	getAudienceSegmentsByStatement(Statement filterStatement) Gets an AudienceSegmentPage of AudienceSegment objects that satisfy the given Statement.query.
UpdateResult	performAudienceSegmentAction(AudienceSegmentAction action, Statement filterStatement) Performs the given AudienceSegmentAction on the set of segments identified by the given statement.
FirstPartyAudienceSegment[]	updateAudienceSegments(FirstPartyAudienceSegment[] segments) Updates the given RuleBasedFirstPartyAudienceSegment objects.

Method Detail

createAudienceSegments

FirstPartyAudienceSegment[] createAudienceSegments(FirstPartyAudienceSegment[] segments)
                                            throws RemoteException,
                                                   ApiException

Creates new RuleBasedFirstPartyAudienceSegment objects.

Parameters:

segments - first-party audience segments to create

Returns:

created first-party audience segments

Throws:

RemoteException

ApiException

getAudienceSegmentsByStatement

AudienceSegmentPage getAudienceSegmentsByStatement(Statement filterStatement)
                                            throws RemoteException,
                                                   ApiException

Gets an AudienceSegmentPage of AudienceSegment objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	AudienceSegment.id
name	AudienceSegment.name
status	AudienceSegment.status
type	AudienceSegment.type
size	AudienceSegment.size
dataProviderName	AudienceSegmentDataProvider.name
segmentType	AudienceSegment.type
approvalStatus	ThirdPartyAudienceSegment.approvalStatus
cost	ThirdPartyAudienceSegment.cost
startDateTime	ThirdPartyAudienceSegment.startDateTime
endDateTime	ThirdPartyAudienceSegment.endDateTime

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of audience segments (the only supported operator is AND)

Returns:

the audience segments that match the given filter

Throws:

RemoteException

ApiException

performAudienceSegmentAction

UpdateResult performAudienceSegmentAction(AudienceSegmentAction action,
                                          Statement filterStatement)
                                   throws RemoteException,
                                          ApiException

Performs the given AudienceSegmentAction on the set of segments identified by the given statement.

Parameters:

action - AudienceSegmentAction to perform

filterStatement - a Publisher Query Language statement used to filter a set of audience segments (the only supported operator is AND)

Returns:

UpdateResult indicating the result

Throws:

RemoteException

ApiException

updateAudienceSegments

FirstPartyAudienceSegment[] updateAudienceSegments(FirstPartyAudienceSegment[] segments)
                                            throws RemoteException,
                                                   ApiException

Updates the given RuleBasedFirstPartyAudienceSegment objects.

Parameters:

segments - first-party audience segments to update

Returns:

updated first-party audience segments

Throws:

RemoteException

ApiException