AppRequest

AppRequest là một 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. Để biết ví dụ về cách sử dụng dữ liệu 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 (User)
  },
  "device": {
    object (Device)
  },
  "surface": {
    object (Surface)
  },
  "conversation": {
    object (Conversation)
  },
  "inputs": [
    {
      object (Input)
    }
  ],
  "isInSandbox": boolean,
  "availableSurfaces": [
    {
      object (Surface)
    }
  ]
}
Trường
user

object (User)

Người dùng đã bắt đầu cuộc trò chuyện.
device

object (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

object (Surface)

Thông tin về nền tảng mà người dùng đang tương tác, ví dụ: thiết bị có thể xuất âm thanh hay có màn hình hay không.
conversation

object (Conversation)

Lưu giữ dữ liệu phiên như mã nhận dạng cuộc trò chuyện và mã thông báo cuộc trò chuyện.
inputs[]

object (Input)

Danh sách dữ liệu đầu vào tương ứng với dữ liệu đầ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, nội dung nhập chứa thông tin về cách người dùng kích hoạt cuộc trò chuyện.
isInSandbox

boolean

Cho biết liệu yêu cầu có được xử lý ở chế độ hộp cát hay không.
availableSurfaces[]

object (Surface)

Các nền tảng có sẵn để chuyển giao bề mặt chéo.

Người dùng

Biểu diễn dưới dạng JSON 
{
  "idToken": string,
  "profile": {
    object (UserProfile)
  },
  "accessToken": string,
  "permissions": [
    enum (Permission)
  ],
  "locale": string,
  "lastSeen": string,
  "userStorage": string,
  "packageEntitlements": [
    {
      object (PackageEntitlement)
    }
  ],
  "userVerificationStatus": enum (UserVerificationStatus)
}
Trường
idToken

string

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 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

object (UserProfile)

Thông tin về người dùng cuối. Một số trường chỉ có sẵn nếu người dùng đã cấp quyền cung cấp thông tin này cho Hành động.
accessToken

string

Mã thông báo OAuth2 xác định 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[]

enum (Permission)

Chứa các quyền mà người dùng cấp cho Hành động này.
locale

string

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

string (Timestamp format)

Dấu thời gian của lần tương tác cuối cùng 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á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ụ: "2014-10-02T15:01:23.045123456Z"
userStorage

string

Mã thông báo mờ do ứng dụng cung cấp và đượ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[]

object (PackageEntitlement)

Danh sách các quyền của người dùng đối với mỗi tên gói được liệt kê trong gói Hành động, nếu có.
userVerificationStatus

enum (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 sẵ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
}
Trường
displayName

string

Tên đầy đủ của người dùng như được chỉ định trong Tài khoản Google của họ. Cần có quyền NAME.
givenName

string

Tên của người dùng như được chỉ định trong Tài khoản Google của họ. Cần có quyền NAME.
familyName

string

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. Cần có quyền NAME.

PackageEntitlement

Danh sách quyền liên quan đến tên gói

Biểu diễn dưới dạng JSON 
{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}
Trường
packageName

string

Phải khớp với tên gói trong gói hành động
entitlements[]

object (Entitlement)

Danh sách 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 thiết bị 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 (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
Trường
sku

string

Dòng 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

enum (SkuType)
inAppDetails

object (SignedData)

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
}
Trường
inAppPurchaseData

object (Struct format)

So khớp INAPP_PURCHASE_DATA từ phương thức getPurchases(). Chứa tất cả dữ liệu về giao dịch mua hàng trong ứng dụng ở định dạng JSON. Xem thông tin chi tiết trong bảng 6 tại https://developer.android.com/google/play/billing/billing_reference.html.
inAppDataSignature

string

So khớp 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 (Location)
  }
}
Trường
location

object (Location)

Biểu thị vị trí thực tế của thiết bị, chẳng hạn như vĩ độ, kinh độ và địa chỉ được định dạng. Cần có quyền DEVICE_COARSE_LOCATION hoặc DEVICE_PRECISE_LOCATION.

Bề mặt

Thông tin dành riêng cho ứng dụng Trợ lý Google mà người dùng đang tương tác. Nền tảng này khác với thiết bị ở chỗ trên thực tế có nhiều khu vực có Trợ lý cùng hoạt động trên cùng một thiết bị.

Biểu diễn dưới dạng JSON 
{
  "capabilities": [
    {
      object (Capability)
    }
  ]
}
Trường
capabilities[]

object (Capability)

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ụ: actions.capability.AUDIO_OUTPUT

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
}
Trường
name

string

Tên chức năng, ví dụ: actions.capability.AUDIO_OUTPUT

Cuộc trò chuyện

Biểu diễn dưới dạng JSON 
{
  "conversationId": string,
  "type": enum (ConversationType),
  "conversationToken": string
}
Trường
conversationId

string

Mã nhận dạng duy nhất cho cuộc trò chuyện nhiều lượt. Xe được gán cho lượt đầu tiên. Sau đó, cuộc trò chuyện vẫn giữ nguyên cho đến khi cuộc trò chuyện kết thúc.
type

enum (ConversationType)

type (loại) cho biết trạng thái của cuộc trò chuyện trong vòng đời của cuộc trò chuyện.
conversationToken

string

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 dữ liệu 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 (RawInput)
    }
  ],
  "intent": string,
  "arguments": [
    {
      object (Argument)
    }
  ]
}
Trường
rawInputs[]

object (RawInput)

Bản chép lời thô từ mỗi lượt trò chuyện. Bạn có thể cần phải quay nhiều lượt trò chuyện để thực hiện một số hành động trên Google nhằm cung cấp một số loại dữ liệu đầu vào cho Hành động.
intent

string

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. Đối với các lượt trò chuyện tiếp theo, ý định sẽ là một hành động phổ biến trong ý định của Google (bắt đầu bằng "hành động"). Ví dụ: nếu dữ liệu đầu vào dự kiến là actions.intent.OPTION, thì ý định được chỉ định ở đây sẽ là actions.intent.OPTION nếu Trợ lý Google có thể đáp ứng ý định đó hoặc actions.intent.TEXT nếu người dùng cung cấp thông tin khác. Hãy xem https://developers.google.com/assistant/df-asdk/reference/intents.
arguments[]

object (Argument)

Danh sách các giá trị đối số được cung cấp cho dữ liệu đầu vào do Hành động yêu cầu.

RawInput

Biểu diễn dưới dạng JSON 
{
  "inputType": enum (InputType),

  // Union field input can be only one of the following:
  "query": string,
  "url": string
  // End of list of possible types for union field input.
}
Trường
inputType

enum (InputType)

Cho biết cách người dùng cung cấp dữ liệu đầu vào này: câu trả lời đã nhập, câu trả lời bằng giọng nói, thông tin chưa được chỉ định, v.v.
Trường kết hợp input. Giá trị nhập thực tế input chỉ có thể là một trong những giá trị sau:
query

string

Nhập liệu bằng giọng nói hoặc nhập từ người dùng cuối.
url

string

URL kích hoạt.