- Yêu cầu HTTP
- Nội dung yêu cầu
- Nội dung phản hồi
- Trình xử lý
- Ý định
- IntentParameterValue
- Cảnh
- SlotFillingStatus
- Khe
- SlotMode
- SlotStatus
- Lời nhắc
- Đơn giản
- Nội dung
- Thẻ
- Hình ảnh
- ImageFill
- Đường liên kết
- OpenUrl
- UrlHint
- Bảng
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- Nội dung đa phương tiện
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- Thu thập
- CollectionItem (Bộ sưu tập)
- Danh sách
- ListItem
- CollectionBrowse
- Mặt hàng
- Đề xuất
- Canvas
- ContinuousMatchConfig –
- ExpectedPhrase
- OrderUpdate
- Loại
- Đơn đặt hàng
- UserInfo
- PhoneNumber
- Hình ảnh
- Người bán
- Vị trí
- LatLng
- PostalAddress (Địa chỉ bưu chính)
- Nội dung
- LineItem
- PriceAttribute
- Loại
- Trạng thái
- Tiền
- Thao tác
- Loại
- OpenUrlAction
- AndroidApp
- VersionFilter
- UrlTypeHint
- ActionMetadata
- Thông tin công bố
- DisclosureText
- TextLink
- DisclosurePresentationOptions
- PresentationRequirement
- PurchaseItemExtension (Tiện ích mở rộng mặt hàng)
- PurchaseStatus
- PurchaseType
- MerchantUnitMeasure
- Đơn vị
- PurchaseReturnsInfo
- PurchaseFulfillmentInfo
- Loại
- Thời gian
- PickupInfo
- PickupType
- CurbsideInfo
- CurbsideFulfillmentType
- Xe
- CheckInInfo
- CheckInType
- ItemOption
- ProductDetails
- ReservationItemExtension (Phần mở rộng đặt trước)
- ReservationStatus
- ReservationType
- StaffFacilitator
- PaymentData
- PaymentResult
- PaymentInfo
- PaymentMethodDisplayInfo
- PaymentType
- PaymentMethodProvenance
- Khuyến mãi
- PurchaseOrderExtension
- PurchaseLocationType
- PurchaseError
- ErrorType
- TicketOrderExtension
- TicketEvent
- Loại
- EventCharacter (Ký tự sự kiện)
- Loại
- UserNotification
- NextScene
- Phiên
- TypeOverride
- TypeOverrideMode
- SynonymType
- Mục nhập
- EntryDisplay
- Người dùng
- AccountLinkingStatus
- UserVerificationStatus
- Mức độ tương tác
- IntentSubscription
- PackageEntitlements (Quyền lợi của gói)
- Quyền
- SkuType
- SignedData
- Quyền
- Trang chủ
- Thiết bị
- Chức năng
- Vị trí
- TimeZone
- Ngữ cảnh
- MediaContext
- CanvasContext
- Dự kiến
RPC đại diện cho API thực hiện
Yêu cầu HTTP
POST https://webhook_handler_service.googleapis.com/fulfill
URL sử dụng cú pháp Chuyển mã gRPC.
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON | |
---|---|
{ "handler": { object ( |
Các trường | |
---|---|
handler |
Bắt buộc. Thông tin để thực hiện về cách xử lý yêu cầu. Ví dụ: một yêu cầu nhằm mục đích tải một dữ kiện có thể có một trình xử lý có tên là "getFact". |
intent |
Bắt buộc. Đại diện cho ý định được so khớp gần đây nhất. Hãy truy cập vào https://developers.google.com/assistant/conversational/intents. |
scene |
Không bắt buộc. Thông tin về cảnh hiện tại và tiếp theo khi hàm được gọi. Sẽ được thực hiện khi lệnh gọi phương thức thực hiện được thực hiện trong phạm vi của một cảnh. Hãy truy cập vào https://developers.google.com/assistant/conversational/scenes. |
session |
Bắt buộc. Lưu giữ dữ liệu về phiên, chẳng hạn như mã phiên và thông số phiên. |
user |
Bắt buộc. Người dùng đã bắt đầu cuộc trò chuyện. |
home |
Không bắt buộc. Thông tin liên quan đến cấu trúc HomeGraph của thiết bị mục tiêu. Hãy truy cập vào https://developers.google.com/actions/smarthome/concepts/homegraph. |
device |
Bắt buộc. Thông tin trên thiết bị mà người dùng đang sử dụng để tương tác với Hành động đó. |
context |
Không bắt buộc. Thông tin về bối cảnh hiện tại của yêu cầu. Bao gồm nhưng không giới hạn ở thông tin về phiên phát nội dung đa phương tiện hoặc ảnh in trên vải canvas đang hoạt động. |
Nội dung phản hồi
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Thể hiện phản hồi được gửi từ phương thức thực hiện của nhà phát triển đối với Actions on Google.
Biểu diễn dưới dạng JSON | |
---|---|
{ "prompt": { object ( |
Các trường | |
---|---|
prompt |
Không bắt buộc. Biểu thị các lời nhắc sẽ được gửi cho người dùng, các lời nhắc này sẽ được thêm vào các tin nhắn đã thêm trước đó trừ phi bị ghi đè một cách rõ ràng. |
scene |
Không bắt buộc. Đại diện cho cảnh hiện tại và cảnh tiếp theo. Nếu bạn đặt |
session |
Không bắt buộc. Mô tả dữ liệu của phiên hiện tại, phương thức thực hiện có thể tạo, cập nhật hoặc xoá các tham số phiên. |
user |
Không bắt buộc. Sử dụng để chỉ định các tham số người dùng cần gửi lại. |
home |
Không bắt buộc. Dùng để chỉ định các tham số liên quan đến cấu trúc HomeGraph của thiết bị mục tiêu. Hãy truy cập vào https://developers.google.com/actions/smarthome/concepts/homegraph. |
device |
Không bắt buộc. Dùng để di chuyển giữa các thiết bị có Trợ lý mà người dùng có quyền truy cập. |
expected |
Không bắt buộc. Mô tả kỳ vọng cho lượt hộp thoại tiếp theo. |
Trình xử lý
Đại diện cho một trình xử lý phương thức thực hiện ánh xạ thông tin sự kiện từ Actions on Google đến phương thức thực hiện. Sử dụng tên trình xử lý để xác định mã bạn nên chạy trong phương thức thực hiện. Ví dụ: một trình xử lý có thể được dùng để lấy thông tin về thông tin đơn đặt hàng của người dùng với tên trình xử lý như "OrderLookup" trong khi trình xử lý khác có thể nhận thông tin sản phẩm từ một cơ sở dữ liệu có tên trình xử lý như "GetProductInfo".
Biểu diễn dưới dạng JSON | |
---|---|
{ "name": string } |
Các trường | |
---|---|
name |
Không bắt buộc. Tên trình xử lý. |
Intent
Đại diện cho một ý định. Hãy truy cập vào https://developers.google.com/assistant/conversational/intents.
Biểu diễn dưới dạng JSON | |
---|---|
{
"name": string,
"params": {
string: {
object ( |
Các trường | |
---|---|
name |
Bắt buộc. Tên của ý định so khớp gần đây nhất. |
params |
Bắt buộc. Biểu thị các tham số được xác định trong quá trình so khớp ý định. Đây là liên kết tên của thông số đã xác định với giá trị của tham số được xác định từ hoạt động đầu vào của người dùng. Tất cả thông số được xác định trong ý định phù hợp đã được xác định sẽ xuất hiện tại đây. Một đối tượng chứa danh sách các cặp |
query |
Không bắt buộc. Thông tin nhập bằng giọng nói hoặc nhập bằng giọng nói của người dùng cuối khớp với ý định này. Giá trị này sẽ được điền sẵn khi so khớp một ý định, dựa trên hoạt động đầu vào của người dùng. |
IntentParameterValue
Đại diện cho một giá trị cho tham số ý định. Hãy truy cập vào https://developers.google.com/assistant/conversational/types.
Biểu diễn dưới dạng JSON | |
---|---|
{ "original": string, "resolved": value } |
Các trường | |
---|---|
original |
Bắt buộc. Giá trị văn bản gốc được trích xuất từ cách nói của người dùng. |
resolved |
Bắt buộc. Giá trị có cấu trúc cho thông số được trích xuất từ hoạt động đầu vào của người dùng. Dữ liệu này sẽ chỉ được điền nếu tham số được xác định trong ý định được so khớp và giá trị của tham số đó có thể được xác định trong quá trình so khớp ý định. |
Scene
Thể hiện một cảnh. Cảnh có thể gọi phương thức thực hiện, thêm lời nhắc và thu thập các giá trị vị trí từ người dùng. Các cảnh được kích hoạt bởi các sự kiện hoặc ý định, đồng thời có thể kích hoạt các sự kiện cũng như so khớp ý định để chuyển đổi sang các cảnh khác.
Biểu diễn dưới dạng JSON | |
---|---|
{ "name": string, "slotFillingStatus": enum ( |
Các trường | |
---|---|
name |
Bắt buộc. Tên cảnh hiện tại. |
slotFillingStatus |
Bắt buộc. Trạng thái hiện tại của việc lấp đầy vị trí. Trường này chỉ để đọc. |
slots |
Các vị trí liên kết với cảnh hiện tại. Phản hồi của trình xử lý không thể trả về các vị trí chưa được gửi trong yêu cầu. Một đối tượng chứa danh sách các cặp |
next |
Không bắt buộc. Thông tin tại hiện trường sẽ được xử lý tiếp theo. |
SlotFillingStatus
Biểu thị trạng thái hiện tại của việc lấp đầy vị trí.
Enum | |
---|---|
UNSPECIFIED |
Giá trị dự phòng khi trường sử dụng không được điền. |
INITIALIZED |
Các khe đã được khởi chạy nhưng việc điền vị trí chưa bắt đầu. |
COLLECTING |
Các giá trị vị trí đang được thu thập. |
FINAL |
Tất cả các giá trị vị trí đều là cuối cùng và không thể thay đổi. |
Vùng
Đại diện cho một vị trí.
Biểu diễn dưới dạng JSON | |
---|---|
{ "mode": enum ( |
Các trường | |
---|---|
mode |
Chế độ của vị trí (bắt buộc hoặc không bắt buộc). Có thể do nhà phát triển thiết lập. |
status |
Trạng thái của vị trí. |
value |
Giá trị của vị trí. Việc thay đổi giá trị này trong phản hồi sẽ sửa đổi giá trị trong điền vị trí. |
updated |
Cho biết liệu giá trị vị trí có được thu thập ở ngã rẽ cuối cùng hay không. Trường này chỉ để đọc. |
prompt |
Không bắt buộc. Lời nhắc này được gửi đến người dùng khi cần điền vào một ô bắt buộc. Lời nhắc này sẽ ghi đè lời nhắc hiện có được xác định trong bảng điều khiển. Trường này không có trong yêu cầu webhook. |
SlotMode
Đại diện cho chế độ của một vị trí, tức là nếu bắt buộc hay không.
Enum | |
---|---|
MODE_UNSPECIFIED |
Giá trị dự phòng khi trường sử dụng không được điền. |
OPTIONAL |
Cho biết rằng vị trí không bắt buộc phải hoàn thành việc lấp đầy vị trí. |
REQUIRED |
Cho biết rằng vị trí này cần phải được hoàn thành để hoàn thành việc lấp đầy vị trí. |
SlotStatus
Biểu thị trạng thái của một vị trí.
Enum | |
---|---|
SLOT_UNSPECIFIED |
Giá trị dự phòng khi trường sử dụng không được điền. |
EMPTY |
Cho biết rằng vị trí không có bất kỳ giá trị nào. Bạn không thể sửa đổi trạng thái này thông qua phản hồi. |
INVALID |
Cho biết rằng giá trị vị trí không hợp lệ. Bạn có thể đặt trạng thái này thông qua câu trả lời. |
FILLED |
Cho biết vị trí có một giá trị. Bạn không thể sửa đổi trạng thái này thông qua phản hồi. |
Lời nhắc trong
Thể hiện nội dung phản hồi cho người dùng. Hãy truy cập vào https://developers.google.com/assistant/conversational/prompts.
Biểu diễn dưới dạng JSON | |
---|---|
{ "override": boolean, "firstSimple": { object ( |
Các trường | |
---|---|
override |
Không bắt buộc. Chế độ cách hợp nhất tin nhắn này với tin nhắn đã xác định trước đó. "true" xoá tất cả thông báo đã xác định trước đó (nội dung, đường liên kết đơn giản đầu tiên và cuối cùng, đường liên kết đề xuất và canvas) đồng thời thêm thông báo được xác định trong câu lệnh này. "false" sẽ thêm thông báo được xác định trong câu lệnh này vào các thông báo được xác định trong các câu trả lời trước. Việc để trường này thành "false" cũng cho phép thêm một số trường trong lời nhắc Đơn giản, lời nhắc Đề xuất và lời nhắc Canvas (một phần của lời nhắc Nội dung). Thông báo Nội dung và Đường liên kết luôn bị ghi đè nếu được xác định trong câu lệnh. Giá trị mặc định là "false". |
firstSimple |
Không bắt buộc. Tin nhắn phản hồi đầu tiên bằng giọng nói và văn bản. |
content |
Không bắt buộc. Nội dung như thẻ, danh sách hoặc nội dung nghe nhìn cần hiển thị với người dùng. |
lastSimple |
Không bắt buộc. Câu trả lời bằng giọng nói và văn bản sau cùng. |
suggestions[] |
Không bắt buộc. Các nội dung đề xuất dành cho người dùng sẽ luôn xuất hiện ở cuối câu trả lời. Nếu trường "override" trong câu lệnh chứa có giá trị "false", thì tiêu đề được xác định trong trường này sẽ được thêm vào tiêu đề được xác định trong mọi câu lệnh đề xuất đã được xác định trước đó và các giá trị trùng lặp sẽ bị xoá. |
link |
Không bắt buộc. Khối đề xuất bổ sung có thể liên kết đến ứng dụng hoặc trang web được liên kết. Khối sẽ hiển thị với tiêu đề "Mở (tên)". Tối đa 20 ký tự. |
canvas |
Không bắt buộc. Biểu thị phản hồi Canvas tương tác sẽ được gửi đến người dùng. |
orderUpdate |
Hành động tùy chọn phản hồi bằng một OrderUpdate sau khi nhận được đơn đặt hàng trong luồng giao dịch. Khi nhận được thông báo này, Google sẽ ghi lại thông tin cập nhật này cho đơn đặt hàng và nếu thành công, sẽ hiển thị thẻ biên nhận cùng với TTS được gửi trên các thiết bị hiển thị. |
Simple
Đại diện cho một lời nhắc đơn giản để gửi đến người dùng. Hãy truy cập vào https://developers.google.com/assistant/conversational/prompts-simple.
Biểu diễn dưới dạng JSON | |
---|---|
{ "speech": string, "text": string } |
Các trường | |
---|---|
speech |
Không bắt buộc. Đại diện cho lời nói sẽ được nói với người dùng. Có thể là SSML hoặc tính năng chuyển văn bản sang lời nói. Nếu trường "ghi đè" trong câu lệnh chứa có giá trị là "đúng", thì lời nói xác định trong trường này sẽ thay thế lời nói của câu lệnh Đơn giản trước đó. Hãy truy cập vào https://developers.google.com/assistant/conversational/ssml. |
text |
Văn bản không bắt buộc xuất hiện trong bong bóng trò chuyện. Nếu không được cung cấp, chế độ hiển thị của trường lời nói ở trên sẽ được sử dụng. Giới hạn ở 640 ký tự. Nếu trường "override" trong câu lệnh chứa có giá trị là "true", thì văn bản được xác định trong trường này sẽ thay thế bằng văn bản của câu lệnh Đơn giản trước đó. |
Nội dung
Đối tượng vùng chứa cho các lời nhắc đa dạng thức hoặc lời nhắc lựa chọn.
Biểu diễn dưới dạng JSON | |
---|---|
{ // Union field |
Các trường | ||
---|---|---|
Trường nhóm
|
||
card |
Một thẻ cơ bản. |
|
image |
Một hình ảnh. |
|
table |
Thẻ bảng. |
|
media |
Phản hồi cho biết một nhóm nội dung nghe nhìn sẽ phát. |
|
collection |
Một thẻ hiển thị một tập hợp các tuỳ chọn để chọn. |
|
list |
Một thẻ hiển thị danh sách các tuỳ chọn để chọn. |
|
collectionBrowse |
Một thẻ hiển thị một tập hợp các trang web sẽ mở. |
Thẻ
Một thẻ cơ bản để hiển thị một số thông tin (ví dụ: hình ảnh và/hoặc văn bản). Hãy xem https://developers.google.com/assistant/conversational/prompts-rich#basic_card.
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Các trường | |
---|---|
title |
Tiêu đề chung của thẻ. Không bắt buộc. |
subtitle |
Không bắt buộc. |
text |
Văn bản nội dung của thẻ. Hỗ trợ một số cú pháp Markdown có giới hạn để định dạng. Bắt buộc, trừ khi có hình ảnh. |
image |
Hình ảnh chính cho thẻ. Chiều cao được cố định là 192 dp. Không bắt buộc. |
imageFill |
Cách tô nền hình ảnh. Không bắt buộc. |
button |
Nút có đường liên kết ra ngoài. Không bắt buộc. |
Bài đăng có hình ảnh
Hình ảnh hiển thị trong thẻ. Hãy xem https://developers.google.com/assistant/conversational/prompts-rich#image-cards.
Biểu diễn dưới dạng JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Các trường | |
---|---|
url |
URL nguồn của hình ảnh. Hình ảnh có thể ở định dạng JPG, PNG và GIF (động và tĩnh). Ví dụ: |
alt |
Nội dung mô tả văn bản của hình ảnh được dùng cho khả năng hỗ trợ tiếp cận, ví dụ: trình đọc màn hình. Bắt buộc. |
height |
Chiều cao của hình ảnh tính bằng pixel. Không bắt buộc. |
width |
Chiều rộng của hình ảnh tính bằng pixel. Không bắt buộc. |
ImageFill
Các tuỳ chọn hiển thị hình ảnh có thể ảnh hưởng đến cách trình bày hình ảnh. Bạn nên sử dụng thuộc tính này khi tỷ lệ khung hình của hình ảnh không khớp với tỷ lệ khung hình của vùng chứa hình ảnh.
Enum | |
---|---|
UNSPECIFIED |
|
GRAY |
Lấp đầy khoảng trống giữa hình ảnh và vùng chứa hình ảnh bằng các thanh màu xám. |
WHITE |
Lấp đầy khoảng trống giữa hình ảnh và vùng chứa hình ảnh bằng các thanh màu trắng. |
CROPPED |
Hình ảnh được điều chỉnh theo tỷ lệ sao cho chiều rộng và chiều cao của hình ảnh khớp hoặc vượt quá kích thước vùng chứa. Thao tác này có thể cắt phần trên cùng và dưới cùng của hình ảnh nếu chiều cao hình ảnh được điều chỉnh theo tỷ lệ lớn hơn chiều cao vùng chứa hoặc cắt bên trái và bên phải của hình ảnh nếu chiều rộng hình ảnh được điều chỉnh theo tỷ lệ lớn hơn chiều rộng vùng chứa. Điều này tương tự như "Chế độ thu phóng" trên TV màn hình rộng khi phát video 4:3. |
Đường liên kết
Khối đề xuất bổ sung có thể liên kết đến ứng dụng hoặc trang web được liên kết. Khối sẽ hiển thị với tiêu đề "Mở (tên)".
Biểu diễn dưới dạng JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Các trường | |
---|---|
name |
Tên của đường liên kết. Tối đa 20 ký tự. |
open |
Điều gì xảy ra khi người dùng mở đường liên kết |
OpenUrl
Biểu diễn dưới dạng JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Các trường | |
---|---|
url |
Trường url có thể là bất kỳ URL nào trong số: – URL http/https để mở Ứng dụng được liên kết với ứng dụng hoặc một trang web |
hint |
Biểu thị gợi ý cho loại URL. |
UrlHint
Các loại gợi ý về URL.
Enum | |
---|---|
LINK_UNSPECIFIED |
Không xác định |
AMP |
URL trỏ trực tiếp đến nội dung AMP hoặc đến URL chính tắc dẫn đến nội dung AMP thông qua . Hãy xem https://amp.dev/. |
Bảng
Thẻ bảng để trình bày một bảng văn bản. Hãy truy cập vào https://developers.google.com/assistant/conversational/prompts-rich#table_cards.
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Các trường | |
---|---|
title |
Tiêu đề chung của bảng. Không bắt buộc nhưng phải đặt nếu đã đặt tiêu đề phụ. |
subtitle |
Tiêu đề phụ cho bảng. Không bắt buộc. |
image |
Hình ảnh được liên kết với bảng. Không bắt buộc. |
columns[] |
Tiêu đề và căn chỉnh các cột. |
rows[] |
Dữ liệu hàng của bảng. 3 hàng đầu tiên chắc chắn sẽ xuất hiện, nhưng những hàng khác có thể bị cắt trên một số vị trí. Vui lòng thử nghiệm bằng trình mô phỏng để xem hàng nào sẽ xuất hiện trên một nền tảng nhất định. Trên các nền tảng hỗ trợ chức năng WEB_BROWSER, bạn có thể trỏ người dùng đến một trang web có nhiều dữ liệu hơn. |
button |
Nút. |
TableColumn
Biểu diễn dưới dạng JSON | |
---|---|
{
"header": string,
"align": enum ( |
Các trường | |
---|---|
header |
Văn bản tiêu đề cho cột. |
align |
Căn ngang nội dung với cột t.r.t. Nếu chưa chỉ định, nội dung sẽ được căn chỉnh vào cạnh trên cùng. |
HorizontalAlignment
Căn chỉnh nội dung trong ô.
Enum | |
---|---|
UNSPECIFIED |
|
LEADING |
Cạnh trên của ô. Đây là lựa chọn mặc định. |
CENTER |
Nội dung được căn chỉnh vào giữa cột. |
TRAILING |
Nội dung được căn chỉnh theo cạnh sau của cột. |
TableRow
Mô tả một hàng trong bảng.
Biểu diễn dưới dạng JSON | |
---|---|
{
"cells": [
{
object ( |
Các trường | |
---|---|
cells[] |
Các ô trong hàng này. 3 ô đầu tiên được đảm bảo sẽ hiển thị, nhưng các ô khác có thể bị cắt trên một số bề mặt nhất định. Vui lòng thử nghiệm bằng trình mô phỏng để xem ô nào sẽ xuất hiện trên một nền tảng nhất định. |
divider |
Cho biết có cần dùng dải phân cách sau mỗi hàng hay không. |
TableCell
Mô tả một ô trong hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "text": string } |
Các trường | |
---|---|
text |
Nội dung văn bản của ô. |
Nội dung nghe nhìn
Đại diện cho một đối tượng nội dung nghe nhìn. Chứa thông tin về nội dung nghe nhìn, chẳng hạn như tên, nội dung mô tả, URL, v.v. Hãy xem https://developers.google.com/assistant/conversational/prompts-media.
Biểu diễn dưới dạng JSON | |
---|---|
{ "mediaType": enum ( |
Các trường | |
---|---|
mediaType |
|
startOffset |
Bắt đầu độ lệch của đối tượng nội dung đa phương tiện đầu tiên. Thời lượng tính bằng giây có tối đa 9 chữ số phân số, kết thúc bằng ' |
optionalMediaControls[] |
Các loại chế độ điều khiển nội dung nghe nhìn không bắt buộc mà phiên phản hồi nội dung nghe nhìn này có thể hỗ trợ. Nếu được đặt, yêu cầu sẽ được gửi đến bên thứ ba khi một sự kiện truyền thông nhất định diễn ra. Nếu không được đặt, 3p vẫn phải xử lý hai loại điều khiển mặc định là ComposeED và FAILED (KHÔNG THÀNH CÔNG). |
mediaObjects[] |
Danh sách đối tượng nội dung đa phương tiện |
repeatMode |
Chế độ lặp lại cho danh sách Đối tượng phương tiện. |
firstMediaObjectIndex |
Chỉ mục dựa trên 0 của Đối tượng đa phương tiện đầu tiên trong mediaObjects để phát. Nếu không được chỉ định, hoặc nằm ngoài giới hạn, thì quá trình phát sẽ bắt đầu ở đối tượng đa phương tiện đầu tiên trong mediaObjects. |
MediaType
Loại nội dung đa phương tiện của phản hồi này.
Enum | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
|
AUDIO |
Tệp âm thanh. |
MEDIA_STATUS_ACK |
Nội dung phản hồi để xác nhận báo cáo trạng thái nội dung nghe nhìn. |
OptionalMediaControls
Các loại điều khiển nội dung nghe nhìn tuỳ chọn mà phản hồi của nội dung nghe nhìn có thể hỗ trợ
Enum | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Giá trị chưa được chỉ định |
PAUSED |
Đã tạm dừng sự kiện. Được kích hoạt khi người dùng tạm dừng nội dung đa phương tiện. |
STOPPED |
Sự kiện đã dừng. Được kích hoạt khi người dùng thoát khỏi phiên 3p trong khi phát nội dung nghe nhìn. |
MediaObject
Đại diện cho một đối tượng nội dung đa phương tiện
Biểu diễn dưới dạng JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Các trường | |
---|---|
name |
Tên của đối tượng nội dung đa phương tiện này. |
description |
Nội dung mô tả về đối tượng nội dung đa phương tiện này. |
url |
URL trỏ đến nội dung nghe nhìn. Tệp MP3 phải được lưu trữ trên máy chủ web và được cung cấp công khai qua URL loại HTTPS. Chỉ hỗ trợ phát trực tiếp cho định dạng MP3. |
image |
Hình ảnh để hiển thị cùng với thẻ nội dung đa phương tiện. |
MediaImage
Biểu diễn dưới dạng JSON | |
---|---|
{ // Union field |
Các trường | ||
---|---|---|
Trường nhóm
|
||
large |
Một hình ảnh lớn, chẳng hạn như bìa album, v.v. |
|
icon |
Một biểu tượng hình ảnh nhỏ ở bên phải của tiêu đề. Nó được đổi kích thước thành 36x36 dp. |
RepeatMode
Các loại chế độ lặp lại cho danh sách đối tượng nội dung đa phương tiện.
Enum | |
---|---|
REPEAT_MODE_UNSPECIFIED |
Tương đương với tuỳ chọn TẮT. |
OFF |
Kết thúc phiên phát nội dung nghe nhìn ở cuối đối tượng nội dung nghe nhìn gần đây nhất. |
ALL |
Lặp lại đến đầu đối tượng nội dung đa phương tiện đầu tiên khi đến cuối đối tượng nội dung đa phương tiện cuối cùng. |
Bộ sưu tập
Một thẻ trình bày một bộ sưu tập các tuỳ chọn để chọn. Hãy truy cập vào https://developers.google.com/assistant/conversational/prompts-selection#collection
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Các trường | |
---|---|
title |
Tên bộ sưu tập. Không bắt buộc. |
subtitle |
Tiêu đề phụ của bộ sưu tập. Không bắt buộc. |
items[] |
Danh sách các mục. Giá trị này có thể có giá trị tối thiểu là 2 và tối đa là 10. |
imageFill |
Cách tô nền hình ảnh của các mục trong bộ sưu tập. Không bắt buộc. |
CollectionItem
Một mục trong bộ sưu tập
Biểu diễn dưới dạng JSON | |
---|---|
{ "key": string } |
Các trường | |
---|---|
key |
Bắt buộc. Khoá NLU khớp với tên khoá nhập trong Loại được liên kết. |
Danh sách
Một thẻ trình bày danh sách các tuỳ chọn để chọn. Hãy truy cập vào https://developers.google.com/assistant/conversational/prompts-selection#list
Biểu diễn dưới dạng JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Các trường | |
---|---|
title |
Tiêu đề danh sách. Không bắt buộc. |
subtitle |
Tiêu đề phụ của danh sách. Không bắt buộc. |
items[] |
Danh sách các mục. Giá trị này có thể có giá trị tối thiểu là 2 và tối đa là 30. |
ListItem
Một mục trong danh sách
Biểu diễn dưới dạng JSON | |
---|---|
{ "key": string } |
Các trường | |
---|---|
key |
Bắt buộc. Khoá NLU khớp với tên khoá nhập trong Loại được liên kết. |
CollectionBrowse
Trình bày một nhóm tài liệu trên web dưới dạng một tập hợp các mục có nhiều ô lớn. Bạn có thể chọn các mục để chạy tài liệu web liên kết trong một trình xem web. Hãy truy cập vào https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse.
Biểu diễn dưới dạng JSON | |
---|---|
{ "items": [ { object ( |
Các trường | |
---|---|
items[] |
Danh sách các mục. Giá trị này có thể có giá trị tối thiểu là 2 và tối đa là 10. |
imageFill |
Loại tuỳ chọn hiển thị hình ảnh. |
Mục
Mục trong bộ sưu tập.
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Các trường | |
---|---|
title |
Bắt buộc. Tên của mục trong bộ sưu tập. |
description |
Nội dung mô tả về mục bộ sưu tập. |
footer |
Văn bản chân trang cho mục trong bộ sưu tập, hiển thị bên dưới phần mô tả. Một dòng văn bản, bị cắt ngắn bằng dấu ba chấm. |
image |
Hình ảnh cho mục trong bộ sưu tập. |
openUriAction |
Bắt buộc. URI để mở nếu mục được chọn. |
Đề xuất
Đề xuất sẽ cung cấp cho người dùng khối đề xuất trên các thiết bị có khả năng hiển thị khi Trợ lý hiển thị lời nhắc. Sử dụng khối đề xuất để gợi ý câu trả lời của người dùng nhằm tiếp tục hoặc chuyển hướng cuộc trò chuyện. Khi người dùng nhấn vào, khối đề xuất sẽ trả về văn bản hiển thị cho cuộc trò chuyện nguyên văn, như thể người dùng đã nhập văn bản đó. Hãy xem https://developers.google.com/assistant/conversational/prompts#suggestions
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string } |
Các trường | |
---|---|
title |
Bắt buộc. Văn bản xuất hiện trong khối đề xuất. Khi được nhấn, văn bản này sẽ được đăng lại nguyên văn trong cuộc trò chuyện như thể người dùng đã nhập. Mỗi tiêu đề phải là duy nhất trong tập hợp khối đề xuất. Tối đa 25 ký tự |
Canvas
Biểu thị phản hồi Canvas tương tác sẽ được gửi đến người dùng. Bạn có thể sử dụng tính năng này cùng với trường "firstSimple" trong câu lệnh chứa lời nhắc để nói chuyện với người dùng ngoài việc hiển thị phản hồi canvas tương tác. Kích thước tối đa của phản hồi là 50 nghìn byte. Hãy truy cập vào https://developers.google.com/assistant/interactivecanvas.
Biểu diễn dưới dạng JSON | |
---|---|
{
"url": string,
"data": [
value
],
"suppressMic": boolean,
"continuousMatchConfig": {
object ( |
Các trường | |
---|---|
url |
URL của ứng dụng web canvas tương tác sẽ tải. Nếu bạn không đặt chính sách này, thì URL từ canvas đang hoạt động sẽ được sử dụng lại. |
data[] |
Không bắt buộc. Dữ liệu JSON sẽ được truyền đến trang web trải nghiệm sống động dưới dạng sự kiện. Nếu trường "ghi đè" trong câu lệnh chứa là "sai" thì các giá trị dữ liệu được xác định trong lời nhắc Canvas này sẽ được thêm vào sau các giá trị dữ liệu được xác định trong các câu lệnh trước đó của Canvas. |
suppressMic |
Không bắt buộc. Giá trị mặc định: false. |
continuousMatchConfig |
Cấu hình dùng để bắt đầu chế độ so khớp liên tục. |
ContinuousMatchConfig
Cấu hình dùng để bắt đầu chế độ so khớp liên tục.
Biểu diễn dưới dạng JSON | |
---|---|
{
"expectedPhrases": [
{
object ( |
Các trường | |
---|---|
expectedPhrases[] |
Tất cả các cụm từ có thể có trong phiên sử dụng chế độ so khớp liên tục này. |
durationSeconds |
Thời lượng để chế độ khớp liên tục đang bật. Nếu được chỉ định, micrô sẽ đóng khi hết thời gian. Giá trị tối đa cho phép là 180. |
ExpectedPhrase
Biểu diễn dưới dạng JSON | |
---|---|
{ "phrase": string, "alternativePhrases": [ string ] } |
Các trường | |
---|---|
phrase |
Cụm từ cần khớp trong phiên sử dụng chế độ so khớp liên tục. |
alternativePhrases[] |
Mẫu lời nói có thể nhận dạng sai một số cụm từ, ngay cả khi có xu hướng lời nói. Điều này cho phép các nhà phát triển chỉ định các điều kiện kích hoạt thay thế cho từ đồng âm. |
OrderUpdate
Cập nhật thành đơn đặt hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "type": enum ( |
Các trường | |
---|---|
type |
Không dùng nữa: Thay vào đó, hãy sử dụng OrderUpdate.update_mask. Nếu loại = SNAPSHOT, OrderUpdate.order phải là toàn bộ đơn đặt hàng. Nếu loại = ORDER_STATUS, đây là sự thay đổi trạng thái cấp đơn đặt hàng. Chỉ đến thứ tự order.last_update_time và thứ hạng theo ngành dọc này mới được đến lấy. Lưu ý: type.ORDER_STATUS chỉ hỗ trợ nội dung cập nhật trạng thái PurcahaseOrderExtension và không có kế hoạch mở rộng phạm vi hỗ trợ này. Thay vào đó, bạn nên sử dụng updateMask vì phương thức này chung chung, dễ mở rộng và có thể dùng cho mọi ngành dọc. |
order |
|
updateMask |
Lưu ý: Sau đây là một số điều nên cân nhắc/đề xuất đối với các trường đặc biệt sau đây: 1. order.last_update_time sẽ luôn được cập nhật trong yêu cầu cập nhật. 2. order.create_time, order.google_order_id và order.merchant_order_id sẽ bị bỏ qua nếu bạn cung cấp thông tin này trong updateMask. Đây là danh sách các tên trường đủ điều kiện được phân tách bằng dấu phẩy. Ví dụ: |
userNotification |
Nếu được chỉ định, hiển thị thông báo cho người dùng cùng với tiêu đề và văn bản đã chỉ định. Chỉ định thông báo là một gợi ý để thông báo và không đảm bảo sẽ tạo ra thông báo. |
reason |
Lý do thay đổi/cập nhật. |
Loại
Không dùng nữa: Thay vào đó, hãy sử dụng OrderUpdate.update_mask. Cho phép cập nhật đơn đặt hàng.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Chưa chỉ định loại, không nên đặt loại này một cách rõ ràng. |
ORDER_STATUS |
Chỉ cập nhật trạng thái của đơn đặt hàng. |
SNAPSHOT |
Cập nhật thông tin tổng quan nhanh về đơn đặt hàng. |
Đặt
Thực thể đơn đặt hàng. Lưu ý: 1. Tất cả các chuỗi ở tất cả cấp phải ít hơn 1000 ký tự trừ khi có quy định khác. 2. Tất cả các trường lặp lại ở tất cả các cấp phải nhỏ hơn 50 số đếm trừ khi có quy định khác. 3. Tất cả dấu thời gian ở tất cả các cấp, nếu được chỉ định, phải là dấu thời gian hợp lệ.
Biểu diễn dưới dạng JSON | |
---|---|
{ "googleOrderId": string, "merchantOrderId": string, "userVisibleOrderId": string, "userVisibleStateLabel": string, "buyerInfo": { object ( |
Các trường | ||
---|---|---|
googleOrderId |
Mã đơn hàng do Google chỉ định. |
|
merchantOrderId |
Bắt buộc: Mã đơn hàng nội bộ do người bán chỉ định. Mã này phải là duy nhất và bắt buộc cho các hoạt động cập nhật đơn đặt hàng tiếp theo. Mã này có thể được đặt thành googleOrderId được cung cấp hoặc bất kỳ giá trị riêng biệt nào khác. Xin lưu ý rằng mã nhận dạng được hiển thị cho người dùng là userVisibleOrderId. Đây có thể là một giá trị khác và thân thiện hơn với người dùng. Độ dài tối đa cho phép là 128 ký tự. |
|
userVisibleOrderId |
Mã nhận dạng dành cho người dùng đang tham chiếu đến đơn đặt hàng hiện tại. Mã này phải nhất quán với mã nhận dạng được hiển thị cho đơn đặt hàng này trong các ngữ cảnh khác, bao gồm cả trang web, ứng dụng và email. |
|
userVisibleStateLabel |
Không dùng nữa: Sử dụng trạng thái OrderExtensions. Nhãn mà người dùng nhìn thấy cho trạng thái của đơn đặt hàng này. |
|
buyerInfo |
Thông tin về người mua. |
|
image |
Hình ảnh liên quan đến đơn đặt hàng. |
|
createTime |
Bắt buộc: Ngày và giờ đơn đặt hàng được tạo. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: |
|
lastUpdateTime |
Ngày và giờ đơn đặt hàng được cập nhật lần gần đây nhất. Bắt buộc đối với OrderUpdate. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: |
|
transactionMerchant |
Người bán hỗ trợ thanh toán. Nhà cung cấp này có thể khác với nhà cung cấp ở cấp mục hàng. Ví dụ: Đơn đặt hàng Expedia với mục hàng từ ANA. |
|
contents |
Bắt buộc: Nội dung đơn đặt hàng là một nhóm các mục hàng. |
|
priceAttributes[] |
Giá, chiết khấu, thuế, v.v. |
|
followUpActions[] |
Các hành động tiếp theo ở cấp đơn đặt hàng. |
|
paymentData |
Dữ liệu liên quan đến thanh toán cho đơn đặt hàng. |
|
termsOfServiceUrl |
Đường liên kết đến điều khoản dịch vụ áp dụng cho đơn đặt hàng/đơn đặt hàng được đề xuất. |
|
note |
Ghi chú đính kèm vào đơn đặt hàng. |
|
promotions[] |
Tất cả chương trình khuyến mãi liên quan đến đơn đặt hàng này. |
|
disclosures[] |
Thông tin công bố liên quan đến đơn đặt hàng này. |
|
vertical |
Ngừng sử dụng: Sử dụng ngành dọc. Các thuộc tính này sẽ áp dụng cho mọi mục hàng, trừ trường hợp bị ghi đè trong một số mục hàng. Ngành dọc này phải phù hợp với loại ngành dọc cấp mục hàng. Các giá trị có thể là: Đối tượng chứa các trường thuộc kiểu tuỳ ý. Trường bổ sung |
|
Trường nhóm verticals . Các thuộc tính này sẽ áp dụng cho mọi mục hàng, trừ trường hợp bị ghi đè trong một số mục hàng. Ngành dọc này phải phù hợp với loại ngành dọc cấp mục hàng. verticals chỉ có thể là một trong những trạng thái sau đây: |
||
purchase |
Đơn đặt hàng |
|
ticket |
Đặt vé |
UserInfo
Thông tin về người dùng. Mã này được dùng để thể hiện thông tin của người dùng liên quan đến một đơn đặt hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{
"email": string,
"firstName": string,
"lastName": string,
"displayName": string,
"phoneNumbers": [
{
object ( |
Các trường | |
---|---|
email |
Email của người dùng, ví dụ: janedoe@gmail.com. |
firstName |
Tên của người dùng. |
lastName |
Họ của người dùng. |
displayName |
Tên hiển thị của người dùng, có thể khác với họ hoặc tên. |
phoneNumbers[] |
Số điện thoại của người dùng. |
PhoneNumber
Biểu thị số điện thoại tiêu chuẩn.
Biểu diễn dưới dạng JSON | |
---|---|
{ "e164PhoneNumber": string, "extension": string, "preferredDomesticCarrierCode": string } |
Các trường | |
---|---|
e164PhoneNumber |
Số điện thoại ở định dạng E.164, như định nghĩa trong Khuyến nghị E.164 của Liên minh Viễn thông Quốc tế (ITU) trên trang wiki liên kết: https://en.wikipedia.org/wiki/E.164 |
extension |
Phần mở rộng không được chuẩn hoá trong các đề xuất của ITU, ngoại trừ việc phần mở rộng được định nghĩa là một chuỗi số có độ dài tối đa là 40 chữ số. Ở đây, số 0 được định nghĩa là một chuỗi để phù hợp với việc sử dụng số 0 đứng đầu trong đuôi (các tổ chức có toàn quyền tự do làm điều đó vì không có tiêu chuẩn nào được xác định). Ngoài chữ số, một số ký tự quay số khác như "," (cho biết đã chờ) có thể được lưu trữ tại đây. Ví dụ: trong xxx-xxx-xxxx phần mở rộng 123, "123" là phần mở rộng. |
preferredDomesticCarrierCode |
Mã lựa chọn nhà mạng được ưu tiên khi gọi đến số điện thoại này trong nước. Việc này cũng bao gồm mã cần gọi ở một số quốc gia khi gọi từ điện thoại cố định đến điện thoại di động hoặc ngược lại. Ví dụ: tại Columbia, số "3" cần được quay trước số điện thoại khi gọi từ điện thoại di động đến điện thoại cố định nội địa và ngược lại. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code Lưu ý rằng đây là mã "ưu tiên", có nghĩa là các mã khác cũng có thể hoạt động. |
Bài đăng có hình ảnh
Hình ảnh hiển thị trong thẻ.
Biểu diễn dưới dạng JSON | |
---|---|
{ "url": string, "accessibilityText": string, "height": integer, "width": integer } |
Các trường | |
---|---|
url |
URL nguồn của hình ảnh. Hình ảnh có thể ở định dạng JPG, PNG và GIF (động và tĩnh). Ví dụ: |
accessibilityText |
Nội dung mô tả văn bản của hình ảnh được dùng cho khả năng hỗ trợ tiếp cận, ví dụ: trình đọc màn hình. Bắt buộc. |
height |
Chiều cao của hình ảnh tính bằng pixel. Không bắt buộc. |
width |
Chiều rộng của hình ảnh tính bằng pixel. Không bắt buộc. |
Người bán
Người bán đối với giỏ hàng/đơn đặt hàng/mục hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "id": string, "name": string, "image": { object ( |
Các trường | |
---|---|
id |
Mã không bắt buộc được chỉ định cho người bán, nếu có. |
name |
Tên của người bán, chẳng hạn như "Panera Bread". |
image |
Hình ảnh liên quan đến người bán. |
phoneNumbers[] |
Số điện thoại của người bán. |
address |
Địa chỉ của người bán. |
Vị trí
Vùng chứa đại diện cho một vị trí.
Biểu diễn dưới dạng JSON | |
---|---|
{ "coordinates": { object ( |
Các trường | |
---|---|
coordinates |
Toạ độ địa lý. Cần có quyền [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
formattedAddress |
Địa chỉ hiển thị, ví dụ: "1600 Amphitheatre Pkwy, Mountain View, CA 94043". Cần có quyền [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
zipCode |
Mã bưu chính. Cần có quyền [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] hoặc [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
city |
Thành phố. Cần có quyền [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] hoặc [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
postalAddress |
Địa chỉ bưu chính. Cần có quyền [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] hoặc [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
name |
Tên của địa điểm. |
phoneNumber |
Số điện thoại của địa điểm, ví dụ: số điện thoại liên hệ của địa điểm doanh nghiệp hoặc số điện thoại của địa điểm giao hàng. |
notes |
Ghi chú về vị trí. |
placeId |
placeId được dùng với Places API để tìm nạp thông tin chi tiết về một địa điểm. Xem https://developers.google.com/places/web-service/place-id |
LatLng
Một đối tượng đại diện cho cặp vĩ độ/kinh độ. Đây là một cặp số kép để biểu thị độ vĩ độ và độ kinh độ. Trừ phi có quy định khác, đối tượng này phải tuân thủ tiêu chuẩn WGS84. Giá trị phải nằm trong phạm vi chuẩn hoá.
Biểu diễn dưới dạng JSON | |
---|---|
{ "latitude": number, "longitude": number } |
Các trường | |
---|---|
latitude |
Vĩ độ tính theo độ. Giá trị này phải nằm trong khoảng [-90,0, +90,0]. |
longitude |
Kinh độ theo độ. Giá trị này phải nằm trong khoảng [-180,0, +180,0]. |
PostalAddress
Đại diện cho địa chỉ bưu chính, ví dụ: địa chỉ giao hàng hoặc thanh toán qua bưu điện. Khi có địa chỉ bưu chính, dịch vụ bưu chính có thể giao hàng đến tận nhà, hộp thư bưu điện hoặc những thứ tương tự. Bố cục này không nhằm lập mô hình vị trí địa lý (đường, thị trấn, núi).
Trong cách sử dụng thông thường, địa chỉ sẽ được tạo qua hoạt động đầu vào của người dùng hoặc bằng cách nhập dữ liệu hiện có, tuỳ thuộc vào loại quy trình.
Lời khuyên về việc nhập / chỉnh sửa địa chỉ: – Sử dụng tiện ích địa chỉ sẵn sàng cho i18n (chẳng hạn như https://github.com/google/libaddressinput) – Không nên cung cấp cho người dùng các thành phần giao diện người dùng để nhập hoặc chỉnh sửa các trường ở bên ngoài quốc gia sử dụng trường đó.
Để được hướng dẫn thêm về cách sử dụng giản đồ này, vui lòng xem: https://support.google.com/business/answer/6397478
Biểu diễn dưới dạng JSON | |
---|---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
Các trường | |
---|---|
revision |
Bản sửa đổi giản đồ của Tất cả bản sửa đổi mới phải tương thích ngược với bản sửa đổi cũ. |
regionCode |
Bắt buộc. Mã vùng CLDR của quốc gia/khu vực trên địa chỉ. Điều này không bao giờ được suy luận và người dùng có trách nhiệm đảm bảo giá trị chính xác. Hãy truy cập vào http://cldr.unicode.org/ và http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html để biết thông tin chi tiết. Ví dụ: "CH" cho Thuỵ Sĩ. |
languageCode |
Không bắt buộc. Mã ngôn ngữ BCP-47 của nội dung địa chỉ này (nếu biết). Đây thường là ngôn ngữ giao diện người dùng của biểu mẫu nhập hoặc dự kiến sẽ khớp với một trong các ngôn ngữ dùng tại quốc gia/khu vực của địa chỉ hoặc các ngôn ngữ tương đương được chuyển tự. Điều này có thể ảnh hưởng đến định dạng ở một số quốc gia nhất định, nhưng không quan trọng đối với độ chính xác của dữ liệu và sẽ không bao giờ ảnh hưởng đến bất kỳ thao tác xác thực hay hoạt động nào khác liên quan đến việc không định dạng. Nếu không xác định được giá trị này, bạn nên bỏ qua giá trị này (thay vì chỉ định giá trị mặc định có thể không chính xác). Ví dụ: "zh-Hant", "ja", "ja-Latn", "en". |
postalCode |
Không bắt buộc. Mã bưu chính của địa chỉ. Không phải quốc gia nào cũng sử dụng hoặc bắt buộc phải có mã bưu chính. Tuy nhiên, ở những nơi sử dụng mã bưu chính, mã bưu chính có thể kích hoạt quy trình xác thực bổ sung với các phần khác của địa chỉ (ví dụ: xác thực tiểu bang/mã bưu chính ở Hoa Kỳ). |
sortingCode |
Không bắt buộc. Mã phân loại bổ sung theo quốc gia. Chế độ này không được sử dụng ở hầu hết các khu vực. Trong trường hợp sử dụng, giá trị có thể là một chuỗi như "CEDEX", tuỳ ý theo sau là một số (ví dụ: "CEDEX 7") hoặc chỉ là một số, đại diện cho "mã ngành" (Jamaica), "chỉ báo khu vực giao hàng" (Malawi) hoặc "chỉ báo bưu điện" (ví dụ: Côte d'Ivoire). |
administrativeArea |
Không bắt buộc. Phân khu hành chính cao nhất dùng cho địa chỉ bưu chính của một quốc gia hoặc khu vực. Ví dụ: đó có thể là một tiểu bang, một tỉnh, một vùng hoặc một tỉnh. Cụ thể, đối với Tây Ban Nha, đây là tỉnh chứ không phải cộng đồng tự trị (ví dụ: "Barcelona" chứ không phải "Catalonia"). Nhiều quốc gia không sử dụng khu vực hành chính trong địa chỉ bưu điện. Ví dụ: ở Thuỵ Sĩ, bạn nên bỏ trống mã này. |
locality |
Không bắt buộc. Thường có nghĩa là phần thành phố/thị trấn trong địa chỉ. Ví dụ: Thành phố ở Hoa Kỳ, khu CNTT, thị trấn có bưu điện ở Vương quốc Anh. Ở những khu vực trên thế giới nơi các địa phương không được xác định rõ hoặc không phù hợp với cấu trúc này, hãy để trống địa phương và sử dụng addressLines. |
sublocality |
Không bắt buộc. Cụm dân cư của địa chỉ. Ví dụ: đây có thể là vùng lân cận, thị xã, quận. |
addressLines[] |
Dòng địa chỉ không có cấu trúc mô tả các cấp thấp hơn của một địa chỉ. Vì các giá trị trong addressLines không có thông tin về loại và đôi khi có thể chứa nhiều giá trị trong một trường (ví dụ: "Austin, TX"), điều quan trọng là thứ tự hàng phải rõ ràng. Thứ tự của các dòng địa chỉ phải là "phong bì đơn đặt hàng" cho quốc gia/khu vực của địa chỉ. Ở những nơi có thể khác nhau (ví dụ: Nhật Bản), address_language được dùng để thể hiện rõ ràng (ví dụ: "ja" cho thứ tự từ lớn đến nhỏ và "ja-Latn" hoặc "en" cho từ nhỏ đến lớn). Bằng cách này, dòng địa chỉ cụ thể nhất có thể được chọn theo ngôn ngữ. Biểu diễn cấu trúc tối thiểu được phép của một địa chỉ bao gồm một mã khu vực với tất cả thông tin còn lại được đặt trong addressLines. Có thể định dạng địa chỉ như vậy rất gần mà không cần mã hoá địa lý, nhưng không thể đưa ra lý luận ngữ nghĩa nào về bất kỳ thành phần địa chỉ nào cho đến khi địa chỉ đó ít nhất được giải quyết một phần. Tạo một địa chỉ chỉ chứa mã vùng và địa chỉ, sau đó mã hoá địa lý là cách được khuyên dùng để xử lý các địa chỉ hoàn toàn không có cấu trúc (thay vì đoán phần nào của địa chỉ nên là địa phương hoặc khu vực hành chính). |
recipients[] |
Không bắt buộc. Người nhận tại địa chỉ. Trong một số trường hợp nhất định, trường này có thể chứa thông tin nhiều dòng. Ví dụ: tài liệu này có thể chứa thông tin "chăm sóc". |
organization |
Không bắt buộc. Tên của tổ chức tại địa chỉ. |
Nội dung
Trình bao bọc cho mục hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{
"lineItems": [
{
object ( |
Các trường | |
---|---|
lineItems[] |
Danh sách mục hàng trong đơn đặt hàng. Bắt buộc phải có ít nhất 1 mục hàng và tối đa 50 mục hàng. Tất cả các mục hàng phải thuộc cùng một ngành dọc. |
LineItem
Một mục hàng chứa một ngành dọc. Một đơn đặt hàng hoặc giỏ hàng có thể có nhiều mục hàng thuộc cùng một ngành dọc. Các mục hàng phụ/tiện ích bổ sung, v.v. nên được xác định trong protos ngành dọc tuỳ thuộc vào trường hợp sử dụng của chúng. Lưu ý: 1. Tất cả các chuỗi ở tất cả cấp phải ít hơn 1000 ký tự trừ khi có quy định khác. 2. Tất cả các trường lặp lại ở tất cả các cấp phải nhỏ hơn 50 số đếm trừ khi có quy định khác. 3. Tất cả dấu thời gian ở tất cả các cấp, nếu được chỉ định, phải là dấu thời gian hợp lệ.
Biểu diễn dưới dạng JSON | |
---|---|
{ "id": string, "name": string, "userVisibleStateLabel": string, "provider": { object ( |
Các trường | ||
---|---|---|
id |
Bắt buộc: Giá trị nhận dạng do người bán chỉ định cho mục hàng. Dùng để xác định mục hàng hiện có khi áp dụng nội dung cập nhật một phần. Độ dài tối đa cho phép là 64 ký tự. |
|
name |
Tên của mục hàng như hiển thị trên biên nhận. Độ dài tối đa cho phép là 100 ký tự. |
|
userVisibleStateLabel |
Không dùng nữa. Thay vào đó, hãy sử dụng trạng thái cấp dọc. Ví dụ: đối với giao dịch mua, hãy sử dụng PurchaseOrderExtension.status. Nhãn mà người dùng nhìn thấy cho trạng thái của mục hàng này. |
|
provider |
Nhà cung cấp mục hàng cụ thể, nếu khác với đơn đặt hàng tổng thể. Ví dụ: Đơn đặt hàng Expedia với nhà cung cấp mục hàng ANA. |
|
priceAttributes[] |
Giá và mức điều chỉnh ở cấp mục hàng. |
|
followUpActions[] |
Các hành động tiếp theo tại mục hàng. |
|
recipients[] |
Khách hàng ở cấp mục hàng, khách hàng có thể khác với người mua cấp Đơn đặt hàng. Ví dụ: Người dùng X đã đặt chỗ tại nhà hàng dưới tên của người dùng Y. |
|
image |
Hình ảnh nhỏ liên kết với mục này, nếu có. |
|
description |
Nội dung mô tả mục hàng. |
|
notes[] |
Ghi chú bổ sung áp dụng cho mục hàng cụ thể này, chẳng hạn như chính sách huỷ. |
|
disclosures[] |
Thông tin công bố liên quan đến mục hàng này. |
|
vertical |
Ngừng sử dụng: Sử dụng ngành dọc. Bắt buộc: Nội dung ngữ nghĩa của mục hàng dựa trên loại/ngành dọc. Mỗi ngành dọc phải có thông tin thực hiện riêng. Phải là một trong các giá trị sau: Đối tượng chứa các trường thuộc kiểu tuỳ ý. Trường bổ sung |
|
Trường nhóm verticals . Bắt buộc: Nội dung ngữ nghĩa của mục hàng dựa trên loại/ngành dọc. Mỗi ngành dọc phải có thông tin thực hiện riêng. verticals chỉ có thể là một trong những trạng thái sau đây: |
||
purchase |
Các đơn đặt hàng như hàng hoá, thực phẩm, v.v. |
|
reservation |
Các đơn đặt hàng trước như nhà hàng, cắt tóc, v.v. |
PriceAttribute
Thuộc tính giá của một đơn đặt hàng hoặc mục hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "type": enum ( |
Các trường | ||
---|---|---|
type |
Bắt buộc: Loại thuộc tính tiền. |
|
name |
Bắt buộc: Chuỗi do người dùng hiển thị của thuộc tính giá. Thông tin này do người bán gửi và bản địa hoá. |
|
id |
Không bắt buộc: Mã của mục hàng tương ứng với giá này. |
|
state |
Bắt buộc: Trạng thái giá: Ước tính so với thực tế |
|
taxIncluded |
Liệu giá đã bao gồm thuế hay chưa. |
|
Trường nhóm spec . Đại diện cho số tiền hoặc phần trăm phần trăm. spec chỉ có thể là một trong những trạng thái sau đây: |
||
amount |
Số tiền. |
|
amountMillipercentage |
Tỷ lệ phần trăm cụ thể, tới 1/1000 của phần trăm. Ví dụ: 8,750% được biểu thị dưới dạng 8750, tỷ lệ phần trăm âm biểu thị tỷ lệ phần trăm giảm giá. Ngừng sử dụng trường này. Bạn có thể cân nhắc thêm lại khi cần có một trường hợp sử dụng chắc chắn. |
Loại
Đại diện cho loại tiền.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Chưa chỉ định loại, ứng dụng không cần phải đặt rõ ràng loại này. |
REGULAR |
Giá hiển thị thông thường, trước khi áp dụng các khoản chiết khấu, v.v. |
DISCOUNT |
Được trừ khỏi thành tiền. |
TAX |
Được thêm vào thành tiền. |
DELIVERY |
Được thêm vào thành tiền. |
SUBTOTAL |
Tổng phụ phí trước khi thêm một số khoản phí. |
FEE |
Mọi khoản phí bổ sung. |
GRATUITY |
Được thêm vào thành tiền. |
TOTAL |
Giá của đơn đặt hàng hoặc mục hàng được hiển thị. |
Tiểu bang
Đại diện cho trạng thái giá.
Enum | |
---|---|
STATE_UNSPECIFIED |
Chưa xác định. |
ESTIMATE |
Giá chỉ là ước tính nhưng số tiền cuối cùng sẽ gần với số tiền này. Ví dụ: Trong trường hợp thuế không được xác định chính xác tại thời điểm giao dịch, tổng số tiền sẽ là số tiền Ước tính. |
ACTUAL |
Giá thực tế sẽ được tính cho người dùng. |
Tiền
Biểu thị số tiền cùng với loại đơn vị tiền tệ.
Biểu diễn dưới dạng JSON | |
---|---|
{ "currencyCode": string, "amountInMicros": string } |
Các trường | |
---|---|
currencyCode |
Mã đơn vị tiền tệ gồm 3 chữ cái theo tiêu chuẩn ISO 4217. |
amountInMicros |
Số tiền tính theo phần triệu. Ví dụ: bạn đặt giá trị của trường này là 1990000 với giá trị là 1, 99 USD. |
Hành động
Hành động tiếp theo liên quan đến đơn đặt hàng hoặc mục hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "type": enum ( |
Các trường | |
---|---|
type |
Bắt buộc: Loại hành động. |
title |
Tiêu đề hoặc nhãn của hành động mà người dùng nhìn thấy. Độ dài tối đa cho phép là 100 ký tự. |
openUrlAction |
Hành động cần thực hiện. |
actionMetadata |
Siêu dữ liệu liên kết với một hành động. |
Loại
Bạn có thể thực hiện các hành động tiếp theo.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Hành động chưa được chỉ định. |
VIEW_DETAILS |
Xem thao tác chi tiết đơn đặt hàng. |
MODIFY |
Sửa đổi hành động đặt hàng. |
CANCEL |
Thao tác huỷ đơn đặt hàng. |
RETURN |
Hành động trả lại đơn đặt hàng. |
EXCHANGE |
Hành động đối với đơn đặt hàng trao đổi. |
EMAIL |
Hành động đối với email. Các loại EMAIL và GỌI không được dùng nữa. OpenUrlAction.url có thể được dùng làm số điện thoại hoặc email. |
CALL |
Hành động trong cuộc gọi. |
REORDER |
Sắp xếp lại hành động. |
REVIEW |
Xem lại thao tác đối với đơn đặt hàng. |
CUSTOMER_SERVICE |
Liên hệ với bộ phận dịch vụ khách hàng. |
FIX_ISSUE |
Chuyển thẳng đến trang web hoặc ứng dụng của người bán để khắc phục vấn đề. |
DIRECTION |
Đường liên kết chỉ đường. |
OpenUrlAction
Mở URL đã cho.
Biểu diễn dưới dạng JSON | |
---|---|
{ "url": string, "androidApp": { object ( |
Các trường | |
---|---|
url |
Trường url có thể là bất kỳ URL nào trong số: – URL http/https để mở Ứng dụng được liên kết với ứng dụng hoặc một trang web |
androidApp |
Thông tin về Ứng dụng Android nếu ứng dụng Android dự kiến URL sẽ được thực hiện. |
urlTypeHint |
Biểu thị gợi ý cho loại URL. |
AndroidApp
Thông số kỹ thuật của ứng dụng Android về các hạn chế trong phương thức thực hiện
Biểu diễn dưới dạng JSON | |
---|---|
{
"packageName": string,
"versions": [
{
object ( |
Các trường | |
---|---|
packageName |
Tên gói Tên gói phải được chỉ định khi chỉ định phương thức thực hiện Android. |
versions[] |
Khi bạn chỉ định nhiều bộ lọc, mọi kết quả khớp bộ lọc sẽ kích hoạt ứng dụng. |
VersionFilter
Bạn nên đưa vào VersionFilter nếu cần phải có (các) phiên bản cụ thể của Ứng dụng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "minVersion": integer, "maxVersion": integer } |
Các trường | |
---|---|
minVersion |
Mã phiên bản tối thiểu hoặc bằng 0 (bao gồm cả mã này). |
maxVersion |
Mã phiên bản tối đa, tính cả 2 giá trị đầu cuối. Dải ô được xem xét là [minVersion:maxVersion]. Phạm vi rỗng ngụ ý bất kỳ phiên bản nào. Ví dụ: Để chỉ định việc sử dụng một phiên bản: [target_version:target_version]. Để chỉ định bất kỳ phiên bản nào, hãy không chỉ định minVersion và maxVersion. Để chỉ định tất cả các phiên bản cho đến maxVersion, hãy không chỉ định minVersion. Để chỉ định tất cả các phiên bản từ minVersion, hãy không chỉ định maxVersion. |
UrlTypeHint
Các loại gợi ý về URL.
Enum | |
---|---|
URL_TYPE_HINT_UNSPECIFIED |
Không xác định |
AMP_CONTENT |
URL trỏ trực tiếp đến nội dung AMP hoặc đến URL chính tắc tham chiếu đến nội dung AMP thông qua <link rel="amphtml">. |
ActionMetadata
Siêu dữ liệu liên quan theo mỗi hành động.
Biểu diễn dưới dạng JSON | |
---|---|
{ "expireTime": string } |
Các trường | |
---|---|
expireTime |
Thời điểm hành động này sẽ hết hạn. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: |
Thông tin công bố
Thông tin công bố về sản phẩm, dịch vụ hoặc chính sách có thể hiển thị cho người dùng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "disclosureText": { object ( |
Các trường | |
---|---|
title |
Tiêu đề thông tin công bố. Ví dụ: "Thông tin về an toàn". |
disclosureText |
Nội dung của thông tin công bố. Được phép sử dụng đường liên kết trang web. |
presentationOptions |
Các tuỳ chọn trình bày cho thông tin công bố. |
DisclosureText
Đại diện cho một văn bản thuần tuý bằng đường liên kết trang web.
Biểu diễn dưới dạng JSON | |
---|---|
{
"template": string,
"textLinks": [
{
object ( |
Các trường | |
---|---|
template |
Văn bản hiển thị, chứa các phần giữ chỗ như "{0}" và "{1}" cho mỗi đường liên kết văn bản cần được chèn vào. Ví dụ: "CẢNH BÁO: Sản phẩm này có thể khiến bạn tiếp xúc với các hoá chất mà Tiểu bang California đã biết là có thể gây ung thư. Để biết thêm thông tin, hãy truy cập {0}." Văn bản công bố này không được chứa bất kỳ nội dung quảng cáo hoặc nội dung nào giống quảng cáo. |
textLinks[] |
Đường liên kết văn bản cần được thay thế vào mẫu. Dòng đầu tiên sẽ được thay thế cho "{0}" trong chuỗi mẫu và dòng thứ hai sẽ được thay thế cho "{1}", v.v. |
TextLink
Một đường liên kết văn bản nên được thay thế vào mẫu.
Biểu diễn dưới dạng JSON | |
---|---|
{ "displayText": string, "url": string } |
Các trường | |
---|---|
displayText |
Văn bản nên hiển thị với người dùng. |
url |
URL mà người dùng phải được chuyển hướng đến khi đường liên kết được kích hoạt. |
DisclosurePresentationOptions
Các tuỳ chọn trình bày thông tin công bố.
Biểu diễn dưới dạng JSON | |
---|---|
{
"presentationRequirement": enum ( |
Các trường | |
---|---|
presentationRequirement |
Yêu cầu về việc trình bày thông tin công bố. |
initiallyExpanded |
Liệu có nên mở rộng nội dung thông tin công bố ban đầu hay không. Theo mặc định, mục này ban đầu được thu gọn. |
PresentationRequirement
Yêu cầu về việc trình bày thông tin công bố.
Enum | |
---|---|
REQUIREMENT_UNSPECIFIED |
Yêu cầu chưa được chỉ định. Không nên đặt giá trị này một cách rõ ràng. |
REQUIREMENT_OPTIONAL |
Bạn không bắt buộc phải công bố thông tin. Bạn có thể bỏ qua bước này nếu thiết bị không hỗ trợ việc hiện thông tin công bố. |
REQUIREMENT_REQUIRED |
Bạn phải cung cấp thông tin công bố. Cuộc trò chuyện sẽ được kết nối qua điện thoại nếu thiết bị không hỗ trợ hiển thị thông tin công bố. |
PurchaseItemExtension
Nội dung mục hàng của Ngành dọc mua hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "status": enum ( |
Các trường | |
---|---|
status |
Bắt buộc: Trạng thái cấp mục hàng. |
userVisibleStatusLabel |
Bắt buộc: Chuỗi/nhãn mà người dùng nhìn thấy cho trạng thái. Độ dài tối đa cho phép là 50 ký tự. |
type |
Bắt buộc: Loại giao dịch mua. |
productId |
Mã sản phẩm hoặc mã ưu đãi được liên kết với mục hàng này. |
quantity |
Số lượng của mặt hàng. |
unitMeasure |
Đơn vị đo lường. Chỉ định kích thước của mặt hàng theo các đơn vị đã chọn. Kích thước cùng với giá đang áp dụng được dùng để xác định đơn giá. |
returnsInfo |
Thông tin trả về của mục hàng này. Nếu bạn không đặt chính sách này, thì mục hàng này sẽ kế thừa thông tin trả về ở cấp đơn đặt hàng. |
fulfillmentInfo |
Thông tin thực hiện đơn hàng cho mục hàng này. Nếu bạn không đặt chính sách này, thì mục hàng này sẽ kế thừa thông tin thực hiện ở cấp đơn đặt hàng. |
itemOptions[] |
Tiện ích bổ sung hoặc mục phụ bổ sung. |
productDetails |
Thông tin chi tiết về sản phẩm. |
extension |
Mọi trường bổ sung được trao đổi giữa người bán và Google. Lưu ý: Bạn không nên sử dụng tiện ích này. Tuỳ theo từng trường hợp sử dụng, hãy cân nhắc một trong những điều sau: 1. Xác định các trường trong PurchaseItemExtension nếu có thể sử dụng cho các trường hợp sử dụng khác (ví dụ: khả năng/chức năng chung). 2. Sử dụng Vertical_extension nếu phần mở rộng này dành riêng cho một trường hợp sử dụng/tính năng tuỳ chỉnh, không chung chung. Đối tượng chứa các trường thuộc kiểu tuỳ ý. Trường bổ sung |
PurchaseStatus
Trạng thái mua hàng được liên kết với một đơn đặt hàng hoặc một mục hàng cụ thể.
Enum | |
---|---|
PURCHASE_STATUS_UNSPECIFIED |
Trạng thái chưa xác định. |
READY_FOR_PICKUP |
Sẵn sàng để nhận. |
SHIPPED |
Đã giao. |
DELIVERED |
Đã gửi thành công. |
OUT_OF_STOCK |
Hết hàng. |
IN_PREPARATION |
"IN_PREPARATION" có thể có ý nghĩa khác trong ngữ cảnh khác nhau. Đối với đơn đặt hàng THỰC TẾ, có thể là đồ ăn đang được chuẩn bị. Đối với Bán lẻ, đó có thể là một mặt hàng đang được đóng gói. |
CREATED |
Đơn đặt hàng đã được tạo. |
CONFIRMED |
Người bán đã xác nhận đơn đặt hàng. |
REJECTED |
Người bán từ chối đơn đặt hàng hoặc mục hàng. |
RETURNED |
Người dùng đã trả về Mặt hàng. |
CANCELLED |
Người dùng đã huỷ đơn đặt hàng hoặc mục hàng. |
CHANGE_REQUESTED |
Người dùng đã yêu cầu thay đổi đơn đặt hàng và nhà tích hợp đang xử lý thay đổi này. Đơn đặt hàng phải được chuyển sang trạng thái khác sau khi yêu cầu được xử lý. |
PurchaseType
Danh mục mua hàng.
Enum | |
---|---|
PURCHASE_TYPE_UNSPECIFIED |
Giá trị không xác định. |
RETAIL |
Nó bao gồm các giao dịch mua như hàng hoá thực. |
FOOD |
Chiến dịch này áp dụng cho cả giao dịch mua đồ ăn. |
GROCERY |
Mua hàng tạp hoá. |
MOBILE_RECHARGE |
Giao dịch nạp tiền điện thoại trả trước. |
MerchantUnitMeasure
Số lượng đo lường để định giá theo đơn vị của người bán.
Biểu diễn dưới dạng JSON | |
---|---|
{
"measure": number,
"unit": enum ( |
Các trường | |
---|---|
measure |
Giá trị: Ví dụ 1.2. |
unit |
Đơn vị: Ví dụ về POUND, GRAM. |
Đơn vị
Enum | |
---|---|
UNIT_UNSPECIFIED |
Đơn vị không xác định. |
MILLIGRAM |
Miligam. |
GRAM |
Gam |
KILOGRAM |
Kg. |
OUNCE |
Ounce. |
POUND |
Bảng Anh. |
PurchaseReturnsInfo
Trả về thông tin liên quan đến đơn đặt hàng hoặc mục hàng cụ thể.
Biểu diễn dưới dạng JSON | |
---|---|
{ "isReturnable": boolean, "daysToReturn": integer, "policyUrl": string } |
Các trường | |
---|---|
isReturnable |
Nếu đúng, hàm được phép trả về. |
daysToReturn |
Bạn có thể trả lại hàng trong vòng nhiều ngày đó. |
policyUrl |
Đường liên kết đến chính sách trả lại hàng. |
PurchaseFulfillmentInfo
Thông tin thực hiện đơn hàng liên quan đến một đơn đặt hàng hoặc một mục hàng cụ thể.
Biểu diễn dưới dạng JSON | |
---|---|
{ "id": string, "fulfillmentType": enum ( |
Các trường | |
---|---|
id |
Giá trị nhận dạng duy nhất cho lựa chọn về dịch vụ này. |
fulfillmentType |
Bắt buộc: Loại phương thức thực hiện. |
expectedFulfillmentTime |
Cửa sổ nếu phạm vi thời gian được chỉ định hoặc ETA nếu chỉ định một thời gian. Thời gian giao hàng hoặc đến lấy hàng dự kiến. |
expectedPreparationTime |
Cửa sổ nếu phạm vi thời gian được chỉ định hoặc ETA nếu chỉ định một thời gian. Thời gian dự kiến để chuẩn bị món ăn. Ưu tiên một lần. |
location |
Địa điểm đến lấy hàng hoặc giao hàng. |
expireTime |
Thời gian hết hạn của phương thức thực hiện này. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: |
price |
Chi phí của lựa chọn này. |
fulfillmentContact |
Thông tin liên hệ của người dùng cho phương thức thực hiện này. |
shippingMethodName |
Tên của phương thức vận chuyển do người dùng chọn. |
storeCode |
Mã cửa hàng của vị trí. Ví dụ: Walmart là người bán và storeCode là cửa hàng walmart nơi có phương thức thực hiện đơn hàng. https://support.google.com/business/answer/3370250?ref_topic=4596653. |
pickupInfo |
Thông tin bổ sung về cách chọn đơn đặt hàng. Trường này chỉ áp dụng khi phương thức thực hiện đơn hàng là PickUP. |
Loại
Loại thực hiện đơn hàng.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Chưa xác định loại. |
DELIVERY |
Đơn đặt hàng này sẽ được giao. |
PICKUP |
Bạn cần đến lấy đơn đặt hàng này. |
Thời gian
Cấu trúc thời gian thể hiện thời gian của một sự kiện cần sử dụng khi hiển thị đơn đặt hàng cho người dùng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "timeIso8601": string } |
Các trường | |
---|---|
timeIso8601 |
Biểu thị thời gian của sự kiện đặt hàng như thời gian đặt trước, thời gian giao hàng, v.v. Có thể là khoảng thời gian (thời gian bắt đầu và kết thúc), chỉ ngày tháng, ngày giờ, v.v. Hãy tham khảo https://en.wikipedia.org/wiki/ISO_8601 để biết tất cả định dạng được hỗ trợ. |
PickupInfo
Thông tin chi tiết về cách đến lấy đơn đặt hàng. Cung cấp thông tin chi tiết như loại hình lấy hàng và siêu dữ liệu bổ sung đính kèm với từng loại (nếu có).
Biểu diễn dưới dạng JSON | |
---|---|
{ "pickupType": enum ( |
Các trường | |
---|---|
pickupType |
Phương thức nhận hàng, chẳng hạn như INSTORE, CURBSIDE, v.v. |
curbsideInfo |
Thông tin chi tiết cụ thể về thông tin về lề đường. Nếu PickupType không phải là "CURBSIDE", trường này sẽ bị bỏ qua. |
checkInInfo[] |
Danh sách nhiều phương thức mà đối tác hỗ trợ để hỗ trợ quá trình xác nhận có mặt. |
PickupType
Danh sách các loại hình nhận hàng được hỗ trợ.
Enum | |
---|---|
UNSPECIFIED |
Chưa xác định loại tính năng đến lấy hàng. |
INSTORE |
Đến lấy đồ ăn trong nhà hàng. |
CURBSIDE |
Xe đỗ ở một vị trí quy định bên ngoài nhà hàng và sẽ có người giao đồ ăn ở đó. |
CurbsideInfo
Thông tin chi tiết về cách thức hỗ trợ việc đặt hàng ở lề đường.
Biểu diễn dưới dạng JSON | |
---|---|
{ "curbsideFulfillmentType": enum ( |
Các trường | |
---|---|
curbsideFulfillmentType |
Đối tác cần thêm thông tin để hỗ trợ đơn đặt hàng nhận hàng ở lề đường. Tuỳ thuộc vào kiểu phương thức thực hiện mà bạn chọn, hệ thống sẽ thu thập thông tin chi tiết tương ứng từ người dùng. |
userVehicle |
Thông tin về xe của người dùng đặt hàng. |
CurbsideFulfillmentType
Các giá trị có thể có của các loại phương thức thực hiện ở lề đường.
Enum | |
---|---|
UNSPECIFIED |
Chưa xác định loại phương thức thực hiện ở lề đường. |
VEHICLE_DETAIL |
Cần có thông tin về xe để có thể nhận hàng ở lề đường. |
Loại xe
Thông tin chi tiết về xe
Biểu diễn dưới dạng JSON | |
---|---|
{
"make": string,
"model": string,
"licensePlate": string,
"colorName": string,
"image": {
object ( |
Các trường | |
---|---|
make |
Nhà sản xuất xe (ví dụ: "Honda"). Người dùng sẽ thấy tên này và tên này phải được bản địa hoá. Bắt buộc. |
model |
Mẫu xe (ví dụ: "Grom"). Người dùng sẽ thấy tên này và tên này phải được bản địa hoá. Bắt buộc. |
licensePlate |
Biển số xe (ví dụ: "1ABC234"). Bắt buộc. |
colorName |
Tên màu xe, ví dụ: màu đen Không bắt buộc. |
image |
URL đến ảnh về chiếc xe. Ảnh sẽ được hiển thị ở khoảng 256x256px. Phải ở định dạng jpg hoặc png. Không bắt buộc. |
CheckInInfo
Siêu dữ liệu theo yêu cầu của đối tác để hỗ trợ phương thức xác nhận có mặt.
Biểu diễn dưới dạng JSON | |
---|---|
{
"checkInType": enum ( |
Các trường | |
---|---|
checkInType |
Phương thức dùng để gửi hướng dẫn xác nhận có mặt. |
CheckInType
Nhiều phương thức dùng để gửi hướng dẫn xác nhận có mặt.
Enum | |
---|---|
CHECK_IN_TYPE_UNSPECIFIED |
Giá trị không xác định. |
EMAIL |
Thông tin đăng ký sẽ được gửi qua email. |
SMS |
Thông tin đăng ký sẽ được gửi qua SMS. |
ItemOption
Đại diện cho các tiện ích bổ sung hoặc mục phụ.
Biểu diễn dưới dạng JSON | |
---|---|
{ "id": string, "name": string, "prices": [ { object ( |
Các trường | |
---|---|
id |
Đối với các lựa chọn là mặt hàng, mã mặt hàng duy nhất. |
name |
Tên lựa chọn. |
prices[] |
Tổng giá cho lựa chọn. |
note |
Ghi chú liên quan đến lựa chọn này. |
quantity |
Đối với các lựa chọn là mặt hàng, hãy chọn số lượng. |
productId |
Mã sản phẩm hoặc mã ưu đãi liên kết với lựa chọn này. |
subOptions[] |
Để xác định các tuỳ chọn phụ lồng nhau khác. |
ProductDetails
Thông tin chi tiết về sản phẩm.
Biểu diễn dưới dạng JSON | |
---|---|
{ "productId": string, "gtin": string, "plu": string, "productType": string, "productAttributes": { string: string, ... } } |
Các trường | |
---|---|
productId |
Mã sản phẩm hoặc mã ưu đãi được liên kết với mục hàng này. |
gtin |
Mã số sản phẩm thương mại toàn cầu của sản phẩm. Hữu ích nếu offerId không có trong Merchant Center. Không bắt buộc. |
plu |
Mã tra cứu giá (thường được gọi là mã PLU, số PLU, PLU, mã sản phẩm hoặc nhãn sản phẩm) là một hệ thống số giúp xác định riêng từng sản phẩm bán theo số lượng lớn tại các cửa hàng tạp hoá và siêu thị. |
productType |
Danh mục sản phẩm do người bán xác định. Ví dụ: "Trang chủ > Hàng tạp hoá > Sữa và trứng > Sữa > Sữa nguyên chất" |
productAttributes |
Do người bán cung cấp thông tin chi tiết về sản phẩm, ví dụ: { "allergen": "peanut" }. Hữu ích nếu offerId không có trong Merchant Center. Không bắt buộc. Một đối tượng chứa danh sách các cặp |
ReservationItemExtension
Nội dung mục hàng cho các đơn đặt hàng đặt trước như nhà hàng, cắt tóc, v.v.
Biểu diễn dưới dạng JSON | |
---|---|
{ "status": enum ( |
Các trường | |
---|---|
status |
Bắt buộc: Trạng thái đặt trước. |
userVisibleStatusLabel |
Bắt buộc: Chuỗi/nhãn mà người dùng nhìn thấy cho trạng thái. Độ dài tối đa cho phép là 50 ký tự. |
type |
Loại đặt trước. Bạn có thể không đặt chính sách này nếu không có lựa chọn loại nào phù hợp. |
reservationTime |
Thời gian dịch vụ/sự kiện được lên lịch để diễn ra. Có thể là phạm vi thời gian, ngày hoặc giờ ngày chính xác. |
userAcceptableTimeRange |
Phạm vi thời gian mà người dùng chấp nhận được. |
confirmationCode |
Mã xác nhận cho yêu cầu đặt chỗ này. |
partySize |
Số người. |
staffFacilitators[] |
Nhân viên hỗ trợ sẽ phục vụ yêu cầu đặt chỗ. Ví dụ: Thợ làm tóc. |
location |
Địa điểm của dịch vụ/sự kiện. |
ReservationStatus
Trạng thái đặt trước.
Enum | |
---|---|
RESERVATION_STATUS_UNSPECIFIED |
Trạng thái chưa xác định. |
PENDING |
Yêu cầu đặt chỗ đang chờ xử lý. |
CONFIRMED |
Yêu cầu đặt chỗ này đã được xác nhận. |
CANCELLED |
Người dùng đã huỷ yêu cầu đặt chỗ. |
FULFILLED |
Yêu cầu đặt chỗ đã được thực hiện. |
CHANGE_REQUESTED |
Có yêu cầu thay đổi đơn đặt chỗ |
REJECTED |
Yêu cầu đặt trước đã hết hạn hoặc bị nhà tích hợp từ chối. |
ReservationType
Loại đặt trước.
Enum | |
---|---|
RESERVATION_TYPE_UNSPECIFIED |
Loại không xác định. |
RESTAURANT |
Đặt chỗ tại nhà hàng. |
HAIRDRESSER |
Đặt trước dịch vụ cho thợ làm tóc. |
StaffFacilitator
Thông tin về nhân viên bảo dưỡng.
Biểu diễn dưới dạng JSON | |
---|---|
{
"name": string,
"image": {
object ( |
Các trường | |
---|---|
name |
Tên của người hỗ trợ nhân viên. Ví dụ: "John Smith" |
image |
Hình ảnh của người biểu diễn. |
PaymentData
Dữ liệu thanh toán liên quan đến đơn đặt hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "paymentResult": { object ( |
Các trường | |
---|---|
paymentResult |
Kết quả thanh toán được nhà tích hợp sử dụng để hoàn tất một giao dịch. Trường này sẽ được điền sẵn bởi Actions on Google nếu trải nghiệm thanh toán do Actions-on-Google quản lý. |
paymentInfo |
Thông tin thanh toán liên quan đến đơn đặt hàng hữu ích cho tương tác dành cho người dùng. |
PaymentResult
Kết quả thanh toán được đơn vị tích hợp sử dụng để hoàn tất một giao dịch.
Biểu diễn dưới dạng JSON | |
---|---|
{ // Union field |
Các trường | ||
---|---|---|
Trường nhóm result . Bạn đã cung cấp dữ liệu thanh toán trên Google hoặc phương thức thanh toán của người bán. result chỉ có thể là một trong những trạng thái sau đây: |
||
googlePaymentData |
Dữ liệu về phương thức thanh toán do Google cung cấp. Nếu công ty xử lý thanh toán của bạn được liệt kê là công ty xử lý thanh toán được Google hỗ trợ tại đây: https://developers.google.com/pay/api/ Hãy chuyển đến công ty xử lý thanh toán của bạn thông qua đường liên kết để tìm hiểu thêm thông tin. Nếu không, hãy tham khảo tài liệu sau đây để biết thông tin chi tiết về tải trọng. https://developers.google.com/pay/api/payment-data-cryptography |
|
merchantPaymentMethodId |
Phương thức thanh toán do Người bán/Hành động cung cấp do người dùng chọn. |
PaymentInfo
Thông tin thanh toán liên quan đến đơn đặt hàng đang được thực hiện. Proto này ghi lại thông tin hữu ích cho tương tác đối mặt với người dùng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "paymentMethodDisplayInfo": { object ( |
Các trường | |
---|---|
paymentMethodDisplayInfo |
Thông tin hiển thị của phương thức thanh toán mà giao dịch sử dụng. |
paymentMethodProvenance |
Chứng minh phương thức thanh toán đã sử dụng cho giao dịch. Người dùng có thể đã đăng ký cùng một phương thức thanh toán với cả Google và người bán. |
PaymentMethodDisplayInfo
Kết quả thanh toán được đơn vị tích hợp sử dụng để hoàn tất một giao dịch.
Biểu diễn dưới dạng JSON | |
---|---|
{
"paymentType": enum ( |
Các trường | |
---|---|
paymentType |
Loại thanh toán. |
paymentMethodDisplayName |
Tên hiển thị của người dùng của phương thức thanh toán. Ví dụ: VISA **** 1234 Đang kiểm tra acct **** 5678 |
paymentMethodVoiceName |
Tên phương thức thanh toán sẽ được đọc cho người dùng đối với các thiết bị chỉ hỗ trợ giọng nói. Ví dụ: "visa kết thúc bằng một hai ba bốn" hoặc "tài khoản séc kết thúc bằng năm sáu bảy tám". Lưu ý: Đây là chuỗi được tối ưu hoá cho giọng nói sẽ được sử dụng thay cho paymentMethodDisplayName cho các thiết bị chỉ có trợ lý bằng giọng nói. Nếu bạn không đặt chuỗi này, thì paymentMethodDisplayName sẽ được đọc to cho người dùng. |
PaymentType
PaymentType cho biết phương thức thanh toán được dùng cho phương thức thanh toán do Người bán cung cấp. Hành động cũng phải cung cấp tên hiển thị cho phương thức thanh toán.
Enum | |
---|---|
PAYMENT_TYPE_UNSPECIFIED |
Hình thức thanh toán chưa được chỉ định. |
PAYMENT_CARD |
Thẻ tín dụng/thẻ ghi nợ hoặc thẻ trả trước. |
BANK |
Phương thức thanh toán là tài khoản ngân hàng. |
LOYALTY_PROGRAM |
Phương thức thanh toán là một chương trình khách hàng thân thiết. |
CASH |
Phương thức thanh toán là tiền mặt. |
GIFT_CARD |
Phương thức thanh toán là thẻ quà tặng. |
WALLET |
Ví của bên thứ ba, ví dụ như PayPal |
PaymentMethodProvenance
Thể hiện nguồn của phương thức thanh toán được sử dụng cho giao dịch.
Enum | |
---|---|
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED |
Chứng minh là chưa được chỉ định. |
PAYMENT_METHOD_PROVENANCE_GOOGLE |
Nguồn chứng minh là Google. |
PAYMENT_METHOD_PROVENANCE_MERCHANT |
Xuất xứ là Người bán. |
Khuyến mãi
Chương trình khuyến mãi/ưu đãi đã được thêm vào giỏ hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "coupon": string } |
Các trường | |
---|---|
coupon |
Bắt buộc: Mã giảm giá được áp dụng cho ưu đãi này. |
PurchaseOrderExtension
Phần mở rộng về đơn đặt hàng cho ngành dọc mua hàng. Bạn có thể áp dụng các thuộc tính này cho tất cả các mục hàng trong đơn đặt hàng, trừ trường hợp bị ghi đè trong một mục hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "status": enum ( |
Các trường | |
---|---|
status |
Bắt buộc: Tình trạng chung của đơn đặt hàng. |
userVisibleStatusLabel |
Chuỗi/nhãn mà người dùng nhìn thấy cho trạng thái. Độ dài tối đa cho phép là 50 ký tự. |
type |
Bắt buộc: Loại giao dịch mua. |
returnsInfo |
Thông tin về trường hợp trả lại hàng của đơn đặt hàng. |
fulfillmentInfo |
Thông tin về việc thực hiện đơn đặt hàng. |
purchaseLocationType |
Vị trí mua hàng (tại cửa hàng / trực tuyến) |
errors[] |
Không bắt buộc: Lỗi do đơn đặt hàng này bị từ chối. |
extension |
Mọi trường bổ sung được trao đổi giữa người bán và Google. Lưu ý: Bạn không nên sử dụng tiện ích này. Tuỳ theo từng trường hợp sử dụng, hãy cân nhắc một trong những điều sau: 1. Hãy xác định các trường trong PurchaseOrderExtension nếu trường đó có thể được sử dụng cho các trường hợp sử dụng khác (ví dụ: khả năng/chức năng chung). 2. Sử dụng Vertical_extension nếu phần mở rộng này dành riêng cho một trường hợp sử dụng/tính năng tuỳ chỉnh, không chung chung. Đối tượng chứa các trường thuộc kiểu tuỳ ý. Trường bổ sung |
PurchaseLocationType
Loại vị trí của giao dịch mua.
Enum | |
---|---|
UNSPECIFIED_LOCATION |
Giá trị không xác định. |
ONLINE_PURCHASE |
Tất cả giao dịch mua hàng trên mạng. |
INSTORE_PURCHASE |
Tất cả giao dịch mua tại cửa hàng. |
PurchaseError
Lỗi đơn đặt hàng có thể bị từ chối.
Biểu diễn dưới dạng JSON | |
---|---|
{ "type": enum ( |
Các trường | |
---|---|
type |
Bắt buộc: Thông tin này cho biết lý do chi tiết vì sao người bán từ chối đơn đặt hàng. |
description |
Nội dung mô tả khác về lỗi. |
entityId |
Mã nhận dạng thực thể tương ứng với lỗi. Ví dụ này có thể tương ứng với LineItemId / ItemOptionId. |
updatedPrice |
Có liên quan trong trường hợp loại lỗiPRICE_CHANGED / INChỉnh sửa_PRICE. |
availableQuantity |
Hiện đang có số lượng. Áp dụng trong trường hợp Availability_CHANGED. |
ErrorType
Các loại lỗi có thể xảy ra.
Enum | |
---|---|
ERROR_TYPE_UNSPECIFIED |
Lỗi không xác định |
NOT_FOUND |
Không tìm thấy thực thể. Mục này có thể là Item, FulfillmentOption, Khuyến mãi. Bắt buộc phải có mã nhận dạng thực thể. |
INVALID |
Dữ liệu thực thể không hợp lệ. Có thể là Mặt hàng, FulfillmentOption, Khuyến mãi. Bắt buộc phải có mã nhận dạng thực thể. |
AVAILABILITY_CHANGED |
Không có mặt hàng hoặc không đủ mặt hàng để thực hiện yêu cầu. Bắt buộc phải có mã nhận dạng thực thể. |
PRICE_CHANGED |
Giá mặt hàng khác với giá trong thực thể Item (mặt hàng). Bắt buộc phải có mã nhận dạng thực thể và giá mới. |
INCORRECT_PRICE |
Lỗi về giá trong phần Phí, Tổng. Bắt buộc phải có mã nhận dạng thực thể và giá mới. |
REQUIREMENTS_NOT_MET |
Không đáp ứng các hạn chế đối với việc chấp nhận đơn đặt hàng – kích thước giỏ hàng tối thiểu, v.v. |
TOO_LATE |
FulfillmentOption đã hết hạn. |
NO_CAPACITY |
Không có sẵn dung lượng dịch vụ. Sử dụng mã lỗi này nếu không có loại lỗi chi tiết nào khác. |
NO_COURIER_AVAILABLE |
Không tìm thấy công ty chuyển phát nhanh giao hàng. Một loại lỗi chi tiết có thể được phân loại là NO_CAPACITY. |
INELIGIBLE |
Người dùng không đủ điều kiện để đặt hàng (bị đưa vào danh sách cấm). |
OUT_OF_SERVICE_AREA |
Không thể gửi đến địa chỉ đã yêu cầu do quy tắc biên giới, v.v. |
CLOSED |
Nhà hàng đóng cửa không hoạt động vào thời điểm đặt món. |
PROMO_NOT_APPLICABLE |
Mã lỗi chung để phát hiện mọi trường hợp không áp dụng được mã khuyến mãi, nếu không có trường hợp nào dưới đây phù hợp. Thêm mã khuyến mãi làm Mã nhận dạng thực thể. |
PROMO_NOT_RECOGNIZED |
Đối tác không nhận dạng được mã giảm giá. Thêm mã khuyến mãi làm Mã nhận dạng thực thể. |
PROMO_EXPIRED |
Không thể áp dụng vì chương trình khuyến mãi đã hết hạn. Thêm mã khuyến mãi làm Mã nhận dạng thực thể. |
PROMO_USER_INELIGIBLE |
Người dùng hiện tại không đủ điều kiện nhận phiếu giảm giá này. Thêm mã khuyến mãi làm Mã nhận dạng thực thể. |
PROMO_ORDER_INELIGIBLE |
Đơn đặt hàng hiện tại không đủ điều kiện nhận phiếu giảm giá này. Thêm mã khuyến mãi làm Mã nhận dạng thực thể. |
UNAVAILABLE_SLOT |
Không có khung đặt hàng trước. |
FAILED_PRECONDITION |
Không đáp ứng các quy tắc ràng buộc đối với việc chấp nhận đơn đặt hàng – kích thước giỏ hàng tối thiểu, v.v. |
PAYMENT_DECLINED |
Khoản thanh toán không hợp lệ. |
MERCHANT_UNREACHABLE |
Không thể truy cập người bán. Điều này hữu ích khi đối tác là đơn vị tập hợp và không thể liên hệ với người bán. |
ACCOUNT_LINKING_FAILED |
Người bán đã cố gắng liên kết Tài khoản Google của người dùng với một tài khoản trong hệ thống của họ nhưng đã gặp lỗi trong khi thực hiện. |
TicketOrderExtension
Đặt hàng nội dung cho các đơn đặt vé như phim, thể thao, v.v.
Biểu diễn dưới dạng JSON | |
---|---|
{
"ticketEvent": {
object ( |
Các trường | |
---|---|
ticketEvent |
Sự kiện áp dụng cho tất cả các phiếu yêu cầu hỗ trợ của mục hàng. |
TicketEvent
Đại diện cho một sự kiện.
Biểu diễn dưới dạng JSON | |
---|---|
{ "type": enum ( |
Các trường | |
---|---|
type |
Bắt buộc: Loại sự kiện bán vé, ví dụ: phim, buổi hoà nhạc. |
name |
Bắt buộc: Tên của sự kiện. Ví dụ: nếu sự kiện là một bộ phim, thì đây phải là tên phim. |
description |
Mô tả về sự kiện. |
url |
URL dẫn đến thông tin sự kiện. |
location |
Địa điểm diễn ra sự kiện hoặc trụ sở của một tổ chức. |
eventCharacters[] |
Các ký tự có liên quan đến sự kiện này. Đó có thể là đạo diễn hoặc diễn viên của một sự kiện phim hoặc người biểu diễn buổi hoà nhạc, v.v. |
startDate |
Thời gian bắt đầu. |
endDate |
Thời gian kết thúc. |
doorTime |
Thời gian tham gia có thể khác với thời gian bắt đầu sự kiện. Ví dụ:sự kiện bắt đầu lúc 9 giờ sáng, nhưng thời gian tham gia là 8 giờ 30 sáng. |
Loại
Loại sự kiện.
Enum | |
---|---|
EVENT_TYPE_UNKNOWN |
Loại sự kiện không xác định. |
MOVIE |
Phim. |
CONCERT |
Buổi hoà nhạc. |
SPORTS |
Thể thao. |
EventCharacter
Một nhân vật sự kiện, ví dụ: người tổ chức, người biểu diễn, v.v.
Biểu diễn dưới dạng JSON | |
---|---|
{ "type": enum ( |
Các trường | |
---|---|
type |
Loại của nhân vật sự kiện, ví dụ: diễn viên hoặc đạo diễn. |
name |
Tên nhân vật. |
image |
Hình ảnh của nhân vật. |
Loại
Loại ký tự.
Enum | |
---|---|
TYPE_UNKNOWN |
Loại không xác định. |
ACTOR |
Diễn viên. |
PERFORMER |
Người biểu diễn. |
DIRECTOR |
Đạo diễn. |
ORGANIZER |
Người tổ chức. |
UserNotification
Thông báo không bắt buộc cho người dùng trong nội dung cập nhật về Đơn đặt hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "text": string } |
Các trường | |
---|---|
title |
Tiêu đề của thông báo cho người dùng. Độ dài tối đa cho phép là 30 ký tự. |
text |
Nội dung của thông báo. Độ dài tối đa cho phép là 100 ký tự. |
NextScene
Đại diện cho cảnh sẽ được thực thi tiếp theo.
Biểu diễn dưới dạng JSON | |
---|---|
{ "name": string } |
Các trường | |
---|---|
name |
Tên cảnh sẽ thực thi tiếp theo. |
Phiên hoạt động
Chứa thông tin về phiên trò chuyện hiện tại
Biểu diễn dưới dạng JSON | |
---|---|
{
"id": string,
"params": {
string: value,
...
},
"typeOverrides": [
{
object ( |
Các trường | |
---|---|
id |
Bắt buộc. Mã nhận dạng duy nhất trên toàn cầu của phiên trò chuyện hiện tại. Trường này chỉ để đọc. |
params |
Bắt buộc. Danh sách tất cả thông số được thu thập từ các biểu mẫu và ý định trong phiên. Khoá là tên thông số. Những thông số được xác định ở đây sẽ được hợp nhất với các thông số đã được xác định trong phiên hoạt động này. Những thông số có giá trị rỗng sẽ bị xoá khỏi phiên hoạt động. Xem tài liệu về lưu trữ phiên: https://developers.google.com/assistant/conversational/storage-session. Một đối tượng chứa danh sách các cặp |
typeOverrides[] |
Không bắt buộc. Các loại trong phạm vi phiên hoạt động. Phần xác định loại phiên có thể bổ sung hoặc thay thế các loại hiện có. Tên loại phải là duy nhất. |
languageCode |
Ngôn ngữ của phiên trò chuyện hiện tại. Tuân theo mã ngôn ngữ BCP-47 của IETF, http://www.rfc-editor.org/rfc/bcp/bcp47.txt. Ngôn ngữ này có thể khác với ngôn ngữ của người dùng nếu thao tác sử dụng các tính năng đa ngôn ngữ. Ví dụ: khi trình xử lý_phản hồi.expected.language_code được đặt, ngôn ngữ này sẽ thay đổi ngôn ngữ của cuộc trò chuyện trong tất cả các lượt tiếp theo. Thao tác này sẽ được phản ánh trong trường này. |
TypeOverride
Đại diện cho một chế độ ghi đè cho một loại.
Biểu diễn dưới dạng JSON | |
---|---|
{ "name": string, "mode": enum ( |
Các trường | |
---|---|
name |
Bắt buộc. Tên của loại cần bổ sung hoặc ghi đè. |
mode |
Bắt buộc. Cách hợp nhất loại này với các giá trị loại khác. |
synonym |
|
TypeOverrideMode
Các loại sửa đổi cho loại thực thể phiên.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Chưa xác định. Đừng bao giờ sử dụng giá trị này. |
TYPE_REPLACE |
Các định nghĩa loại trong phản hồi này sẽ thay thế các định nghĩa loại đã được xác định trước đó. |
TYPE_MERGE |
Các định nghĩa loại trong phản hồi này sẽ được hợp nhất với các định nghĩa loại đã được xác định trước đó. Định nghĩa loại mới sẽ thay thế định nghĩa loại hiện tại. |
SynonymType
Đại diện cho một loại bằng các từ đồng nghĩa.
Biểu diễn dưới dạng JSON | |
---|---|
{
"entries": [
{
object ( |
Các trường | |
---|---|
entries[] |
Bắt buộc. Danh sách các mục cho loại từ đồng nghĩa. |
Vé vào cửa
Đại diện cho một mục nhập cho một loại từ đồng nghĩa.
Biểu diễn dưới dạng JSON | |
---|---|
{
"name": string,
"synonyms": [
string
],
"display": {
object ( |
Các trường | |
---|---|
name |
Bắt buộc. Tên của mục nhập (ví dụ: "xe đạp"). Mục nhập trong trường này phải có trong trường từ đồng nghĩa lặp lại để được nhận dạng là giá trị loại hợp lệ. |
synonyms[] |
Bắt buộc. Danh sách từ đồng nghĩa của mục nhập (ví dụ: "xe đạp", "xe đạp"). |
display |
Không bắt buộc. Thông tin về mục sẽ hiển thị. |
EntryDisplay
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "description": string, "image": { object ( |
Các trường | |
---|---|
title |
Bắt buộc. Tiêu đề của mặt hàng. Khi được nhấn, văn bản này sẽ được đăng lại nguyên văn trong cuộc trò chuyện như thể người dùng đã nhập. Mỗi tiêu đề phải là duy nhất trong tập hợp các mục của bộ sưu tập. |
description |
Không bắt buộc. Văn bản nội dung của thẻ. |
image |
Không bắt buộc. Hình ảnh để hiển thị. |
footer |
Không bắt buộc. Văn bản chân trang cho mục bộ sưu tập duyệt web, hiển thị bên dưới phần mô tả. Một dòng văn bản, bị cắt ngắn bằng dấu ba chấm. |
openUrl |
URL của tài liệu liên kết với mục băng chuyền duyệt xem. Bắt buộc để duyệt băng chuyền. |
Người dùng
Đại diện cho người dùng đưa ra yêu cầu cho Hành động.
Biểu diễn dưới dạng JSON | |
---|---|
{ "locale": string, "params": { string: value, ... }, "accountLinkingStatus": enum ( |
Các trường | |
---|---|
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ữ BCP-47 của IETF, 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. |
params |
Không bắt buộc. Danh sách tất cả thông số liên quan đến người dùng hiện tại. Xem tài liệu về bộ nhớ của người dùng: https://developers.google.com/assistant/conversational/storage-user. Một đối tượng chứa danh sách các cặp |
accountLinkingStatus |
Liệu tài khoản người dùng có được liên kết với ứng dụng hay không. |
verificationStatus |
Cho biết trạng thái xác minh của người dùng. |
lastSeenTime |
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, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: |
engagement |
Mức độ tương tác của người dùng hiện tại, bao gồm cả mọi gói thuê bao đối với ý định. |
packageEntitlements[] |
Quyền của người dùng liên quan đến gói Android liên kết với hành động hiện tại. |
permissions[] |
Chứa các quyền mà người dùng cấp cho Hành động này. |
AccountLinkingStatus
Cho biết liệu người dùng cuối đã liên kết tài khoản của họ với ứng dụng này hay chưa. Xem tài liệu về việc liên kết tài khoản: https://developers.google.com/assistant/identity.
Enum | |
---|---|
ACCOUNT_LINKING_STATUS_UNSPECIFIED |
Không xác định. |
NOT_LINKED |
Người dùng chưa liên kết tài khoản của họ với ứng dụng này. |
LINKED |
Người dùng đã liên kết tài khoản của họ với ứng dụng này. |
UserVerificationStatus
Cho biết liệu Google đã xác minh người dùng hay chưa. Trạng thái ĐÃ XÁC MINH cho biết rằng bạn có thể lưu dữ liệu trong các cuộc trò chuyện bằng cách sử dụng trường thông số hoặc bằng cách liên kết tài khoản.
Enum | |
---|---|
USER_VERIFICATION_STATUS_UNSPECIFIED |
Không xác định. |
GUEST |
Người dùng là khách. |
VERIFIED |
Người dùng đã được xác minh. |
Mức độ tương tác
Cung cấp thêm thông tin chỉ có thể đọc về cơ chế tương tác mà người dùng hiện tại đã đăng ký. Ví dụ: bạn nên biết ý định mà người dùng đã đăng ký để tránh yêu cầu họ đăng ký lại cùng một ý định. Tức là, bạn có thể sử dụng thông tin này để định tuyến có điều kiện đến một cảnh để thiết lập DailyUpdate hoặc PushNotifications chỉ khi người dùng chưa đăng ký. Xem tài liệu về mức độ tương tác của người dùng: https://developers.google.com/assistant/engagement.
Biểu diễn dưới dạng JSON | |
---|---|
{ "pushNotificationIntents": [ { object ( |
Các trường | |
---|---|
pushNotificationIntents[] |
Chứa danh sách các ý định mà người dùng đã bật thông báo đẩy. |
dailyUpdateIntents[] |
Chứa danh sách các ý định mà người dùng đã bật tính năng cập nhật hằng ngày. |
IntentSubscription
Mô tả một IntentSubscription hiện có.
Biểu diễn dưới dạng JSON | |
---|---|
{ "intent": string, "contentTitle": string } |
Các trường | |
---|---|
intent |
Tên của ý định được đăng ký. |
contentTitle |
Nội dung mô tả ngắn về gói thuê bao. Thông tin này được dùng làm nhãn của thông báo và khi Trợ lý yêu cầu người dùng cấp quyền. |
PackageEntitlements
Danh sách các quyền của người dùng liên quan đến tên gói. Xem tài liệu về giao dịch hàng hoá kỹ thuật số: https://developers.google.com/assistant/transactions/digital/dev-guide-digital-non-consumables.
Biểu diễn dưới dạng JSON | |
---|---|
{
"packageName": string,
"entitlements": [
{
object ( |
Các trường | |
---|---|
packageName |
Tên gói Android được chỉ định trong gói hành động. |
entitlements[] |
Quyền của người dùng đối với gói nhất định. |
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.
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. Xem tài liệu về Thanh toán trong ứng dụng của Play: https://developer.android.com/google/play/billing. |
skuType |
Loại SKU. |
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. |
SkuType
Enum | |
---|---|
SKU_TYPE_UNSPECIFIED |
|
IN_APP |
Mua hàng trong ứng dụng |
SUBSCRIPTION |
Gói thuê bao |
APP |
Ứng dụng có tính phí |
SignedData
Biểu diễn dưới dạng JSON | |
---|---|
{ "inAppPurchaseData": { object }, "inAppDataSignature": string } |
Các trường | |
---|---|
inAppPurchaseData |
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 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. |
Quyền
Các giá trị có thể sử dụng cho quyền.
Enum | |
---|---|
PERMISSION_UNSPECIFIED |
Quyền chưa được chỉ định. |
DEVICE_PRECISE_LOCATION |
Yêu cầu vị trí chính xác, vĩ độ/kinh độ và địa chỉ đã định dạng của người dùng. |
DEVICE_COARSE_LOCATION |
Yêu cầu vị trí tương đối, mã bưu chính, thành phố và mã quốc gia của người dùng. |
UPDATE |
Hãy yêu cầu cấp quyền gửi thông tin cập nhật. Hãy truy cập vào https://developers.google.com/assistant/engagement/daily. |
Trang chủ
Đại diện cho cấu trúc HomeGraph thuộc thiết bị mục tiêu của người dùng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "params": { string: value, ... } } |
Các trường | |
---|---|
params |
Không bắt buộc. Danh sách thông số liên kết với cấu trúc HomeGraph của thiết bị mục tiêu. Xem tài liệu về bộ nhớ tại nhà: https://developers.google.com/assistant/conversational/storage-home. Một đối tượng chứa danh sách các cặp |
Thiết bị
Đại diện cho thiết bị mà người dùng đang sử dụng để gửi yêu cầu đến Hành động.
Biểu diễn dưới dạng JSON | |
---|---|
{ "capabilities": [ enum ( |
Các trường | |
---|---|
capabilities[] |
Bắt buộc. khả năng của thiết bị đưa ra yêu cầu đối với Hành động. |
currentLocation |
Không bắt buộc. Vị trí thiết bị của người dùng. Xin lưu ý rằng thông tin này chỉ được điền sau khi người dùng cuối đã cấp quyền truy cập thông tin vị trí. Xem thông báo vị trí để biết thêm thông tin chi tiết về những trường được đặt tuỳ thuộc vào quyền tương đối và quyền chi tiết. Xem tài liệu về quyền truy cập: https://developers.google.com/assistant/conversational/permissions. |
timeZone |
Không bắt buộc. Múi giờ được liên kết với thiết bị khách hàng. Thuộc tính này có thể dùng để phân giải giá trị ngày giờ. |
Chức năng
Các chức năng mà nền tảng thiết bị hỗ trợ tại thời điểm yêu cầu.
Enum | |
---|---|
UNSPECIFIED |
Khả năng của thiết bị chưa được chỉ định. |
SPEECH |
Thiết bị có thể tương tác với người dùng thông qua tính năng chuyển văn bản sang lời nói hoặc SSML. |
RICH_RESPONSE |
Thiết bị có thể hiển thị câu trả lời nhiều định dạng như thẻ, danh sách và bảng. |
LONG_FORM_AUDIO |
Thiết bị có thể phát nội dung nghe nhìn dạng âm thanh dài như nhạc và podcast. |
INTERACTIVE_CANVAS |
Thiết bị có thể hiển thị phản hồi canvas tương tác. |
WEB_LINK |
Thiết bị có thể sử dụng các đường liên kết trang web trong câu trả lời nhiều định dạng để mở một trình duyệt web. |
HOME_STORAGE |
Thiết bị có thể hỗ trợ việc lưu và tìm nạp bộ nhớ nhà. |
Vị trí
Vùng chứa đại diện cho một vị trí.
Biểu diễn dưới dạng JSON | |
---|---|
{ "coordinates": { object ( |
Các trường | |
---|---|
coordinates |
Toạ độ địa lý. Cần có quyền [DEVICE_PRECISE_LOCATION]. |
postalAddress |
Địa chỉ bưu chính. Cần có quyền [DEVICE_PRECISE_LOCATION] hoặc [DEVICE_COARSE_LOCATION]. Khi quyền truy cập thông tin vị trí thô được cấp, hệ thống dự kiến chỉ điền các trường "postalCode" và "local". Quyền truy cập thông tin vị trí chính xác sẽ điền sẵn các trường bổ sung, chẳng hạn như "AdministrationArea" và "addressLines". |
TimeZone
Đại diện cho múi giờ của Cơ sở dữ liệu múi giờ IANA.
Biểu diễn dưới dạng JSON | |
---|---|
{ "id": string, "version": string } |
Các trường | |
---|---|
id |
Múi giờ của Cơ sở dữ liệu múi giờ IANA, ví dụ: "America/New_ York". |
version |
Không bắt buộc. Số phiên bản Cơ sở dữ liệu múi giờ IANA, ví dụ: "2019a". |
Bối cảnh
Chứa thông tin ngữ cảnh khi người dùng truy vấn. Những thông tin này bao gồm nhưng không giới hạn ở thông tin về phiên phát nội dung đa phương tiện đang hoạt động, trạng thái của ứng dụng canvas trên web, v.v.
Biểu diễn dưới dạng JSON | |
---|---|
{ "media": { object ( |
Các trường | |
---|---|
media |
Chứa thông tin bối cảnh về phiên phát nội dung đa phương tiện hiện đang hoạt động. |
canvas |
Chứa thông tin ngữ cảnh về canvas hiện tại. |
MediaContext
Chứa thông tin bối cảnh về phiên phát nội dung đa phương tiện hiện đang hoạt động.
Biểu diễn dưới dạng JSON | |
---|---|
{ "progress": string, "index": integer } |
Các trường | |
---|---|
progress |
Tiến trình phát nội dung đa phương tiện của tệp nội dung nghe nhìn hiện đang hoạt động. Thời lượng tính bằng giây có tối đa 9 chữ số phân số, kết thúc bằng ' |
index |
Chỉ mục dựa trên 0 của tệp nội dung nghe nhìn hiện đang hoạt động trong danh sách các tệp nội dung nghe nhìn trong phản hồi nội dung nghe nhìn. |
CanvasContext
Chứa thông tin ngữ cảnh về canvas hiện tại.
Biểu diễn dưới dạng JSON | |
---|---|
{ "state": value } |
Các trường | |
---|---|
state |
Không bắt buộc. Trạng thái do ứng dụng Canvas tương tác của bên thứ ba đặt. Trạng thái này chỉ được đặt cho yêu cầu, chứ không phải để phản hồi. Ví dụ: nếu đây là ứng dụng cung cấp công thức nấu ăn, trạng thái có thể là giá trị của struct : { "current_page" : 5, "last_page" : 3, } Giới hạn kích thước là 50 KB. |
Dự kiến
Mô tả kỳ vọng cho lượt hộp thoại tiếp theo.
Biểu diễn dưới dạng JSON | |
---|---|
{ "speech": [ string ] } |
Các trường | |
---|---|
speech[] |
Danh sách các cụm từ mà Hành động mong đợi từ cách nói của người dùng để xu hướng lời nói. Bạn được phép sử dụng tối đa 1.000 cụm từ. Lưu ý: Trường này có cùng ý nghĩa với cột "ExpectedInput.speech_biasing_hints" trong API phiên bản 2. |