Reference documentation and code samples for the Google Shopping Css V1 Client class ListChildAccountsRequest.
The request message for the ListChildAccounts method.
Generated from protobuf message google.shopping.css.v1.ListChildAccountsRequest
Namespace
Google \ Shopping \ Css \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent account. Must be a CSS group or domain. Format: accounts/{account} |
↳ label_id |
int|string
If set, only the MC accounts with the given label ID will be returned. |
↳ full_name |
string
If set, only the MC accounts with the given name (case sensitive) will be returned. |
↳ page_size |
int
Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
↳ page_token |
string
Optional. A page token, received from a previous |
getParent
Required. The parent account. Must be a CSS group or domain.
Format: accounts/{account}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent account. Must be a CSS group or domain.
Format: accounts/{account}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabelId
If set, only the MC accounts with the given label ID will be returned.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasLabelId
clearLabelId
setLabelId
If set, only the MC accounts with the given label ID will be returned.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFullName
If set, only the MC accounts with the given name (case sensitive) will be returned.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasFullName
clearFullName
setFullName
If set, only the MC accounts with the given name (case sensitive) will be returned.
| 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 50 accounts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
| 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 50 accounts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. A page token, received from a previous ListChildAccounts call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListChildAccounts must
match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token, received from a previous ListChildAccounts call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListChildAccounts 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 account. Must be a CSS group or domain. Format: accounts/{account} Please see Google\Shopping\Css\V1\AccountsServiceClient::accountName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Css\V1\ListChildAccountsRequest |
|