- Biểu diễn dưới dạng JSON
- Người dùng
- UserProfile
- PackageEntitlement (Quyền của gói)
- Quyền
- SignedData
- Thiết bị
- Nền tảng
- Chức năng
- Cuộc trò chuyện
- Đầu vào
- RawInput
AppRequest là yêu cầu do Trợ lý Google gửi đến một phương thức thực hiện để tương tác với một Hành động. Phiên bản API được chỉ định trong tiêu đề HTTP. Đối với API phiên bản 1, tiêu đề chứa: Google-Assistant-API-Version: v1
. Đối với API phiên bản 2, tiêu đề chứa: Google-actions-API-Version: 2
. Để xem ví dụ về cách dùng tài sản này trong các hành động trên Google, hãy truy cập https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json .
Biểu diễn dưới dạng JSON | |
---|---|
{ "user": { object ( |
Các trường | |
---|---|
user |
Người dùng đã bắt đầu cuộc trò chuyện. |
device |
Thông tin về thiết bị mà người dùng đang sử dụng để tương tác với Hành động đó. |
surface |
Thông tin về nền tảng mà người dùng đang tương tác, ví dụ: nền tảng có thể xuất âm thanh hoặc có màn hình hay không. |
conversation |
Lưu giữ dữ liệu về phiên, chẳng hạn như mã cuộc trò chuyện và mã thông báo cuộc trò chuyện. |
inputs[] |
Danh sách đầu vào tương ứng với đầu vào dự kiến do Hành động chỉ định. Đối với điều kiện kích hoạt cuộc trò chuyện ban đầu, dữ liệu đầu vào chứa thông tin về cách người dùng kích hoạt cuộc trò chuyện. |
isInSandbox |
Cho biết có nên xử lý yêu cầu ở chế độ hộp cát hay không. |
availableSurfaces[] |
Các bề mặt có thể chuyển giao trên nhiều bề mặt. |
Người dùng
Biểu diễn dưới dạng JSON | |
---|---|
{ "idToken": string, "profile": { object ( |
Các trường | |
---|---|
idToken |
mã thông báo đại diện cho danh tính của người dùng. Đây là mã thông báo web của Json bao gồm cả hồ sơ đã mã hoá. Bạn có thể xem định nghĩa tại https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo. |
profile |
Thông tin về người dùng cuối. Một số trường chỉ xuất hiện nếu người dùng đã cấp quyền cung cấp thông tin này cho Hành động. |
accessToken |
Mã thông báo OAuth2 giúp nhận dạng người dùng trong hệ thống của bạn. Chỉ có sẵn nếu người dùng liên kết tài khoản của họ. |
permissions[] |
Chứa các quyền mà người dùng cấp cho Hành động này. |
locale |
Chế độ cài đặt ngôn ngữ chính của người dùng đưa ra yêu cầu. Tuân theo mã ngôn ngữ IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt Tuy nhiên, thẻ phụ của tập lệnh không được bao gồm. |
lastSeen |
Dấu thời gian của lượt tương tác gần đây nhất với người dùng này. Trường này sẽ bị bỏ qua nếu người dùng chưa từng tương tác với nhân viên hỗ trợ. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, chính xác đến nano giây. Ví dụ: |
userStorage |
Mã thông báo mờ do ứng dụng cung cấp. Mã này được duy trì trong các cuộc trò chuyện của một người dùng cụ thể. Kích thước tối đa của chuỗi là 10 nghìn ký tự. |
packageEntitlements[] |
Danh sách các quyền của người dùng đối với mọi tên gói nêu trong Gói Hành động (nếu có). |
userVerificationStatus |
Cho biết trạng thái xác minh của người dùng. |
UserProfile
Chứa thông tin cá nhân của người dùng. Các trường chỉ được điền nếu người dùng cấp quyền cho Hành động đối với một trường cụ thể.
Biểu diễn dưới dạng JSON | |
---|---|
{ "displayName": string, "givenName": string, "familyName": string } |
Các trường | |
---|---|
displayName |
Tên đầy đủ của người dùng như được chỉ định trong Tài khoản Google của họ. Yêu cầu quyền |
givenName |
Tên của người dùng như được chỉ định trong Tài khoản Google của họ. Yêu cầu quyền |
familyName |
Họ của người dùng như được chỉ định trong Tài khoản Google của họ. Xin lưu ý rằng trường này có thể để trống. Yêu cầu quyền |
PackageEntitlement
Danh sách các quyền liên quan đến một tên gói
Biểu diễn dưới dạng JSON | |
---|---|
{
"packageName": string,
"entitlements": [
{
object ( |
Các trường | |
---|---|
packageName |
Phải khớp với tên gói trong gói hành động |
entitlements[] |
Danh sách các quyền của một ứng dụng cụ thể |
Quyền đối với sản phẩm
Xác định quyền sử dụng nội dung kỹ thuật số của người dùng. Các loại quyền có thể có: ứng dụng có tính phí,giao dịch mua hàng trong ứng dụng, gói thuê bao trong ứng dụng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "sku": string, "skuType": enum ( |
Các trường | |
---|---|
sku |
SKU sản phẩm. Tên gói cho ứng dụng có tính phí, hậu tố của Finsky docid cho giao dịch mua hàng trong ứng dụng và gói thuê bao trong ứng dụng. So khớp getSku() trong API Thanh toán trong ứng dụng của Play. |
skuType |
|
inAppDetails |
Chỉ áp dụng cho giao dịch mua hàng trong ứng dụng và gói thuê bao trong ứng dụng. |
SignedData
Biểu diễn dưới dạng JSON | |
---|---|
{ "inAppPurchaseData": { object }, "inAppDataSignature": string } |
Các trường | |
---|---|
inAppPurchaseData |
So khớp INAPP_PURCHASE_DATA từ phương thức getPurchases(). Chứa tất cả dữ liệu mua hàng trong ứng dụng ở định dạng JSON Xem thông tin chi tiết trong bảng 6 trên https://developer.android.com/google/play/billing/billing_reference.html. |
inAppDataSignature |
Khớp với IN_APP_DATA_SIGNATURE từ phương thức getPurchases() trong API Thanh toán trong ứng dụng của Play. |
Thiết bị
Thông tin về thiết bị mà người dùng đang sử dụng để tương tác với Hành động đó.
Biểu diễn dưới dạng JSON | |
---|---|
{
"location": {
object ( |
Các trường | |
---|---|
location |
Thể hiện vị trí thực của thiết bị, chẳng hạn như vĩ độ, kinh độ và địa chỉ đã định dạng. Yêu cầu quyền |
Bề mặt
Thông tin dành riêng cho giao diện ứng dụng Trợ lý Google mà người dùng đang tương tác. Nền tảng được phân biệt với thiết bị ở chỗ nhiều nền tảng của Trợ lý có thể hoạt động trên cùng một thiết bị.
Biểu diễn dưới dạng JSON | |
---|---|
{
"capabilities": [
{
object ( |
Các trường | |
---|---|
capabilities[] |
Danh sách các chức năng mà nền tảng hỗ trợ tại thời điểm yêu cầu, ví dụ: |
Chức năng
Đại diện cho một đơn vị chức năng mà nền tảng có thể hỗ trợ.
Biểu diễn dưới dạng JSON | |
---|---|
{ "name": string } |
Các trường | |
---|---|
name |
Tên chức năng, ví dụ: |
Giao lưu và trò chuyện
Biểu diễn dưới dạng JSON | |
---|---|
{
"conversationId": string,
"type": enum ( |
Các trường | |
---|---|
conversationId |
Mã nhận dạng duy nhất cho cuộc trò chuyện nhiều lượt. Nó được giao cho lượt đầu tiên. Sau đó, chuyển đổi sẽ giữ nguyên cho các cuộc trò chuyện tiếp theo cho đến khi cuộc trò chuyện bị chấm dứt. |
type |
cho biết trạng thái của cuộc trò chuyện trong vòng đời của nó. |
conversationToken |
Mã thông báo mờ do Hành động chỉ định trong lượt trò chuyện gần đây nhất. Hành động có thể dùng tính năng này để theo dõi cuộc trò chuyện hoặc lưu trữ dữ liệu liên quan đến cuộc trò chuyện. |
Đầu vào
Biểu diễn dưới dạng JSON | |
---|---|
{ "rawInputs": [ { object ( |
Các trường | |
---|---|
rawInputs[] |
Bản chép lời nhập thô từ mỗi lượt trò chuyện. Có thể cần phải thực hiện nhiều lượt trò chuyện để Hành động trên Google cung cấp một số loại thông tin đầu vào cho Hành động đó. |
intent |
Cho biết ý định của người dùng. Đối với lượt trò chuyện đầu tiên, ý định sẽ đề cập đến ý định kích hoạt cho Hành động. Trong các cuộc trò chuyện tiếp theo, ý định sẽ là một hành động phổ biến đối với ý định của Google (bắt đầu bằng "actions".). Ví dụ: nếu giá trị đầu vào dự kiến là |
arguments[] |
Danh sách các giá trị đối số được cung cấp cho dữ liệu đầu vào mà Hành động yêu cầu. |
RawInput
Biểu diễn dưới dạng JSON | |
---|---|
{ "inputType": enum ( |
Các trường | ||
---|---|---|
inputType |
Cho biết cách người dùng cung cấp thông tin đầu vào này: phản hồi đã nhập, phản hồi bằng giọng nói, không xác định, v.v. |
|
Trường nhóm input . Giá trị nhập vào thực tế input có thể chỉ là một trong những giá trị sau: |
||
query |
Tính năng nhập bằng giọng nói hoặc nhập từ người dùng cuối. |
|
url |
URL kích hoạt. |