com.google.api.ads.dfp.axis.v201306

Interface LabelServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

LabelServiceSoapBindingStub

public interface LabelServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
Label	createLabel(Label label) Creates a new Label.
Label[]	createLabels(Label[] labels) Creates new Label objects.
Label	getLabel(Long labelId) Returns the Label uniquely identified by the given ID.
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.
Label	updateLabel(Label label) Updates the specified Label.
Label[]	updateLabels(Label[] labels) Updates the specified Label objects.

Method Detail

createLabel

Label createLabel(Label label)
                  throws RemoteException,
                         ApiException

Creates a new Label. The following fields are required:

• Label.name
• Label#type

Parameters:

label - the label to create

Returns:

the label with its ID filled in

Throws:

RemoteException

ApiException

createLabels

Label[] createLabels(Label[] labels)
                     throws RemoteException,
                            ApiException

Creates new Label objects.

Parameters:

labels - the labels to create

Returns:

the created labels with their IDs filled in

Throws:

RemoteException

ApiException

getLabel

Label getLabel(Long labelId)
               throws RemoteException,
                      ApiException

Returns the Label uniquely identified by the given ID.

Parameters:

labelId - the ID of the label, which must already exist

Returns:

the Label uniquely identified by the given ID

Throws:

RemoteException

ApiException

getLabelsByStatement

LabelPage getLabelsByStatement(Statement filterStatement)
                               throws RemoteException,
                                      ApiException

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.

Returns:

the labels that match the given filter

Throws:

RemoteException

ApiException

performLabelAction

UpdateResult performLabelAction(LabelAction labelAction,
                              Statement filterStatement)
                                throws RemoteException,
                                       ApiException

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateLabel

Label updateLabel(Label label)
                  throws RemoteException,
                         ApiException

Updates the specified Label.

Parameters:

label - the label to update

Returns:

the updated label

Throws:

RemoteException

ApiException

updateLabels

Label[] updateLabels(Label[] labels)
                     throws RemoteException,
                            ApiException

Updates the specified Label objects.

Parameters:

labels - the labels to update

Returns:

the updated labels

Throws:

RemoteException

ApiException