Создать отчет в реальном времени

Это обзор возможностей метода API отчетов в реальном времени API данных Google Analytics v1. Подробную информацию об API см. в справочнике по API .

События появляются в отчетах в реальном времени через несколько секунд после их отправки в Google Analytics. Отчеты в реальном времени отображают события и данные об использовании за периоды времени от настоящего момента до 30 минут назад (до 60 минут для ресурсов Google Analytics 360) и могут использоваться для таких приложений, как оперативный счетчик посетителей на вашем веб-сайте.

Отчеты в реальном времени поддерживают ограниченное подмножество параметров и показателей по сравнению с основной функциональностью отчетов Data API v1.

Общие функции с основными отчетами

Запросы отчетов в реальном времени имеют ту же семантику, что и запросы основных отчетов для многих общих функций. Например, нумерация страниц , фильтры измерений и свойства пользователя ведут себя в отчетах в реальном времени так же, как и в основных отчетах. Пожалуйста, ознакомьтесь с обзором основных функций отчетности Data API v1 , поскольку оставшаяся часть этого документа будет посвящена функциям, специфичным для запросов отчетов в реальном времени.

Запрос отчета

Чтобы запросить отчеты в реальном времени, вы можете создать объект RunRealtimeReportRequest . Мы рекомендуем начать со следующих параметров запроса:

  • По крайней мере одна действительная запись в поле размеров .
  • По крайней мере одна действительная запись в поле метрики .

Вот пример запроса с рекомендуемыми полями.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runRealtimeReport
{
 
"dimensions": [{ "name": "country" }],
 
"metrics": [{ "name": "activeUsers" }]
}

import com.google.analytics.data.v1beta.BetaAnalyticsDataClient;
import com.google.analytics.data.v1beta.Dimension;
import com.google.analytics.data.v1beta.DimensionHeader;
import com.google.analytics.data.v1beta.Metric;
import com.google.analytics.data.v1beta.MetricHeader;
import com.google.analytics.data.v1beta.Row;
import com.google.analytics.data.v1beta.RunRealtimeReportRequest;
import com.google.analytics.data.v1beta.RunRealtimeReportResponse;

/**
 * Google Analytics Data API sample application demonstrating the creation of a realtime report.
 *
 * <p>See
 * https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runRealtimeReport
 * for more information.
 *
 * <p>Before you start the application, please review the comments starting with "TODO(developer)"
 * and update the code to use correct values.
 *
 * <p>To run this sample using Maven:
 *
 * <pre>{@code
 * cd google-analytics-data
 * mvn compile exec:java -Dexec.mainClass="com.google.analytics.data.samples.RunRealtimeReportSample"
 * }</pre>
 */

public class RunRealtimeReportSample {

 
public static void main(String... args) throws Exception {
   
// TODO(developer): Replace with your Google Analytics 4 property ID before running the sample.
   
String propertyId = "YOUR-GA4-PROPERTY-ID";
    sampleRunRealtimeReport
(propertyId);
 
}

 
// Runs a realtime report on a Google Analytics 4 property.
 
static void sampleRunRealtimeReport(String propertyId) throws Exception {
   
// Initialize client that will be used to send requests. This client only needs to be created
   
// once, and can be reused for multiple requests. After completing all of your requests, call
   
// the "close" method on the client to safely clean up any remaining background resources.
   
try (BetaAnalyticsDataClient analyticsData = BetaAnalyticsDataClient.create()) {
     
RunRealtimeReportRequest request =
         
RunRealtimeReportRequest.newBuilder()
             
.setProperty("properties/" + propertyId)
             
.addDimensions(Dimension.newBuilder().setName("country"))
             
.addMetrics(Metric.newBuilder().setName("activeUsers"))
             
.build();

     
// Make the request.
     
RunRealtimeReportResponse response = analyticsData.runRealtimeReport(request);
      printRunRealtimeReportResponse
(response);
   
}
 
}

 
// Prints results of a runRealReport call.
 
static void printRunRealtimeReportResponse(RunRealtimeReportResponse response) {
   
System.out.printf("%s rows received%n", response.getRowsList().size());

   
for (DimensionHeader header : response.getDimensionHeadersList()) {
     
System.out.printf("Dimension header name: %s%n", header.getName());
   
}

   
for (MetricHeader header : response.getMetricHeadersList()) {
     
System.out.printf("Metric header name: %s (%s)%n", header.getName(), header.getType());
   
}

   
System.out.println("Report result:");
   
for (Row row : response.getRowsList()) {
     
System.out.printf(
         
"%s, %s%n", row.getDimensionValues(0).getValue(), row.getMetricValues(0).getValue());
   
}
 
}
}
use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
use Google\Analytics\Data\V1beta\RunRealtimeReportRequest;
use Google\Analytics\Data\V1beta\RunRealtimeReportResponse;

