• Home
• com.google.api-ads
• dfp-axis
• 2.14.0
• source code
• UserServiceInterface.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.api.ads.dfp.axis.v201605.UserServiceInterface Maven / Gradle / Ivy

/**
 * UserServiceInterface.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.dfp.axis.v201605;

public interface UserServiceInterface extends java.rmi.Remote {

    /**
     * Creates new {@link User} objects.
     *         
     *         
     * @param users the users to create
     *         
     * @return the created users with their IDs filled in
     */
    public com.google.api.ads.dfp.axis.v201605.User[] createUsers(com.google.api.ads.dfp.axis.v201605.User[] users) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201605.ApiException;

    /**
     * Returns the {@link Role} objects that are defined for the users
     * of the
     *         network.
     *         
     *         
     * @return the roles defined for the user's network
     */
    public com.google.api.ads.dfp.axis.v201605.Role[] getAllRoles() throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201605.ApiException;

    /**
     * Returns the current {@link User}.
     *         
     *         
     * @return the current user
     */
    public com.google.api.ads.dfp.axis.v201605.User getCurrentUser() throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201605.ApiException;

    /**
     * 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 a Publisher Query Language statement used to
     * filter
     *         a set of users
     *         
     * @return the users that match the given filter
     */
    public com.google.api.ads.dfp.axis.v201605.UserPage getUsersByStatement(com.google.api.ads.dfp.axis.v201605.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201605.ApiException;

    /**
     * Performs actions on {@link User} objects that match the given
     * {@link Statement#query}.
     *         
     *         
     * @param userAction the action to perform
     *         
     * @param filterStatement a Publisher Query Language statement used to
     * filter
     *         a set of users
     *         
     * @return the result of the action performed
     */
    public com.google.api.ads.dfp.axis.v201605.UpdateResult performUserAction(com.google.api.ads.dfp.axis.v201605.UserAction userAction, com.google.api.ads.dfp.axis.v201605.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201605.ApiException;

    /**
     * Updates the specified {@link User} objects.
     *         
     *         
     * @param users the users to update
     *         
     * @return the updated users
     */
    public com.google.api.ads.dfp.axis.v201605.User[] updateUsers(com.google.api.ads.dfp.axis.v201605.User[] users) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201605.ApiException;
}