यहां रीयल टाइम रिपोर्टिंग एपीआई तरीके की सुविधाओं के बारे में खास जानकारी दी गई है Google Analytics Data API v1. एपीआई की ज़्यादा जानकारी के लिए, यहां देखें एपीआई का संदर्भ.
इवेंट Google को भेजे जाने के कुछ सेकंड बाद, वे रीयलटाइम रिपोर्ट में दिखेंगी Analytics. रीयलटाइम रिपोर्ट में, तय समयावधि के दौरान हुए इवेंट और इस्तेमाल से जुड़ा डेटा दिखता है मौजूदा समय से लेकर 30 मिनट पहले तक (Google के लिए 60 मिनट तक) Analytics 360 प्रॉपर्टी) से लिंक किया जा सकता है और इसका इस्तेमाल लाइव आपकी वेबसाइट पर कई विज़िटरों की संख्या बढ़ाने के लिए.
रीयल टाइम रिपोर्ट, डाइमेंशन और मेट्रिक के सीमित सबसेट के साथ काम करती हैं की तुलना में मुख्य रिपोर्टिंग की सुविधा की तुलना में डेटा एपीआई v1.
मुख्य रिपोर्ट के साथ शेयर की गई सुविधाएं
रीयल टाइम रिपोर्ट के अनुरोधों और कोर रिपोर्ट अनुरोधों का मतलब एक जैसा होता है शेयर किए गए कई फ़ीचर शामिल हैं. उदाहरण के लिए, पेज पर नंबर डालना, डाइमेंशन फ़िल्टर और उपयोगकर्ता प्रॉपर्टी, दोनों एक ही तरह काम करती हैं इन्हें 'रीयल टाइम रिपोर्ट' में कोर रिपोर्ट के तौर पर देखा जा सकता है. कृपया इसके बारे में जानें Data API v1 के मुख्य रिपोर्टिंग फ़ंक्शन के बारे में खास जानकारी, इस दस्तावेज़ का बाकी हिस्सा, हमारी उन सुविधाओं पर फ़ोकस करेगा जो रीयलटाइम रिपोर्ट के अनुरोध.
शिकायत अनुरोध
रीयलटाइम रिपोर्ट का अनुरोध करने के लिए, RunRealtimeReportRequest ऑब्जेक्ट है. हमारा सुझाव है कि आप इन अनुरोध पैरामीटर से शुरू करें:
यहां सुझाए गए फ़ील्ड के साथ अनुरोध का एक सैंपल दिया गया है.
HTTP
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runRealtimeReport
{
"dimensions": [{ "name": "country" }],
"metrics": [{ "name": "activeUsers" }]
}
Java
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());
}
}
}
PHP
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()
);
}
}
Python
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)
Node.js
/**
* 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}`
);
});
}
जवाब की शिकायत करें
रीयल टाइम रिपोर्ट का जवाब में मुख्य रूप से हेडर और लाइनें होती हैं. हेडर में ये शामिल होते हैं 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 डाइमेंशन से शहर ("पेरिस" का पता चलता है
या "न्यूयॉर्क") जिससे हर इवेंट शुरू हुआ. रिपोर्ट अनुरोध में, ये काम किए जा सकते हैं
शून्य या उससे ज़्यादा डाइमेंशन डालें. रीयल टाइम डाइमेंशन देखें
रीयलटाइम अनुरोधों में उपलब्ध एपीआई डाइमेंशन के नामों की पूरी सूची देखने के लिए.
उदाहरण के लिए, यह अनुरोध, सक्रिय उपयोगकर्ताओं को दो डाइमेंशन कॉलम में ग्रुप करता है:
HTTP
POST https://analyticsdata.googleapis.com/v1beta/property/GA_PROPERTY_ID:runRealtimeReport
{
"dimensions": [
{
"name": "country"
},
{
"name": "city"
}
],
"metrics": [{ "name": "activeUsers" }]
}
Java
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);
}
}
}
PHP
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()
);
}
}
Python
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)
Node.js
/**
* 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"
}
]
},
...
],
मेट्रिक
मेट्रिक आपकी वेबसाइट या ऐप्लिकेशन पर दिखाए जाते हैं. रिपोर्ट के अनुरोध में, एक या उससे ज़्यादा मेट्रिक तय की जा सकती हैं. एपीआई की पूरी सूची के लिए, रीयल टाइम मेट्रिक देखें अनुरोधों में मेट्रिक के नाम उपलब्ध हैं.
उदाहरण के लिए, यह अनुरोध डाइमेंशन के हिसाब से ग्रुप की गई दो मेट्रिक दिखाएगा
unifiedScreenName:
HTTP
POST https://analyticsdata.googleapis.com/v1beta/property/GA_PROPERTY_ID:runRealtimeReport
{
"dimensions": [{ "name": "unifiedScreenName" }],
"metrics": [
{
"name": "screenPageViews"
},
{
"name": "keyEvents"
}
],
}
Java
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);
}
}
}
PHP
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()
);
}
}
Python
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)
Node.js
/**
* 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"
}
]
},
...
],
मिनट की रेंज
रीयलटाइम रिपोर्ट के अनुरोध में, minuteRanges का इस्तेमाल किया जा सकता है मिनट की रेंज बताने वाला फ़ील्ड में से इवेंट डेटा को पढ़ सकते हैं. किसी क्वेरी में ज़्यादा से ज़्यादा दो मिनट की रेंज का इस्तेमाल किया जा सकता है. अगर कोई मिनट की सीमा की जानकारी किसी क्वेरी में मौजूद नहीं है. पिछले 30 मिनट का इस्तेमाल किया जाएगा.
उदाहरण के लिए, नीचे दिया गया अनुरोध, दो अलग-अलग मिनट के लिए सक्रिय उपयोगकर्ताओं की संख्या दिखाएगा रेंज:
- रेंज #1: 4 मिनट पहले से लेकर मौजूदा समय तक.
रेंज #2: 29 मिनट पहले से लेकर 25 मिनट पहले तक (शामिल हैं).
HTTP
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,
}
],
}
Java
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);
}
}
}
PHP
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()
);
}
}
Python
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)
Node.js
// 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"
}