com.google.api.ads.dfp.jaxws.v201711

Interface LabelServiceInterface

public interface LabelServiceInterface

Provides methods for the creation and management of Labels. 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<Label>	createLabels(List<Label> labels) Creates new Label objects.
LabelPage	getLabelsByStatement(Statement filterStatement) Gets a LabelPage of Label objects that satisfy the given Statement.query.
UpdateResult	performLabelAction(LabelAction labelAction, Statement filterStatement) Performs actions on Label objects that match the given Statement.query.
List<Label>	updateLabels(List<Label> labels) Updates the specified Label objects.

Method Detail

createLabels

@RequestWrapper(localName="createLabels",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.LabelServiceInterfacecreateLabels")
 @ResponseWrapper(localName="createLabelsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.LabelServiceInterfacecreateLabelsResponse")
List<Label> createLabels(List<Label> labels)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Creates new Label objects.

Parameters:

labels - the labels to create

labels -

Returns:

the created labels with their IDs filled in

Throws:

ApiException_Exception

getLabelsByStatement

@RequestWrapper(localName="getLabelsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.LabelServiceInterfacegetLabelsByStatement")
 @ResponseWrapper(localName="getLabelsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.LabelServiceInterfacegetLabelsByStatementResponse")
LabelPage getLabelsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

Gets a LabelPage of Label objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	Label.id
type	Label#type
name	Label.name
description	Label.description
isActive	Label.isActive

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of labels.

filterStatement -

Returns:

the labels that match the given filter

Throws:

ApiException_Exception

performLabelAction

@RequestWrapper(localName="performLabelAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.LabelServiceInterfaceperformLabelAction")
 @ResponseWrapper(localName="performLabelActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.LabelServiceInterfaceperformLabelActionResponse")
UpdateResult performLabelAction(LabelAction labelAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           throws ApiException_Exception

Performs actions on Label objects that match the given Statement.query.

Parameters:

labelAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of labels

filterStatement -

labelAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateLabels

@RequestWrapper(localName="updateLabels",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.LabelServiceInterfaceupdateLabels")
 @ResponseWrapper(localName="updateLabelsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.LabelServiceInterfaceupdateLabelsResponse")
List<Label> updateLabels(List<Label> labels)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Updates the specified Label objects.

Parameters:

labels - the labels to update

labels -

Returns:

the updated labels

Throws:

ApiException_Exception