/**
 * Runs a realtime report on a Google Analytics 4 property.
 * @param string $propertyId Your GA-4 Property ID
 */

function run_realtime_report(string $propertyId)
{
   
// Create an instance of the Google Analytics Data API client library.
    $client
= new BetaAnalyticsDataClient();

   
// Make an API call.
    $request
= (new RunRealtimeReportRequest())
       
->setProperty('properties/' . $propertyId)
       
->setDimensions([new Dimension(['name' => 'country'])])
       
->setMetrics([new Metric(['name' => 'activeUsers'])]);
    $response
= $client->runRealtimeReport($request);

    printRunRealtimeReportResponse
($response);
}

/**
 * Print results of a runRealtimeReport call.
 * @param RunRealtimeReportResponse $response
 */

function printRunRealtimeReportResponse(RunRealtimeReportResponse $response)
{
    printf
('%s rows received%s', $response->getRowCount(), PHP_EOL);
   
foreach ($response->getDimensionHeaders() as $dimensionHeader) {
        printf
('Dimension header name: %s%s', $dimensionHeader->getName(), PHP_EOL);
   
}
   
foreach ($response->getMetricHeaders() as $metricHeader) {
        printf
(
           
'Metric header name: %s (%s)%s',
            $metricHeader
->getName(),
           
MetricType::name($metricHeader->getType()),
            PHP_EOL
       
);
   
}

   
print 'Report result: ' . PHP_EOL;

   
foreach ($response->getRows() as $row) {
        printf
(
           
'%s %s' . PHP_EOL,
            $row
->getDimensionValues()[0]->getValue(),
            $row
->getMetricValues()[0]->getValue()
       
);
   
}
}
from google.analytics.data_v1beta import BetaAnalyticsDataClient
from google.analytics.data_v1beta.types import (
   
Dimension,
   
Metric,
   
RunRealtimeReportRequest,
)

from run_report import print_run_report_response


def run_sample():
   
"""Runs the sample."""
   
# TODO(developer): Replace this variable with your Google Analytics 4
   
#  property ID before running the sample.
    property_id
= "YOUR-GA4-PROPERTY-ID"
    run_realtime_report
(property_id)


def run_realtime_report(property_id="YOUR-GA4-PROPERTY-ID"):
   
"""Runs a realtime report on a Google Analytics 4 property."""
    client
= BetaAnalyticsDataClient()

    request
= RunRealtimeReportRequest(
        property
=f"properties/{property_id}",
        dimensions
=[Dimension(name="country")],
        metrics
=[Metric(name="activeUsers")],
   
)
    response
= client.run_realtime_report(request)
    print_run_report_response
(response)


  /**
   * TODO(developer): Uncomment this variable and replace with your GA4
   *   property ID before running the sample.
   */

 
// propertyId = 'YOUR-GA4-PROPERTY-ID';

 
// Imports the Google Analytics Data API client library.
 
const {BetaAnalyticsDataClient} = require('@google-analytics/data');

 
// Creates a client.
 
const analyticsDataClient = new BetaAnalyticsDataClient();

 
// Runs a realtime report on a Google Analytics 4 property.
  async
function runRealtimeReport() {
   
const [response] = await analyticsDataClient.runRealtimeReport({
      property
: `properties/${propertyId}`,
      dimensions
: [
       
{
          name
: 'country',
       
},
     
],
      metrics
: [
       
{
          name
: 'activeUsers',
       
},
     
],
   
});
    printRunReportResponse
(response);
 
}

  runRealtimeReport
();

 
// Prints results of a runReport call.
 
function printRunReportResponse(response) {
    console
.log(`${response.rowCount} rows received`);
    response
.dimensionHeaders.forEach(dimensionHeader => {
      console
.log(`Dimension header name: ${dimensionHeader.name}`);
   
});
    response
.metricHeaders.forEach(metricHeader => {
      console
.log(
       
`Metric header name: ${metricHeader.name} (${metricHeader.type})`
     
);
   
});

    console
.log('Report result:');
    response
.rows.forEach(row => {
      console
.log(
       
`${row.dimensionValues[0].value}, ${row.metricValues[0].value}`
     
);
   
});
 
}

Сообщить об ответе

Ответ отчета в реальном времени на запрос API представляет собой в основном заголовок и строки. Заголовок состоит из DimensionHeaders и MetricHeaders , в которых перечислены столбцы отчета. Каждая строка состоит из DimensionValues ​​и MetricValues ​​для столбцов отчета. Порядок столбцов одинаков в запросе, заголовке и каждой строке.

