• Home
• com.google.api-ads
• dfp-axis
• 2.14.0
• source code
• CustomFieldServiceInterface.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.v201605.CustomFieldServiceInterface Maven / Gradle / Ivy

/**
 * CustomFieldServiceInterface.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.v201605;

public interface CustomFieldServiceInterface extends java.rmi.Remote {

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

     *         
{@link CustomFieldOption#displayName}
     *         
{@link CustomFieldOption#customFieldId}
     *         
     *         
     *         
     * @param customFieldOptions the custom fields to create
     *         
     * @return the created custom field options with their IDs filled in
     */
    public com.google.api.ads.dfp.axis.v201605.CustomFieldOption[] createCustomFieldOptions(com.google.api.ads.dfp.axis.v201605.CustomFieldOption[] customFieldOptions) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201605.ApiException;

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

     *         
{@link CustomField#name}
     *         
{@link CustomField#entityType}
     *         
{@link CustomField#dataType}
     *         
{@link CustomField#visibility}
     *         
     *         
     *         
     * @param customFields the custom fields to create
     *         
     * @return the created custom fields with their IDs filled in
     */
    public com.google.api.ads.dfp.axis.v201605.CustomField[] createCustomFields(com.google.api.ads.dfp.axis.v201605.CustomField[] customFields) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201605.ApiException;

    /**
     * Returns the {@link CustomFieldOption} uniquely identified by
     * the given ID.
     *         
     *         
     * @param customFieldOptionId the ID of the custom field option, which
     * must already exist
     *         
     * @return the {@code CustomFieldOption} uniquely identified by the given
     * ID
     */
    public com.google.api.ads.dfp.axis.v201605.CustomFieldOption getCustomFieldOption(java.lang.Long customFieldOptionId) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201605.ApiException;

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

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

    /**
     * Updates the specified {@link CustomFieldOption} objects.
     *         
     *         
     * @param customFieldOptions the custom field options to update
     *         
     * @return the updated custom field options
     */
    public com.google.api.ads.dfp.axis.v201605.CustomFieldOption[] updateCustomFieldOptions(com.google.api.ads.dfp.axis.v201605.CustomFieldOption[] customFieldOptions) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201605.ApiException;

    /**
     * Updates the specified {@link CustomField} objects.
     *         
     *         
     * @param customFields the custom fields to update
     *         
     * @return the updated custom fields
     */
    public com.google.api.ads.dfp.axis.v201605.CustomField[] updateCustomFields(com.google.api.ads.dfp.axis.v201605.CustomField[] customFields) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201605.ApiException;
}