Class RunAccessReportRequest

The request for a Data Access Record Report.

Inheritance

object

RunAccessReportRequest

Implements

IMessage<RunAccessReportRequest>

IEquatable<RunAccessReportRequest>

IDeepCloneable<RunAccessReportRequest>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Analytics.Admin.V1Alpha

Assembly: Google.Analytics.Admin.V1Alpha.dll

Syntax

public sealed class RunAccessReportRequest : IMessage<RunAccessReportRequest>, IEquatable<RunAccessReportRequest>, IDeepCloneable<RunAccessReportRequest>, IBufferMessage, IMessage

Constructors

RunAccessReportRequest()

Declaration

public RunAccessReportRequest()

RunAccessReportRequest(RunAccessReportRequest)

Declaration

public RunAccessReportRequest(RunAccessReportRequest other)

Parameters

Type	Name	Description
RunAccessReportRequest	other

Properties

DateRanges

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.

Declaration

public RepeatedField<AccessDateRange> DateRanges { get; }

Property Value

Type	Description
RepeatedField<AccessDateRange>

DimensionFilter

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.

Declaration

public AccessFilterExpression DimensionFilter { get; set; }

Property Value

Type	Description
AccessFilterExpression

Dimensions

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

Declaration

public RepeatedField<AccessDimension> Dimensions { get; }

Property Value

Type	Description
RepeatedField<AccessDimension>

Entity

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.

Declaration

public string Entity { get; set; }

Property Value

Type	Description
string

ExpandGroups

Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned.

Declaration

public bool ExpandGroups { get; set; }

Property Value

Type	Description
bool

IncludeAllUsers

Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included.

Declaration

public bool IncludeAllUsers { get; set; }

Property Value

Type	Description
bool

Limit

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.

Declaration

public long Limit { get; set; }

Property Value

Type	Description
long

MetricFilter

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.

Declaration

public AccessFilterExpression MetricFilter { get; set; }

Property Value

Type	Description
AccessFilterExpression

Metrics

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

Declaration

public RepeatedField<AccessMetric> Metrics { get; }

Property Value

Type	Description
RepeatedField<AccessMetric>

Offset

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.

Declaration

public long Offset { get; set; }

Property Value

Type	Description
long

OrderBys

Specifies how rows are ordered in the response.

Declaration

public RepeatedField<AccessOrderBy> OrderBys { get; }

Property Value

Type	Description
RepeatedField<AccessOrderBy>

ReturnEntityQuota

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.

Declaration

public bool ReturnEntityQuota { get; set; }

Property Value

Type	Description
bool

TimeZone

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

Declaration

public string TimeZone { get; set; }

Property Value

Type	Description
string