com.google.api.ads.admanager.jaxws.v202402.UserServiceInterface 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.v202402;
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 User} objects.
*
* A user is assigned one of several different roles. Each {@link Role} type has a unique ID that
* is used to identify that role in an organization. Role types and their IDs can be retrieved by
* invoking {@link #getAllRoles}.
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.3.0.2
* Generated source version: 2.1
*
*/
@WebService(name = "UserServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@XmlSeeAlso({
ObjectFactory.class
})
public interface UserServiceInterface {
/**
*
* Creates new {@link User} objects.
*
*
* @param users
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "createUsers", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.UserServiceInterfacecreateUsers")
@ResponseWrapper(localName = "createUsersResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.UserServiceInterfacecreateUsersResponse")
public List createUsers(
@WebParam(name = "users", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
List users)
throws ApiException_Exception
;
/**
*
* Returns the {@link Role} objects that are defined for the users of the network.
*
*
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "getAllRoles", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.UserServiceInterfacegetAllRoles")
@ResponseWrapper(localName = "getAllRolesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.UserServiceInterfacegetAllRolesResponse")
public List getAllRoles()
throws ApiException_Exception
;
/**
*
* Returns the current {@link User}.
*
*
* @return
* returns com.google.api.ads.admanager.jaxws.v202402.User
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "getCurrentUser", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.UserServiceInterfacegetCurrentUser")
@ResponseWrapper(localName = "getCurrentUserResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.UserServiceInterfacegetCurrentUserResponse")
public User getCurrentUser()
throws ApiException_Exception
;
/**
*
* Gets a {@link UserPage} of {@link User} objects that satisfy the given {@link Statement#query}.
* The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code email}
* {@link User#email}
*
*
* {@code id}
* {@link User#id}
*
*
* {@code name}
* {@link User#name}
*
*
* {@code roleId}
* {@link User#roleId}
*
*
* {@code rolename}
* {@link User#roleName}
*
*
* {@code status}
* {@code ACTIVE} if {@link User#isActive} is true; {@code INACTIVE}
* otherwise
*
*
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202402.UserPage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "getUsersByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.UserServiceInterfacegetUsersByStatement")
@ResponseWrapper(localName = "getUsersByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.UserServiceInterfacegetUsersByStatementResponse")
public UserPage getUsersByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Performs actions on {@link User} objects that match the given {@link Statement#query}.
*
*
* @param userAction
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202402.UpdateResult
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "performUserAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.UserServiceInterfaceperformUserAction")
@ResponseWrapper(localName = "performUserActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.UserServiceInterfaceperformUserActionResponse")
public UpdateResult performUserAction(
@WebParam(name = "userAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
UserAction userAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link User} objects.
*
*
* @param users
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "updateUsers", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.UserServiceInterfaceupdateUsers")
@ResponseWrapper(localName = "updateUsersResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.UserServiceInterfaceupdateUsersResponse")
public List updateUsers(
@WebParam(name = "users", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
List users)
throws ApiException_Exception
;
}