com.google.api.ads.admanager.jaxws.v202405.InventoryServiceInterface 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 operations for creating, updating and retrieving {@link AdUnit} objects.
*
* Line items connect a creative with its associated ad unit through targeting.
*
*
An ad unit represents a piece of inventory within a publisher. It contains all the settings
* that need to be associated with the inventory in order to serve ads. For example, the ad unit
* contains creative size restrictions and AdSense settings.
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.3.0.2
* Generated source version: 2.1
*
*/
@WebService(name = "InventoryServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@XmlSeeAlso({
ObjectFactory.class
})
public interface InventoryServiceInterface {
/**
*
* Creates new {@link AdUnit} objects.
*
*
* @param adUnits
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "createAdUnits", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.CreateAdUnits")
@ResponseWrapper(localName = "createAdUnitsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.CreateAdUnitsResponse")
public List createAdUnits(
@WebParam(name = "adUnits", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
List adUnits)
throws ApiException_Exception
;
/**
*
* Returns a set of all relevant {@link AdUnitSize} objects.
*
* The given {@link Statement} is currently ignored but may be honored in future versions.
*
*
* @param filterStatement
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "getAdUnitSizesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.GetAdUnitSizesByStatement")
@ResponseWrapper(localName = "getAdUnitSizesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.GetAdUnitSizesByStatementResponse")
public List getAdUnitSizesByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Gets a {@link AdUnitPage} of {@link AdUnit} objects that satisfy the given {@link
* Statement#query}. The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code adUnitCode}
* {@link AdUnit#adUnitCode}
*
*
* {@code id}
* {@link AdUnit#id}
*
*
* {@code name}
* {@link AdUnit#name}
*
*
* {@code parentId}
* {@link AdUnit#parentId}
*
*
* {@code status}
* {@link AdUnit#status}
*
*
* {@code lastModifiedDateTime}
* {@link AdUnit#lastModifiedDateTime}
*
*
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202405.AdUnitPage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "getAdUnitsByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.GetAdUnitsByStatement")
@ResponseWrapper(localName = "getAdUnitsByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.GetAdUnitsByStatementResponse")
public AdUnitPage getAdUnitsByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Performs actions on {@link AdUnit} objects that match the given {@link Statement#query}.
*
*
* @param filterStatement
* @param adUnitAction
* @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 = "performAdUnitAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.PerformAdUnitAction")
@ResponseWrapper(localName = "performAdUnitActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.PerformAdUnitActionResponse")
public UpdateResult performAdUnitAction(
@WebParam(name = "adUnitAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
AdUnitAction adUnitAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link AdUnit} objects.
*
*
* @param adUnits
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "updateAdUnits", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.UpdateAdUnits")
@ResponseWrapper(localName = "updateAdUnitsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.UpdateAdUnitsResponse")
public List updateAdUnits(
@WebParam(name = "adUnits", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
List adUnits)
throws ApiException_Exception
;
}