Вот пример ответа на приведенный выше образец запроса:

{
 
"dimensionHeaders": [
   
{
     
"name": "country"
   
}
 
],
 
"metricHeaders": [
   
{
     
"name": "activeUsers",
     
"type": "TYPE_INTEGER"
   
}
 
],
 
"rows": [
   
{
     
"dimensionValues": [
       
{
         
"value": "Japan"
       
}
     
],
     
"metricValues": [
       
{
         
"value": "2541"
       
}
     
]
   
},
   
{
     
"dimensionValues": [
       
{
         
"value": "France"
       
}
     
],
     
"metricValues": [
       
{
         
"value": "12"
       
}
     
]
   
}
 
],
 
"rowCount": 2
}

Размеры

Размеры описывают и группируют данные о событиях для вашего веб-сайта или приложения. Например, параметр city указывает город («Париж» или «Нью-Йорк»), в котором произошло каждое событие. В запросе отчета вы можете указать ноль или более измерений. Полный список имен измерений API, доступных в запросах в реальном времени, см. в разделе «Измерения реального времени» .

Например, этот запрос группирует активных пользователей в двух столбцах измерений:

POST https://analyticsdata.googleapis.com/v1beta/property/GA_PROPERTY_ID:runRealtimeReport
 
{
   
"dimensions": [
     
{
       
"name": "country"
     
},
     
{
       
"name": "city"
     
}
   
],
   
"metrics": [{ "name": "activeUsers" }]
 
}

import com.google.analytics.data.v1beta.BetaAnalyticsDataClient;
import com.google.analytics.data.v1beta.Dimension;
import com.google.analytics.data.v1beta.Metric;
import com.google.analytics.data.v1beta.RunRealtimeReportRequest;
import com.google.analytics.data.v1beta.RunRealtimeReportResponse;

/**
 * Google Analytics Data API sample application demonstrating the creation of a realtime report.
 *
 * <p>See
 * https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runRealtimeReport
 * for more information.
 *
 * <p>Before you start the application, please review the comments starting with "TODO(developer)"
 * and update the code to use correct values.
 *
 * <p>To run this sample using Maven:
 *
 * <pre>{@code
 * cd google-analytics-data
 * mvn compile exec:java -Dexec.mainClass="com.google.analytics.data.samples.RunRealtimeReportWithMultipleDimensionsSample"
 * }</pre>
 */

public class RunRealtimeReportWithMultipleDimensionsSample {

 
public static void main(String... args) throws Exception {
   
// TODO(developer): Replace with your Google Analytics 4 property ID before running the sample.
   
String propertyId = "YOUR-GA4-PROPERTY-ID";
    sampleRunRealtimeReportWithMultipleDimensions
(propertyId);
 
}

 
// Runs a realtime report on a Google Analytics 4 property.
 
static void sampleRunRealtimeReportWithMultipleDimensions(String propertyId) throws Exception {
   
// Initialize client that will be used to send requests. This client only needs to be created
   
// once, and can be reused for multiple requests. After completing all of your requests, call
   
// the "close" method on the client to safely clean up any remaining background resources.
   
try (BetaAnalyticsDataClient analyticsData = BetaAnalyticsDataClient.create()) {
     
RunRealtimeReportRequest request =
         
RunRealtimeReportRequest.newBuilder()
             
.setProperty("properties/" + propertyId)
             
.addDimensions(Dimension.newBuilder().setName("country"))
             
.addDimensions(Dimension.newBuilder().setName(("city")))
             
.addMetrics(Metric.newBuilder().setName("activeUsers"))
             
.build();

     
// Make the request.
     
RunRealtimeReportResponse response = analyticsData.runRealtimeReport(request);
     
// Prints the response using a method in RunRealtimeReportSample.java
     
RunRealtimeReportSample.printRunRealtimeReportResponse(response);
   
}
 
}
}
use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
use Google\Analytics\Data\V1beta\RunRealtimeReportRequest;
use Google\Analytics\Data\V1beta\RunRealtimeReportResponse;

/**
 * Runs a realtime report on a Google Analytics 4 property.
 * @param string $propertyId Your GA-4 Property ID
 */

function run_realtime_report_with_multiple_dimensions(string $propertyId)
{
   
// Create an instance of the Google Analytics Data API client library.
    $client
= new BetaAnalyticsDataClient();

   
// Make an API call.
    $request
= (new RunRealtimeReportRequest())
       
->setProperty('properties/' . $propertyId)
       
->setDimensions([
           
new Dimension(['name' => 'country']),
           
new Dimension(['name' => 'city']),
       
])
       
->setMetrics([new Metric(['name' => 'activeUsers'])]);
    $response
= $client->runRealtimeReport($request);

    printRunRealtimeReportWithMultipleDimensionsResponse
($response);
}

