Documentation

Google_Service_Partners_Resource_Users extends Google_Service_Resource
in package

The "users" collection of methods.

Typical usage is: $partnersService = new Google_Service_Partners(...); $users = $partnersService->users;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createCompanyRelation()  : Google_Service_Partners_CompanyRelation
Creates a user's company relation. Affiliates the user to a company.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
deleteCompanyRelation()  : Google_Service_Partners_PartnersEmpty
Deletes a user's company relation. Unaffiliaites the user from a company.
get()  : Google_Service_Partners_User
Gets a user. (users.get)
updateProfile()  : Google_Service_Partners_UserProfile
Updates a user's profile. A user can only update their own profile and should only be called within the context of a logged in user. (users.updateProfile)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createCompanyRelation()

Creates a user's company relation. Affiliates the user to a company.

public createCompanyRelation(string $userId, Google_Service_Partners_CompanyRelation $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Partners_CompanyRelation

(users.createCompanyRelation)

Parameters
$userId : string

The ID of the user. Can be set to me to mean the currently authenticated user.

$postBody : Google_Service_Partners_CompanyRelation
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestMetadata.partnersSessionId Google Partners session ID.

opt_param

string requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID.

opt_param

string requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

opt_param

string requestMetadata.locale Locale to use for the current request.

opt_param

string requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address.

opt_param

string requestMetadata.experimentIds Experiment IDs the current request belongs to.

opt_param

string requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

Return values
Google_Service_Partners_CompanyRelation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

deleteCompanyRelation()

Deletes a user's company relation. Unaffiliaites the user from a company.

public deleteCompanyRelation(string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Partners_PartnersEmpty

(users.deleteCompanyRelation)

Parameters
$userId : string

The ID of the user. Can be set to me to mean the currently authenticated user.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestMetadata.locale Locale to use for the current request.

opt_param

string requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address.

opt_param

string requestMetadata.experimentIds Experiment IDs the current request belongs to.

opt_param

string requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

opt_param

string requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID.

opt_param

string requestMetadata.partnersSessionId Google Partners session ID.

opt_param

string requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

Return values
Google_Service_Partners_PartnersEmpty —

get()

Gets a user. (users.get)

public get(string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Partners_User
Parameters
$userId : string

Identifier of the user. Can be set to me to mean the currently authenticated user.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID.

opt_param

string requestMetadata.partnersSessionId Google Partners session ID.

opt_param

string userView Specifies what parts of the user information to return.

opt_param

string requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

opt_param

string requestMetadata.locale Locale to use for the current request.

opt_param

string requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address.

opt_param

string requestMetadata.experimentIds Experiment IDs the current request belongs to.

opt_param

string requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

Return values
Google_Service_Partners_User —

updateProfile()

Updates a user's profile. A user can only update their own profile and should only be called within the context of a logged in user. (users.updateProfile)

public updateProfile(Google_Service_Partners_UserProfile $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Partners_UserProfile
Parameters
$postBody : Google_Service_Partners_UserProfile
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestMetadata.locale Locale to use for the current request.

opt_param

string requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address.

opt_param

string requestMetadata.experimentIds Experiment IDs the current request belongs to.

opt_param

string requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

opt_param

string requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID.

opt_param

string requestMetadata.partnersSessionId Google Partners session ID.

opt_param

string requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

Return values
Google_Service_Partners_UserProfile —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results