ตั้งค่าและจัดการโปรเจ็กต์ Firebase โดยใช้ Management REST API

Firebase Management REST API ช่วยให้คุณตั้งค่าและจัดการโปรเจ็กต์ Firebase ได้โดยอัตโนมัติ รวมถึงทรัพยากร Firebase และแอป Firebase ของโปรเจ็กต์

ภาพรวมนี้อธิบายเวิร์กโฟลว์ทั่วไปในการเพิ่มทรัพยากรและ แอป Firebase ลงในGoogle Cloud โปรเจ็กต์ ที่มีอยู่ซึ่งยังไม่ได้ใช้บริการ Firebase

คุณข้ามไปยังส่วนที่ต้องการของหน้านี้ได้หากต้องการทำสิ่งต่อไปนี้

• เพิ่มบริการ Firebase ลงในโปรเจ็กต์
• เพิ่มแอป Firebase ลงในโปรเจ็กต์ Firebase
• ลิงก์โปรเจ็กต์ Firebase กับบัญชี Google Analytics

โปรดตรวจสอบว่าได้เปิดใช้ API แล้วก่อนที่จะทำตามขั้นตอนใดๆ ในหน้านี้

ดูข้อมูลเกี่ยวกับการจัดการการเข้าถึงสำหรับ Firebase Management API ได้ที่ เอกสารประกอบของ Cloud Identity Access Management (IAM) API

ก่อนเริ่มต้น

ก่อนเริ่มต้น คุณจะต้องเปิดใช้ Management API สำหรับ โปรเจ็กต์ Google Cloudและ สร้างโทเค็นเพื่อการเข้าถึง

เปิดใช้ Management REST API สำหรับโปรเจ็กต์ Google Cloud

หากยังไม่ได้ดำเนินการ คุณจะต้องเปิดใช้ Firebase Management API เพื่อใช้กับโปรเจ็กต์ Google Cloud

1. เปิดหน้า Firebase Management API ในคอนโซล Google API
2. เลือกโปรเจ็กต์ Google Cloud เมื่อมีข้อความแจ้ง
3. คลิกเปิดใช้ ในหน้า Firebase Management API

สร้างโทเค็นเพื่อการเข้าถึง API

นี่คือตัวอย่างสำหรับ Node.js ที่ดึงโทเค็นเพื่อการเข้าถึง

ขั้นแรก หากคุณไม่ได้อยู่ในสภาพแวดล้อม Google Cloud ให้ตั้งค่าตัวแปรสภาพแวดล้อม GOOGLE_APPLICATION_CREDENTIALS เป็นเส้นทางไปยังคีย์บัญชีบริการ

export GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/service-account-file.json"

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\path\to\your\service-account-file.json"

จากนั้นใช้ Firebase Admin SDK เพื่อรับโทเค็นเพื่อการเข้าถึงจากข้อมูลเข้าสู่ระบบบัญชีบริการ

import { initializeApp, applicationDefault } from "firebase-admin/app";

initializeApp();

async function getAccessToken() {
  try {
    const accessToken = await applicationDefault().getAccessToken();
    return accessToken.access_token;
  } catch (err) {
    console.error('Unable to get access token');
    console.error(err);
  }
}

ค้นหาชื่อทรัพยากรของโปรเจ็กต์

คุณสามารถค้นหาโปรเจ็กต์ Google Cloud ที่พร้อมใช้งานสำหรับการเพิ่มบริการ Firebase

คำขอ

Gọi availableProjects.list. เนื้อหาคำขอสำหรับการเรียกนี้ต้องว่างเปล่า

นี่คือตัวอย่างสำหรับ Node.js เพื่อขอรายการGoogle Cloud โปรเจ็กต์ที่พร้อมใช้งาน:

const fetch = require('node-fetch');

async function listProjects() {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/availableProjects';
  const options = {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    const projects = resp['projectInfo'];
    console.log('Project total: ' + projects.length);
    console.log('');
    for (let i in projects) {
      const project = projects[i];
      console.log('Project ' + i);
      console.log('ID: ' + project['project']);
      console.log('Display Name: ' + project['displayName']);
      console.log('');
    }
  } catch(err) {
    console.error(err);
  }
}

