Reference documentation and code samples for the Google Analytics Data V1alpha Client class ReportMetadata.
The report metadata for a specific report task.
Generated from protobuf message google.analytics.data.v1alpha.ReportTask.ReportMetadata
Namespace
Google \ Analytics \ Data \ V1alpha \ ReportTaskMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ state
int
Output only. The current state for this report task.
↳ begin_creating_time
Google\Protobuf\Timestamp
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.
int
hasState
clearState
setState
Output only. The current state for this report task.
var
int
$this
getBeginCreatingTime
Output only. The time when CreateReportTask
was called and the report
began the CREATING
state.
hasBeginCreatingTime
clearBeginCreatingTime
setBeginCreatingTime
Output only. The time when CreateReportTask
was called and the report
began the CREATING
state.
$this
getCreationQuotaTokensCharged
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.
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.
var
int
$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.
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.
var
int
$this
getErrorMessage
Output only. Error message is populated if a report task fails during creation.
string
hasErrorMessage
clearErrorMessage
setErrorMessage
Output only. Error message is populated if a report task fails during creation.
var
string
$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.
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.
var
int
$this
