Google Analytics Admin V1alpha Client - Class RunAccessReportResponse (0.9.0)

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
NameDescription
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. 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.

↳ 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
TypeDescription
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
NameDescription
var array<Google\Analytics\Admin\V1alpha\AccessDimensionHeader>
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array<Google\Analytics\Admin\V1alpha\AccessMetricHeader>
Returns
TypeDescription
$this

getRows

Rows of dimension value combinations and metric values in the report.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRows

Rows of dimension value combinations and metric values in the report.

Parameter
NameDescription
var array<Google\Analytics\Admin\V1alpha\AccessRow>
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getQuota

The quota state for this Analytics property including this request.

Returns
TypeDescription
Google\Analytics\Admin\V1alpha\AccessQuota|null

hasQuota

clearQuota

setQuota

The quota state for this Analytics property including this request.

Parameter
NameDescription
var Google\Analytics\Admin\V1alpha\AccessQuota
Returns
TypeDescription
$this