使用舊版 HTTP 和 XMPP FCM API 的應用程式，應盡快遷移至 HTTP v1 API。使用這些 API 傳送訊息 (包括上游訊息) 已於 2023 年 6 月 20 日淘汰，並將於 2024 年 7 月 22 日開始停用。
進一步瞭解受影響的特定功能。
除了持續支援和新功能之外，HTTP v1 API 相較於舊版 API 還具有以下優點：
透過存取權杖提升安全性：HTTP v1 API 會根據 OAuth2 安全性模型使用短效存取權杖。如果存取權杖變成公開，則在到期前，惡意人士只能在約一小時內使用。更新權杖的傳輸頻率不如舊版 API 中使用的安全性金鑰，因此較不容易遭到擷取。
更有效率地跨平台自訂訊息：針對訊息主體，HTTP v1 API 提供常用鍵，可用於所有指定的例項，以及平台專用鍵，可讓您跨平台自訂訊息。這可讓您建立「覆寫值」，在單一訊息中向不同的用戶端平台傳送略有不同的酬載。
可進一步擴充，並支援新版用戶端平台 HTTP v1 API 完全支援 Apple 平台、Android 和 Web 上的訊息選項。由於每個平台在 JSON 酬載中都有專屬的定義區塊，FCM 可視需要將 API 延伸至新版本和新平台。
更新伺服器端點
HTTP v1 API 的端點網址與舊版端點的差異如下：
- 它已分版本，路徑中含有
/v1。 - 路徑包含應用程式 Firebase 專案的專案 ID，格式為
/projects/myproject-ID/。這個 ID 可在 Firebase 主控台的「General project settings」分頁中找到。 - 明確指定
send方法為:send。
如要更新 HTTP v1 的伺服器端點，請在傳送要求的標頭中，將這些元素新增至端點。
之前的 HTTP 要求
POST https://fcm.googleapis.com/fcm/send
先前的 XMPP 要求
舊版 XMPP 訊息會透過連線傳送至下列端點：
fcm-xmpp.googleapis.com:5235
晚於
POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send
更新傳送要求的授權
在 HTTP v1 傳送要求時，需要使用 OAuth 2.0 存取權憑證，而非舊版要求中使用的伺服器金鑰字串。如果您使用管理員 SDK 傳送訊息，程式庫會為您處理權杖。如果您使用 eef 原始通訊協定，請按照本節所述取得權杖，並將其新增至標頭做為 Authorization: Bearer <valid Oauth 2.0 token>。
早於
Authorization: key=AIzaSyZ-1u...0GBYzPu7Udno5aA
晚於
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
視伺服器環境的詳細資料而定，請結合下列策略，授權伺服器要求存取 Firebase 服務：
- Google 應用程式預設憑證 (ADC)
- 服務帳戶 JSON 檔案
- 由服務帳戶衍生的短期 OAuth 2.0 存取權杖
如果應用程式在 Compute Engine、Google Kubernetes Engine、App Engine 或 Cloud Functions (包括 Cloud Functions for Firebase) 上執行，請使用應用程式預設憑證 (ADC)。ADC 會使用您現有的預設服務帳戶取得憑證，以便授權要求，並透過 GOOGLE_APPLICATION_CREDENTIALS 環境變數啟用彈性的本機測試。如要將授權流程自動化，請搭配使用 ADC 和 Admin SDK 伺服器程式庫。
如果應用程式在非 Google 伺服器環境中執行，您必須從 Firebase 專案下載服務帳戶 JSON 檔案。只要您可以存取內含私密金鑰檔案的檔案系統，即可使用環境變數 GOOGLE_APPLICATION_CREDENTIALS，透過手動取得的憑證授權要求。如果您沒有這類檔案存取權，就必須在程式碼中參照服務帳戶檔案，但這可能會洩漏您的憑證，因此請務必格外小心。
使用 ADC 提供憑證
Google 應用程式預設憑證 (ADC) 會依照以下順序檢查您的憑證：
ADC 會檢查是否已設定 GOOGLE_APPLICATION_CREDENTIALS 環境變數。如有，ADC 就會使用該項變數所指的服務帳戶檔案。
如未設定環境變數，ADC 會使用 Compute Engine、Google Kubernetes Engine、App Engine 和 Cloud Functions 針對當中運作的應用程式提供的預設服務帳戶。
如果 ADC 無法使用上述任一項憑證，系統會擲回錯誤。
以下 Admin SDK 程式碼範例說明這項策略。這個範例並未明確指定應用程式憑證，不過只要已設有環境變數，或者應用程式是在 Compute Engine、Google Kubernetes Engine、App Engine 或 Cloud Functions 中運作，ADC 就能以隱密的方式找到憑證。
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)
}
C#
FirebaseApp.Create(new AppOptions()
{
Credential = GoogleCredential.GetApplicationDefault(),
});
手動提供憑證
Firebase 專案支援 Google 服務帳戶，您可以透過這些帳戶從應用程式伺服器或信任環境呼叫 Firebase 伺服器 API。如果您在本機開發程式碼，或將應用程式部署到內部部署，則可以使用透過此服務帳戶取得的憑證，授權伺服器要求。
如要驗證服務帳戶並授權存取 Firebase 服務，您必須以 JSON 格式產生私密金鑰檔案。
如何為服務帳戶產生私密金鑰檔案：
透過服務帳戶授權時，您可以透過兩種方式向應用程式提供憑證。您可以設定 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 憑證搭配偏好語言的 Google 驗證程式庫，擷取短期 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);
});
});
}
在這個範例中，Google API 用戶端程式庫會使用 JSON Web Token (JWT) 驗證要求。詳情請參閱「JSON Web 權杖」。
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.token
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();
}
存取權杖到期後，系統會自動呼叫權杖重新整理方法，以便擷取更新的存取權杖。
如要授權存取 FCM，請要求範圍 https://www.googleapis.com/auth/firebase.messaging。
如何將存取權杖新增至 HTTP 要求標頭：
以 Authorization: Bearer <access_token> 格式將權杖新增為 Authorization 標頭的值：
node.js
headers: {
'Authorization': 'Bearer ' + accessToken
}
Python
headers = {
'Authorization': 'Bearer ' + _get_access_token(),
'Content-Type': 'application/json; UTF-8',
}
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;
更新傳送要求的酬載
FCM HTTP v1 在 JSON 訊息酬載的結構上做出重大變更。這些變更的主要目的，是確保在不同用戶端平台上接收訊息時，能正確處理訊息；此外，這些變更還可讓您更彈性地自訂或「覆寫」各平台的訊息欄位。
除了查看本節中的範例，請參閱「跨平台自訂訊息」和API 參考資料，進一步瞭解 HTTP v1。
範例：簡單的通知訊息
以下比較了非常簡單的通知酬載 (僅包含 title、body 和 data 欄位)，說明舊版和 HTTP v1 酬載的基本差異。
早於
{
"to": "/topics/news",
"notification": {
"title": "Breaking News",
"body": "New news story available."
},
"data": {
"story_id": "story_12345"
}
}
晚於
{
"message": {
"topic": "news",
"notification": {
"title": "Breaking News",
"body": "New news story available."
},
"data": {
"story_id": "story_12345"
}
}
}
範例：巢狀 JSON 資料
與舊版訊息 API 不同，HTTP v1 API 不支援 data 欄位中的巢狀 JSON 值。必須將 JSON 轉換為字串。
早於
{
...
"data": {
"keysandvalues": {"key1": "value1", "key2": 123}
}
}
晚於
{
"message": {
...
"data": {
"keysandvalues": "{\"key1\": \"value1\", \"key2\": 123}"
}
}
}
範例：指定多個平台
為了啟用多平台指定目標，舊版 API 會在後端執行覆寫作業。相較之下，HTTP v1 提供平台專屬的金鑰區塊，可讓開發人員清楚看到平台之間的差異。這樣一來，您就能一律使用單一要求指定多個平台，如以下範例所示。
早於
// Android
{
"to": "/topics/news",
"notification": {
"title": "Breaking News",
"body": "New news story available.",
"click_action": "TOP_STORY_ACTIVITY"
},
"data": {
"story_id": "story_12345"
}
}
// Apple
{
"to": "/topics/news",
"notification": {
"title": "Breaking News",
"body": "New news story available.",
"click_action": "HANDLE_BREAKING_NEWS"
},
"data": {
"story_id": "story_12345"
}
}
晚於
{
"message": {
"topic": "news",
"notification": {
"title": "Breaking News",
"body": "New news story available."
},
"data": {
"story_id": "story_12345"
},
"android": {
"notification": {
"click_action": "TOP_STORY_ACTIVITY"
}
},
"apns": {
"payload": {
"aps": {
"category" : "NEW_MESSAGE_CATEGORY"
}
}
}
}
}
範例：使用平台覆寫值進行自訂
除了簡化訊息的跨平台指定目標，HTTP v1 API 還可彈性地針對各個平台自訂訊息。
早於
// Android
{
"to": "/topics/news",
"notification": {
"title": "Breaking News",
"body": "Check out the Top Story.",
"click_action": "TOP_STORY_ACTIVITY"
},
"data": {
"story_id": "story_12345"
}
}
// Apple
{
"to": "/topics/news",
"notification": {
"title": "Breaking News",
"body": "New news story available.",
"click_action": "HANDLE_BREAKING_NEWS"
},
"data": {
"story_id": "story_12345"
}
}
晚於
{
"message": {
"topic": "news",
"notification": {
"title": "Breaking News",
"body": "New news story available."
},
"data": {
"story_id": "story_12345"
},
"android": {
"notification": {
"click_action": "TOP_STORY_ACTIVITY",
"body": "Check out the Top Story"
}
},
"apns": {
"payload": {
"aps": {
"category" : "NEW_MESSAGE_CATEGORY"
}
}
}
}
}
範例：指定特定裝置
如要使用 HTTP v1 API 指定特定裝置，請在 token 鍵中提供裝置目前的註冊權杖，而不是 to 鍵。
早於
{ "notification": {
"body": "This is an FCM notification message!",
"title": "FCM Message"
},
"to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}
晚於
{
"message":{
"token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
"notification":{
"body":"This is an FCM notification message!",
"title":"FCM Message"
}
}
}
如要進一步瞭解 FCM HTTP v1 API 的範例和相關資訊，請參閱下列資源：
指引說明如何使用 HTTP v1 API 建立應用程式伺服器傳送要求。除非另有註明，否則所有「REST」程式碼片段都會使用 v1 API。