com.google.api.ads.admanager.axis.v202311.CustomFieldServiceInterface 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.6.0

// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * 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.admanager.axis.v202311;

public interface CustomFieldServiceInterface extends java.rmi.Remote {

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

     *         {@link CustomFieldOption#displayName}
     *         
{@link CustomFieldOption#customFieldId}
     *         
     */
    public com.google.api.ads.admanager.axis.v202311.CustomFieldOption[] createCustomFieldOptions(com.google.api.ads.admanager.axis.v202311.CustomFieldOption[] customFieldOptions) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202311.ApiException;

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

     *         {@link CustomField#name}
     *         
{@link CustomField#entityType}
     *         
{@link CustomField#dataType}
     *         
{@link CustomField#visibility}
     *         
     */
    public com.google.api.ads.admanager.axis.v202311.CustomField[] createCustomFields(com.google.api.ads.admanager.axis.v202311.CustomField[] customFields) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202311.ApiException;

    /**
     * Returns the {@link CustomFieldOption} uniquely identified by
     * the given ID.
     */
    public com.google.api.ads.admanager.axis.v202311.CustomFieldOption getCustomFieldOption(java.lang.Long customFieldOptionId) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202311.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}
     */
    public com.google.api.ads.admanager.axis.v202311.CustomFieldPage getCustomFieldsByStatement(com.google.api.ads.admanager.axis.v202311.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202311.ApiException;

    /**
     * Performs actions on {@link CustomField} objects that match
     * the given {@link Statement#query}.
     */
    public com.google.api.ads.admanager.axis.v202311.UpdateResult performCustomFieldAction(com.google.api.ads.admanager.axis.v202311.CustomFieldAction customFieldAction, com.google.api.ads.admanager.axis.v202311.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202311.ApiException;

    /**
     * Updates the specified {@link CustomFieldOption} objects.
     */
    public com.google.api.ads.admanager.axis.v202311.CustomFieldOption[] updateCustomFieldOptions(com.google.api.ads.admanager.axis.v202311.CustomFieldOption[] customFieldOptions) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202311.ApiException;

    /**
     * Updates the specified {@link CustomField} objects.
     */
    public com.google.api.ads.admanager.axis.v202311.CustomField[] updateCustomFields(com.google.api.ads.admanager.axis.v202311.CustomField[] customFields) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202311.ApiException;
}

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}