PHP Class UserService, googleads-php-lib

Afficher le fichier Open project: googleads/googleads-php-lib Class Usage Examples

Méthodes publiques

Свойство Type Description
$classmap array Default class map for wsdl=>php
$endpoint string The endpoint of the service

Méthodes publiques

Méthode Description
__construct ( string $wsdl, array $options, $user ) Constructor using wsdl location and options array
createUsers ( $users ) : the Creates new {@link User} objects.
getAllRoles ( ) : the Returns the {@link Role} objects that are defined for the users of the network.
getCurrentUser ( ) : the Returns the current {@link User}.
getUsersByStatement ( $filterStatement ) : the Gets a {@link UserPage} of {@link User} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:
performUserAction ( $userAction, $filterStatement ) : the Performs actions on {@link User} objects that match the given {@link Statement#query}.
updateUsers ( $users ) : the Updates the specified {@link User} objects.

Method Details

__construct() public méthode

Constructor using wsdl location and options array
public __construct ( string $wsdl, array $options, $user )
$wsdl string WSDL location for this service
$options array Options for the SoapClient

createUsers() public méthode

Creates new {@link User} objects.
public createUsers ( $users ) : the
Résultat the created users with their IDs filled in

getAllRoles() public méthode

Returns the {@link Role} objects that are defined for the users of the network.
public getAllRoles ( ) : the
Résultat the roles defined for the user's network

getCurrentUser() public méthode

Returns the current {@link User}.
public getCurrentUser ( ) : the
Résultat the current user

getUsersByStatement() public méthode

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
public getUsersByStatement ( $filterStatement ) : the
Résultat the users that match the given filter

performUserAction() public méthode

Performs actions on {@link User} objects that match the given {@link Statement#query}.
public performUserAction ( $userAction, $filterStatement ) : the
Résultat the result of the action performed

updateUsers() public méthode

Updates the specified {@link User} objects.
public updateUsers ( $users ) : the
Résultat the updated users

Property Details

$classmap public_oe static_oe property

Default class map for wsdl=>php
public static array $classmap
Résultat array

$endpoint public_oe static_oe property

The endpoint of the service
public static string $endpoint
Résultat string