Google Analytics Data API Updates: new dimensions, compatibility check method
Ilya Kuleshov
New dimensions/metrics compatibility check method
checkCompatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility.
New dimensions added to the Data API reporting schema
Date/time dimensions:
dateHourMinute The combined values of date, hour, and minute formatted as YYYYMMDDHHMM.
minute The two-digit minute of the hour that the event was logged.
nthMinute The number of minutes since the start of the date range.
Event parameter dimensions:
achievementId The achievement ID in a game for an event.
character The player character in a game for an event.
fileExtension The extension of the downloaded file.
fileName The page path of the downloaded file.
groupId The player group ID in a game for an event.
linkClasses The HTML class attribute for an outbound link.
linkDomain The destination domain of the outbound link.
linkId The HTML id attribute for an outbound link or file download.
linkText The link text of the file download.
linkUrl The full url for an outbound link or file download.
method The method by which an event was triggered.
outbound Returns 'true' if the link leads to a site is not a part of the property’s domain.
pageLocation The protocol, hostname, page path, and query string for web pages visited.
pageReferrer The full referring URL including the hostname and path.
percentScrolled The percentage down the page that the user has scrolled (for example, '90').
searchTerm The term searched by the user.
videoProvider The source of the video (for example, 'youtube').
videoTitle The title of the video.
videoUrl The url of the video.
visible Returns 'true' if the content is visible.
unifiedPagePathScreen The page path (web) or screen class (app) on which the event was logged.
Changes in existing dimensions:
unifiedPageScreen For web generated events, this dimension now returns the page path and query string on which the event was logged.
Upcoming changes announcement:
firstUserTrafficOrigin The traffic origin that first acquired the user. Please do not depend on this field returning 'Manual' for traffic that uses UTMs; this field will update from returning 'Manual' to returning '(not set)' for an upcoming feature launch.
sessionTrafficOrigin The traffic origin of the session's campaign. Please do not depend on this field returning 'Manual' for traffic that uses UTMs; this field will update from returning 'Manual' to returning '(not set)' for an upcoming feature launch.
trafficOrigin The traffic origin of the conversion event's campaign. Please do not depend on this field returning 'Manual' for traffic that uses UTMs; this field will update from returning 'Manual' to returning '(not set)' for an upcoming feature launch.
As part of the testing process, we kindly ask you to answer a quick Google Analytics 4 APIs Tester Survey and provide any feedback you have regarding the testing experience.
Ilya,
The Google Analytics Team