com.google.api.ads.admanager.jaxws.v202405.ProposalServiceInterface Maven / Gradle / Ivy
Show all versions of dfp-appengine Show documentation
// 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.
package com.google.api.ads.admanager.jaxws.v202405;
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 methods for adding, updating and retrieving {@link Proposal} objects.
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.3.0.2
* Generated source version: 2.1
*
*/
@WebService(name = "ProposalServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@XmlSeeAlso({
ObjectFactory.class
})
public interface ProposalServiceInterface {
/**
*
* Creates new {@link Proposal} objects.
*
* For each proposal, the following fields are required:
*
*
* - {@link Proposal#name}
*
*
*
* @param proposals
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "createProposals", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.ProposalServiceInterfacecreateProposals")
@ResponseWrapper(localName = "createProposalsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.ProposalServiceInterfacecreateProposalsResponse")
public List createProposals(
@WebParam(name = "proposals", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
List proposals)
throws ApiException_Exception
;
/**
*
* 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
* @return
* returns com.google.api.ads.admanager.jaxws.v202405.MarketplaceCommentPage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "getMarketplaceCommentsByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.ProposalServiceInterfacegetMarketplaceCommentsByStatement")
@ResponseWrapper(localName = "getMarketplaceCommentsByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.ProposalServiceInterfacegetMarketplaceCommentsByStatementResponse")
public MarketplaceCommentPage getMarketplaceCommentsByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* 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 isProgrammatic}
* {@link Proposal#isProgrammatic}
*
*
*
* {@code negotiationStatus}
* Only applicable for programmatic proposals
*
* {@link ProposalMarketplaceInfo#negotiationStatus}
*
*
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202405.ProposalPage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "getProposalsByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.ProposalServiceInterfacegetProposalsByStatement")
@ResponseWrapper(localName = "getProposalsByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.ProposalServiceInterfacegetProposalsByStatementResponse")
public ProposalPage getProposalsByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* 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 filterStatement
* @param proposalAction
* @return
* returns com.google.api.ads.admanager.jaxws.v202405.UpdateResult
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "performProposalAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.ProposalServiceInterfaceperformProposalAction")
@ResponseWrapper(localName = "performProposalActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.ProposalServiceInterfaceperformProposalActionResponse")
public UpdateResult performProposalAction(
@WebParam(name = "proposalAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
ProposalAction proposalAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link Proposal} objects.
*
*
* @param proposals
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "updateProposals", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.ProposalServiceInterfaceupdateProposals")
@ResponseWrapper(localName = "updateProposalsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.ProposalServiceInterfaceupdateProposalsResponse")
public List updateProposals(
@WebParam(name = "proposals", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
List proposals)
throws ApiException_Exception
;
}