com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterface 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 AdRule} objects.
*
* Ad rules contain data that the ad server uses to generate a playlist of video ads.
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.3.0.2
* Generated source version: 2.1
*
*/
@WebService(name = "AdRuleServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@XmlSeeAlso({
ObjectFactory.class
})
public interface AdRuleServiceInterface {
/**
*
* Creates new {@link AdRule} objects.
*
*
* @param adRules
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "createAdRules", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfacecreateAdRules")
@ResponseWrapper(localName = "createAdRulesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfacecreateAdRulesResponse")
public List createAdRules(
@WebParam(name = "adRules", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
List adRules)
throws ApiException_Exception
;
/**
*
* Creates new {@link AdSpot} objects.
*
*
* @param adSpots
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "createAdSpots", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfacecreateAdSpots")
@ResponseWrapper(localName = "createAdSpotsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfacecreateAdSpotsResponse")
public List createAdSpots(
@WebParam(name = "adSpots", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
List adSpots)
throws ApiException_Exception
;
/**
*
* Creates new {@link breakTemplate} objects.
*
*
* @param breakTemplate
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "createBreakTemplates", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfacecreateBreakTemplates")
@ResponseWrapper(localName = "createBreakTemplatesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfacecreateBreakTemplatesResponse")
public List createBreakTemplates(
@WebParam(name = "breakTemplate", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
List breakTemplate)
throws ApiException_Exception
;
/**
*
* Gets an {@link AdRulePage} of {@link AdRule} objects that satisfy the given {@link
* Statement#query}. The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code id}
* {@link AdRule#id} ({@link AdRule#adRuleId} beginning in v201702)
*
*
* {@code name}
* {@link AdRule#name}
*
*
* {@code priority}
* {@link AdRule#priority}
*
*
* {@code status}
* {@link AdRule#status}
*
*
*
* @param statement
* @return
* returns com.google.api.ads.admanager.jaxws.v202402.AdRulePage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "getAdRulesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfacegetAdRulesByStatement")
@ResponseWrapper(localName = "getAdRulesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfacegetAdRulesByStatementResponse")
public AdRulePage getAdRulesByStatement(
@WebParam(name = "statement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
Statement statement)
throws ApiException_Exception
;
/**
*
* Gets a {@link AdSpotPage} of {@link AdSpot} objects that satisfy the given {@link
* Statement#query}.
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202402.AdSpotPage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "getAdSpotsByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfacegetAdSpotsByStatement")
@ResponseWrapper(localName = "getAdSpotsByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfacegetAdSpotsByStatementResponse")
public AdSpotPage getAdSpotsByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Gets a {@link BreakTemplatePage} of {@link BreakTemplate} objects that satisfy the given {@link
* Statement#query}.
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202402.BreakTemplatePage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "getBreakTemplatesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfacegetBreakTemplatesByStatement")
@ResponseWrapper(localName = "getBreakTemplatesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfacegetBreakTemplatesByStatementResponse")
public BreakTemplatePage getBreakTemplatesByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Performs actions on {@link AdRule} objects that match the given {@link Statement#query}.
*
*
* @param filterStatement
* @param adRuleAction
* @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 = "performAdRuleAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfaceperformAdRuleAction")
@ResponseWrapper(localName = "performAdRuleActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfaceperformAdRuleActionResponse")
public UpdateResult performAdRuleAction(
@WebParam(name = "adRuleAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
AdRuleAction adRuleAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link AdRule} objects.
*
*
* @param adRules
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "updateAdRules", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfaceupdateAdRules")
@ResponseWrapper(localName = "updateAdRulesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfaceupdateAdRulesResponse")
public List updateAdRules(
@WebParam(name = "adRules", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
List adRules)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link AdSpot} objects.
*
*
* @param adSpots
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "updateAdSpots", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfaceupdateAdSpots")
@ResponseWrapper(localName = "updateAdSpotsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfaceupdateAdSpotsResponse")
public List updateAdSpots(
@WebParam(name = "adSpots", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
List adSpots)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link breakTemplate} objects.
*
*
* @param breakTemplate
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "updateBreakTemplates", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfaceupdateBreakTemplates")
@ResponseWrapper(localName = "updateBreakTemplatesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.AdRuleServiceInterfaceupdateBreakTemplatesResponse")
public List updateBreakTemplates(
@WebParam(name = "breakTemplate", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
List breakTemplate)
throws ApiException_Exception
;
}