ผลลัพธ์

เนื้อหาการตอบกลับจากการเรียก availableProjects.list จะมีรายการออบเจ็กต์ ProjectInfo หากรายการโปรเจ็กต์ยาวเกินไป เนื้อหาการตอบกลับจะมี nextPageToken ที่คุณใช้เป็นพารามิเตอร์การค้นหาเพื่อรับโปรเจ็กต์หน้าถัดไปได้ด้วย

นี่คือตัวอย่างเนื้อหาการตอบกลับของการเรียก availableProjects.list

{
  "projectInfo": [
    {
      "project": "projects/first-cloud-project",
      "displayName": "First Cloud Project"
    },
    {
      "project": "projects/second-cloud-project",
      "displayName": "Second Cloud Project"
    }
  ]
}

การตอบกลับตัวอย่างนี้มีโปรเจ็กต์ Google Cloud 2 รายการที่เพิ่มบริการ Firebase ได้ โปรดทราบว่าช่อง project จะระบุชื่อทรัพยากรที่ไม่ซ้ำกันทั่วโลกสำหรับโปรเจ็กต์

คุณสามารถใช้ค่า project ใดก็ได้ที่แสดงในการตอบกลับจาก availableProjects.list เพื่อ เพิ่มบริการ Firebase หรือ เพิ่มแอป ลงในโปรเจ็กต์

ในส่วนถัดไป เราจะเพิ่มบริการ Firebase ลงใน First Cloud Project โดยใช้ชื่อทรัพยากร projects/first-gcp-project

เพิ่มบริการ Firebase ลงในโปรเจ็กต์

โปรเจ็กต์ Google Cloud สามารถใช้ประโยชน์จากบริการที่ Firebase มีให้ ใน ส่วนนี้ คุณจะได้เรียนรู้วิธีเพิ่มบริการ Firebase ลงในโปรเจ็กต์ Google Cloud ที่มีอยู่โดยอัตโนมัติ โปรดทราบว่าคุณยังเพิ่มบริการ Firebase ลงในโปรเจ็กต์ Google Cloud ที่มีอยู่ได้ในคอนโซล Firebase

คำขอ

Gọi projects.addFirebase. เนื้อหาคำขอสำหรับการเรียกนี้ต้องว่างเปล่า

นี่คือตัวอย่างสำหรับ Node.js เพื่อเพิ่มบริการ Firebase ลงใน Google Cloud โปรเจ็กต์:

const fetch = require('node-fetch');

async function addFirebase(projectId) {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/projects/' + projectId + ':addFirebase';
  const options = {
    method: 'POST',
    // Use a manual access token here since explicit user access token is required.
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    console.log(resp);
  } catch(err) {
    console.error(err['message']);
  }
}

ผลลัพธ์

ผลลัพธ์ของการเรียก projects.addFirebase คือ Operation คุณต้องเรียกปลายทางอื่นๆ ที่เกี่ยวข้องกับ Firebase สำหรับโปรเจ็กต์ได้ก็ต่อเมื่อการดำเนินการสำเร็จ

หากต้องการตรวจสอบว่าการดำเนินการสำเร็จหรือไม่ ให้เรียก operations.get ในการดำเนินการจนกว่าค่าของ done จะเป็น true และ response เป็นประเภท FirebaseProject หากการดำเนินการล้มเหลว ระบบจะตั้งค่า error เป็น google.rpc.Status

นี่คือเนื้อหาการตอบกลับของการเรียก operations.get

{
  "name": "operations/...",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.firebase.service.v1beta1.FirebaseProject",
    "projectId": "first-cloud-project",
    "projectNumber": "...",
    "displayName": "First Cloud Project",
    "name": "projects/first-cloud-project",
    "resources": {
      "hostingSite": "first-cloud-project",
      "realtimeDatabaseInstance": "first-cloud-project"
    }
  }
}

เนื่องจาก done เป็น true และประเภท response คือ FirebaseProject ตอนนี้โปรเจ็กต์ Google Cloud จึงมีบริการ Firebase แล้ว การตอบกลับยังมีข้อมูลที่เป็นประโยชน์อื่นๆ เกี่ยวกับ FirebaseProject ที่สร้างขึ้นใหม่ เช่น projectNumber และ resources เริ่มต้น ระบบจะลบ Operation โดยอัตโนมัติหลังจากดำเนินการเสร็จสมบูรณ์

