ส่งข้อความโดยใช้ FCM HTTP v1 API

เมื่อใช้ FCM HTTP v1 API, คุณจะสร้างคำขอข้อความและส่งไปยังเป้าหมายประเภทต่อไปนี้ได้

ชื่อหัวข้อ
เงื่อนไข
โทเค็นการลงทะเบียนอุปกรณ์
ชื่อกลุ่มอุปกรณ์ (โปรโตคอลเท่านั้น)

คุณสามารถส่งข้อความที่มีเพย์โหลดการแจ้งเตือนซึ่งประกอบด้วยช่องที่กำหนดไว้ล่วงหน้า เพย์โหลดข้อมูลที่มีช่องที่ผู้ใช้กำหนดเอง หรือข้อความที่มีเพย์โหลดทั้ง 2 ประเภท ดูข้อมูลเพิ่มเติมได้ที่ประเภทข้อความ

ให้สิทธิ์คำขอส่ง HTTP v1

ใช้กลยุทธ์ต่อไปนี้ร่วมกันเพื่อให้สิทธิ์คำขอของเซิร์ฟเวอร์ไปยังบริการ Firebase ทั้งนี้ขึ้นอยู่กับรายละเอียดของสภาพแวดล้อมเซิร์ฟเวอร์

ข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน (ADC) ของ Google
ไฟล์ JSON ของบัญชีบริการ
โทเค็นเพื่อการเข้าถึง OAuth 2.0 ที่มีอายุสั้นซึ่งได้มาจากบัญชีบริการ

หากแอปพลิเคชันทำงานใน Compute Engine, Google Kubernetes Engine, App Engine, หรือ Cloud Functions (รวมถึง Cloud Functions for Firebase) ให้ใช้ข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน (ADC) ADC ใช้บัญชีบริการเริ่มต้นที่มีอยู่เพื่อรับข้อมูลรับรองในการให้สิทธิ์คำขอ และ ADC ช่วยให้ทดสอบในเครื่องได้อย่างยืดหยุ่นผ่านตัวแปรสภาพแวดล้อมGOOGLE_APPLICATION_CREDENTIALS หากต้องการระบบอัตโนมัติเต็มรูปแบบสำหรับขั้นตอนการให้สิทธิ์ ให้ใช้ ADC ร่วมกับไลบรารีเซิร์ฟเวอร์ Admin SDK

หากแอปพลิเคชันทำงานในสภาพแวดล้อมเซิร์ฟเวอร์ที่ไม่ใช่ของ Google, คุณจะต้องดาวน์โหลดไฟล์ JSON ของบัญชีบริการจากโปรเจ็กต์ Firebase ตราบใดที่คุณมีสิทธิ์เข้าถึงระบบไฟล์ที่มีไฟล์คีย์ส่วนตัว คุณก็สามารถใช้ตัวแปรสภาพแวดล้อม GOOGLE_APPLICATION_CREDENTIALSเพื่อให้สิทธิ์คำขอ ด้วยข้อมูลรับรองที่ได้รับด้วยตนเองเหล่านี้ หากไม่มีสิทธิ์เข้าถึงไฟล์ดังกล่าว คุณต้องอ้างอิงไฟล์บัญชีบริการในโค้ด ซึ่งควรทำด้วยความระมัดระวังอย่างยิ่งเนื่องจากมีความเสี่ยงที่จะเปิดเผยข้อมูลรับรอง

ให้ข้อมูลรับรองโดยใช้ ADC

ข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน (ADC) ของ Google จะตรวจสอบข้อมูลรับรองตามลำดับต่อไปนี้

ADC จะตรวจสอบว่าได้ตั้งค่าตัวแปรสภาพแวดล้อม GOOGLE_APPLICATION_CREDENTIALS หรือไม่ หากตั้งค่าตัวแปรไว้ ADC จะใช้ไฟล์บัญชีบริการที่ตัวแปรชี้ไป
หากไม่ได้ตั้งค่าตัวแปรสภาพแวดล้อม ADC จะใช้บัญชีบริการเริ่มต้น ที่ Compute Engine, Google Kubernetes Engine, App Engine, และ Cloud Functions จัดเตรียมไว้ให้สำหรับแอปพลิเคชันที่ทำงานในบริการเหล่านั้น
หาก ADC ใช้ข้อมูลรับรองใดข้อมูลรับรองหนึ่งข้างต้นไม่ได้ ระบบจะแสดงข้อผิดพลาด

