com.google.api.ads.admanager.axis.v202008

Interface LabelServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

LabelServiceSoapBindingStub

public interface LabelServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
Label[]	createLabels(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.
Label[]	updateLabels(Label[] labels) Updates the specified Label objects.

Method Detail

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

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

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