Module google_analyticsreporting4::api [−][src]
Structs
An Activity represents data for an activity of a user. Note that an Activity is different from a hit. A hit might result in multiple Activity’s. For example, if a hit includes a transaction and a goal completion, there will be two Activity protos for this hit, one for ECOMMERCE and one for GOAL. Conversely, multiple hits can also construct one Activity. In classic e-commerce, data for one transaction might be sent through multiple hits. These hits will be merged into one ECOMMERCE Activity.
Central instance to access all AnalyticsReporting related resource activities
Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort.
Defines a cohort group. For example: “cohortGroup”: { “cohorts”: [{ “name”: “cohort 1”, “type”: “FIRST_VISIT_DATE”, “dateRange”: { “startDate”: “2015-08-01”, “endDate”: “2015-08-01” } },{ “name”: “cohort 2” “type”: “FIRST_VISIT_DATE” “dateRange”: { “startDate”: “2015-07-01”, “endDate”: “2015-07-01” } }] }
Column headers.
Custom dimension.
A contiguous set of days: startDate, startDate + 1 day, …, endDate. The start and end dates are specified in ISO8601 date format YYYY-MM-DD.
Used to return a list of metrics for a single DateRange / dimension combination
Dimensions are attributes of your data. For example, the dimension ga:city indicates the city, for example, “Paris” or “New York”, from which a session originates.
Dimension filter specifies the filtering options on a dimension.
A group of dimension filters. Set the operator value to specify how the filters are logically combined.
Dynamic segment definition for defining the segment within the request. A segment can select users, sessions or both.
E-commerce details associated with the user activity.
Represents all the details pertaining to an event.
The batch request containing multiple report request.
The main response class which holds the reports from the Reporting API batchGet call.
Represents all the details pertaining to a goal.
Represents a set of goals that were reached in an activity.
Metrics are the quantitative measurements. For example, the metric ga:users indicates the total number of users for the requested time period.
MetricFilter specifies the filter on a metric.
Represents a group of metric filters. Set the operator value to specify how the filters are logically combined.
The headers for the metrics.
Header for the metrics.
A list of segment filters in the OR group are combined with the logical OR operator.
Specifies the sorting options.
Represents details collected when the visitor views a page.
The Pivot describes the pivot section in the request. The Pivot helps rearrange the information in the table for certain reports by pivoting your data on a second dimension.
The headers for each of the pivot sections defined in the request.
The headers for the each of the metric column corresponding to the metrics requested in the pivots section of the response.
The metric values in the pivot region.
Details of the products in an e-commerce transaction.
The data response corresponding to the request.
Returns the Analytics data.
The data part of the report.
A builder providing access to all methods supported on report resources.
It is not used directly, but through the AnalyticsReporting hub.
The main request class which specifies the Reporting API request.
A row in the report.
The resource quota tokens remaining for the property after the request is completed.
There is no detailed description.
The request to fetch User Report from Reporting API userActivity:get call.
The response from userActivity:get call.
The segment definition, if the report needs to be segmented. A Segment is a subset of the Analytics data. For example, of the entire set of users, one Segment might be users from a particular country or city.
SegmentDefinition defines the segment to be a set of SegmentFilters which are combined together with a logical AND operation.
Dimension filter specifies the filtering options on a dimension.
SegmentFilter defines the segment to be either a simple or a sequence segment. A simple segment condition contains dimension and metric conditions to select the sessions or users. A sequence segment condition can be used to select users or sessions based on sequential conditions.
Filter Clause to be used in a segment definition, can be wither a metric or a dimension filter.
Metric filter to be used in a segment filter clause.
A segment sequence definition.
Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators.
A Simple segment conditions consist of one or more dimension/metric conditions that can be combined.
Represents details collected when the visitor performs a transaction on the page.
Contains information to identify a particular user uniquely.
A builder providing access to all methods supported on userActivity resources.
It is not used directly, but through the AnalyticsReporting hub.
Returns User Activity data.
This represents a user session performed on a specific device at a certain time over a period of time.
Enums
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.