API ของ Analytics ลิงก์แบบไดนามิกของ Firebase

คุณสามารถใช้ API ของ REST นี้เพื่อรับข้อมูลการวิเคราะห์สำหรับ Dynamic Links แบบสั้นแต่ละรายการ ไม่ว่าจะสร้างในคอนโซลหรือแบบเป็นโปรแกรม

การให้สิทธิ์ API

เมื่อส่งคำขอไปยัง Dynamic Link Analytics API คุณจะต้องรวม OAuth โทเค็นเพื่อการเข้าถึง 2.0 ที่ให้สิทธิ์เข้าถึงโปรเจ็กต์ Firebase

คุณรับโทเค็นเพื่อการเข้าถึงได้โดยใช้ไลบรารีของไคลเอ็นต์ Google API โดยทำดังนี้

1. เพิ่ม Firebase ลงในแอปเป็น ตามที่อธิบายไว้ในคู่มือการตั้งค่า Admin SDK กล่าวคือ สร้างบัญชีบริการ และสร้างคีย์ส่วนตัว
2. ใช้ไลบรารีของไคลเอ็นต์ Google API เพื่อรับโทเค็นเพื่อการเข้าถึงจากบริการของคุณ ข้อมูลเข้าสู่ระบบบัญชี:

   Java

   การใช้ ไลบรารีของไคลเอ็นต์ Google API สำหรับ Java:

   // 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 สำหรับ Node.js

   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

   การใช้ ไลบรารี Google Auth สำหรับ Python มีลักษณะดังต่อไปนี้

   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 เดียว

ใช้ปลายทาง linkStats เพื่อรับสถิติเหตุการณ์สำหรับ Dynamic Link รายการเดียว

คำขอ HTTP

คำขอ linkStats มีรูปแบบดังต่อไปนี้

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

Authorization: Bearer ACCESS_TOKEN

ตัวอย่างเช่น หากต้องการดึงข้อมูลสถิติในช่วง 7 วันที่ผ่านมาสำหรับลิงก์แบบสั้น 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...

เนื้อหาการตอบกลับ

การตอบกลับคำขอจะเป็นออบเจ็กต์ 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 ชั่วโมง