Output only. The time when CreateReportTask was called and the report began the CREATING state.
↳ creation_quota_tokens_charged
int
Output only. The total quota tokens charged during creation of the report. Because this token count is based on activity from the CREATING state, this tokens charge will be fixed once a report task enters the ACTIVE or FAILED state.
↳ task_row_count
int
Output only. The total number of rows in the report result. This field will be populated when the state is active. You can utilize task_row_count for pagination within the confines of their existing report.
↳ error_message
string
Output only. Error message is populated if a report task fails during creation.
↳ total_row_count
int
Output only. The total number of rows in Google Analytics storage. If you want to query additional data rows beyond the current report, they can initiate a new report task based on the total_row_count. The task_row_count represents the number of rows specifically pertaining to the current report, whereas total_row_count encompasses the total count of rows across all data retrieved from Google Analytics storage. For example, suppose the current report's task_row_count is 20, displaying the data from the first 20 rows. Simultaneously, the total_row_count is 30, indicating the presence of data for all 30 rows. The task_row_count can be utilizated to paginate through the initial 20 rows. To expand the report and include data from all 30 rows, a new report task can be created using the total_row_count to access the full set of 30 rows' worth of data.
getState
Output only. The current state for this report task.
Returns
Type
Description
int
hasState
clearState
setState
Output only. The current state for this report task.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getBeginCreatingTime
Output only. The time when CreateReportTask was called and the report
began the CREATING state.
Output only. The total quota tokens charged during creation of the
report. Because this token count is based on activity from the CREATING
state, this tokens charge will be fixed once a report task enters the
ACTIVE or FAILED state.
Returns
Type
Description
int
setCreationQuotaTokensCharged
Output only. The total quota tokens charged during creation of the
report. Because this token count is based on activity from the CREATING
state, this tokens charge will be fixed once a report task enters the
ACTIVE or FAILED state.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getTaskRowCount
Output only. The total number of rows in the report result. This field
will be populated when the state is active. You can utilize
task_row_count for pagination within the confines of their existing
report.
Returns
Type
Description
int
hasTaskRowCount
clearTaskRowCount
setTaskRowCount
Output only. The total number of rows in the report result. This field
will be populated when the state is active. You can utilize
task_row_count for pagination within the confines of their existing
report.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getErrorMessage
Output only. Error message is populated if a report task fails during
creation.
Returns
Type
Description
string
hasErrorMessage
clearErrorMessage
setErrorMessage
Output only. Error message is populated if a report task fails during
creation.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTotalRowCount
Output only. The total number of rows in Google Analytics storage. If you
want to query additional data rows beyond the current report, they can
initiate a new report task based on the total_row_count.
The task_row_count represents the number of rows specifically
pertaining to the current report, whereas total_row_count encompasses
the total count of rows across all data retrieved from Google
Analytics storage.
For example, suppose the current report's task_row_count is 20,
displaying the data from the first 20 rows. Simultaneously, the
total_row_count is 30, indicating the presence of data for all 30 rows.
The task_row_count can be utilizated to paginate through the initial 20
rows. To expand the report and include data from all 30 rows, a new
report task can be created using the total_row_count to access the full
set of 30 rows' worth of data.
Returns
Type
Description
int
hasTotalRowCount
clearTotalRowCount
setTotalRowCount
Output only. The total number of rows in Google Analytics storage. If you
want to query additional data rows beyond the current report, they can
initiate a new report task based on the total_row_count.
The task_row_count represents the number of rows specifically
pertaining to the current report, whereas total_row_count encompasses
the total count of rows across all data retrieved from Google
Analytics storage.
For example, suppose the current report's task_row_count is 20,
displaying the data from the first 20 rows. Simultaneously, the
total_row_count is 30, indicating the presence of data for all 30 rows.
The task_row_count can be utilizated to paginate through the initial 20
rows. To expand the report and include data from all 30 rows, a new
report task can be created using the total_row_count to access the full
set of 30 rows' worth of data.
[[["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 ReportMetadata (0.22.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.22.3 (latest)](/php/docs/reference/analytics-data/latest/V1alpha.ReportTask.ReportMetadata)\n- [0.22.2](/php/docs/reference/analytics-data/0.22.2/V1alpha.ReportTask.ReportMetadata)\n- [0.21.1](/php/docs/reference/analytics-data/0.21.1/V1alpha.ReportTask.ReportMetadata)\n- [0.20.1](/php/docs/reference/analytics-data/0.20.1/V1alpha.ReportTask.ReportMetadata)\n- [0.19.0](/php/docs/reference/analytics-data/0.19.0/V1alpha.ReportTask.ReportMetadata)\n- [0.18.0](/php/docs/reference/analytics-data/0.18.0/V1alpha.ReportTask.ReportMetadata)\n- [0.17.1](/php/docs/reference/analytics-data/0.17.1/V1alpha.ReportTask.ReportMetadata)\n- [0.16.4](/php/docs/reference/analytics-data/0.16.4/V1alpha.ReportTask.ReportMetadata)\n- [0.14.0](/php/docs/reference/analytics-data/0.14.0/V1alpha.ReportTask.ReportMetadata)\n- [0.13.0](/php/docs/reference/analytics-data/0.13.0/V1alpha.ReportTask.ReportMetadata)\n- [0.12.0](/php/docs/reference/analytics-data/0.12.0/V1alpha.ReportTask.ReportMetadata)\n- [0.11.2](/php/docs/reference/analytics-data/0.11.2/V1alpha.ReportTask.ReportMetadata)\n- [0.10.1](/php/docs/reference/analytics-data/0.10.1/V1alpha.ReportTask.ReportMetadata)\n- [0.9.5](/php/docs/reference/analytics-data/0.9.5/V1alpha.ReportTask.ReportMetadata) \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 ReportMetadata.\n\nThe report metadata for a specific report task.\n\nGenerated from protobuf message `google.analytics.data.v1alpha.ReportTask.ReportMetadata`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Data \\\\ V1alpha \\\\ ReportTask\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getState\n\nOutput only. The current state for this report task.\n\n### hasState\n\n### clearState\n\n### setState\n\nOutput only. The current state for this report task.\n\n### getBeginCreatingTime\n\nOutput only. The time when `CreateReportTask` was called and the report\nbegan the `CREATING` state.\n\n### hasBeginCreatingTime\n\n### clearBeginCreatingTime\n\n### setBeginCreatingTime\n\nOutput only. The time when `CreateReportTask` was called and the report\nbegan the `CREATING` state.\n\n### getCreationQuotaTokensCharged\n\nOutput only. The total quota tokens charged during creation of the\nreport. Because this token count is based on activity from the `CREATING`\nstate, this tokens charge will be fixed once a report task enters the\n`ACTIVE` or `FAILED` state.\n\n### setCreationQuotaTokensCharged\n\nOutput only. The total quota tokens charged during creation of the\nreport. Because this token count is based on activity from the `CREATING`\nstate, this tokens charge will be fixed once a report task enters the\n`ACTIVE` or `FAILED` state.\n\n### getTaskRowCount\n\nOutput only. The total number of rows in the report result. This field\nwill be populated when the state is active. You can utilize\n`task_row_count` for pagination within the confines of their existing\nreport.\n\n### hasTaskRowCount\n\n### clearTaskRowCount\n\n### setTaskRowCount\n\nOutput only. The total number of rows in the report result. This field\nwill be populated when the state is active. You can utilize\n`task_row_count` for pagination within the confines of their existing\nreport.\n\n### getErrorMessage\n\nOutput only. Error message is populated if a report task fails during\ncreation.\n\n### hasErrorMessage\n\n### clearErrorMessage\n\n### setErrorMessage\n\nOutput only. Error message is populated if a report task fails during\ncreation.\n\n### getTotalRowCount\n\nOutput only. The total number of rows in Google Analytics storage. If you\nwant to query additional data rows beyond the current report, they can\ninitiate a new report task based on the `total_row_count`.\n\nThe `task_row_count` represents the number of rows specifically\npertaining to the current report, whereas `total_row_count` encompasses\nthe total count of rows across all data retrieved from Google\nAnalytics storage.\nFor example, suppose the current report's `task_row_count` is 20,\ndisplaying the data from the first 20 rows. Simultaneously, the\n`total_row_count` is 30, indicating the presence of data for all 30 rows.\nThe `task_row_count` can be utilizated to paginate through the initial 20\nrows. To expand the report and include data from all 30 rows, a new\nreport task can be created using the total_row_count to access the full\nset of 30 rows' worth of data.\n\n### hasTotalRowCount\n\n### clearTotalRowCount\n\n### setTotalRowCount\n\nOutput only. The total number of rows in Google Analytics storage. If you\nwant to query additional data rows beyond the current report, they can\ninitiate a new report task based on the `total_row_count`.\n\nThe `task_row_count` represents the number of rows specifically\npertaining to the current report, whereas `total_row_count` encompasses\nthe total count of rows across all data retrieved from Google\nAnalytics storage.\nFor example, suppose the current report's `task_row_count` is 20,\ndisplaying the data from the first 20 rows. Simultaneously, the\n`total_row_count` is 30, indicating the presence of data for all 30 rows.\nThe `task_row_count` can be utilizated to paginate through the initial 20\nrows. To expand the report and include data from all 30 rows, a new\nreport task can be created using the total_row_count to access the full\nset of 30 rows' worth of data."]]
