com.google.api.ads.admanager.jaxws.v202405.CreativeServiceInterface 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 adding, updating and retrieving {@link Creative} objects.
*
* For a creative to run, it must be associated with a {@link LineItem} managed by the {@link
* LineItemCreativeAssociationService}.
*
*
Read more about creatives on the Ad Manager Help Center.
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.3.0.2
* Generated source version: 2.1
*
*/
@WebService(name = "CreativeServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@XmlSeeAlso({
ObjectFactory.class
})
public interface CreativeServiceInterface {
/**
*
* Creates new {@link Creative} objects.
*
*
* @param creatives
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "createCreatives", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.CreativeServiceInterfacecreateCreatives")
@ResponseWrapper(localName = "createCreativesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.CreativeServiceInterfacecreateCreativesResponse")
public List createCreatives(
@WebParam(name = "creatives", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
List creatives)
throws ApiException_Exception
;
/**
*
* Gets a {@link CreativePage} of {@link Creative} objects that satisfy the given {@link
* Statement#query}. The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code id}
* {@link Creative#id}
*
*
* {@code name}
* {@link Creative#name}
*
*
* {@code advertiserId}
* {@link Creative#advertiserId}
*
*
* {@code width}
* {@link Creative#size}
*
*
* {@code height}
* {@link Creative#size}
*
*
* {@code lastModifiedDateTime}
* {@link Creative#lastModifiedDateTime}
*
*
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202405.CreativePage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "getCreativesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.CreativeServiceInterfacegetCreativesByStatement")
@ResponseWrapper(localName = "getCreativesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.CreativeServiceInterfacegetCreativesByStatementResponse")
public CreativePage getCreativesByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Performs action on {@link Creative} objects that match the given {@link Statement#query}.
*
*
* @param filterStatement
* @param creativeAction
* @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 = "performCreativeAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.CreativeServiceInterfaceperformCreativeAction")
@ResponseWrapper(localName = "performCreativeActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.CreativeServiceInterfaceperformCreativeActionResponse")
public UpdateResult performCreativeAction(
@WebParam(name = "creativeAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
CreativeAction creativeAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link Creative} objects.
*
*
* @param creatives
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
@RequestWrapper(localName = "updateCreatives", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.CreativeServiceInterfaceupdateCreatives")
@ResponseWrapper(localName = "updateCreativesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405", className = "com.google.api.ads.admanager.jaxws.v202405.CreativeServiceInterfaceupdateCreativesResponse")
public List updateCreatives(
@WebParam(name = "creatives", targetNamespace = "https://www.google.com/apis/ads/publisher/v202405")
List creatives)
throws ApiException_Exception
;
}