ตัวอย่างโค้ด Admin SDK ต่อไปนี้แสดงกลยุทธ์นี้ ตัวอย่างไม่ได้ระบุข้อมูลรับรองของแอปพลิเคชันอย่างชัดเจน อย่างไรก็ตาม ADC สามารถ ค้นหาข้อมูลรับรองโดยนัยได้ตราบใดที่ตั้งค่าตัวแปรสภาพแวดล้อมไว้ หรือ ตราบใดที่แอปพลิเคชันทำงานใน Compute Engine, Google Kubernetes Engine, App Engine, หรือ Cloud Functions

Node.js

admin.initializeApp({
  credential: admin.credential.applicationDefault(),
});

Java

FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.getApplicationDefault())
    .setDatabaseUrl("https://<DATABASE_NAME>.firebaseio.com/")
    .build();

FirebaseApp.initializeApp(options);

Python

default_app = firebase_admin.initialize_app()

Go

app, err := firebase.NewApp(context.Background(), nil)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}init.go

C#

FirebaseApp.Create(new AppOptions()
{
    Credential = GoogleCredential.GetApplicationDefault(),
});

ให้ข้อมูลรับรองด้วยตนเอง

โปรเจ็กต์ Firebase รองรับบัญชีบริการของ Google ซึ่งคุณสามารถใช้เพื่อเรียก Firebase Server API จากเซิร์ฟเวอร์แอปหรือสภาพแวดล้อมที่เชื่อถือได้ หากคุณกำลังพัฒนาโค้ดในเครื่องหรือติดตั้งใช้งานแอปพลิเคชันในองค์กร คุณสามารถใช้ข้อมูลรับรองที่ได้รับโดยใช้บัญชีบริการนี้เพื่อให้สิทธิ์คำขอของเซิร์ฟเวอร์

คุณดูบัญชีบริการทั้งหมดสำหรับโปรเจ็กต์ Firebase ได้ใน แท็บการตั้งค่า > บัญชีบริการ

หากต้องการตรวจสอบสิทธิ์บัญชีบริการและให้สิทธิ์เข้าถึงบริการ Firebase คุณต้องสร้างไฟล์คีย์ส่วนตัวในรูปแบบ JSON

วิธีสร้างไฟล์คีย์ส่วนตัวสำหรับบัญชีบริการ

ในคอนโซล Firebase ให้ไปที่แท็บ การตั้งค่า > บัญชีบริการ
คลิกสร้างคีย์ส่วนตัวใหม่ แล้วยืนยันโดยคลิก สร้างคีย์
จัดเก็บไฟล์ JSON ที่มีคีย์อย่างปลอดภัย

เมื่อให้สิทธิ์ผ่านบัญชีบริการ คุณจะมี 2 ตัวเลือกในการให้ข้อมูลรับรองแก่แอปพลิเคชัน คุณสามารถตั้งค่าตัวแปรสภาพแวดล้อม GOOGLE_APPLICATION_CREDENTIALS หรือคุณสามารถ ส่งเส้นทางไปยังคีย์บัญชีบริการในโค้ดอย่างชัดเจน ตัวเลือกแรกมีความปลอดภัยมากกว่าและขอแนะนำอย่างยิ่ง

วิธีตั้งค่าตัวแปรสภาพแวดล้อม

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

Linux หรือ macOS

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Windows

ด้วย PowerShell

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

หลังจากทำตามขั้นตอนข้างต้นแล้ว ข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน (ADC) จะสามารถกำหนดข้อมูลรับรองของคุณโดยนัย ซึ่งช่วยให้คุณใช้ข้อมูลรับรองของบัญชีบริการได้เมื่อทดสอบหรือเรียกใช้ในสภาพแวดล้อมที่ไม่ใช่ของ Google

