Reference documentation and code samples for the Google Analytics Data V1alpha Client class QueryReportTaskRequest.
A request to fetch the report content for a report task.
Generated from protobuf messagegoogle.analytics.data.v1alpha.QueryReportTaskRequest
Namespace
Google \ Analytics \ Data \ V1alpha
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The report source name. Format:properties/{property}/reportTasks/{report}
↳ offset
int|string
Optional. The row count of the start row in the report. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the firstlimitof rows. The second request sets offset to thelimitof the first request; the second request returns the secondlimitof rows. To learn more about this pagination parameter, seePagination.
↳ limit
int|string
Optional. The number of rows to return from the report. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for.limitmust be positive. The API can also return fewer rows than the requestedlimit, if there aren't as many dimension values as thelimit. The number of rows available to a QueryReportTaskRequest is further limited by the limit of the associated ReportTask. A query can retrieve at most ReportTask.limit rows. For example, if the ReportTask has a limit of 1,000, then a QueryReportTask request with offset=900 and limit=500 will return at most 100 rows. To learn more about this pagination parameter, seePagination.
getName
Required. The report source name.
Format:properties/{property}/reportTasks/{report}
Returns
Type
Description
string
setName
Required. The report source name.
Format:properties/{property}/reportTasks/{report}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOffset
Optional. The row count of the start row in the report. The first row is
counted as row 0.
When paging, the first request does not specify offset; or equivalently,
sets offset to 0; the first request returns the firstlimitof rows. The
second request sets offset to thelimitof the first request; the second
request returns the secondlimitof rows.
To learn more about this pagination parameter, seePagination.
Returns
Type
Description
int|string
setOffset
Optional. The row count of the start row in the report. The first row is
counted as row 0.
When paging, the first request does not specify offset; or equivalently,
sets offset to 0; the first request returns the firstlimitof rows. The
second request sets offset to thelimitof the first request; the second
request returns the secondlimitof rows.
To learn more about this pagination parameter, seePagination.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getLimit
Optional. The number of rows to return from the report. If unspecified,
10,000 rows are returned. The API returns a maximum of 250,000 rows per
request, no matter how many you ask for.limitmust be positive.
The API can also return fewer rows than the requestedlimit, if there
aren't as many dimension values as thelimit. The number of rows
available to a QueryReportTaskRequest is further limited by the limit of
the associated ReportTask. A query can retrieve at most ReportTask.limit
rows. For example, if the ReportTask has a limit of 1,000, then a
QueryReportTask request with offset=900 and limit=500 will return at most
100 rows.
To learn more about this pagination parameter, seePagination.
Returns
Type
Description
int|string
setLimit
Optional. The number of rows to return from the report. If unspecified,
10,000 rows are returned. The API returns a maximum of 250,000 rows per
request, no matter how many you ask for.limitmust be positive.
The API can also return fewer rows than the requestedlimit, if there
aren't as many dimension values as thelimit. The number of rows
available to a QueryReportTaskRequest is further limited by the limit of
the associated ReportTask. A query can retrieve at most ReportTask.limit
rows. For example, if the ReportTask has a limit of 1,000, then a
QueryReportTask request with offset=900 and limit=500 will return at most
100 rows.
To learn more about this pagination parameter, seePagination.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
name
string
Required. The report source name.
Format:properties/{property}/reportTasks/{report}
[[["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 Analytics Data V1alpha Client - Class QueryReportTaskRequest (0.22.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.22.3 (latest)](/php/docs/reference/analytics-data/latest/V1alpha.QueryReportTaskRequest)\n- [0.22.2](/php/docs/reference/analytics-data/0.22.2/V1alpha.QueryReportTaskRequest)\n- [0.21.1](/php/docs/reference/analytics-data/0.21.1/V1alpha.QueryReportTaskRequest)\n- [0.20.1](/php/docs/reference/analytics-data/0.20.1/V1alpha.QueryReportTaskRequest)\n- [0.19.0](/php/docs/reference/analytics-data/0.19.0/V1alpha.QueryReportTaskRequest)\n- [0.18.0](/php/docs/reference/analytics-data/0.18.0/V1alpha.QueryReportTaskRequest)\n- [0.17.1](/php/docs/reference/analytics-data/0.17.1/V1alpha.QueryReportTaskRequest)\n- [0.16.4](/php/docs/reference/analytics-data/0.16.4/V1alpha.QueryReportTaskRequest)\n- [0.14.0](/php/docs/reference/analytics-data/0.14.0/V1alpha.QueryReportTaskRequest)\n- [0.13.0](/php/docs/reference/analytics-data/0.13.0/V1alpha.QueryReportTaskRequest)\n- [0.12.0](/php/docs/reference/analytics-data/0.12.0/V1alpha.QueryReportTaskRequest)\n- [0.11.2](/php/docs/reference/analytics-data/0.11.2/V1alpha.QueryReportTaskRequest)\n- [0.10.1](/php/docs/reference/analytics-data/0.10.1/V1alpha.QueryReportTaskRequest)\n- [0.9.5](/php/docs/reference/analytics-data/0.9.5/V1alpha.QueryReportTaskRequest) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Analytics Data V1alpha Client class QueryReportTaskRequest.\n\nA request to fetch the report content for a report task.\n\nGenerated from protobuf message `google.analytics.data.v1alpha.QueryReportTaskRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Data \\\\ V1alpha\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The report source name.\n\nFormat: `properties/{property}/reportTasks/{report}`\n\n### setName\n\nRequired. The report source name.\n\nFormat: `properties/{property}/reportTasks/{report}`\n\n### getOffset\n\nOptional. The row count of the start row in the report. The first row is\ncounted as row 0.\n\nWhen paging, the first request does not specify offset; or equivalently,\nsets offset to 0; the first request returns the first `limit` of rows. The\nsecond request sets offset to the `limit` of the first request; the second\nrequest returns the second `limit` of rows.\nTo learn more about this pagination parameter, see\n[Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).\n\n### setOffset\n\nOptional. The row count of the start row in the report. The first row is\ncounted as row 0.\n\nWhen paging, the first request does not specify offset; or equivalently,\nsets offset to 0; the first request returns the first `limit` of rows. The\nsecond request sets offset to the `limit` of the first request; the second\nrequest returns the second `limit` of rows.\nTo learn more about this pagination parameter, see\n[Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).\n\n### getLimit\n\nOptional. The number of rows to return from the report. If unspecified,\n10,000 rows are returned. The API returns a maximum of 250,000 rows per\nrequest, no matter how many you ask for. `limit` must be positive.\n\nThe API can also return fewer rows than the requested `limit`, if there\naren't as many dimension values as the `limit`. The number of rows\navailable to a QueryReportTaskRequest is further limited by the limit of\nthe associated ReportTask. A query can retrieve at most ReportTask.limit\nrows. For example, if the ReportTask has a limit of 1,000, then a\nQueryReportTask request with offset=900 and limit=500 will return at most\n100 rows.\nTo learn more about this pagination parameter, see\n[Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).\n\n### setLimit\n\nOptional. The number of rows to return from the report. If unspecified,\n10,000 rows are returned. The API returns a maximum of 250,000 rows per\nrequest, no matter how many you ask for. `limit` must be positive.\n\nThe API can also return fewer rows than the requested `limit`, if there\naren't as many dimension values as the `limit`. The number of rows\navailable to a QueryReportTaskRequest is further limited by the limit of\nthe associated ReportTask. A query can retrieve at most ReportTask.limit\nrows. For example, if the ReportTask has a limit of 1,000, then a\nQueryReportTask request with offset=900 and limit=500 will return at most\n100 rows.\nTo learn more about this pagination parameter, see\n[Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).\n\n### static::build"]]