Modules§

Structs§

  • An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the QueryAudienceListResponse.
  • The value of a dimension.
  • An audience list is a list of users in an audience at the time of the list’s creation. One audience may have multiple audience lists created for different days.
  • This metadata is currently blank.
  • Dimension value attributes for the audience user row.
  • To express that the result needs to be between two numbers (inclusive).
  • Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same firstSessionDate belong to the same cohort.
  • Optional settings of a cohort report.
  • The specification of cohorts for a cohort report.
  • Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.
  • A request to create a new audience list.
  • A request to create a new recurring audience list.
  • A request to create a report task.
  • A contiguous set of days: startDate, startDate + 1, …, endDate. Requests are allowed up to 4 date ranges.
  • Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be “Paris” or “New York”.
  • Used to express a dimension which is the result of a formula of multiple dimensions. Example usages:
  • Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.
  • The value of a dimension.
  • Event segments are subsets of events that were triggered on your site or app. for example, all purchase events made in a particular location; app_exception events that occurred on a specific operating system.
  • Conditions tell Analytics what data to include in or exclude from the segment.
  • An event matches a criteria if the event meet the conditions in the criteria.
  • Specifies which events are excluded in this segment.
  • An expression to filter dimension or metric values.
  • To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.
  • A list of filter expressions.
  • Configures the funnel in a funnel report request. A funnel reports on users as they pass through a sequence of steps.
  • Breakdowns add a dimension to the funnel table sub report response.
  • Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.
  • An expression to filter dimension or metric values.
  • Expresses combinations of funnel filters.
  • A list of funnel filter expressions.
  • Next actions state the value for a dimension after the user has achieved a step but before the same user has achieved the next step. For example if the nextActionDimension is eventName, then nextActionDimension in the ith funnel step row will return first event after the event that qualified the user into the ith funnel step but before the user achieved the i+1th funnel step.
  • An expression to filter parameter values in a funnel.
  • Expresses combinations of funnel filters on parameters.
  • A list of funnel parameter filter expressions.
  • The funnel report’s response metadata carries additional information about the funnel report.
  • Steps define the user journey you want to measure. Steps contain one or more conditions that your users must meet to be included in that step of the funnel journey.
  • Funnel sub reports contain the dimension and metric data values. For example, 12 users reached the second step of the funnel.
  • A request to retrieve configuration metadata about a specific audience list.
  • A request to retrieve configuration metadata about a specific recurring audience list.
  • A request to retrieve configuration metadata about a specific report task.
  • The result needs to be in a list of string values.
  • A request to list all audience lists for a property.
  • A list of all audience lists for a property.
  • A request to list all recurring audience lists for a property.
  • A list of all recurring audience lists for a property.
  • A request to list all report tasks for a property.
  • A list of all report tasks for a property.
  • The quantitative measurements of a report. For example, the metric eventCount is the total number of events. Requests are allowed up to 10 metrics.
  • Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.
  • The value of a metric.
  • Filters for numeric or date values.
  • To represent a number.
  • Order bys define how rows will be sorted in the response. For example, ordering rows by descending event count is one ordering, and ordering rows by the event name string is a different ordering.
  • Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors.
  • A request to list users in an audience list.
  • A list of users in an audience list.
  • A request to fetch the report content for a report task.
  • The report content corresponding to a report task.
  • Current state for a particular quota group.
  • A recurring audience list produces new audience lists each day. Audience lists are users in an audience at the time of the list’s creation. A recurring audience list ensures that you have audience list based on the most recent data available for use each day.
  • A specific report task configuration.
  • Represents the metadata of a long-running operation. Currently, this metadata is blank.
  • Response’s metadata carrying additional information about the report content.
  • Report data for each row. For example if RunReportRequest contains:
  • The request for a funnel report.
  • The funnel report response contains two sub reports. The two sub reports are different combinations of dimensions and metrics.
  • If funnel report results are sampled, this metadata describes what percentage of events were used in this funnel report for a date range. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set.
  • A segment is a subset of your Analytics data. For example, of your entire set of users, one segment might be users from a particular country or city. Another segment might be users who purchase a particular line of products or who visit a specific part of your site or trigger certain events in your app.
  • Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.
  • An expression to filter dimension or metric values.
  • Expresses combinations of segment filters.
  • A list of segment filter expressions.
  • Scopings specify how the dimensions & metrics of multiple events should be considered when evaluating a segment filter.
  • An expression to filter parameter values in a segment.
  • Expresses combinations of segment filter on parameters.
  • A list of segment parameter filter expressions.
  • Scopings specify how multiple events should be considered when evaluating a segment parameter filter.
  • Session segments are subsets of the sessions that occurred on your site or app: for example, all the sessions that originated from a particular advertising campaign.
  • Conditions tell Analytics what data to include in or exclude from the segment.
  • A session matches a criteria if the session’s events meet the conditions in the criteria.
  • Specifies which sessions are excluded in this segment.
  • A request to export users in an audience list to a Google Sheet.
  • The created Google Sheet with the list of users in an audience list.
  • The filter for string
  • User segments are subsets of users who engaged with your site or app. For example, users who have previously purchased; users who added items to their shopping carts, but didn’t complete a purchase.
  • Conditions tell Analytics what data to include in or exclude from the segment.
  • A user matches a criteria if the user’s events meet the conditions in the criteria.
  • Specifies which users are excluded in this segment.
  • Define conditions that must occur in a specific order for the user to be a member of the segment.
  • A condition that must occur in the specified step order for this user to match the sequence.
  • Configures a long-running operation resource to send a webhook notification from the Google Analytics Data API to your webhook server when the resource updates.

Enums§

  • Scoping specifies which events are considered when evaluating if an event meets a criteria.
  • Enumerates options for how long an exclusion will last if an event matches the eventExclusionCriteria.
  • Represents aggregation of metrics.
  • A metric’s value type.
  • Categories of data that you may be restricted from viewing on certain GA4 properties.
  • Scoping specifies which events are considered when evaluating if a session meets a criteria.
  • Enumerates options for how long an exclusion will last if a session matches the sessionExclusionCriteria.
  • Scoping specifies which events are considered when evaluating if a user meets a criteria.
  • Enumerates options for how long an exclusion will last if a user matches the userExclusionCriteria.