Firebase डाइनैमिक लिंक Analytics API

अपने हर शॉर्ट वीडियो Dynamic Links का ऐनलिटिक्स डेटा पाने के लिए, इस REST API का इस्तेमाल किया जा सकता है, भले ही, उसे कंसोल में बनाया गया हो या प्रोग्राम के हिसाब से.

एपीआई की अनुमति

Dynamic Link Analytics APIs को ऐक्सेस करने का अनुरोध करते समय, आपको एक OAuth शामिल करना होगा 2.0 ऐक्सेस टोकन, जो आपके Firebase प्रोजेक्ट को ऐक्सेस करने की अनुमति देता है.

Google API क्लाइंट लाइब्रेरी का इस्तेमाल करके, ऐक्सेस टोकन हासिल किए जा सकते हैं:

  1. Firebase को अपने ऐप्लिकेशन में इस तौर पर जोड़ें एडमिन SDK सेटअप गाइड में बताया गया है. इसका मतलब है कि सेवा खाता बनाना और एक निजी कुंजी जनरेट करें.
  2. अपनी सेवा से ऐक्सेस टोकन पाने के लिए, Google API क्लाइंट लाइब्रेरी का इस्तेमाल करना खाते के क्रेडेंशियल:

    Java

    इसका उपयोग करके Java के लिए 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

    इसका उपयोग करके 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.
      }
    });
    

    Python

    का उपयोग करके Python के लिए 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
    

एकल Dynamic Link के आंकड़े पाएं

किसी Dynamic Link के इवेंट के आंकड़े पाने के लिए, linkStats एंडपॉइंट का इस्तेमाल करें.

एचटीटीपी अनुरोध

linkStats अनुरोध का फ़ॉर्मैट इस तरह होता है:

GET https://firebasedynamiclinks.googleapis.com/v1/SHORT_DYNAMIC_LINK/linkStats?durationDays=DURATION

Authorization: Bearer ACCESS_TOKEN

उदाहरण के लिए, छोटे लिंक के पिछले सात दिनों के आंकड़े पाने के लिए https://example.page.link/wXYz:

GET https://firebasedynamiclinks.googleapis.com/v1/https%3A%2F%2Fexample.page.link%2FwXYz/linkStats?durationDays=7

Authorization: Bearer ya29.Abc123...
पैरामीटर
SHORT_DYNAMIC_LINK यूआरएल से कोड में बदला गया छोटा Dynamic Link जिसके लिए आपको इवेंट का डेटा पाना है.
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 सूची के हर आइटम में, प्लैटफ़ॉर्म के हिसाब से Dynamic Link से जुड़ा कोई इवेंट (जैसे, Android पर मिले क्लिक की संख्या). ध्यान दें कि इन आंकड़ों में वे इवेंट शामिल नहीं हो सकते हैं जो पिछली बार 36 घंटे.

इवेंट ब्यौरा Firebase कंसोल REST API
क्लिक करें डाइनैमिक लिंक पर किए गए किसी भी क्लिक की संख्या, भले ही उसे मैनेज करने के लिए पेज और डेस्टिनेशन का इस्तेमाल किया गया हो
रीडायरेक्ट ऐप्लिकेशन को इंस्टॉल या अपडेट करने के लिए, उपयोगकर्ताओं को App Store या Play Store पर या किसी अन्य डेस्टिनेशन पर रीडायरेक्ट करने की कोशिशों की संख्या
APP_INSTALL असल में इंस्टॉल किए गए ऐप्लिकेशन की संख्या (सिर्फ़ Play Store पर उपलब्ध है)
APP_FIRST_OPEN किसी इंस्टॉल के बाद पहली बार ऐप्लिकेशन खोलने वाले लोगों की संख्या
APP_RE_OPEN डाइनैमिक लिंक की वजह से, किसी ऐप्लिकेशन को फिर से खोले जाने की संख्या