/**
 * Print results of a runRealtimeReport call.
 * @param RunRealtimeReportResponse $response
 */

function printRunRealtimeReportWithMultipleDimensionsResponse(RunRealtimeReportResponse $response)
{
    printf
('%s rows received%s', $response->getRowCount(), PHP_EOL);
   
foreach ($response->getDimensionHeaders() as $dimensionHeader) {
        printf
('Dimension header name: %s%s', $dimensionHeader->getName(), PHP_EOL);
   
}
   
foreach ($response->getMetricHeaders() as $metricHeader) {
        printf
(
           
'Metric header name: %s (%s)%s',
            $metricHeader
->getName(),
           
MetricType::name($metricHeader->getType()),
            PHP_EOL
       
);
   
}

   
print 'Report result: ' . PHP_EOL;

   
foreach ($response->getRows() as $row) {
        printf
(
           
'%s %s' . PHP_EOL,
            $row
->getDimensionValues()[0]->getValue(),
            $row
->getMetricValues()[0]->getValue()
       
);
   
}
}
from google.analytics.data_v1beta import BetaAnalyticsDataClient
from google.analytics.data_v1beta.types import (
   
Dimension,
   
Metric,
   
RunRealtimeReportRequest,
)

from run_report import print_run_report_response


def run_sample():
   
"""Runs the sample."""
   
# TODO(developer): Replace this variable with your Google Analytics 4
   
#  property ID before running the sample.
    property_id
= "YOUR-GA4-PROPERTY-ID"
    run_realtime_report_with_multiple_dimensions
(property_id)


def run_realtime_report_with_multiple_dimensions(property_id="YOUR-GA4-PROPERTY-ID"):
   
"""Runs a realtime report on a Google Analytics 4 property."""
    client
= BetaAnalyticsDataClient()

    request
= RunRealtimeReportRequest(
        property
=f"properties/{property_id}",
        dimensions
=[Dimension(name="country"), Dimension(name="city")],
        metrics
=[Metric(name="activeUsers")],
   
)
    response
= client.run_realtime_report(request)
    print_run_report_response
(response)


  /**
   * TODO(developer): Uncomment this variable and replace with your GA4
   *   property ID before running the sample.
   */

 
// propertyId = 'YOUR-GA4-PROPERTY-ID';

 
// Imports the Google Analytics Data API client library.
 
const {BetaAnalyticsDataClient} = require('@google-analytics/data');

 
// Initialize client that will be used to send requests. This client only
 
// needs to be created once, and can be reused for multiple requests.
 
const analyticsDataClient = new BetaAnalyticsDataClient();

 
// Runs a realtime report on a Google Analytics 4 property.
  async
function runRealtimeReportWithMultipleDimensions() {
   
const [response] = await analyticsDataClient.runRealtimeReport({
      property
: `properties/${propertyId}`,
      dimensions
: [
       
{
          name
: 'country',
       
},
       
{
          name
: 'city',
       
},
     
],
      metrics
: [
       
{
          name
: 'activeUsers',
       
},
     
],
   
});
    printRunReportResponse
(response);
 
}

  runRealtimeReportWithMultipleDimensions
();

 
// Prints results of a runReport call.
 
function printRunReportResponse(response) {
    console
.log(`${response.rowCount} rows received`);
    response
.dimensionHeaders.forEach(dimensionHeader => {
      console
.log(`Dimension header name: ${dimensionHeader.name}`);
   
});
    response
.metricHeaders.forEach(metricHeader => {
      console
.log(
       
`Metric header name: ${metricHeader.name} (${metricHeader.type})`
     
);
   
});

    console
.log('Report result:');
    response
.rows.forEach(row => {
      console
.log(
       
`${row.dimensionValues[0].value}, ${row.metricValues[0].value}`
     
);
   
});
 
}

Например, строка в ответе отчета может содержать следующее. Эта строка означает, что на вашем веб-сайте или в приложении зарегистрировано 47 активных пользователей с событиями из Кейптауна, Южная Африка, за последние 30 минут.

"rows": [
...
{
 
"dimensionValues": [
   
{
     
"value": "South Africa"
   
},
   
{
     
"value": "Cape Town"
   
}
 
],
 
"metricValues": [
   
{
     
"value": "47"
   
}
 
]
},
...
],

Метрики

