Google Shopping Merchant Accounts V1 Client - Class ListAccountRelationshipsRequest (1.0.0)

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

Request to list account relationships.

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

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent account of the account relationship to filter by. Format: accounts/{account}

↳ page_token string

Optional. The token returned by the previous list request.

↳ page_size int

Optional. The maximum number of elements to return in the response. Use for paging. If no page_size is specified, 100 is used as the default value. The maximum allowed value is 1000.

getParent

Required. The parent account of the account relationship to filter by.

Format: accounts/{account}

Returns
Type Description
string

setParent

Required. The parent account of the account relationship to filter by.

Format: accounts/{account}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageToken

Optional. The token returned by the previous list request.

Returns
Type Description
string

setPageToken

Optional. The token returned by the previous list request.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of elements to return in the response. Use for paging. If no page_size is specified, 100 is used as the default value.

The maximum allowed value is 1000.

Returns
Type Description
int

setPageSize

Optional. The maximum number of elements to return in the response. Use for paging. If no page_size is specified, 100 is used as the default value.

The maximum allowed value is 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent account of the account relationship to filter by. Format: accounts/{account} Please see AccountRelationshipsServiceClient::accountName() for help formatting this field.

Returns
Type Description
ListAccountRelationshipsRequest