Firebase is back at Google I/O on May 14! Register now.

Trang này được dịch bởi Cloud Translation API.

Đặc tả giao thức cho https.onCall

Trình kích hoạt https.onCall cho Cloud Functions là trình kích hoạt HTTPS có định dạng cụ thể cho yêu cầu và phản hồi. Phần này cung cấp thông số kỹ thuật cho các định dạng phản hồi và yêu cầu HTTPS được SDK khách sử dụng để triển khai API. Thông tin này có thể hữu ích cho bạn nếu các yêu cầu của bạn không thể được đáp ứng khi sử dụng nền tảng Android, Apple hoặc SDK web.

Định dạng yêu cầu: tiêu đề

Yêu cầu HTTP tới điểm cuối của trình kích hoạt có thể gọi phải là POST với các tiêu đề sau:

Bắt buộc: Content-Type: application/json
- Một tùy chọn ; charset=utf-8 được cho phép.
Tùy chọn: Authorization: Bearer <token>
- Mã thông báo ID người dùng Xác thực Firebase cho người dùng đã đăng nhập thực hiện yêu cầu. Phần phụ trợ tự động xác minh mã thông báo này và cung cấp mã thông báo này trong context của trình xử lý. Nếu mã thông báo không hợp lệ, yêu cầu sẽ bị từ chối.
Tùy chọn: Firebase-Instance-ID-Token: <iid>
- Mã thông báo đăng ký FCM từ SDK khách Firebase. Đây phải là một chuỗi. Điều này có sẵn trong context của trình xử lý. Nó được sử dụng để nhắm mục tiêu thông báo đẩy.
Tùy chọn: X-Firebase-AppCheck: <token>
- Mã thông báo kiểm tra ứng dụng Firebase do ứng dụng khách đưa ra yêu cầu cung cấp. Phần phụ trợ tự động xác minh mã thông báo này và giải mã nó, đưa appId vào context của trình xử lý. Nếu mã thông báo không thể được xác minh, yêu cầu sẽ bị từ chối. (Có sẵn cho SDK >=3.14.0)

Nếu bao gồm bất kỳ tiêu đề nào khác thì yêu cầu sẽ bị từ chối, như được mô tả trong tài liệu phản hồi bên dưới.

Lưu ý: Trong các ứng dụng khách JavaScript, những yêu cầu này kích hoạt ánh sáng trước CORS OPTIONS , bởi vì:

application/json không được phép. Nó phải là text/plain hoặc application/x-www-form-urlencoded .
Tiêu đề Authorization không phải là tiêu đề yêu cầu được liệt kê trong danh sách an toàn của CORS .
Các tiêu đề khác cũng không được phép tương tự.

Trình kích hoạt có thể gọi được sẽ tự động xử lý các yêu cầu OPTIONS này.

Nội dung yêu cầu

Nội dung của yêu cầu HTTP phải là một đối tượng JSON có bất kỳ trường nào sau đây:

Bắt buộc: data - Đối số được truyền cho hàm. Đây có thể là bất kỳ giá trị JSON hợp lệ nào. Điều này được tự động giải mã thành các loại JavaScript gốc theo định dạng tuần tự hóa được mô tả bên dưới.

Nếu có bất kỳ trường nào khác xuất hiện trong yêu cầu, phần phụ trợ sẽ coi yêu cầu đó không đúng định dạng và nó sẽ bị từ chối.

Định dạng phản hồi: mã trạng thái

Có một số trường hợp có thể dẫn đến các mã trạng thái HTTP và mã trạng thái chuỗi khác nhau do lỗi trong phản hồi.