Метрики – это количественные измерения данных о событиях на вашем веб-сайте или в приложении. В запросе отчета вы можете указать одну или несколько метрик. Полный список названий метрик API, доступных в запросах, см. в разделе «Метрики реального времени» .

Например, этот запрос покажет две метрики, сгруппированные по измерению unifiedScreenName :

POST https://analyticsdata.googleapis.com/v1beta/property/GA_PROPERTY_ID:runRealtimeReport
 
{
   
"dimensions": [{ "name": "unifiedScreenName" }],
   
"metrics": [
     
{
       
"name": "screenPageViews"
     
},
     
{
       
"name": "keyEvents"
     
}
   
],
 
}

import com.google.analytics.data.v1beta.BetaAnalyticsDataClient;
import com.google.analytics.data.v1beta.Dimension;
import com.google.analytics.data.v1beta.Metric;
import com.google.analytics.data.v1beta.RunRealtimeReportRequest;
import com.google.analytics.data.v1beta.RunRealtimeReportResponse;

/**
 * Google Analytics Data API sample application demonstrating the creation of a realtime report.
 *
 * <p>See
 * https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runRealtimeReport
 * for more information.
 *
 * <p>Before you start the application, please review the comments starting with "TODO(developer)"
 * and update the code to use correct values.
 *
 * <p>To run this sample using Maven:
 *
 * <pre>{@code
 * cd google-analytics-data
 * mvn compile exec:java -Dexec.mainClass="com.google.analytics.data.samples.RunRealtimeReportWithMultipleMetricsSample"
 * }</pre>
 */

public class RunRealtimeReportWithMultipleMetricsSample {

 
public static void main(String... args) throws Exception {
   
// TODO(developer): Replace with your Google Analytics 4 property ID before running the sample.
   
String propertyId = "YOUR-GA4-PROPERTY-ID";
    sampleRunRealtimeReportWithMultipleMetrics
(propertyId);
 
}

 
// Runs a realtime report on a Google Analytics 4 property.
 
static void sampleRunRealtimeReportWithMultipleMetrics(String propertyId) throws Exception {
   
// Initialize client that will be used to send requests. This client only needs to be created
   
// once, and can be reused for multiple requests. After completing all of your requests, call
   
// the "close" method on the client to safely clean up any remaining background resources.
   
try (BetaAnalyticsDataClient analyticsData = BetaAnalyticsDataClient.create()) {
     
RunRealtimeReportRequest request =
         
RunRealtimeReportRequest.newBuilder()
             
.setProperty("properties/" + propertyId)
             
.addDimensions(Dimension.newBuilder().setName("unifiedScreenName"))
             
.addMetrics(Metric.newBuilder().setName(("screenPageViews")))
             
.addMetrics(Metric.newBuilder().setName("keyEvents"))
             
.build();

     
// Make the request.
     
RunRealtimeReportResponse response = analyticsData.runRealtimeReport(request);
     
// Prints the response using a method in RunRealtimeReportSample.java
     
RunRealtimeReportSample.printRunRealtimeReportResponse(response);
   
}
 
}
}
use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
use Google\Analytics\Data\V1beta\RunRealtimeReportRequest;
use Google\Analytics\Data\V1beta\RunRealtimeReportResponse;

/**
 * Runs a realtime report on a Google Analytics 4 property.
 * @param string $propertyId Your GA-4 Property ID
 */

function run_realtime_report_with_multiple_metrics(string $propertyId)
{
   
// Create an instance of the Google Analytics Data API client library.
    $client
= new BetaAnalyticsDataClient();

   
// Make an API call.
    $request
= (new RunRealtimeReportRequest())
       
->setProperty('properties/' . $propertyId)
       
->setDimensions([new Dimension(['name' => 'unifiedScreenName'])])
       
->setMetrics([
           
new Metric(['name' => 'screenPageViews']),
           
new Metric(['name' => 'keyEvents']),
       
]);
    $response
= $client->runRealtimeReport($request);

    printRunRealtimeReportWithMultipleMetricsResponse
($response);
}

/**
 * Print results of a runRealtimeReport call.
 * @param RunRealtimeReportResponse $response
 */

function printRunRealtimeReportWithMultipleMetricsResponse(RunRealtimeReportResponse $response)
{
    printf
('%s rows received%s', $response->getRowCount(), PHP_EOL);
   
foreach ($response->getDimensionHeaders() as $dimensionHeader) {
        printf
('Dimension header name: %s%s', $dimensionHeader->getName(), PHP_EOL);
   
}
   
foreach ($response->getMetricHeaders() as $metricHeader) {
        printf
(
           
'Metric header name: %s (%s)%s',
            $metricHeader
->getName(),
           
MetricType::name($metricHeader->getType()),
            PHP_EOL
       
);
   
}

   
print 'Report result: ' . PHP_EOL;

   
foreach ($response->getRows() as $row) {
        printf
(
           
'%s %s' . PHP_EOL,
            $row
->getDimensionValues()[0]->getValue(),
            $row
->getMetricValues()[0]->getValue()
       
);
   
}
}
from google.analytics.data_v1beta import BetaAnalyticsDataClient
from google.analytics.data_v1beta.types import (
   
Dimension,
   
Metric,
   
RunRealtimeReportRequest,
)

