Properties
class Properties extends Resource (View source)
The "properties" collection of methods.
Typical usage is:
$analyticsdataService = new Google\Service\AnalyticsData(...);
$properties = $analyticsdataService->properties;Methods
Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property. (properties.batchRunPivotReports)
Returns multiple reports in a batch. All reports must be for the same GA4 Property. (properties.batchRunReports)
This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.
Returns metadata for dimensions and metrics available in reporting methods.
Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot.
Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics 360 properties). For a guide to constructing realtime requests & understanding responses, see Creating a Realtime Report.
Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count.
Details
BatchRunPivotReportsResponse
batchRunPivotReports(string $property, BatchRunPivotReportsRequest $postBody, array $optParams = [])
Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property. (properties.batchRunPivotReports)
BatchRunReportsResponse
batchRunReports(string $property, BatchRunReportsRequest $postBody, array $optParams = [])
Returns multiple reports in a batch. All reports must be for the same GA4 Property. (properties.batchRunReports)
CheckCompatibilityResponse
checkCompatibility(string $property, CheckCompatibilityRequest $postBody, array $optParams = [])
This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.
(properties.checkCompatibility)
Metadata
getMetadata(string $name, array $optParams = [])
Returns metadata for dimensions and metrics available in reporting methods.
Used to explore the dimensions and metrics. In this method, a Google
Analytics GA4 Property Identifier is specified in the request, and the
metadata response includes Custom dimensions and metrics as well as Universal
metadata. For example if a custom metric with parameter name
levels_unlocked is registered to a property, the Metadata response will
contain customEvent:levels_unlocked. Universal metadata are dimensions and
metrics applicable to any property such as country and totalUsers.
(properties.getMetadata)
RunPivotReportResponse
runPivotReport(string $property, RunPivotReportRequest $postBody, array $optParams = [])
Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot.
Multiple pivots can be specified to further dissect your data. (properties.runPivotReport)
RunRealtimeReportResponse
runRealtimeReport(string $property, RunRealtimeReportRequest $postBody, array $optParams = [])
Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics 360 properties). For a guide to constructing realtime requests & understanding responses, see Creating a Realtime Report.
(properties.runRealtimeReport)
RunReportResponse
runReport(string $property, RunReportRequest $postBody, array $optParams = [])
Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count.
Dimensions break down metrics across some common criteria, such as country or event name. For a guide to constructing requests & understanding responses, see Creating a Report. (properties.runReport)