Google Shopping Merchant Accounts V1beta Client - Class ListUsersRequest (0.2.0)

Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class ListUsersRequest.

Request message for the ListUsers method.

Generated from protobuf message google.shopping.merchant.accounts.v1beta.ListUsersRequest

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The parent, which owns this collection of users. Format: `accounts/{account}`
`↳ page_size`	`int` Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100
`↳ page_token`	`string` Optional. A page token, received from a previous `ListUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUsers` must match the call that provided the page token.

getParent

Required. The parent, which owns this collection of users.

Format: accounts/{account}

Returns
Type	Description
`string`

setParent

Required. The parent, which owns this collection of users.

Format: accounts/{account}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned.

The maximum value is 100; values above 100 will be coerced to 100

Returns
Type	Description
`int`

setPageSize

Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned.

The maximum value is 100; values above 100 will be coerced to 100

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

Optional. A page token, received from a previous ListUsers call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUsers must match the call that provided the page token.

Returns
Type	Description
`string`

setPageToken

Optional. A page token, received from a previous ListUsers call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUsers must match the call that provided the page token.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. The parent, which owns this collection of users. Format: `accounts/{account}` Please see Google\Shopping\Merchant\Accounts\V1beta\UserServiceClient::accountName() for help formatting this field.

Returns
Type	Description
`Google\Shopping\Merchant\Accounts\V1beta\ListUsersRequest`