Google Analytics Admin V1alpha Client - Class RunAccessReportRequest (0.18.1)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class RunAccessReportRequest.

The request for a Data Access Record Report.

Generated from protobuf message google.analytics.admin.v1alpha.RunAccessReportRequest

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ entity`	`string` The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account. To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your GA4 Account ID.
`↳ dimensions`	`array<Google\Analytics\Admin\V1alpha\AccessDimension>` The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
`↳ metrics`	`array<Google\Analytics\Admin\V1alpha\AccessMetric>` The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
`↳ date_ranges`	`array<Google\Analytics\Admin\V1alpha\AccessDateRange>` Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges.
`↳ dimension_filter`	`Google\Analytics\Admin\V1alpha\AccessFilterExpression` Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.
`↳ metric_filter`	`Google\Analytics\Admin\V1alpha\AccessFilterExpression` Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.
`↳ offset`	`int\|string` The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with `limit` entries. To learn more about this pagination parameter, see Pagination.
`↳ limit`	`int\|string` The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API may return fewer rows than the requested `limit`, if there aren't as many remaining rows as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see Pagination.
`↳ time_zone`	`string` This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".
`↳ order_bys`	`array<Google\Analytics\Admin\V1alpha\AccessOrderBy>` Specifies how rows are ordered in the response.
`↳ return_entity_quota`	`bool` Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in AccessQuota. For account-level requests, this field must be false.

getEntity

The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account.

To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your GA4 Account ID.

Returns
Type	Description
`string`

setEntity

The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDimensions

The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDimensions

The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.

Parameter
Name	Description
`var`	`array<Google\Analytics\Admin\V1alpha\AccessDimension>`

Returns
Type	Description
`$this`

getMetrics

The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setMetrics

The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.

Parameter
Name	Description
`var`	`array<Google\Analytics\Admin\V1alpha\AccessMetric>`

Returns
Type	Description
`$this`

getDateRanges

Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDateRanges

Parameter
Name	Description
`var`	`array<Google\Analytics\Admin\V1alpha\AccessDateRange>`

Returns
Type	Description
`$this`

getDimensionFilter

Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.

Returns
Type	Description
`Google\Analytics\Admin\V1alpha\AccessFilterExpression\|null`

hasDimensionFilter

clearDimensionFilter

setDimensionFilter

Parameter
Name	Description
`var`	`Google\Analytics\Admin\V1alpha\AccessFilterExpression`

Returns
Type	Description
`$this`

getMetricFilter

Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.

Returns
Type	Description
`Google\Analytics\Admin\V1alpha\AccessFilterExpression\|null`

hasMetricFilter

clearMetricFilter

setMetricFilter

Parameter
Name	Description
`var`	`Google\Analytics\Admin\V1alpha\AccessFilterExpression`

Returns
Type	Description
`$this`

getOffset

The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with limit entries.

To learn more about this pagination parameter, see Pagination.

Returns
Type	Description
`int\|string`

setOffset

To learn more about this pagination parameter, see Pagination.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getLimit

The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. limit must be positive.

The API may return fewer rows than the requested limit, if there aren't as many remaining rows as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value. To learn more about this pagination parameter, see Pagination.

Returns
Type	Description
`int\|string`

setLimit

The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. limit must be positive.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getTimeZone

This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report.

Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".

Returns
Type	Description
`string`

setTimeZone

This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report.

Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderBys

Specifies how rows are ordered in the response.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setOrderBys

Specifies how rows are ordered in the response.

Parameter
Name	Description
`var`	`array<Google\Analytics\Admin\V1alpha\AccessOrderBy>`

Returns
Type	Description
`$this`

getReturnEntityQuota

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in AccessQuota. For account-level requests, this field must be false.

Returns
Type	Description
`bool`

setReturnEntityQuota

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in AccessQuota. For account-level requests, this field must be false.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`