com.google.api.ads.admanager.jaxws.v202311.SiteServiceInterface Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dfp-appengine Show documentation
Ad Manager specific AppEngine components.
The newest version!
// 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;


/**
 * This class was generated by the JAX-WS RI.
 * JAX-WS RI 2.3.0.2
 * Generated source version: 2.1
 * 
 */
@WebService(name = "SiteServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@XmlSeeAlso({
    ObjectFactory.class
})
public interface SiteServiceInterface {


    /**
     * 
     *         Creates new {@link Site} objects.
     *       
     * 
     * @param sites
     * @return
     *     returns java.util.List
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
    @RequestWrapper(localName = "createSites", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.SiteServiceInterfacecreateSites")
    @ResponseWrapper(localName = "createSitesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.SiteServiceInterfacecreateSitesResponse")
    public List createSites(
        @WebParam(name = "sites", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
        List sites)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Gets a {@link SitePage} of {@link Site} objects that satisfy the given {@link Statement#query}.
     *         The following fields are supported for filtering:
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         PQL Property  Object Property
{@code id} {@link Site#id}
{@code url} {@link Site#url}
{@code childNetworkCode} {@link Site#childNetworkCode}
{@code approvalStatus} {@link Site#approvalStatus}
{@code active} {@link Site#active}
{@code lastModifiedApprovalStatusDateTime} 
     *         
     *         Restriction: The {@code lastModifiedApprovalStatusDateTime} PQL property can only be used in a
     *         top-level expression scoping the {@code filterStatement} to {@link Site}s whose {@code
     *         approvalStatus} was modified on or after a specified date and time. (e.x. {@code "WHERE
     *         lastModifiedApprovalStatusDateTime >= '2022-01-01T00:00:00'"}).
     *       
     * 
     * @param filterStatement
     * @return
     *     returns com.google.api.ads.admanager.jaxws.v202311.SitePage
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
    @RequestWrapper(localName = "getSitesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.SiteServiceInterfacegetSitesByStatement")
    @ResponseWrapper(localName = "getSitesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.SiteServiceInterfacegetSitesByStatementResponse")
    public SitePage getSitesByStatement(
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
        Statement filterStatement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Performs actions on {@link Site} objects that match the given {@link Statement#query}.
     *       
     * 
     * @param filterStatement
     * @param siteAction
     * @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 = "performSiteAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.SiteServiceInterfaceperformSiteAction")
    @ResponseWrapper(localName = "performSiteActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.SiteServiceInterfaceperformSiteActionResponse")
    public UpdateResult performSiteAction(
        @WebParam(name = "siteAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
        SiteAction siteAction,
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
        Statement filterStatement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Updates the specified {@link Site} objects.
     *         
     *         The {@link Site#childNetworkCode} can be updated in order to 1) change the child network, 2)
     *         move a site from O&O to represented, or 3) move a site from represented to O&O.
     *       
     * 
     * @param sites
     * @return
     *     returns java.util.List
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
    @RequestWrapper(localName = "updateSites", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.SiteServiceInterfaceupdateSites")
    @ResponseWrapper(localName = "updateSitesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.SiteServiceInterfaceupdateSitesResponse")
    public List updateSites(
        @WebParam(name = "sites", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
        List sites)
        throws ApiException_Exception
    ;

}
PQL Property	Object Property
{@code id}	{@link Site#id}
{@code url}	{@link Site#url}
{@code childNetworkCode}	{@link Site#childNetworkCode}
{@code approvalStatus}	{@link Site#approvalStatus}
{@code active}	{@link Site#active}
{@code lastModifiedApprovalStatusDateTime}