ใช้ข้อมูลรับรองเพื่อสร้างโทเค็นเพื่อการเข้าถึง

คุณจะต้องสร้างโทเค็นเพื่อการเข้าถึง และเพิ่มโทเค็นดังกล่าวลงในคำขอส่ง เว้นแต่จะใช้ Firebase Admin SDKซึ่งจัดการการให้สิทธิ์โดยอัตโนมัติ

ใช้ข้อมูลรับรอง Firebase ร่วมกับ Google Auth Library สำหรับภาษาที่คุณต้องการเพื่อดึงโทเค็นเพื่อการเข้าถึง OAuth 2.0 ที่มีอายุสั้น

node.js

 function getAccessToken() {
  return new Promise(function(resolve, reject) {
    const key = require('../placeholders/service-account.json');
    const jwtClient = new google.auth.JWT(
      key.client_email,
      null,
      key.private_key,
      SCOPES,
      null
    );
    jwtClient.authorize(function(err, tokens) {
      if (err) {
        reject(err);
        return;
      }
      resolve(tokens.access_token);
    });
  });
}index.js

ในตัวอย่างนี้ ไลบรารีของไคลเอ็นต์ Google API จะตรวจสอบสิทธิ์คำขอด้วยโทเค็นเว็บ JSON หรือ JWT ดูข้อมูลเพิ่มเติมได้ที่ โทเค็นเว็บ JSON.

Python

def _get_access_token():
  """Retrieve a valid access token that can be used to authorize requests.

  :return: Access token.
  """
  credentials = service_account.Credentials.from_service_account_file(
    'service-account.json', scopes=SCOPES)
  request = google.auth.transport.requests.Request()
  credentials.refresh(request)
  return credentials.tokenmessaging.py

Java

private static String getAccessToken() throws IOException {
  GoogleCredentials googleCredentials = GoogleCredentials
          .fromStream(new FileInputStream("service-account.json"))
          .createScoped(Arrays.asList(SCOPES));
  googleCredentials.refresh();
  return googleCredentials.getAccessToken().getTokenValue();
}Messaging.java

หลังจากโทเค็นเพื่อการเข้าถึงหมดอายุ ระบบจะเรียกใช้เมธอดรีเฟรชโทเค็นโดยอัตโนมัติเพื่อดึงโทเค็นเพื่อการเข้าถึงที่อัปเดต

หากต้องการให้สิทธิ์เข้าถึง FCM ให้ขอขอบเขต https://www.googleapis.com/auth/firebase.messaging

วิธีเพิ่มโทเค็นเพื่อการเข้าถึงลงในส่วนหัวของคำขอ HTTP

เพิ่มโทเค็นเป็นค่าของส่วนหัว Authorization ในรูปแบบ Authorization: Bearer <access_token>

node.js

headers: {
  'Authorization': 'Bearer ' + accessToken
}index.js

Python

headers = {
  'Authorization': 'Bearer ' + _get_access_token(),
  'Content-Type': 'application/json; UTF-8',
}messaging.py

Java

URL url = new URL(BASE_URL + FCM_SEND_ENDPOINT);
HttpURLConnection httpURLConnection = (HttpURLConnection) url.openConnection();
httpURLConnection.setRequestProperty("Authorization", "Bearer " + getServiceAccountAccessToken());
httpURLConnection.setRequestProperty("Content-Type", "application/json; UTF-8");
return httpURLConnection;FirebaseMessagingSnippets.java

ให้สิทธิ์บัญชีบริการจากโปรเจ็กต์อื่น

คุณสามารถส่งข้อความสำหรับโปรเจ็กต์หนึ่ง ซึ่งก็คือ "โปรเจ็กต์เป้าหมาย" ขณะที่ใช้โทเค็น OAuth 2.0 ที่สร้างจากบัญชีบริการในโปรเจ็กต์อื่น ซึ่งก็คือ "โปรเจ็กต์ผู้ส่ง" ซึ่งจะช่วยให้คุณจัดการบัญชีบริการแบบรวมศูนย์ในโปรเจ็กต์เดียวขณะส่งข้อความในนามของโปรเจ็กต์อื่นๆ หากต้องการทราบวิธีดำเนินการ ให้ทำตามขั้นตอนต่อไปนี้