Trong trường hợp xảy ra lỗi HTTP trước khi kích hoạt trình kích hoạt client , phản hồi sẽ không được xử lý dưới dạng hàm máy khách. Ví dụ: nếu khách hàng cố gắng gọi một hàm không tồn tại, nó sẽ nhận được phản hồi 404 Not Found .
Nếu trình kích hoạt máy khách được gọi nhưng yêu cầu có định dạng sai, chẳng hạn như không phải là JSON, có trường không hợp lệ hoặc thiếu trường data , thì yêu cầu sẽ bị từ chối với 400 Bad Request , với mã lỗi INVALID_ARGUMENT .
Nếu mã thông báo xác thực được cung cấp trong yêu cầu không hợp lệ thì yêu cầu sẽ bị từ chối với 401 Unauthorized , với mã lỗi UNAUTHENTICATED .
Nếu mã thông báo đăng ký FCM được cung cấp trong yêu cầu không hợp lệ thì hành vi đó sẽ không được xác định. Mã thông báo không được kiểm tra theo mọi yêu cầu, ngoại trừ khi nó được sử dụng để gửi thông báo đẩy bằng FCM.
Nếu trình kích hoạt có thể gọi được gọi nhưng không thành công với ngoại lệ chưa được xử lý hoặc trả về lời hứa không thành công thì yêu cầu sẽ bị từ chối với 500 Internal Server Error , với mã lỗi INTERNAL . Điều này ngăn chặn các lỗi mã hóa vô tình được tiếp xúc với người dùng cuối.
Nếu hàm có thể gọi được gọi và trả về tình trạng lỗi rõ ràng bằng cách sử dụng API được cung cấp cho các hàm có thể gọi thì yêu cầu sẽ không thành công. Mã trạng thái HTTP được trả về dựa trên ánh xạ chính thức của trạng thái lỗi sang trạng thái HTTP, như được xác định trong code.proto . Mã lỗi cụ thể, thông báo và chi tiết trả về được mã hóa trong nội dung phản hồi như chi tiết bên dưới. Điều này có nghĩa là nếu hàm trả về một lỗi rõ ràng với trạng thái OK thì phản hồi có trạng thái 200 OK nhưng trường error được đặt trong phản hồi.
Nếu kích hoạt máy khách thành công, trạng thái phản hồi là 200 OK .

Định dạng phản hồi: tiêu đề

Phản hồi có các tiêu đề sau:

Content-Type: application/json
Một tùy chọn ; charset=utf-8 được cho phép.

Nội dung phản hồi

Phản hồi từ điểm cuối của máy khách luôn là đối tượng JSON. Ở mức tối thiểu, nó chứa result hoặc error , cùng với bất kỳ trường tùy chọn nào. Nếu phản hồi không phải là đối tượng JSON hoặc không chứa data hay error thì SDK khách sẽ coi yêu cầu đó là không thành công với mã lỗi INTERNAL (13) của Google.

error - Nếu có trường này thì yêu cầu được coi là không thành công, bất kể mã trạng thái HTTP hay data có hiện diện hay không. Giá trị của trường này phải là một đối tượng JSON ở định dạng Bản đồ HTTP Google Cloud tiêu chuẩn để phát hiện lỗi, với các trường dành cho status , message và details (tùy chọn). Trường code sẽ không được bao gồm. Nếu trường status không được đặt hoặc có giá trị không hợp lệ thì máy khách phải coi trạng thái là INTERNAL , theo code.proto . Nếu có details chi tiết thì thông tin đó sẽ được bao gồm trong mọi thông tin người dùng kèm theo lỗi trong SDK máy khách, nếu có.
Lưu ý: Trường details ở đây là giá trị do người dùng cung cấp. Nó không nhất thiết phải là danh sách các giá trị được khóa theo loại nguyên mẫu như ở định dạng Status Google.
result - Giá trị được trả về bởi hàm. Đây có thể là bất kỳ giá trị JSON hợp lệ nào. SDK chức năng firebase tự động mã hóa giá trị được người dùng trả về sang định dạng JSON này. SDK khách tự động giải mã các thông số này thành các loại gốc theo định dạng tuần tự hóa được mô tả bên dưới.

Nếu có các trường khác thì nên bỏ qua.

Tuần tự hóa

Định dạng tuần tự hóa cho tải trọng dữ liệu tùy ý là giống nhau cho cả yêu cầu và phản hồi.