from run_report import print_run_report_response


def run_sample():
   
"""Runs the sample."""
   
# TODO(developer): Replace this variable with your Google Analytics 4
   
#  property ID before running the sample.
    property_id
= "YOUR-GA4-PROPERTY-ID"
    run_realtime_report_with_multiple_metrics
(property_id)


def run_realtime_report_with_multiple_metrics(property_id="YOUR-GA4-PROPERTY-ID"):
   
"""Runs a realtime report on a Google Analytics 4 property."""
    client
= BetaAnalyticsDataClient()

    request
= RunRealtimeReportRequest(
        property
=f"properties/{property_id}",
        dimensions
=[Dimension(name="unifiedScreenName")],
        metrics
=[Metric(name="screenPageViews"), Metric(name="keyEvents")],
   
)
    response
= client.run_realtime_report(request)
    print_run_report_response
(response)


  /**
   * TODO(developer): Uncomment this variable and replace with your GA4
   *   property ID before running the sample.
   */

 
// propertyId = 'YOUR-GA4-PROPERTY-ID';

 
// Imports the Google Analytics Data API client library.
 
const {BetaAnalyticsDataClient} = require('@google-analytics/data');

 
// Creates a client.
 
const analyticsDataClient = new BetaAnalyticsDataClient();

 
// Runs a realtime report on a Google Analytics 4 property.
  async
function runRealtimeReportWithMultipleMetrics() {
   
const [response] = await analyticsDataClient.runRealtimeReport({
     
// The property parameter value must be in the form `properties/1234`
     
// where `1234` is a GA4 property Id.
      property
: `properties/${propertyId}`,
      dimensions
: [
       
{
          name
: 'unifiedScreenName',
       
},
     
],
      metrics
: [
       
{
          name
: 'screenPageViews',
       
},
       
{
          name
: 'keyEvents',
       
},
     
],
   
});
    printRunReportResponse
(response);
 
}

  runRealtimeReportWithMultipleMetrics
();

 
// Prints results of a runReport call.
 
function printRunReportResponse(response) {
    console
.log(`${response.rowCount} rows received`);
    response
.dimensionHeaders.forEach(dimensionHeader => {
      console
.log(`Dimension header name: ${dimensionHeader.name}`);
   
});
    response
.metricHeaders.forEach(metricHeader => {
      console
.log(
       
`Metric header name: ${metricHeader.name} (${metricHeader.type})`
     
);
   
});

    console
.log('Report result:');
    response
.rows.forEach(row => {
      console
.log(
       
`${row.dimensionValues[0].value}, ${row.metricValues[0].value}`
     
);
   
});
 
}

Например, строка в ответе отчета может содержать следующее. Эта строка означает, что для заголовка страницы (веб) или имени экрана (приложение) main_menu за последние 30 минут было 257 просмотров и 72 ключевых события.

"rows": [
...
{
 
"dimensionValues": [
   
{
     
"value": "main_menu"
   
}
 
],
 
"metricValues": [
   
{
     
"value": "257"
   
},
   
{
     
"value": "72"
   
}
 
]
},
...
],

Минутные диапазоны

В запросе отчета в реальном времени вы можете использовать поле минутные диапазоны , чтобы указать минутные диапазоны данных событий для чтения. В запросе можно использовать до двух отдельных диапазонов минут. Если в запросе отсутствует указание минутного диапазона, будет использоваться один минутный диапазон за последние 30 минут.

Например, запрос ниже покажет количество активных пользователей для двух отдельных диапазонов минут:

  • Диапазон №1: начиная с 4 минут назад и до настоящего момента.
  • Диапазон №2: от 29 минут назад до 25 минут назад (включительно).

POST https://analyticsdata.googleapis.com/v1beta/property/GA_PROPERTY_ID:runRealtimeReport
 
{
   
"metrics": [
     
{
       
"name": "activeUsers"
     
}
   
],
   
"minuteRanges": [
     
{
       
"name": "0-4 minutes ago",
       
"startMinutesAgo": 4,
     
},
     
{
       
"name": "25-29 minutes ago",
       
"startMinutesAgo": 29,
       
"endMinutesAgo": 25,
     
}
   
],
 
}

