com.google.api.ads.admanager.axis.v202102.LabelServiceInterface Maven / Gradle / Ivy

Go to download
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * LabelServiceInterface.java
 *
 * This file was auto-generated from WSDL
 * by the Apache Axis 1.4 Mar 02, 2009 (07:08:06 PST) WSDL2Java emitter.
 */

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

public interface LabelServiceInterface extends java.rmi.Remote {

    /**
     * Creates new {@link Label} objects.
     *         
     *         
     * @param labels the labels to create
     *         
     * @return the created labels with their IDs filled in
     */
    public com.google.api.ads.admanager.axis.v202102.Label[] createLabels(com.google.api.ads.admanager.axis.v202102.Label[] labels) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202102.ApiException;

    /**
     * Gets a {@link LabelPage} of {@link Label} objects that satisfy
     * the
     *         given {@link Statement#query}. The following fields are supported
     * for
     *         filtering:
     *         
     *         
     *         
     *         
     * 
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         PQL Property  Object Property
{@code id} {@link Label#id}
{@code type} {@link Label#type}
{@code name} {@link Label#name}
{@code description} {@link Label#description}
{@code isActive} {@link Label#isActive}
     *         
     *         
     *         
     * @param filterStatement a Publisher Query Language statement used to
     * filter
     *         a set of labels.
     *         
     * @return the labels that match the given filter
     */
    public com.google.api.ads.admanager.axis.v202102.LabelPage getLabelsByStatement(com.google.api.ads.admanager.axis.v202102.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202102.ApiException;

    /**
     * Performs actions on {@link Label} objects that match the given
     * {@link Statement#query}.
     *         
     *         
     * @param labelAction the action to perform
     *         
     * @param filterStatement a Publisher Query Language statement used to
     * filter
     *         a set of labels
     *         
     * @return the result of the action performed
     */
    public com.google.api.ads.admanager.axis.v202102.UpdateResult performLabelAction(com.google.api.ads.admanager.axis.v202102.LabelAction labelAction, com.google.api.ads.admanager.axis.v202102.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202102.ApiException;

    /**
     * Updates the specified {@link Label} objects.
     *         
     *         
     * @param labels the labels to update
     *         
     * @return the updated labels
     */
    public com.google.api.ads.admanager.axis.v202102.Label[] updateLabels(com.google.api.ads.admanager.axis.v202102.Label[] labels) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202102.ApiException;
}
PQL Property	Object Property
{@code id}	{@link Label#id}
{@code type}	{@link Label#type}
{@code name}	{@link Label#name}
{@code description}	{@link Label#description}
{@code isActive}	{@link Label#isActive}