• Home
• com.google.api-ads
• dfp-axis
• 5.6.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.admanager.axis.v202408.CustomTargetingServiceInterface Maven / Gradle / Ivy

// Copyright 2024 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.

/**
 * CustomTargetingServiceInterface.java
 *
 * This file was auto-generated from WSDL
 * by the Apache Axis 1.4.1-SNAPSHOT Mar 20, 2024 (11:59:10 PDT) WSDL2Java emitter.
 */

package com.google.api.ads.admanager.axis.v202408;

public interface CustomTargetingServiceInterface extends java.rmi.Remote {

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

     *         
{@link CustomTargetingKey#name}
     *         
{@link CustomTargetingKey#type}
     *         
     */
    public com.google.api.ads.admanager.axis.v202408.CustomTargetingKey[] createCustomTargetingKeys(com.google.api.ads.admanager.axis.v202408.CustomTargetingKey[] keys) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202408.ApiException;

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

     *         
{@link CustomTargetingValue#customTargetingKeyId}
     *         
{@link CustomTargetingValue#name}
     *         
     */
    public com.google.api.ads.admanager.axis.v202408.CustomTargetingValue[] createCustomTargetingValues(com.google.api.ads.admanager.axis.v202408.CustomTargetingValue[] values) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202408.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}
     */
    public com.google.api.ads.admanager.axis.v202408.CustomTargetingKeyPage getCustomTargetingKeysByStatement(com.google.api.ads.admanager.axis.v202408.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202408.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}
     */
    public com.google.api.ads.admanager.axis.v202408.CustomTargetingValuePage getCustomTargetingValuesByStatement(com.google.api.ads.admanager.axis.v202408.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202408.ApiException;

    /**
     * Performs actions on {@link CustomTargetingKey} objects that
     * match the given {@link
     *         Statement#query}.
     */
    public com.google.api.ads.admanager.axis.v202408.UpdateResult performCustomTargetingKeyAction(com.google.api.ads.admanager.axis.v202408.CustomTargetingKeyAction customTargetingKeyAction, com.google.api.ads.admanager.axis.v202408.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202408.ApiException;

    /**
     * Performs actions on {@link CustomTargetingValue} objects that
     * match the given {@link
     *         Statement#query}.
     */
    public com.google.api.ads.admanager.axis.v202408.UpdateResult performCustomTargetingValueAction(com.google.api.ads.admanager.axis.v202408.CustomTargetingValueAction customTargetingValueAction, com.google.api.ads.admanager.axis.v202408.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202408.ApiException;

    /**
     * Updates the specified {@link CustomTargetingKey} objects.
     */
    public com.google.api.ads.admanager.axis.v202408.CustomTargetingKey[] updateCustomTargetingKeys(com.google.api.ads.admanager.axis.v202408.CustomTargetingKey[] keys) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202408.ApiException;

    /**
     * Updates the specified {@link CustomTargetingValue} objects.
     */
    public com.google.api.ads.admanager.axis.v202408.CustomTargetingValue[] updateCustomTargetingValues(com.google.api.ads.admanager.axis.v202408.CustomTargetingValue[] values) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202408.ApiException;
}