Để đảm bảo tính nhất quán của nền tảng, các giá trị này được mã hóa bằng JSON như thể chúng là giá trị của trường Any trong vùng đệm giao thức proto3, sử dụng ánh xạ JSON tiêu chuẩn . Giá trị của các loại đơn giản như null , int , double hoặc string được mã hóa trực tiếp và không bao gồm loại rõ ràng của chúng. Vì vậy, float và double được mã hóa theo cùng một cách và bạn có thể không biết cái nào được nhận ở đầu bên kia của cuộc gọi. Đối với các loại không có nguồn gốc từ JSON, mã hóa proto3 đã nhập cho giá trị sẽ được sử dụng. Để biết thêm thông tin, hãy xem tài liệu về Bất kỳ mã hóa JSON nào .

Các loại sau đây được cho phép:

null null
int (có dấu hoặc không dấu, tối đa 32 bit) - ví dụ: 3 hoặc -30 .
nổi - ví dụ 3.14
gấp đôi - ví dụ 3.14
boolean - true hay false
chuỗi - ví dụ "hello world"
bản đồ - ví dụ {"x": 3}
danh sách - ví dụ [1, 2, 3]
dài (có dấu hoặc không dấu, tối đa 64 bit) - [xem bên dưới để biết chi tiết]

Giá trị NaN và Infinity cho float và double không được hỗ trợ.

Lưu ý rằng long là loại đặc biệt thường không được phép trong JSON nhưng được bao phủ bởi đặc tả proto3. Ví dụ: chúng được mã hóa dưới dạng:

dài

{
    '@type': 'type.googleapis.com/google.protobuf.Int64Value',
    'value': '-123456789123456'
}

dài không dấu

{
    '@type': 'type.googleapis.com/google.protobuf.UInt64Value',
    'value': '123456789123456'
}

Nói chung, khóa @type phải được coi là dành riêng và không được sử dụng cho các bản đồ được truyền vào.

Vì loại không được chỉ định cho các loại đơn giản nên một số giá trị sẽ thay đổi loại sau khi truyền qua dây. Một float được truyền vào sẽ trở thành double . Một short trở thành int , v.v. Trong Android, cả List và JSONArray đều được hỗ trợ cho các giá trị danh sách. Trong những trường hợp đó, việc chuyển JSONArray vào sẽ mang lại List .

Nếu một bản đồ có trường @type không xác định được giải tuần tự hóa thì bản đồ đó sẽ được giữ lại dưới dạng bản đồ. Điều này cho phép các nhà phát triển thêm các trường có loại mới vào giá trị trả về của họ mà không làm hỏng các ứng dụng khách cũ hơn.

Mẫu mã

Các mẫu trong phần này minh họa cách mã hóa như sau:

Một ví dụ về callable.call trong Swift
Phản hồi thành công cho cuộc gọi
Phản hồi thất bại cho cuộc gọi

Ví dụ Callable.call trong Swift để mã hóa

callable.call([
    "aString": "some string",
    "anInt": 57,
    "aFloat": 1.23,
    "aLong": -123456789123456 as Int64
])

Tiêu đề yêu cầu:

Method: POST
Content-Type: application/json; charset=utf-8
Authorization: Bearer some-auth-token
Firebase-Instance-ID-Token: some-iid-token

Nội dung yêu cầu:

{
    "data": {
        "aString": "some string",
        "anInt": 57,
        "aFloat": 1.23,
        "aLong": {
            "@type": "type.googleapis.com/google.protobuf.Int64Value",
            "value": "-123456789123456"
        }
    }
}

Phản hồi mã hóa

return {
    "aString": "some string",
    "anInt": 57,
    "aFloat": 1.23
};

Tiêu đề phản hồi thành công:

200 OK
Content-Type: application/json; charset=utf-8

Cơ quan phản hồi thành công:

{
    "response": {
        "aString": "some string",
        "anInt": 57,
        "aFloat": 1.23
    }
}

Phản hồi mã hóa không thành công

throw new HttpsError("unauthenticated", "Request had invalid credentials.", {
  "some-key": "some-value"
});

Tiêu đề phản hồi không thành công:

401 UNAUTHENTICATED
Content-Type: application/json; charset=utf-8

Nội dung phản hồi không thành công:

{
    "error": {
        "message": "Request had invalid credentials.",
        "status": "UNAUTHENTICATED",
        "details": {
            "some-key": "some-value"
        }
    }
}