• Home
• com.google.api-ads
• dfp-axis
• 2.14.0
• source code
• CustomTargetingServiceInterface.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.api.ads.dfp.axis.v201508.CustomTargetingServiceInterface Maven / Gradle / Ivy

/**
 * CustomTargetingServiceInterface.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.v201508;

public interface CustomTargetingServiceInterface extends java.rmi.Remote {

    /**
     * Creates new {@link CustomTargetingKey} objects.
     *         
     *         The following fields are required:
     *         

     *         
{@link CustomTargetingKey#name}
     *         
{@link CustomTargetingKey#type}
     *         
     *         
     *         
     * @param keys the custom targeting keys to update
     *         
     * @return the updated custom targeting keys
     */
    public com.google.api.ads.dfp.axis.v201508.CustomTargetingKey[] createCustomTargetingKeys(com.google.api.ads.dfp.axis.v201508.CustomTargetingKey[] keys) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201508.ApiException;

    /**
     * Creates new {@link CustomTargetingValue} objects.
     *         
     *         The following fields are required:
     *         

     *         
{@link CustomTargetingValue#customTargetingKeyId}
     * 
{@link CustomTargetingValue#name}
     *         
     *         
     *         
     * @param values the custom targeting values to update
     *         
     * @return the updated custom targeting keys
     */
    public com.google.api.ads.dfp.axis.v201508.CustomTargetingValue[] createCustomTargetingValues(com.google.api.ads.dfp.axis.v201508.CustomTargetingValue[] values) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201508.ApiException;

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

    /**
     * Gets a {@link CustomTargetingValuePage} of {@link CustomTargetingValue}
     * objects that satisfy the given {@link Statement#query}.
     *         

     *         The {@code WHERE} clause in the {@link Statement#query} must
     * always contain
     *         {@link CustomTargetingValue#customTargetingKeyId} as one of
     * its columns in
     *         a way that it is AND'ed with the rest of the query. So, if
     * you want to
     *         retrieve values for a known set of key ids, valid {@link Statement#query}
     * would look like:
     *         
     *         

     *         

     *         "WHERE customTargetingKeyId IN ('17','18','19')" retrieves
     * all values that
     *         are associated with keys having ids 17, 18, 19.
     *         
     *         

     *         "WHERE customTargetingKeyId = '17' AND name = 'red'" retrieves
     * values that
     *         are associated with keys having id 17 and value name is 'red'.
     * 
     *         
     *         

     *         

     *         The following fields are supported for filtering:
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     * 
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
PQL Property
Object Property
{@code id}
{@link CustomTargetingValue#id}
{@code customTargetingKeyId}
{@link CustomTargetingValue#customTargetingKeyId}
{@code name}
{@link CustomTargetingValue#name}
{@code displayName}
{@link CustomTargetingValue#displayName}
{@code matchType}
{@link CustomTargetingValue#matchType}
     *         
     *         
     * @param filterStatement a Publisher Query Language statement used to
     * filter
     *         a set of custom targeting values
     *         
     * @return the custom targeting values that match the given filter
     */
    public com.google.api.ads.dfp.axis.v201508.CustomTargetingValuePage getCustomTargetingValuesByStatement(com.google.api.ads.dfp.axis.v201508.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201508.ApiException;

    /**
     * Performs actions on {@link CustomTargetingKey} objects that
     * match the given
     *         {@link Statement#query}.
     *         
     *         
     * @param customTargetingKeyAction the action to perform
     *         
     * @param filterStatement a Publisher Query Language statement used to
     * filter
     *         a set of custom targeting keys
     *         
     * @return the result of the action performed
     */
    public com.google.api.ads.dfp.axis.v201508.UpdateResult performCustomTargetingKeyAction(com.google.api.ads.dfp.axis.v201508.CustomTargetingKeyAction customTargetingKeyAction, com.google.api.ads.dfp.axis.v201508.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201508.ApiException;

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

    /**
     * Updates the specified {@link CustomTargetingKey} objects.
     *         
     *         
     * @param keys the custom targeting keys to update
     *         
     * @return the updated custom targeting keys
     */
    public com.google.api.ads.dfp.axis.v201508.CustomTargetingKey[] updateCustomTargetingKeys(com.google.api.ads.dfp.axis.v201508.CustomTargetingKey[] keys) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201508.ApiException;

    /**
     * Updates the specified {@link CustomTargetingValue} objects.
     * 
     *         
     * @param values the custom targeting values to update
     *         
     * @return the updated custom targeting values
     */
    public com.google.api.ads.dfp.axis.v201508.CustomTargetingValue[] updateCustomTargetingValues(com.google.api.ads.dfp.axis.v201508.CustomTargetingValue[] values) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201508.ApiException;
}