com.google.api.ads.dfp.jaxws.v201708

Interface AudienceSegmentServiceInterface

public interface AudienceSegmentServiceInterface

Provides operations for creating, updating and retrieving AudienceSegment objects. This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
List<FirstPartyAudienceSegment>	createAudienceSegments(List<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.
List<FirstPartyAudienceSegment>	updateAudienceSegments(List<FirstPartyAudienceSegment> segments) Updates the given RuleBasedFirstPartyAudienceSegment objects.

Method Detail

createAudienceSegments

@RequestWrapper(localName="createAudienceSegments",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.AudienceSegmentServiceInterfacecreateAudienceSegments")
 @ResponseWrapper(localName="createAudienceSegmentsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.AudienceSegmentServiceInterfacecreateAudienceSegmentsResponse")
List<FirstPartyAudienceSegment> createAudienceSegments(List<FirstPartyAudienceSegment> segments)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      throws ApiException_Exception

Creates new RuleBasedFirstPartyAudienceSegment objects.

Parameters:

segments - first-party audience segments to create

segments -

Returns:

created first-party audience segments

Throws:

ApiException_Exception

getAudienceSegmentsByStatement

@RequestWrapper(localName="getAudienceSegmentsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.AudienceSegmentServiceInterfacegetAudienceSegmentsByStatement")
 @ResponseWrapper(localName="getAudienceSegmentsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.AudienceSegmentServiceInterfacegetAudienceSegmentsByStatementResponse")
AudienceSegmentPage getAudienceSegmentsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

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
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

filterStatement -

Returns:

the audience segments that match the given filter

Throws:

ApiException_Exception

performAudienceSegmentAction

@RequestWrapper(localName="performAudienceSegmentAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.AudienceSegmentServiceInterfaceperformAudienceSegmentAction")
 @ResponseWrapper(localName="performAudienceSegmentActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.AudienceSegmentServiceInterfaceperformAudienceSegmentActionResponse")
UpdateResult performAudienceSegmentAction(AudienceSegmentAction action,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 throws ApiException_Exception

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

filterStatement -

action -

Returns:

UpdateResult indicating the result

Throws:

ApiException_Exception

updateAudienceSegments

@RequestWrapper(localName="updateAudienceSegments",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.AudienceSegmentServiceInterfaceupdateAudienceSegments")
 @ResponseWrapper(localName="updateAudienceSegmentsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.AudienceSegmentServiceInterfaceupdateAudienceSegmentsResponse")
List<FirstPartyAudienceSegment> updateAudienceSegments(List<FirstPartyAudienceSegment> segments)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      throws ApiException_Exception

Updates the given RuleBasedFirstPartyAudienceSegment objects.

Parameters:

segments - first-party audience segments to update

segments -

Returns:

updated first-party audience segments

Throws:

ApiException_Exception