com.google.api.ads.admanager.axis.v202108.LiveStreamEventServiceInterface Maven / Gradle / Ivy
// Copyright 2021 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.
/**
* LiveStreamEventServiceInterface.java
*
* This file was auto-generated from WSDL
* by the Apache Axis 1.4 Mar 02, 2009 (07:08:06 PST) WSDL2Java emitter.
*/
package com.google.api.ads.admanager.axis.v202108;
public interface LiveStreamEventServiceInterface extends java.rmi.Remote {
/**
* 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 the live stream events to create
*
* @return the created live stream events with their IDs filled in
*/
public com.google.api.ads.admanager.axis.v202108.LiveStreamEvent[] createLiveStreamEvents(com.google.api.ads.admanager.axis.v202108.LiveStreamEvent[] liveStreamEvents) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202108.ApiException;
/**
* 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 list of slate objects to create.
*
* @throws ApiException if there is an error while fetching the logging
* information
*/
public com.google.api.ads.admanager.axis.v202108.Slate[] createSlates(com.google.api.ads.admanager.axis.v202108.Slate[] slates) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202108.ApiException;
/**
* 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 a Publisher Query Language statement to filter
* a
* list of live stream events
*
* @return the live stream events that match the filter
*/
public com.google.api.ads.admanager.axis.v202108.LiveStreamEventPage getLiveStreamEventsByStatement(com.google.api.ads.admanager.axis.v202108.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202108.ApiException;
/**
* 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 a Publisher Query Language statement used to filter
* slates
*
* @return the slates that match the given filter
*/
public com.google.api.ads.admanager.axis.v202108.SlatePage getSlatesByStatement(com.google.api.ads.admanager.axis.v202108.Statement statement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202108.ApiException;
/**
* Performs actions on {@link LiveStreamEvent} objects that match
* the given
* {@link Statement#query}.
*
*
* @param liveStreamEventAction the action to perform
*
* @param filterStatement a Publisher Query Language statement used to
* filter
* a set of live stream events
*
* @return the result of the action performed
*/
public com.google.api.ads.admanager.axis.v202108.UpdateResult performLiveStreamEventAction(com.google.api.ads.admanager.axis.v202108.LiveStreamEventAction liveStreamEventAction, com.google.api.ads.admanager.axis.v202108.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202108.ApiException;
/**
* Performs actions on slates that match the given {@link Statement}.
*
*
* @param slateAction the action to perform
*
* @param filterStatement a Publisher Query Language statement used to
* filter a set of slates
*
* @return the result of the action performed
*/
public com.google.api.ads.admanager.axis.v202108.UpdateResult performSlateAction(com.google.api.ads.admanager.axis.v202108.SlateAction slateAction, com.google.api.ads.admanager.axis.v202108.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202108.ApiException;
/**
* Updates the specified {@link LiveStreamEvent} objects.
*
*
* @param liveStreamEvents the live stream events to update
*
* @return the updated live stream events
*
* @throws ApiException if there is an error updating the live stream
* events
*/
public com.google.api.ads.admanager.axis.v202108.LiveStreamEvent[] updateLiveStreamEvents(com.google.api.ads.admanager.axis.v202108.LiveStreamEvent[] liveStreamEvents) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202108.ApiException;
/**
* Update existing slates.
*
* Only the slateName is editable.
*
*
* @param slates list of slate objects to update.
*
* @throws ApiException if there is an error while fetching the logging
* information
*/
public com.google.api.ads.admanager.axis.v202108.Slate[] updateSlates(com.google.api.ads.admanager.axis.v202108.Slate[] slates) throws java.rmi.RemoteException, com.google.api.ads.admanager.axis.v202108.ApiException;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy