• Home
• com.google.api-ads
• dfp-axis
• 4.16.0
• source code
• ProposalServiceInterface.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.v202111.ProposalServiceInterface Maven / Gradle / Ivy

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

/**
 * ProposalServiceInterface.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.v202111;

public interface ProposalServiceInterface extends java.rmi.Remote {

    /**
     * Creates new {@link Proposal} objects.
     *         
     *         For each proposal, the following fields are required:
     *         

     *         
{@link Proposal#name}
     *         
     *         
     *         
     * @param proposals the proposals to create
     *         
     * @return the created proposals with their IDs filled in
     */
    public com.google.api.ads.admanager.axis.v202111.Proposal[] createProposals(com.google.api.ads.admanager.axis.v202111.Proposal[] proposals) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202111.ApiException;

    /**
     * Gets a {@link MarketplaceCommentPage} of {@link MarketplaceComment}
     * objects that satisfy the
     *         given {@link Statement#query}. This method only returns comments
     * already sent to Marketplace,
     *         local draft {@link ProposalMarketplaceInfo#marketplaceComment}
     * are not included. The following
     *         fields are supported for filtering:
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
PQL Property
Object Property
{@code proposalId}
{@link MarketplaceComment#proposalId}
     *         
     *         The query must specify a {@code proposalId}, and only supports
     * a subset of PQL syntax:

     *         [WHERE  {AND  ...}]

     * [ORDER BY  [ASC | DESC]]

     *         [LIMIT {[,] } | { OFFSET }]

     * 
     *         


     *              :=  = 

     *  :=  IN 

     *         Only supports {@code ORDER BY} {@link MarketplaceComment#creationTime}.
     * 
     *         
     * @param filterStatement a Publisher Query Language statement used to
     * filter a set of marketplace
     *         comments
     *         
     * @return the marketplace comments that match the given filter
     */
    public com.google.api.ads.admanager.axis.v202111.MarketplaceCommentPage getMarketplaceCommentsByStatement(com.google.api.ads.admanager.axis.v202111.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202111.ApiException;

    /**
     * Gets a {@link ProposalPage} of {@link Proposal} objects that
     * satisfy the given
     *         {@link Statement#query}. The following fields are supported
     * for filtering:
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     * 
     *         
PQL Property
Object Property
{@code id}
{@link Proposal#id}
{@code dfpOrderId}
{@link Proposal#dfpOrderId}
{@code name}
{@link Proposal#name}
{@code status}
{@link Proposal#status}
{@code isArchived}
{@link Proposal#isArchived}

     *         {@code approvalStatus}
     *         
Only applicable for proposals using
     * sales management
     *         
{@link Proposal#approvalStatus}
{@code lastModifiedDateTime}
{@link Proposal#lastModifiedDateTime}

     *         {@code thirdPartyAdServerId}
     *         

     *         Only applicable for non-programmatic proposals using sales
     * management
     *         
     *         
{@link Proposal#thirdPartyAdServerId}

     *         {@code customThirdPartyAdServerName}
     *         

     *         Only applicable for non-programmatic proposals using sales
     * management
     *         
     *         
{@link Proposal#customThirdPartyAdServerName}
{@code hasOfflineErrors}
{@link Proposal#hasOfflineErrors}
{@code isProgrammatic}
{@link Proposal#isProgrammatic}

     *         {@code negotiationStatus}
     *         
Only applicable for programmatic proposals
     * 
{@link ProposalMarketplaceInfo#negotiationStatus}
     *         
     *         
     * @param filterStatement a Publisher Query Language statement used to
     * filter
     *         a set of proposals
     *         
     * @return the proposals that match the given filter
     */
    public com.google.api.ads.admanager.axis.v202111.ProposalPage getProposalsByStatement(com.google.api.ads.admanager.axis.v202111.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202111.ApiException;

    /**
     * Performs actions on {@link Proposal} objects that match the
     * given {@link Statement#query}.
     *         
     *         The following fields are also required when submitting proposals
     * for approval:
     *         

     *         
{@link Proposal#advertiser}
     *         
{@link Proposal#primarySalesperson}
     *         
{@link Proposal#primaryTraffickerId}
     *         
     *         
     *         
     * @param proposalAction the action to perform
     *         
     * @param filterStatement a Publisher Query Language statement used to
     * filter a set of proposals
     *         
     * @return the result of the action performed
     */
    public com.google.api.ads.admanager.axis.v202111.UpdateResult performProposalAction(com.google.api.ads.admanager.axis.v202111.ProposalAction proposalAction, com.google.api.ads.admanager.axis.v202111.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202111.ApiException;

    /**
     * Updates the specified {@link Proposal} objects.
     *         
     *         
     * @param proposals the proposals to update
     *         
     * @return the updated proposals
     */
    public com.google.api.ads.admanager.axis.v202111.Proposal[] updateProposals(com.google.api.ads.admanager.axis.v202111.Proposal[] proposals) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202111.ApiException;
}