Method: properties.runAccessReport

string

The Data Access Report is requested for this property. For example if "123" is your GA4 property ID, then entity should be "properties/123".

{
  "dimensionName": string
}

string

The API name of the dimension. See Data Access Schema for the list of dimensions supported in this API.

Dimensions are referenced by name in dimensionFilter and orderBys.

{
  "metricName": string
}

string

The API name of the metric. See Data Access Schema for the list of metrics supported in this API.

Metrics are referenced by name in metricFilter & orderBys.

{
  "startDate": string,
  "endDate": string
}

string

The inclusive start date for the query in the format YYYY-MM-DD. Cannot be after endDate. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the current time in the request's time zone.

string

The inclusive end date for the query in the format YYYY-MM-DD. Cannot be before startDate. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the current time in the request's time zone.

{

  // Union field one_expression can be only one of the following:
  "andGroup": {
    object (AccessFilterExpressionList)
  },
  "orGroup": {
    object (AccessFilterExpressionList)
  },
  "notExpression": {
    object (AccessFilterExpression)
  },
  "accessFilter": {
    object (AccessFilter)
  }
  // End of list of possible types for union field one_expression.
}

object (AccessFilterExpressionList)

Each of the FilterExpressions in the andGroup has an AND relationship.

object (AccessFilterExpressionList)

Each of the FilterExpressions in the orGroup has an OR relationship.

object (AccessFilterExpression)

The FilterExpression is NOT of notExpression.

object (AccessFilter)

A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics.

{
  "expressions": [
    {
      object (AccessFilterExpression)
    }
  ]
}

object (AccessFilterExpression)

A list of filter expressions.

{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (AccessStringFilter)
  },
  "inListFilter": {
    object (AccessInListFilter)
  },
  "numericFilter": {
    object (AccessNumericFilter)
  },
  "betweenFilter": {
    object (AccessBetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}

string

The dimension name or metric name.

object (AccessStringFilter)

Strings related filter.

object (AccessInListFilter)

A filter for in list values.

object (AccessNumericFilter)

A filter for numeric or date values.

object (AccessBetweenFilter)

A filter for two values.

{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}

enum (MatchType)

The match type for this filter.

string

The string value used for the matching.

boolean

If true, the string value is case sensitive.

{
  "values": [
    string
  ],
  "caseSensitive": boolean
}

string

The list of string values. Must be non-empty.

boolean

If true, the string value is case sensitive.

{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}

enum (Operation)

The operation type for this filter.

object (NumericValue)

A numeric value or a date value.

{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}

string (int64 format)

Integer value

number

Double value

{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}

object (NumericValue)

Begins with this number.

object (NumericValue)

Ends with this number.

{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}

boolean

If true, sorts by descending order. If false or unspecified, sorts in ascending order.

object (MetricOrderBy)

Sorts results by a metric's values.

object (DimensionOrderBy)

Sorts results by a dimension's values.

{
  "metricName": string
}

string

A metric name in the request to order by.

{
  "dimensionName": string,
  "orderType": enum (OrderType)
}

string

A dimension name in the request to order by.

enum (OrderType)

Controls the rule for dimension value ordering.

{
  "dimensionName": string
}

string

The dimension's name; for example 'userEmail'.

{
  "metricName": string
}

string

The metric's name; for example 'accessCount'.

{
  "dimensionValues": [
    {
      object (AccessDimensionValue)
    }
  ],
  "metricValues": [
    {
      object (AccessMetricValue)
    }
  ]
}

object (AccessDimensionValue)

List of dimension values. These values are in the same order as specified in the request.

object (AccessMetricValue)

List of metric values. These values are in the same order as specified in the request.

{
  "value": string
}

string

The dimension value. For example, this value may be 'France' for the 'country' dimension.

{
  "value": string
}

string

The measurement value. For example, this value may be '13'.

{
  "tokensPerDay": {
    object (AccessQuotaStatus)
  },
  "tokensPerHour": {
    object (AccessQuotaStatus)
  },
  "concurrentRequests": {
    object (AccessQuotaStatus)
  },
  "serverErrorsPerProjectPerHour": {
    object (AccessQuotaStatus)
  },
  "tokensPerProjectPerHour": {
    object (AccessQuotaStatus)
  }
}

object (AccessQuotaStatus)

Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.

object (AccessQuotaStatus)

Properties can use 50,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas.

object (AccessQuotaStatus)

Properties can use up to 50 concurrent requests.

object (AccessQuotaStatus)

Properties and cloud project pairs can have up to 50 server errors per hour.

object (AccessQuotaStatus)

Properties can use up to 25% of their tokens per project per hour. This amounts to Analytics 360 Properties can use 12,500 tokens per project per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas.

{
  "consumed": integer,
  "remaining": integer
}

integer

Quota consumed by this request.

integer

Quota remaining after this request.