com.google.api.ads.admanager.jaxws.v202402.LineItemServiceInterface 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.v202402;
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 LineItem} objects.
*
* Line items define the campaign. For example, line items define:
*
*
* - a budget
*
- a span of time to run
*
- ad unit targeting
*
*
* In short, line items connect all of the elements of an ad campaign.
*
*
Line items and creatives can be associated with each other through {@link
* LineItemCreativeAssociation} objects. An ad unit will host a creative through both this
* association and the {@link LineItem#targeting} to it. The delivery of a line item depends on its
* priority. More information on line item priorities can be found on the Ad Manager Help Center.
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.3.0.2
* Generated source version: 2.1
*
*/
@WebService(name = "LineItemServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@XmlSeeAlso({
ObjectFactory.class
})
public interface LineItemServiceInterface {
/**
*
* Creates new {@link LineItem} objects.
*
*
* @param lineItems
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "createLineItems", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.LineItemServiceInterfacecreateLineItems")
@ResponseWrapper(localName = "createLineItemsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.LineItemServiceInterfacecreateLineItemsResponse")
public List createLineItems(
@WebParam(name = "lineItems", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
List lineItems)
throws ApiException_Exception
;
/**
*
* Gets a {@link LineItemPage} of {@link LineItem} objects that satisfy the given {@link
* Statement#query}. The following fields are supported for filtering:
*
*
*
*
* PQL property
* Entity property
*
*
*
* {@code CostType}
*
*
* {@link LineItem#costType}
*
*
*
*
* {@code CreationDateTime}
*
*
* {@link LineItem#creationDateTime}
*
*
*
*
* {@code DeliveryRateType}
*
*
* {@link LineItem#deliveryRateType}
*
*
*
*
* {@code EndDateTime}
*
*
* {@link LineItem#endDateTime}
*
*
*
*
* {@code ExternalId}
*
*
* {@link LineItem#externalId}
*
*
*
*
* {@code Id}
*
*
* {@link LineItem#id}
*
*
*
*
* {@code IsMissingCreatives}
*
*
* {@link LineItem#isMissingCreatives}
*
*
*
*
* {@code IsSetTopBoxEnabled}
*
*
* {@link LineItem#isSetTopBoxEnabled}
*
*
*
*
* {@code LastModifiedDateTime}
*
*
* {@link LineItem#lastModifiedDateTime}
*
*
*
*
* {@code LineItemType}
*
*
* {@link LineItem#lineItemType}
*
*
*
*
* {@code Name}
*
*
* {@link LineItem#name}
*
*
*
*
* {@code OrderId}
*
*
* {@link LineItem#orderId}
*
*
*
*
* {@code StartDateTime}
*
*
* {@link LineItem#startDateTime}
*
*
*
*
* {@code Status}
*
*
* {@link LineItem#status}
*
*
*
*
* {@code UnitsBought}
*
*
* {@link LineItem#unitsBought}
*
*
*
*
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202402.LineItemPage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "getLineItemsByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.LineItemServiceInterfacegetLineItemsByStatement")
@ResponseWrapper(localName = "getLineItemsByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.LineItemServiceInterfacegetLineItemsByStatementResponse")
public LineItemPage getLineItemsByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Performs actions on {@link LineItem} objects that match the given {@link Statement#query}.
*
*
* @param filterStatement
* @param lineItemAction
* @return
* returns com.google.api.ads.admanager.jaxws.v202402.UpdateResult
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "performLineItemAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.LineItemServiceInterfaceperformLineItemAction")
@ResponseWrapper(localName = "performLineItemActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.LineItemServiceInterfaceperformLineItemActionResponse")
public UpdateResult performLineItemAction(
@WebParam(name = "lineItemAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
LineItemAction lineItemAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link LineItem} objects.
*
*
* @param lineItems
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "updateLineItems", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.LineItemServiceInterfaceupdateLineItems")
@ResponseWrapper(localName = "updateLineItemsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.LineItemServiceInterfaceupdateLineItemsResponse")
public List updateLineItems(
@WebParam(name = "lineItems", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
List lineItems)
throws ApiException_Exception
;
}