com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterface 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 LiveStreamEvent} objects.
*
* This feature is only available for Ad Manager 360 networks. Publishers will need to be
* activated through the Video > Live streams tab in the Ad Manager UI. For access, apply
* through your account manager.
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.3.0.2
* Generated source version: 2.1
*
*/
@WebService(name = "LiveStreamEventServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@XmlSeeAlso({
ObjectFactory.class
})
public interface LiveStreamEventServiceInterface {
/**
*
* Creates new {@link LiveStreamEvent} objects.
*
*
The following fields are required:
*
*
* - {@link LiveStreamEvent#name}
*
- {@link LiveStreamEvent#startDateTime}
*
- {@link LiveStreamEvent#endDateTime}
*
- {@link LiveStreamEvent#contentUrls}
*
- {@link LiveStreamEvent#adTags}
*
*
*
* @param liveStreamEvents
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "createLiveStreamEvents", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfacecreateLiveStreamEvents")
@ResponseWrapper(localName = "createLiveStreamEventsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfacecreateLiveStreamEventsResponse")
public List createLiveStreamEvents(
@WebParam(name = "liveStreamEvents", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
List liveStreamEvents)
throws ApiException_Exception
;
/**
*
* Create new slates.
*
* A slate creative is served as backup content in a live stream event when no other creatives
* are eligible to be served.
*
*
* @param slates
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "createSlates", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfacecreateSlates")
@ResponseWrapper(localName = "createSlatesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfacecreateSlatesResponse")
public List createSlates(
@WebParam(name = "slates", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
List slates)
throws ApiException_Exception
;
/**
*
* Gets a {@link LiveStreamEventPage} of {@link LiveStreamEvent} objects that satisfy the given
* {@link Statement#query}. The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code id}
* {@link LiveStreamEvent#id}
*
*
* {@code slateCreativeId}
* {@link LiveStreamEvent#slateCreativeId}
*
*
* {@code assetKey}
* {@link LiveStreamEvent#assetKey}
*
*
* {@code streamCreateDaiAuthenticationKeyIds}
* {@link LiveStreamEvent#streamCreateDaiAuthenticationKeyIds}
*
*
* {@code dynamicAdInsertionType}
* {@link LiveStreamEvent#dynamicAdInsertionType}
*
*
* {@code streamingFormat}
* {@link LiveStreamEvent#streamingFormat}
*
*
* {@code customAssetKey}
* {@link LiveStreamEvent#customAssetKey}
*
*
* {@code daiEncodingProfileIds}
* {@link LiveStreamEvent#daiEncodingProfileIds}
*
*
* {@code segmentUrlAuthenticationKeyIds}
* {@link LiveStreamEvent#segmentUrlAuthenticationKeyIds}
*
*
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventPage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "getLiveStreamEventsByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfacegetLiveStreamEventsByStatement")
@ResponseWrapper(localName = "getLiveStreamEventsByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfacegetLiveStreamEventsByStatementResponse")
public LiveStreamEventPage getLiveStreamEventsByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Gets a {@link SlatePage} of {@link Slate} objects that satisfy the given {@link
* Statement#query}. The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code id}
* {@link Slate#id}
*
*
* {@code name}
* {@link Slate#name}
*
*
* {@code lastModifiedDateTime}
* {@link Slate#lastModifiedDateTime}
*
*
*
*
* @param statement
* @return
* returns com.google.api.ads.admanager.jaxws.v202405.SlatePage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "getSlatesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfacegetSlatesByStatement")
@ResponseWrapper(localName = "getSlatesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfacegetSlatesByStatementResponse")
public SlatePage getSlatesByStatement(
@WebParam(name = "statement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement statement)
throws ApiException_Exception
;
/**
*
* Performs actions on {@link LiveStreamEvent} objects that match the given {@link
* Statement#query}.
*
*
* @param liveStreamEventAction
* @param filterStatement
* @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 = "performLiveStreamEventAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfaceperformLiveStreamEventAction")
@ResponseWrapper(localName = "performLiveStreamEventActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfaceperformLiveStreamEventActionResponse")
public UpdateResult performLiveStreamEventAction(
@WebParam(name = "liveStreamEventAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
LiveStreamEventAction liveStreamEventAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Performs actions on slates that match the given {@link Statement}.
*
*
* @param filterStatement
* @param slateAction
* @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 = "performSlateAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfaceperformSlateAction")
@ResponseWrapper(localName = "performSlateActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfaceperformSlateActionResponse")
public UpdateResult performSlateAction(
@WebParam(name = "slateAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
SlateAction slateAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link LiveStreamEvent} objects.
*
*
* @param liveStreamEvents
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "updateLiveStreamEvents", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfaceupdateLiveStreamEvents")
@ResponseWrapper(localName = "updateLiveStreamEventsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfaceupdateLiveStreamEventsResponse")
public List updateLiveStreamEvents(
@WebParam(name = "liveStreamEvents", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
List liveStreamEvents)
throws ApiException_Exception
;
/**
*
* Update existing slates.
*
* Only the slateName is editable.
*
*
* @param slates
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "updateSlates", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfaceupdateSlates")
@ResponseWrapper(localName = "updateSlatesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.LiveStreamEventServiceInterfaceupdateSlatesResponse")
public List updateSlates(
@WebParam(name = "slates", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
List slates)
throws ApiException_Exception
;
}