com.google.api.ads.dfp.axis.v201511.AdRuleServiceInterface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dfp-axis Show documentation

Ad Manager specific Axis components.

There is a newer version: 5.8.0

/**
 * AdRuleServiceInterface.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.dfp.axis.v201511;

public interface AdRuleServiceInterface extends java.rmi.Remote {

    /**
     * Creates new {@link AdRule} objects.
     *         
     *         
     * @param adRules the ad rules to create
     *         
     * @return the created ad rules with their IDs filled in
     */
    public com.google.api.ads.dfp.axis.v201511.AdRule[] createAdRules(com.google.api.ads.dfp.axis.v201511.AdRule[] adRules) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201511.ApiException;

    /**
     * Gets an {@link AdRulePage} of {@link AdRule} objects that satisfy
     * the given
     *         {@link Statement#query}. The following fields are supported
     * for filtering:
     *         
     *         
     *         
     *         
     * 
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         PQL Property  Object Property
{@code id} {@link AdRule#id}
{@code name} {@link AdRule#name}
{@code priority} {@link AdRule#priority}
{@code status} {@link AdRule#status}
     *         
     *         
     * @param filterStatement a Publisher Query Language statement used to
     * filter
     *         a set of ad rules
     *         
     * @return the ad rules that match the given filter
     *         
     * @throws ApiException if the ID of the active network does not exist
     * or
     *         there is a backend error
     */
    public com.google.api.ads.dfp.axis.v201511.AdRulePage getAdRulesByStatement(com.google.api.ads.dfp.axis.v201511.Statement statement) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201511.ApiException;

    /**
     * Performs actions on {@link AdRule} objects that match the given
     * {@link Statement#query}.
     *         
     *         
     * @param adRuleAction the action to perform
     *         
     * @param filterStatement a Publisher Query Language statement used to
     * filter
     *         a set of ad rules
     *         
     * @return the result of the action performed
     */
    public com.google.api.ads.dfp.axis.v201511.UpdateResult performAdRuleAction(com.google.api.ads.dfp.axis.v201511.AdRuleAction adRuleAction, com.google.api.ads.dfp.axis.v201511.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201511.ApiException;

    /**
     * Updates the specified {@link AdRule} objects.
     *         
     *         
     * @param adRules the ad rules to update
     *         
     * @return the updated ad rules
     *         
     * @throws ApiException if there is an error updating the ad rules
     */
    public com.google.api.ads.dfp.axis.v201511.AdRule[] updateAdRules(com.google.api.ads.dfp.axis.v201511.AdRule[] adRules) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201511.ApiException;
}

PQL Property	Object Property
{@code id}	{@link AdRule#id}
{@code name}	{@link AdRule#name}
{@code priority}	{@link AdRule#priority}
{@code status}	{@link AdRule#status}