เพิ่มแอป Firebase ลงในโปรเจ็กต์

FirebaseProject สามารถใช้ได้กับแอปต่างๆ มากมาย รวมถึงแอป iOS, Android และเว็บแอป ในส่วนนี้ คุณจะได้เรียนรู้วิธีเพิ่มแอป Firebase ลงใน FirebaseProject ที่มีอยู่โดยอัตโนมัติ โปรดทราบว่าคุณยังเพิ่มแอป Firebase ลงใน โปรเจ็กต์ Firebase ที่มีอยู่ได้ในFirebaseคอนโซล

เลือกประเภทแอป Firebase ที่จะเพิ่มลงในโปรเจ็กต์ Firebase

{
  "displayName": "My Firebase iOS App",
  "bundleId": "com.firebase.ios"
}

const fetch = require('node-fetch');

async function addIosApp(projectId, displayName, bundleId) {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/projects/' + projectId + '/iosApps';
  const options = {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
    body: JSON.stringify({
      'displayName': displayName,
      'bundleId': bundleId
    }),
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    console.log(resp);
  } catch(err) {
    console.error(err['message']);
  }
}

{
  "name": "operations/...",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.firebase.service.v1beta1.IosApp",
    "name": "projects/first-cloud-project/iosApps/...",
    "appId": "...",
    "displayName": "My Firebase iOS App",
    "projectId": "first-cloud-project",
    "bundleId": "com.firebase.ios"
  }
}

{
  "displayName": "My Firebase Android App"
  "packageName": "com.firebase.android"
}

const fetch = require('node-fetch');

async function addAndroidApp(projectId, displayName, packageName) {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/projects/' + projectId + '/androidApps';
  const options = {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
    body: JSON.stringify({
      'displayName': displayName,
      'packageName': packageName
    }),
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    console.log(resp);
  } catch(err) {
    console.error(err['message']);
  }
}

{
  "name": "operations/...",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.firebase.service.v1beta1.AndroidApp",
    "name": "projects/first-cloud-project/androidApps/...",
    "appId": "...",
    "displayName": "My Firebase Android App",
    "projectId": "first-cloud-project",
    "packageName": "com.firebase.android"
  }
}

./gradlew signingReport

{
  "displayName": "My Firebase Web App"
}

const fetch = require('node-fetch');

async function addWebApp(projectId, displayName) {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/projects/' + projectId + '/webApps';
  const options = {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
    body: JSON.stringify({
      'displayName': displayName
    }),
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    console.log(resp);
  } catch(err) {
    console.error(err['message']);
  }
}

{
  "name": "operations/...",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.firebase.service.v1beta1.WebApp",
    "name": "projects/first-cloud-project/webApps/...",
    "appId": "...",
    "displayName": "My Firebase Web App",
    "projectId": "first-cloud-project"
  }
}

ลิงก์โปรเจ็กต์ Firebase กับบัญชี Google Analytics (ไม่บังคับ)

คุณสามารถลิงก์บัญชี Google Analytics ที่มีอยู่กับ FirebaseProject ที่มีอยู่โดยอัตโนมัติ โปรดทราบว่าคุณยังลิงก์โปรเจ็กต์ Firebase ที่มีอยู่กับ Google Analytics ได้ในแท็บการผสานรวม ของ การตั้งค่าโปรเจ็กต์

การเรียก projects.addGoogleAnalytics ต้องใช้ analytics_resource ซึ่งอาจเป็น analyticsAccountId หรือ analyticsPropertyId

• ระบุ analyticsAccountId ที่มีอยู่เพื่อจัดสรรพร็อพเพอร์ตี้ Google Analytics ใหม่ภายในบัญชีที่ระบุและเชื่อมโยงพร็อพเพอร์ตี้ใหม่กับโปรเจ็กต์ Firebase

• ระบุ analyticsPropertyId ที่มีอยู่เพื่อเชื่อมโยงพร็อพเพอร์ตี้ Google Analytics กับโปรเจ็กต์ Firebase

