आप अपने प्रत्येक छोटे डायनेमिक लिंक के लिए एनालिटिक्स डेटा प्राप्त करने के लिए इस REST API का उपयोग कर सकते हैं, चाहे वह कंसोल में बनाया गया हो या प्रोग्रामेटिक रूप से ।
एपीआई प्राधिकरण
जब आप डायनामिक लिंक एनालिटिक्स एपीआई के लिए अनुरोध करते हैं, तो आपको एक OAuth 2.0 एक्सेस टोकन शामिल करना होगा जो आपके फायरबेस प्रोजेक्ट तक पहुंच को अधिकृत करता है।
आप Google API क्लाइंट लाइब्रेरी का उपयोग करके एक्सेस टोकन प्राप्त कर सकते हैं:
- एडमिन एसडीके सेटअप गाइड में बताए अनुसार अपने ऐप में फायरबेस जोड़ें । यानी एक सर्विस अकाउंट बनाएं और एक प्राइवेट कुंजी जेनरेट करें।
- अपने सेवा खाता क्रेडेंशियल से एक्सेस टोकन प्राप्त करने के लिए Google API क्लाइंट लाइब्रेरी का उपयोग करें:
जावा
जावा के लिए Google API क्लाइंट लाइब्रेरी का उपयोग करना:
// Load the service account key JSON file FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountKey.json"); // Authenticate a Google credential with the service account GoogleCredential googleCred = GoogleCredential.fromStream(serviceAccount); // Add the required scope to the Google credential GoogleCredential scoped = googleCred.createScoped( Arrays.asList( "https://www.googleapis.com/auth/firebase" ) ); // Use the Google credential to generate an access token scoped.refreshToken(); String token = scoped.getAccessToken(); // Include the access token in the Authorization header.
नोड.जे.एस
Node.js के लिए Google API क्लाइंट लाइब्रेरी का उपयोग करना:
var { google } = require("googleapis"); // Load the service account key JSON file. var serviceAccount = require("path/to/serviceAccountKey.json"); // Specify the required scope. var scopes = [ "https://www.googleapis.com/auth/firebase" ]; // Authenticate a JWT client with the service account. var jwtClient = new google.auth.JWT( serviceAccount.client_email, null, serviceAccount.private_key, scopes ); // Use the JWT client to generate an access token. jwtClient.authorize(function(error, tokens) { if (error) { console.log("Error making request to generate access token:", error); } else if (tokens.access_token === null) { console.log("Provided service account does not have permission to generate access tokens"); } else { var accessToken = tokens.access_token; // Include the access token in the Authorization header. } });
अजगर
पायथन के लिए Google Auth लाइब्रेरी का उपयोग करना:
from google.oauth2 import service_account from google.auth.transport.requests import AuthorizedSession # Specify the required scope scopes = [ "https://www.googleapis.com/auth/firebase" ] # Authenticate a credential with the service account credentials = service_account.Credentials.from_service_account_file( "path/to/serviceAccountKey.json", scopes=scopes) # Use the credentials object to authenticate a Requests session. authed_session = AuthorizedSession(credentials) response = authed_session.get( "https://firebasedynamiclinks.googleapis.com/v1/SHORT_DYNAMIC_LINK/linkStats?durationDays=DURATION") # Or, use the token directly, as described below. request = google.auth.transport.requests.Request() credentials.refresh(request) access_token = credentials.token
एकल डायनामिक लिंक के लिए आँकड़े प्राप्त करें
एकल डायनामिक लिंक के लिए ईवेंट आँकड़े प्राप्त करने के लिए linkStats
एंडपॉइंट का उपयोग करें।
HTTP अनुरोध
एक linkStats
अनुरोध में निम्नलिखित प्रारूप होता है:
GET https://firebasedynamiclinks.googleapis.com/v1/SHORT_DYNAMIC_LINK/linkStats?durationDays=DURATION Authorization: Bearer ACCESS_TOKEN
उदाहरण के लिए, छोटे लिंक https://example.page.link/wXYz
के लिए पिछले 7 दिनों के आंकड़े पुनः प्राप्त करने के लिए:
GET https://firebasedynamiclinks.googleapis.com/v1/https%3A%2F%2Fexample.page.link%2FwXYz/linkStats?durationDays=7 Authorization: Bearer ya29.Abc123...
पैरामीटर | |
---|---|
SHORT_DYNAMIC_LINK | URL-एन्कोडेड लघु डायनामिक लिंक जिसके लिए आप ईवेंट डेटा प्राप्त करना चाहते हैं। |
DURATION | इवेंट डेटा प्राप्त करने के लिए दिनों की संख्या. उदाहरण के लिए, यदि आप 30 निर्दिष्ट करते हैं, तो अनुरोध पिछले 30 दिनों का डेटा पुनर्प्राप्त करता है। ध्यान दें कि पिछले 36 घंटों में लॉग इन किए गए कुछ ईवेंट शामिल नहीं किए जा सकते हैं। |
ACCESS_TOKEN | एक असमाप्त पहुंच टोकन. एपीआई प्राधिकरण देखें। |
प्रतिक्रिया निकाय
किसी अनुरोध की प्रतिक्रिया निम्नलिखित की तरह एक JSON ऑब्जेक्ट है:
{
"linkEventStats": [
{
"platform": "ANDROID",
"count": "123",
"event": "CLICK"
},
{
"platform": "IOS",
"count": "123",
"event": "CLICK"
},
{
"platform": "DESKTOP",
"count": "456",
"event": "CLICK"
},
{
"platform": "ANDROID",
"count": "99",
"event": "APP_INSTALL"
},
{
"platform": "ANDROID",
"count": "42",
"event": "APP_FIRST_OPEN"
},
...
]
}
linkEventStats
सूची के प्रत्येक आइटम में कुछ डायनामिक लिंक संबंधित ईवेंट (जैसे एंड्रॉइड पर क्लिक की संख्या) की प्लेटफ़ॉर्म-विशिष्ट गणना होती है। ध्यान दें कि इन आँकड़ों में वे घटनाएँ शामिल नहीं हो सकती हैं जो पिछले 36 घंटों के भीतर लॉग की गई हैं।
आयोजन | विवरण | फायरबेस कंसोल | बाकी एपीआई |
---|---|---|---|
क्लिक | डायनामिक लिंक पर किसी भी क्लिक की गिनती, चाहे इसे कैसे भी प्रबंधित किया जाए और इसका गंतव्य कुछ भी हो | ||
पुन: निर्देशित करें | ऐप इंस्टॉल करने या अपडेट करने के लिए उपयोगकर्ताओं को ऐप स्टोर या प्ले स्टोर पर या किसी अन्य गंतव्य पर रीडायरेक्ट करने के प्रयासों की संख्या | ||
एपीपी_इंस्टॉल करें | वास्तविक इंस्टॉल की संख्या (केवल प्ले स्टोर द्वारा समर्थित) | ||
APP_FIRST_OPEN | इंस्टॉल के बाद पहली बार खुलने की संख्या | ||
एपीपी_RE_OPEN | डायनामिक लिंक के कारण किसी ऐप को दोबारा खोलने की संख्या |