com.google.api.ads.dfp.axis.v201602.AdExclusionRuleServiceInterface 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

/**
 * AdExclusionRuleServiceInterface.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.v201602;

public interface AdExclusionRuleServiceInterface extends java.rmi.Remote {

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

    /**
     * Gets a {@link AdExclusionRulePage} of {@link AdExclusionRule}
     * objects that satisfy the
     *         given {@link Statement#query}.  The following fields are supported
     * for
     *         filtering:
     *         
     *         
     *         
     *         
     * 
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         PQL Property  Object Property
{@code id} {@link AdExclusionRule#id}
{@code name} {@link AdExclusionRule#name}
{@code status} {@link AdExclusionRule#status}
     *         
     *         
     * @param filterStatement a Publisher Query Language statement used to
     * filter
     *         a set of rules
     *         
     * @return the rules that match the given filter
     */
    public com.google.api.ads.dfp.axis.v201602.AdExclusionRulePage getAdExclusionRulesByStatement(com.google.api.ads.dfp.axis.v201602.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201602.ApiException;

    /**
     * Performs action on {@link AdExclusionRule} objects that satisfy
     * the
     *         given {@link Statement#query}.
     *         
     *         
     * @param adExclusionRuleAction the action to perform
     *         
     * @param filterStatement a Publisher Query Language statement used to
     * filter
     *         a set of ad exclusion rules
     *         
     * @return the result of the action performed
     */
    public com.google.api.ads.dfp.axis.v201602.UpdateResult performAdExclusionRuleAction(com.google.api.ads.dfp.axis.v201602.AdExclusionRuleAction adExclusionRuleAction, com.google.api.ads.dfp.axis.v201602.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201602.ApiException;

    /**
     * Updates the specified {@link AdExclusionRule} objects.
     *         
     *         
     * @param adExclusionRules the ad exclusion rules to update
     *         
     * @return the updated rules
     */
    public com.google.api.ads.dfp.axis.v201602.AdExclusionRule[] updateAdExclusionRules(com.google.api.ads.dfp.axis.v201602.AdExclusionRule[] adExclusionRules) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201602.ApiException;
}

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