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 message google.analytics.data.v1alpha.QueryReportTaskRequest
Namespace
Google \ Analytics \ Data \ V1alphaMethods
__construct
Constructor.
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 first limit
of rows. The second request sets offset to the limit
of the first request; the second request returns the second limit
of rows. To learn more about this pagination parameter, see Pagination
.
↳ 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. limit
must be positive. The API can also return fewer rows than the requested limit
, if there aren't as many dimension values as the limit
. 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, see Pagination
.
getName
Required. The report source name.
Format: properties/{property}/reportTasks/{report}
string
setName
Required. The report source name.
Format: properties/{property}/reportTasks/{report}
var
string
$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 first limit
of rows. The
second request sets offset to the limit
of the first request; the second
request returns the second limit
of rows.
To learn more about this pagination parameter, see Pagination
.
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 first limit
of rows. The
second request sets offset to the limit
of the first request; the second
request returns the second limit
of rows.
To learn more about this pagination parameter, see Pagination
.
var
int|string
$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. limit
must be positive.
The API can also return fewer rows than the requested limit
, if there
aren't as many dimension values as the limit
. 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, see Pagination
.
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. limit
must be positive.
The API can also return fewer rows than the requested limit
, if there
aren't as many dimension values as the limit
. 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, see Pagination
.
var
int|string
$this
static::build
name
string
Required. The report source name.
Format: properties/{property}/reportTasks/{report}