คุณสามารถค้นหาทั้ง analyticsAccountId และ analyticsPropertyId ที่มีอยู่ใน เว็บไซต์ Google Analytics

เมื่อเรียก projects.addGoogleAnalytics ระบบจะดำเนินการดังนี้

1. การตรวจสอบครั้งแรกจะพิจารณาว่าสตรีมข้อมูลที่มีอยู่ในพร็อพเพอร์ตี้ Google Analytics ตรงกับแอป Firebase ที่มีอยู่ใน FirebaseProject หรือไม่ (โดยอิงตาม packageName หรือ bundleId ที่เชื่อมโยงกับสตรีมข้อมูล) จากนั้นระบบจะลิงก์สตรีมข้อมูลและแอปตามความเหมาะสม โปรดทราบว่าการลิงก์อัตโนมัตินี้ใช้ได้กับแอป Android และแอป iOS เท่านั้น

2. หากไม่พบสตรีมข้อมูลที่ตรงกันสำหรับแอป Firebase ระบบจะจัดสรรสตรีมข้อมูลใหม่ในพร็อพเพอร์ตี้ Google Analytics สำหรับแอป Firebase แต่ละแอป โปรดทราบว่าระบบจะจัดสรรสตรีมข้อมูลใหม่สำหรับเว็บแอปเสมอ แม้ว่าก่อนหน้านี้จะเชื่อมโยงกับสตรีมข้อมูลในพร็อพเพอร์ตี้ Analytics แล้วก็ตาม

ดูข้อมูลเพิ่มเติมเกี่ยวกับลำดับชั้นและโครงสร้างของบัญชี Google Analytics ได้ใน เอกสารประกอบของ Analytics

คำขอ

เรียก projects.addGoogleAnalytics

ในเนื้อหาคำขอสำหรับการเรียก project.addGoogleAnalytics ตัวอย่าง เราจะระบุ analyticsAccountId ของบัญชี Google Analytics การเรียกนี้จะจัดสรรพร็อพเพอร์ตี้ Google Analytics ใหม่และเชื่อมโยงพร็อพเพอร์ตี้ใหม่กับ FirebaseProject

{
  "analyticsAccountId": "<your-google-analytics-account-id>"
}

นี่คือตัวอย่างสำหรับ Node.js เพื่อลิงก์โปรเจ็กต์ Firebase กับบัญชี Google Analytics

const fetch = require('node-fetch');

async function addGoogleAnalytics(projectId, analyticsAccountId) {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/projects/' + projectId + ':addGoogleAnalytics';
  const options = {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
    body: JSON.stringify({
      'analyticsAccountId': analyticsAccountId
    }),
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    console.log(resp);
  } catch(err) {
    console.error(err['message']);
  }
}

ผลลัพธ์

ผลลัพธ์ของการเรียก projects.addGoogleAnalytics คือ Operation คุณต้องเรียกปลายทางอื่นๆ ที่เกี่ยวข้องกับ Firebase สำหรับโปรเจ็กต์ได้ก็ต่อเมื่อการดำเนินการสำเร็จ

หากต้องการตรวจสอบว่าการดำเนินการสำเร็จหรือไม่ ให้เรียก operations.get ในการดำเนินการจนกว่าค่าของ done จะเป็น true และ response เป็นประเภท analyticsDetails หากการดำเนินการล้มเหลว ระบบจะตั้งค่า error เป็น google.rpc.Status

นี่คือเนื้อหาการตอบกลับของการเรียก operations.get

{
  "name": "operations/...",
  "none": true,
  "response": {
    "@type": "type.googleapis.com/google.firebase.service.v1beta1.AnalyticsDetails",
    "analyticsProperty": [
      {
        "id": "...",
        "displayName": "..."
      }
    ],
    "streamMappings": [
      {
        "app": "...",
        "streamId": "...",
        "measurementId": "..."
      }
    ]
  }
}

เนื่องจาก done เป็น "จริง" และประเภท response คือ analyticsDetails ตอนนี้ FirebaseProject จึงลิงก์กับบัญชี Google Analytics ที่ระบุแล้ว ระบบจะลบ Operation โดยอัตโนมัติหลังจากดำเนินการเสร็จสมบูรณ์