com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterface Maven / Gradle / Ivy
Show all versions of dfp-appengine Show documentation
// Copyright 2023 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.v202311;
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 ForecastAdjustment}s and {@link
* TrafficForecastSegment}s.
*
* Forecast adjustments allow editing the volume and traffic composition of forecasted inventory.
* Traffic forecast segments divide forecasted inventory into segments to which forecast adjustments
* can be applied.
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.3.0.2
* Generated source version: 2.1
*
*/
@WebService(name = "AdjustmentServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@XmlSeeAlso({
ObjectFactory.class
})
public interface AdjustmentServiceInterface {
/**
*
* Takes a prospective forecast adjustment and calculates the daily ad opportunity counts
* corresponding to its provided volume settings.
*
*
* @param forecastAdjustment
* @return
* returns com.google.api.ads.admanager.jaxws.v202311.ForecastAdjustment
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@RequestWrapper(localName = "calculateDailyAdOpportunityCounts", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfacecalculateDailyAdOpportunityCounts")
@ResponseWrapper(localName = "calculateDailyAdOpportunityCountsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfacecalculateDailyAdOpportunityCountsResponse")
public ForecastAdjustment calculateDailyAdOpportunityCounts(
@WebParam(name = "forecastAdjustment", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
ForecastAdjustment forecastAdjustment)
throws ApiException_Exception
;
/**
*
* Creates new {@link ForecastAdjustment} objects.
*
*
* @param forecastAdjustments
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@RequestWrapper(localName = "createForecastAdjustments", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfacecreateForecastAdjustments")
@ResponseWrapper(localName = "createForecastAdjustmentsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfacecreateForecastAdjustmentsResponse")
public List createForecastAdjustments(
@WebParam(name = "forecastAdjustments", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
List forecastAdjustments)
throws ApiException_Exception
;
/**
*
* Creates new {@link TrafficForecastSegment} objects.
*
*
* @param trafficForecastSegments
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@RequestWrapper(localName = "createTrafficForecastSegments", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfacecreateTrafficForecastSegments")
@ResponseWrapper(localName = "createTrafficForecastSegmentsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfacecreateTrafficForecastSegmentsResponse")
public List createTrafficForecastSegments(
@WebParam(name = "trafficForecastSegments", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
List trafficForecastSegments)
throws ApiException_Exception
;
/**
*
* Gets a {@link ForecastAdjustmentPage} of {@link ForecastAdjustment} objects that satisfy the
* given {@link Statement#query}.
*
* The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code id}
* {@link ForecastAdjustment#id}
*
*
* {@code trafficForecastSegmentId}
* {@link ForecastAdjustment#trafficForecastSegmentId}
*
*
* {@code name}
* {@link ForecastAdjustment#name}
*
*
* {@code startDate}
* {@link ForecastAdjustment#startDate}
*
*
* {@code endDate}
* {@link ForecastAdjustment#endDate}
*
*
* {@code status}
* {@link ForecastAdjustment#status}
*
*
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202311.ForecastAdjustmentPage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@RequestWrapper(localName = "getForecastAdjustmentsByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfacegetForecastAdjustmentsByStatement")
@ResponseWrapper(localName = "getForecastAdjustmentsByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfacegetForecastAdjustmentsByStatementResponse")
public ForecastAdjustmentPage getForecastAdjustmentsByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Gets a {@link TrafficForecastSegmentPage} of {@link TrafficForecastSegment} objects that
* satisfy the given {@link Statement#query}.
*
* The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code id}
* {@link TrafficForecastSegment#id}
*
*
* {@code name}
* {@link TrafficForecastSegment#name}
*
*
* {@code creationTime}
* {@link TrafficForecastSegment#creationTime}
*
*
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202311.TrafficForecastSegmentPage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@RequestWrapper(localName = "getTrafficForecastSegmentsByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfacegetTrafficForecastSegmentsByStatement")
@ResponseWrapper(localName = "getTrafficForecastSegmentsByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfacegetTrafficForecastSegmentsByStatementResponse")
public TrafficForecastSegmentPage getTrafficForecastSegmentsByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Performs actions on {@link ForecastAdjustment} objects that match the given {@link
* Statement#query}.
*
*
* @param forecastAdjustmentAction
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202311.UpdateResult
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@RequestWrapper(localName = "performForecastAdjustmentAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfaceperformForecastAdjustmentAction")
@ResponseWrapper(localName = "performForecastAdjustmentActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfaceperformForecastAdjustmentActionResponse")
public UpdateResult performForecastAdjustmentAction(
@WebParam(name = "forecastAdjustmentAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
ForecastAdjustmentAction forecastAdjustmentAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link ForecastAdjustment} objects.
*
*
* @param forecastAdjustments
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@RequestWrapper(localName = "updateForecastAdjustments", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfaceupdateForecastAdjustments")
@ResponseWrapper(localName = "updateForecastAdjustmentsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfaceupdateForecastAdjustmentsResponse")
public List updateForecastAdjustments(
@WebParam(name = "forecastAdjustments", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
List forecastAdjustments)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link TrafficForecastSegment} objects.
*
*
* @param trafficForecastSegments
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@RequestWrapper(localName = "updateTrafficForecastSegments", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfaceupdateTrafficForecastSegments")
@ResponseWrapper(localName = "updateTrafficForecastSegmentsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.AdjustmentServiceInterfaceupdateTrafficForecastSegmentsResponse")
public List updateTrafficForecastSegments(
@WebParam(name = "trafficForecastSegments", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
List trafficForecastSegments)
throws ApiException_Exception
;
}