Reference documentation and code samples for the Google Shopping Merchant Reports V1 Client class SearchRequest.
Request message for theReportService.Searchmethod.
Generated from protobuf messagegoogle.shopping.merchant.reports.v1.SearchRequest
Namespace
Google \ Shopping \ Merchant \ Reports \ V1
Methods
__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 theQuery Language guide. For the full list of available tables and fields, see theAvailable fields.
↳ page_size
int
Optional. Number ofReportRowsto retrieve in a single page. Defaults to 1000. Values above 5000 are coerced to 5000.
↳ 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 fromnext_page_tokenin the previous response should be used.
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 theQuery Language
guide. For the full list of
available tables and fields, see theAvailable
fields.
Returns
Type
Description
string
setQuery
Required. Query that defines a report to be retrieved.
For details on how to construct your query, see theQuery Language
guide. For the full list of
available tables and fields, see theAvailable
fields.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. Number ofReportRowsto retrieve in a single page. Defaults to
Values above 5000 are coerced to 5000.
Returns
Type
Description
int
setPageSize
Optional. Number ofReportRowsto 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 fromnext_page_tokenin 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 fromnext_page_tokenin 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}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Shopping Merchant Reports V1 Client - Class SearchRequest (1.0.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0 (latest)](/php/docs/reference/shopping-merchant-reports/latest/V1.SearchRequest)\n- [0.10.0](/php/docs/reference/shopping-merchant-reports/0.10.0/V1.SearchRequest)\n- [0.9.1](/php/docs/reference/shopping-merchant-reports/0.9.1/V1.SearchRequest)\n- [0.8.4](/php/docs/reference/shopping-merchant-reports/0.8.4/V1.SearchRequest)\n- [0.7.3](/php/docs/reference/shopping-merchant-reports/0.7.3/V1.SearchRequest)\n- [0.6.0](/php/docs/reference/shopping-merchant-reports/0.6.0/V1.SearchRequest)\n- [0.5.0](/php/docs/reference/shopping-merchant-reports/0.5.0/V1.SearchRequest)\n- [0.4.0](/php/docs/reference/shopping-merchant-reports/0.4.0/V1.SearchRequest)\n- [0.3.0](/php/docs/reference/shopping-merchant-reports/0.3.0/V1.SearchRequest)\n- [0.2.0](/php/docs/reference/shopping-merchant-reports/0.2.0/V1.SearchRequest)\n- [0.1.0](/php/docs/reference/shopping-merchant-reports/0.1.0/V1.SearchRequest) \nReference documentation and code samples for the Google Shopping Merchant Reports V1 Client class SearchRequest.\n\nRequest message for the `ReportService.Search` method.\n\nGenerated from protobuf message `google.shopping.merchant.reports.v1.SearchRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Shopping \\\\ Merchant \\\\ Reports \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. Id of the account making the call. Must be a standalone account\nor an MCA subaccount. Format: accounts/{account}\n\n### setParent\n\nRequired. Id of the account making the call. Must be a standalone account\nor an MCA subaccount. Format: accounts/{account}\n\n### getQuery\n\nRequired. Query that defines a report to be retrieved.\n\nFor details on how to construct your query, see the [Query Language\nguide](/merchant/api/guides/reports/query-language). For the full list of\navailable tables and fields, see the [Available\nfields](/merchant/api/reference/rest/reports_v1/accounts.reports).\n\n### setQuery\n\nRequired. Query that defines a report to be retrieved.\n\nFor details on how to construct your query, see the [Query Language\nguide](/merchant/api/guides/reports/query-language). For the full list of\navailable tables and fields, see the [Available\nfields](/merchant/api/reference/rest/reports_v1/accounts.reports).\n\n### getPageSize\n\nOptional. Number of `ReportRows` to retrieve in a single page. Defaults to\n\n1. Values above 5000 are coerced to 5000.\n\n### setPageSize\n\nOptional. Number of `ReportRows` to retrieve in a single page. Defaults to\n\n1. Values above 5000 are coerced to 5000.\n\n### getPageToken\n\nOptional. Token of the page to retrieve. If not specified, the first page\nof results is returned. In order to request the next page of results, the\nvalue obtained from `next_page_token` in the previous response should be\nused.\n\n### setPageToken\n\nOptional. Token of the page to retrieve. If not specified, the first page\nof results is returned. In order to request the next page of results, the\nvalue obtained from `next_page_token` in the previous response should be\nused.\n\n### static::build"]]
