Reference documentation and code samples for the Google Shopping Merchant Reports V1beta Client class SearchRequest.
Request message for the ReportService.Search method.
Generated from protobuf message google.shopping.merchant.reports.v1beta.SearchRequest
Namespace
Google \ Shopping \ Merchant \ Reports \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account} |
↳ query |
string
Required. Query that defines a report to be retrieved. For details on how to construct your query, see the Query Language guide. For the full list of available tables and fields, see the Available fields. |
↳ page_size |
int
Optional. Number of |
↳ page_token |
string
Optional. Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from |
getParent
Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuery
Required. Query that defines a report to be retrieved.
For details on how to construct your query, see the Query Language guide. For the full list of available tables and fields, see the Available fields.
| Returns | |
|---|---|
| Type | Description |
string |
|
setQuery
Required. Query that defines a report to be retrieved.
For details on how to construct your query, see the Query Language guide. For the full list of available tables and fields, see the Available fields.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. Number of ReportRows to retrieve in a single page. Defaults to
- Values above 5000 are coerced to 5000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. Number of ReportRows to retrieve in a single page. Defaults to
- Values above 5000 are coerced to 5000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. Token of the page to retrieve. If not specified, the first page
of results is returned. In order to request the next page of results, the
value obtained from next_page_token in the previous response should be
used.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. Token of the page to retrieve. If not specified, the first page
of results is returned. In order to request the next page of results, the
value obtained from next_page_token in the previous response should be
used.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account} |
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Merchant\Reports\V1beta\SearchRequest |
|