Reference documentation and code samples for the Google Analytics Admin V1alpha Client class RunAccessReportResponse.
The customized Data Access Record Report response.
Generated from protobuf message google.analytics.admin.v1alpha.RunAccessReportResponse
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ dimension_headers |
array<Google\Analytics\Admin\V1alpha\AccessDimensionHeader>
The header for a column in the report that corresponds to a specific dimension. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. |
↳ metric_headers |
array<Google\Analytics\Admin\V1alpha\AccessMetricHeader>
The header for a column in the report that corresponds to a specific metric. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. |
↳ rows |
array<Google\Analytics\Admin\V1alpha\AccessRow>
Rows of dimension value combinations and metric values in the report. |
↳ row_count |
int
The total number of rows in the query result. |
↳ quota |
Google\Analytics\Admin\V1alpha\AccessQuota
The quota state for this Analytics property including this request. |
getDimensionHeaders
The header for a column in the report that corresponds to a specific dimension. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setDimensionHeaders
The header for a column in the report that corresponds to a specific dimension. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Analytics\Admin\V1alpha\AccessDimensionHeader>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMetricHeaders
The header for a column in the report that corresponds to a specific metric. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setMetricHeaders
The header for a column in the report that corresponds to a specific metric. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Analytics\Admin\V1alpha\AccessMetricHeader>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRows
Rows of dimension value combinations and metric values in the report.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setRows
Rows of dimension value combinations and metric values in the report.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Analytics\Admin\V1alpha\AccessRow>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRowCount
The total number of rows in the query result. rowCount is independent of
the number of rows returned in the response, the limit request
parameter, and the offset request parameter. For example if a query
returns 175 rows and includes limit of 50 in the API request, the
response will contain rowCount of 175 but only 50 rows.
To learn more about this pagination parameter, see Pagination.
| Returns | |
|---|---|
| Type | Description |
int | |
setRowCount
The total number of rows in the query result. rowCount is independent of
the number of rows returned in the response, the limit request
parameter, and the offset request parameter. For example if a query
returns 175 rows and includes limit of 50 in the API request, the
response will contain rowCount of 175 but only 50 rows.
To learn more about this pagination parameter, see Pagination.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQuota
The quota state for this Analytics property including this request.
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Admin\V1alpha\AccessQuota|null | |
hasQuota
clearQuota
setQuota
The quota state for this Analytics property including this request.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Admin\V1alpha\AccessQuota
|
| Returns | |
|---|---|
| Type | Description |
$this | |