• Home
• com.google.api-ads
• dfp-appengine
• 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.jaxws.v201505.CustomTargetingServiceInterface Maven / Gradle / Ivy

package com.google.api.ads.dfp.jaxws.v201505;

import java.util.List;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.ws.RequestWrapper;
import javax.xml.ws.ResponseWrapper;


/**
 * 
 *       Provides operations for creating, updating and retrieving
 *       {@link CustomTargetingKey} and {@link CustomTargetingValue} objects.
 *     
 * 
 * This class was generated by the JAX-WS RI.
 * JAX-WS RI 2.2.9-b130926.1035
 * Generated source version: 2.1
 * 
 */
@WebService(name = "CustomTargetingServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
@XmlSeeAlso({
    ObjectFactory.class
})
public interface CustomTargetingServiceInterface {


    /**
     * 
     *         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
     *       
     * 
     * @param keys
     * @return
     *     returns java.util.List
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
    @RequestWrapper(localName = "createCustomTargetingKeys", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfacecreateCustomTargetingKeys")
    @ResponseWrapper(localName = "createCustomTargetingKeysResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfacecreateCustomTargetingKeysResponse")
    public List createCustomTargetingKeys(
        @WebParam(name = "keys", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
        List keys)
        throws ApiException_Exception
    ;

    /**
     * 
     *         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
     *       
     * 
     * @param values
     * @return
     *     returns java.util.List
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
    @RequestWrapper(localName = "createCustomTargetingValues", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfacecreateCustomTargetingValues")
    @ResponseWrapper(localName = "createCustomTargetingValuesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfacecreateCustomTargetingValuesResponse")
    public List createCustomTargetingValues(
        @WebParam(name = "values", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
        List values)
        throws ApiException_Exception
    ;

    /**
     * 
     *         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
     *       
     * 
     * @param filterStatement
     * @return
     *     returns com.google.api.ads.dfp.jaxws.v201505.CustomTargetingKeyPage
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
    @RequestWrapper(localName = "getCustomTargetingKeysByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfacegetCustomTargetingKeysByStatement")
    @ResponseWrapper(localName = "getCustomTargetingKeysByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfacegetCustomTargetingKeysByStatementResponse")
    public CustomTargetingKeyPage getCustomTargetingKeysByStatement(
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
        Statement filterStatement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         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
     *       
     * 
     * @param filterStatement
     * @return
     *     returns com.google.api.ads.dfp.jaxws.v201505.CustomTargetingValuePage
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
    @RequestWrapper(localName = "getCustomTargetingValuesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfacegetCustomTargetingValuesByStatement")
    @ResponseWrapper(localName = "getCustomTargetingValuesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfacegetCustomTargetingValuesByStatementResponse")
    public CustomTargetingValuePage getCustomTargetingValuesByStatement(
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
        Statement filterStatement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         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
     *       
     * 
     * @param filterStatement
     * @param customTargetingKeyAction
     * @return
     *     returns com.google.api.ads.dfp.jaxws.v201505.UpdateResult
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
    @RequestWrapper(localName = "performCustomTargetingKeyAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfaceperformCustomTargetingKeyAction")
    @ResponseWrapper(localName = "performCustomTargetingKeyActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfaceperformCustomTargetingKeyActionResponse")
    public UpdateResult performCustomTargetingKeyAction(
        @WebParam(name = "customTargetingKeyAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
        CustomTargetingKeyAction customTargetingKeyAction,
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
        Statement filterStatement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         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
     *       
     * 
     * @param filterStatement
     * @param customTargetingValueAction
     * @return
     *     returns com.google.api.ads.dfp.jaxws.v201505.UpdateResult
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
    @RequestWrapper(localName = "performCustomTargetingValueAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfaceperformCustomTargetingValueAction")
    @ResponseWrapper(localName = "performCustomTargetingValueActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfaceperformCustomTargetingValueActionResponse")
    public UpdateResult performCustomTargetingValueAction(
        @WebParam(name = "customTargetingValueAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
        CustomTargetingValueAction customTargetingValueAction,
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
        Statement filterStatement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Updates the specified {@link CustomTargetingKey} objects.
     *         
     *         @param keys the custom targeting keys to update
     *         @return the updated custom targeting keys
     *       
     * 
     * @param keys
     * @return
     *     returns java.util.List
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
    @RequestWrapper(localName = "updateCustomTargetingKeys", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfaceupdateCustomTargetingKeys")
    @ResponseWrapper(localName = "updateCustomTargetingKeysResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfaceupdateCustomTargetingKeysResponse")
    public List updateCustomTargetingKeys(
        @WebParam(name = "keys", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
        List keys)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Updates the specified {@link CustomTargetingValue} objects.
     *         
     *         @param values the custom targeting values to update
     *         @return the updated custom targeting values
     *       
     * 
     * @param values
     * @return
     *     returns java.util.List
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
    @RequestWrapper(localName = "updateCustomTargetingValues", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfaceupdateCustomTargetingValues")
    @ResponseWrapper(localName = "updateCustomTargetingValuesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.CustomTargetingServiceInterfaceupdateCustomTargetingValuesResponse")
    public List updateCustomTargetingValues(
        @WebParam(name = "values", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
        List values)
        throws ApiException_Exception
    ;

}