Google Shopping Merchant Accounts V1 Client - Class User (0.10.0)

Reference documentation and code samples for the Google Shopping Merchant Accounts V1 Client class User.

The User message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see Frequently asked questions about people and access levels.

Generated from protobuf message google.shopping.merchant.accounts.v1.User

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name of the user. Format: accounts/{account}/user/{email} Use me to refer to your own email address, for example accounts/{account}/users/me.

↳ state int

Output only. The state of the user.

↳ access_rights array

Required. The access rights the user has.

getName

Identifier. The resource name of the user.

Format: accounts/{account}/user/{email} Use me to refer to your own email address, for example accounts/{account}/users/me.

Returns
Type Description
string

setName

Identifier. The resource name of the user.

Format: accounts/{account}/user/{email} Use me to refer to your own email address, for example accounts/{account}/users/me.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The state of the user.

Returns
Type Description
int

setState

Output only. The state of the user.

Parameter
Name Description
var int
Returns
Type Description
$this

getAccessRights

Required. The access rights the user has.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAccessRights

Required. The access rights the user has.

Parameter
Name Description
var int[]
Returns
Type Description
$this