Reference documentation and code samples for the Google Shopping Merchant Accounts V1 Client class ListSubAccountsRequest.
Request message for the ListSubAccounts method.
Generated from protobuf message google.shopping.merchant.accounts.v1.ListSubAccountsRequest
Namespace
Google \ Shopping \ Merchant \ Accounts \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ provider |
string
Required. The aggregation service provider. Format: |
↳ page_size |
int
Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. |
↳ page_token |
string
Optional. A page token, received from a previous |
getProvider
Required. The aggregation service provider.
Format: accounts/{accountId}
| Returns | |
|---|---|
| Type | Description |
string |
|
setProvider
Required. The aggregation service provider.
Format: accounts/{accountId}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned.
The maximum value is 500; values above 500 are coerced to 500.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned.
The maximum value is 500; values above 500 are coerced to 500.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. A page token, received from a previous accounts.list call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided in the accounts.list
request must match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token, received from a previous accounts.list call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided in the accounts.list
request must match the call that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
provider |
string
Required. The aggregation service provider.
Format: |
| Returns | |
|---|---|
| Type | Description |
ListSubAccountsRequest |
|