com.google.api.ads.admanager.jaxws.v202405.OrderServiceInterface 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 creating, updating and retrieving {@link Order} objects.
*
* An order is a grouping of {@link LineItem} objects. Line items have a many-to-one relationship
* with orders, meaning each line item can belong to only one order, but orders can have multiple
* line items. An order can be used to manage the line items it contains.
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.3.0.2
* Generated source version: 2.1
*
*/
@WebService(name = "OrderServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@XmlSeeAlso({
ObjectFactory.class
})
public interface OrderServiceInterface {
/**
*
* Creates new {@link Order} objects.
*
*
* @param orders
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "createOrders", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.OrderServiceInterfacecreateOrders")
@ResponseWrapper(localName = "createOrdersResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.OrderServiceInterfacecreateOrdersResponse")
public List createOrders(
@WebParam(name = "orders", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
List orders)
throws ApiException_Exception
;
/**
*
* Gets an {@link OrderPage} of {@link Order} objects that satisfy the given {@link
* Statement#query}. The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code advertiserId}
* {@link Order#advertiserId}
*
*
* {@code endDateTime}
* {@link Order#endDateTime}
*
*
* {@code id}
* {@link Order#id}
*
*
* {@code name}
* {@link Order#name}
*
*
* {@code salespersonId}
* {@link Order#salespersonId}
*
*
* {@code startDateTime}
* {@link Order#startDateTime}
*
*
* {@code status}
* {@link Order#status}
*
*
* {@code traffickerId}
* {@link Order#traffickerId}
*
*
* {@code lastModifiedDateTime}
* {@link Order#lastModifiedDateTime}
*
*
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202405.OrderPage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "getOrdersByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.OrderServiceInterfacegetOrdersByStatement")
@ResponseWrapper(localName = "getOrdersByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.OrderServiceInterfacegetOrdersByStatementResponse")
public OrderPage getOrdersByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Performs actions on {@link Order} objects that match the given {@link Statement#query}.
*
*
* @param filterStatement
* @param orderAction
* @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 = "performOrderAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.OrderServiceInterfaceperformOrderAction")
@ResponseWrapper(localName = "performOrderActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.OrderServiceInterfaceperformOrderActionResponse")
public UpdateResult performOrderAction(
@WebParam(name = "orderAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
OrderAction orderAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link Order} objects.
*
*
* @param orders
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "updateOrders", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.OrderServiceInterfaceupdateOrders")
@ResponseWrapper(localName = "updateOrdersResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.OrderServiceInterfaceupdateOrdersResponse")
public List updateOrders(
@WebParam(name = "orders", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
List orders)
throws ApiException_Exception
;
}