com.google.api.ads.admanager.jaxws.v202311.CompanyServiceInterface 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;


/**
 * 
 *       Provides operations for creating, updating and retrieving {@link Company} objects.
 *     
 * 
 * This class was generated by the JAX-WS RI.
 * JAX-WS RI 2.3.0.2
 * Generated source version: 2.1
 * 
 */
@WebService(name = "CompanyServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@XmlSeeAlso({
    ObjectFactory.class
})
public interface CompanyServiceInterface {


    /**
     * 
     *         Creates new {@link Company} objects.
     *       
     * 
     * @param companies
     * @return
     *     returns java.util.List
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
    @RequestWrapper(localName = "createCompanies", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.CompanyServiceInterfacecreateCompanies")
    @ResponseWrapper(localName = "createCompaniesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.CompanyServiceInterfacecreateCompaniesResponse")
    public List createCompanies(
        @WebParam(name = "companies", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
        List companies)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Gets a {@link CompanyPage} of {@link Company} objects that satisfy the given {@link
     *         Statement#query}. The following fields are supported for filtering:
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         PQL Property  Object Property
{@code id} {@link Company#id}
{@code name} {@link Company#name}
{@code type} {@link Company#type}
{@code lastModifiedDateTime} {@link Company#lastModifiedDateTime}
     *       
     * 
     * @param filterStatement
     * @return
     *     returns com.google.api.ads.admanager.jaxws.v202311.CompanyPage
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
    @RequestWrapper(localName = "getCompaniesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.CompanyServiceInterfacegetCompaniesByStatement")
    @ResponseWrapper(localName = "getCompaniesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.CompanyServiceInterfacegetCompaniesByStatementResponse")
    public CompanyPage getCompaniesByStatement(
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
        Statement filterStatement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Performs actions on {@link Company} objects that match the given {@code Statement}.
     *       
     * 
     * @param statement
     * @param companyAction
     * @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 = "performCompanyAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.CompanyServiceInterfaceperformCompanyAction")
    @ResponseWrapper(localName = "performCompanyActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.CompanyServiceInterfaceperformCompanyActionResponse")
    public UpdateResult performCompanyAction(
        @WebParam(name = "companyAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
        CompanyAction companyAction,
        @WebParam(name = "statement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
        Statement statement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Updates the specified {@link Company} objects.
     *       
     * 
     * @param companies
     * @return
     *     returns java.util.List
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
    @RequestWrapper(localName = "updateCompanies", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.CompanyServiceInterfaceupdateCompanies")
    @ResponseWrapper(localName = "updateCompaniesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.CompanyServiceInterfaceupdateCompaniesResponse")
    public List updateCompanies(
        @WebParam(name = "companies", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
        List companies)
        throws ApiException_Exception
    ;

}
PQL Property	Object Property
{@code id}	{@link Company#id}
{@code name}	{@link Company#name}
{@code type}	{@link Company#type}
{@code lastModifiedDateTime}	{@link Company#lastModifiedDateTime}