import com.google.analytics.data.v1beta.BetaAnalyticsDataClient;
import com.google.analytics.data.v1beta.Metric;
import com.google.analytics.data.v1beta.MinuteRange;
import com.google.analytics.data.v1beta.RunRealtimeReportRequest;
import com.google.analytics.data.v1beta.RunRealtimeReportResponse;

/**
 * Google Analytics Data API sample application demonstrating the creation of a realtime report.
 *
 * <p>See
 * https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runRealtimeReport
 * for more information.
 *
 * <p>Before you start the application, please review the comments starting with "TODO(developer)"
 * and update the code to use correct values.
 *
 * <p>To run this sample using Maven:
 *
 * <pre>{@code
 * cd google-analytics-data
 * mvn compile exec:java -Dexec.mainClass="com.google.analytics.data.samples.RunRealtimeReportWithMinuteRangesSample"
 * }</pre>
 */

public class RunRealtimeReportWithMinuteRangesSample {

 
public static void main(String... args) throws Exception {
   
// TODO(developer): Replace with your Google Analytics 4 property ID before running the sample.
   
String propertyId = "YOUR-GA4-PROPERTY-ID";
    sampleRunRealtimeReportWithMinuteRanges
(propertyId);
 
}

 
// Runs a realtime report on a Google Analytics 4 property.
 
static void sampleRunRealtimeReportWithMinuteRanges(String propertyId) throws Exception {
   
// Initialize client that will be used to send requests. This client only needs to be created
   
// once, and can be reused for multiple requests. After completing all of your requests, call
   
// the "close" method on the client to safely clean up any remaining background resources.
   
try (BetaAnalyticsDataClient analyticsData = BetaAnalyticsDataClient.create()) {
     
RunRealtimeReportRequest request =
         
RunRealtimeReportRequest.newBuilder()
             
.setProperty("properties/" + propertyId)
             
.addMetrics(Metric.newBuilder().setName(("activeUsers")))
             
.addMinuteRanges(
                 
MinuteRange.newBuilder().setName("0-4 minutes ago").setStartMinutesAgo(4))
             
.addMinuteRanges(
                 
MinuteRange.newBuilder()
                     
.setName("25-29 minutes ago")
                     
.setEndMinutesAgo(29)
                     
.setEndMinutesAgo(25))
             
.build();

     
// Make the request.
     
RunRealtimeReportResponse response = analyticsData.runRealtimeReport(request);
     
// Prints the response using a method in RunRealtimeReportSample.java
     
RunRealtimeReportSample.printRunRealtimeReportResponse(response);
   
}
 
}
}
use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
use Google\Analytics\Data\V1beta\MinuteRange;
use Google\Analytics\Data\V1beta\RunRealtimeReportRequest;
use Google\Analytics\Data\V1beta\RunRealtimeReportResponse;

/**
 * Runs a realtime report on a Google Analytics 4 property. Dimensions field is
 * omitted in the query, which results in total values of active users returned
 * for each minute range in the report.
 *
 * Note the `dateRange` dimension added to the report response automatically as
 * a result of querying multiple minute ranges.
 * @param string $propertyId Your GA-4 Property ID
 */

function run_realtime_report_with_minute_ranges(string $propertyId)
{
   
// Create an instance of the Google Analytics Data API client library.
    $client
= new BetaAnalyticsDataClient();

   
// Make an API call.
    $request
= (new RunRealtimeReportRequest())
       
->setProperty('properties/' . $propertyId)
       
->setMetrics([
           
new Metric(['name' => 'activeUsers']),
       
])
       
->setMinuteRanges([
           
new MinuteRange(['name' => '0-4 minutes ago', 'start_minutes_ago' => 4]),
           
new MinuteRange(['name' => '25-29 minutes ago', 'start_minutes_ago' => 29, 'end_minutes_ago' => 25]),
       
]);
    $response
= $client->runRealtimeReport($request);

    printRunRealtimeReportWithMinuteRangesResponse
($response);
}

/**
 * Print results of a runRealtimeReport call.
 * @param RunRealtimeReportResponse $response
 */