ในโปรเจ็กต์ผู้ส่ง ให้ตรวจสอบว่าได้เปิดใช้ Firebase Cloud Messaging API แล้ว ตรวจสอบการเปิดใช้ในคอนโซล Firebase โดยไปที่ การตั้งค่า > ทั่วไป จากนั้นคลิกแท็บ Cloud Messaging
สร้าง บัญชีบริการในโปรเจ็กต์ผู้ส่ง
ในโปรเจ็กต์เป้าหมาย ให้กำหนดบทบาท ผู้ดูแลระบบ Firebase Cloud Messaging API ให้กับที่อยู่อีเมลของบัญชีบริการ คุณดำเนินการนี้ได้ในหน้า IAM และผู้ดูแลระบบ > IAM ของ Google Cloud คอนโซล บทบาทนี้อนุญาตให้บัญชีบริการจากโปรเจ็กต์ผู้ส่งส่งข้อความไปยังโปรเจ็กต์เป้าหมาย
สร้างโทเค็นเพื่อการเข้าถึง OAuth 2.0 สำหรับบัญชีบริการในโปรเจ็กต์ผู้ส่ง คุณทำได้โดยใช้ตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้
- ดาวน์โหลดและใช้ไฟล์ JSON ของคีย์บัญชีบริการ
- ใช้ Workload Identity หากบริการทำงานใน Google Cloud
ใช้โทเค็นเพื่อการเข้าถึงที่ได้รับในส่วนหัว Authorization ของคำขอส่ง คำขอต้องส่งไปยังปลายทาง HTTP v1 สำหรับ โปรเจ็กต์เป้าหมาย:
```
  POST https://fcm.googleapis.com/v1/TARGET_PROJECT_ID/messages:send
```

ส่งข้อความไปยังอุปกรณ์ที่เฉพาะเจาะจง

หากต้องการส่งไปยังอุปกรณ์เดียวที่เฉพาะเจาะจง ให้ส่งโทเค็นการลงทะเบียนของอุปกรณ์ตามที่แสดง

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
   "message":{
      "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
      "notification":{
        "body":"This is an FCM notification message!",
        "title":"FCM Message"
      }
   }
}

คำสั่ง cURL

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message":{
   "notification":{
     "title":"FCM Message",
     "body":"This is an FCM Message"
   },
   "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

หากสำเร็จ การตอบกลับของ HTTP v1 API จะเป็นออบเจ็กต์ JSON ที่มีรหัสข้อความ

    {
      "name":"projects/myproject-b5ae1/messages/0:1500415314455276%31bd1c9631bd1c96"
    }

ส่งข้อความแจ้งเตือนทดสอบโดยใช้ FCM HTTP v1 API

ส่วนนี้อธิบายวิธีส่งข้อความแจ้งเตือนทดสอบโดยใช้ FCM HTTP v1 API

URL คำขอ HTTP

คำขอประกอบด้วย HTTP POST ไปยังเป้าหมายที่ระบุ (โทเค็นการลงทะเบียน หัวข้อ หรือเงื่อนไข) ที่ URL ต่อไปนี้

POST https://fcm.googleapis.com/v1/projectId/messages:send

ตัวอย่าง JSON ของคำขอ HTTP ที่สมบูรณ์

ต่อไปนี้เป็นตัวอย่างที่สมบูรณ์ซึ่งแสดงวิธีโพสต์การแจ้งเตือนภายในคำขอ HTTP POST

{
  "message": {
    "token": REGISTRATION_TOKEN,
    "notification": {
      "title": "FCM API test",
      "body": "This is the body of the notification.",
      "image": "https://cat.10515.net/1.jpg"
    }
  }
}

วิ่ง

คลิกเรียกใช้ เพื่อลองใช้ตัวอย่างในโปรแกรมสำรวจ API