function printRunRealtimeReportWithMinuteRangesResponse(RunRealtimeReportResponse $response)
{
    printf
('%s rows received%s', $response->getRowCount(), PHP_EOL);
   
foreach ($response->getDimensionHeaders() as $dimensionHeader) {
        printf
('Dimension header name: %s%s', $dimensionHeader->getName(), PHP_EOL);
   
}
   
foreach ($response->getMetricHeaders() as $metricHeader) {
        printf
(
           
'Metric header name: %s (%s)%s',
            $metricHeader
->getName(),
           
MetricType::name($metricHeader->getType()),
            PHP_EOL
       
);
   
}

   
print 'Report result: ' . PHP_EOL;
   
foreach ($response->getRows() as $row) {
        printf
(
           
'%s %s' . PHP_EOL,
            $row
->getDimensionValues()[0]->getValue(),
            $row
->getMetricValues()[0]->getValue()
       
);
   
}
}
from google.analytics.data_v1beta import BetaAnalyticsDataClient
from google.analytics.data_v1beta.types import (
   
Metric,
   
MinuteRange,
   
RunRealtimeReportRequest,
)

from run_report import print_run_report_response


def run_sample():
   
"""Runs the sample."""
   
# TODO(developer): Replace this variable with your Google Analytics 4
   
#  property ID before running the sample.
    property_id
= "YOUR-GA4-PROPERTY-ID"
    run_realtime_report_with_minute_ranges
(property_id)


def run_realtime_report_with_minute_ranges(property_id="YOUR-GA4-PROPERTY-ID"):
   
"""Runs a realtime report on a Google Analytics 4 property. Dimensions
    field is omitted in the query, which results in total values of active users
    returned for each minute range in the report.

    Note the `dateRange` dimension added to the report response automatically
    as a result of querying multiple minute ranges.
    """

    client
= BetaAnalyticsDataClient()

    request
= RunRealtimeReportRequest(
        property
=f"properties/{property_id}",
        metrics
=[Metric(name="activeUsers")],
        minute_ranges
=[
           
MinuteRange(name="0-4 minutes ago", start_minutes_ago=4),
           
MinuteRange(
                name
="25-29 minutes ago", start_minutes_ago=29, end_minutes_ago=25
           
),
       
],
   
)
    response
= client.run_realtime_report(request)
    print_run_report_response
(response)



 
// TODO(developer): Uncomment this variable and replace with your
 
// Google Analytics 4 property ID before running the sample.
 
// propertyId = 'YOUR-GA4-PROPERTY-ID';

 
// Imports the Google Analytics Data API client library.
 
const {BetaAnalyticsDataClient} = require('@google-analytics/data');

 
// Initialize client that will be used to send requests. This client only
 
// needs to be created once, and can be reused for multiple requests.
 
const analyticsDataClient = new BetaAnalyticsDataClient();

 
// Runs a report using two date ranges.
  async
function runRealtimeReportWithMinuteRanges() {
   
const [response] = await analyticsDataClient.runRealtimeReport({
      property
: `properties/${propertyId}`,
      minuteRanges
: [
       
{
          name
: '0-4 minutes ago',
          startMinutesAgo
: 4,
          endMinutesAgo
: 0,
       
},
       
{
          name
: '25-29 minutes ago',
          startMinutesAgo
: 29,
          endMinutesAgo
: 25,
       
},
     
],
      metrics
: [
       
{
          name
: 'activeUsers',
       
},
     
],
   
});
    printRunReportResponse
(response);
 
}

  runRealtimeReportWithMinuteRanges
();

 
// Prints results of a runReport call.
 
function printRunReportResponse(response) {
    console
.log(`${response.rowCount} rows received`);
    response
.dimensionHeaders.forEach(dimensionHeader => {
      console
.log(`Dimension header name: ${dimensionHeader.name}`);
   
});
    response
.metricHeaders.forEach(metricHeader => {
      console
.log(
       
`Metric header name: ${metricHeader.name} (${metricHeader.type})`
     
);
   
});

    console
.log('Report result:');
    response
.rows.forEach(row => {
      console
.log(
       
`${row.dimensionValues[0].value}, ${row.metricValues[0].value}`
     
);
   
});
 
}

Ниже приведен полный пример ответа на запрос. Обратите внимание, что измерение dateRange автоматически добавляется в ответ отчета в результате запроса нескольких диапазонов минут.

  {
   
"dimensionHeaders": [
     
{
       
"name": "dateRange"
     
}
   
],
   
"metricHeaders": [
     
{
       
"name": "activeUsers",
       
"type": "TYPE_INTEGER"
     
}
   
],
   
"rows": [
     
{
       
"dimensionValues": [
         
{
           
"value": "0-4 minutes ago"
         
}
       
],
       
"metricValues": [
         
{
           
"value": "16"
         
}
       
]
     
},
     
{
       
"dimensionValues": [
         
{
           
"value": "25-29 minutes ago"
         
}
       
],
       
"metricValues": [
         
{
           
"value": "14"
         
}
       
]
     
}
   
],
   
"rowCount": 2,
   
"kind": "analyticsData#runRealtimeReport"
 
}