- 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 cắm
- SlotMode
- SlotStatus
- Câu lệnh
- Đơ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
- List (Danh sách)
- ListItem
- CollectionBrowse
- Mặt hàng
- Đề xuất
- Canvas
- ContinuousMatchConfig
- ExpectedPhrase
- OrderUpdate
- Loại
- Đơn đặt hàng
- Thông tin người dùng
- PhoneNumber
- Hình ảnh
- Người bán
- Vị trí
- LatLng
- PostalAddress
- Mục lục
- LineItem
- PriceAttribute
- Loại
- Trạng thái
- Tiền
- Thao tác
- Loại
- OpenUrlAction
- Ứng dụng Android
- VersionFilter
- UrlTypeHint
- ActionMetadata
- Thông tin công bố
- DisclosureText
- TextLink
- DisclosurePresentationOptions
- PresentationRequirement
- PurchaseItemExtension
- PurchaseStatus
- PurchaseType
- MerchantUnitMeasure
- Đơn vị
- PurchaseReturnsInfo
- PurchaseFulfillmentInfo
- Loại
- Thời gian
- PickupInfo
- PickupType
- CurbsideInfo
- CurbsideFulfillmentType
- Xe
- CheckInInfo
- CheckInType
- ItemOption
- ProductDetails
- ReservationItemExtension
- ReservationStatus
- ReservationType
- StaffFacilitator
- PaymentData
- PaymentResult
- PaymentInfo
- PaymentMethodDisplayInfo
- PaymentType
- PaymentMethodProvenance
- Khuyến mãi
- PurchaseOrderExtension
- PurchaseLocationType
- PurchaseError
- ErrorType
- TicketOrderExtension
- TicketEvent
- Loại
- EventCharacter
- 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
- SkuType
- SignedData
- Quyền
- Trang chủ
- Thiết bị
- Chức năng
- Vị trí
- TimeZone
- Bối cảnh
- MediaContext
- CanvasContext
- Dự kiến
RPC đại diện cho API phương thức 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 ( |
Trường | |
---|---|
handler |
Bắt buộc. Thông tin về cách thực hiện yêu cầu. Ví dụ: một yêu cầu nhằm lấy thông tin thực tế 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à cảnh tiếp theo khi hàm được gọi. Sẽ được điề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 phiên như id 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 chứa thiết bị mục tiêu. Hãy xem 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 nghe nhìn đang diễn ra hoặc thông tin về canvas. |
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:
Đại diện cho phản hồi được gửi từ phương thức thực hiện của nhà phát triển đến Actions on Google.
Biểu diễn dưới dạng JSON | |
---|---|
{ "prompt": { object ( |
Trường | |
---|---|
prompt |
Không bắt buộc. Thể hiện các lời nhắc cần gửi cho người dùng, các lời nhắc này sẽ được nối 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. 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 chứa thiết bị mục tiêu. Hãy xem 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 vòng quay 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 giúp liên kết 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ụ: trình xử lý có thể được sử 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 một nhà cung cấp khác có thể nhận thông tin sản phẩm từ cơ sở dữ liệu, với tên trình xử lý như "GetProductInfo".
Biểu diễn dưới dạng JSON | |
---|---|
{ "name": string } |
Trường | |
---|---|
name |
Không bắt buộc. Tên của 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 ( |
Trường | |
---|---|
name |
Bắt buộc. Tên của ý định được 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à sơ đồ liên kết tên của thông số đã xác định với giá trị của thông số đã xác định từ hoạt động đầu vào của người dùng. Tất cả các thông số được xác định trong ý định phù hợp đã xác định được 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 từ người dùng cuối khớp với ý định này. Mã này sẽ được điền sẵn khi một ý định được so khớp, 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 } |
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. Mã này sẽ chỉ được điền sẵn nếu tham số được xác định trong ý định được so khớp và giá trị của tham số này có thể được xác định trong quá trình so khớp ý định. |
Scene
Mô tả 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ị ô từ người dùng. 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 và so khớp ý định để chuyển sang các cảnh khác.
Biểu diễn dưới dạng JSON | |
---|---|
{ "name": string, "slotFillingStatus": enum ( |
Trường | |
---|---|
name |
Bắt buộc. Tên của 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ùng. Trường này ở chế độ chỉ đọc. |
slots |
Các vị trí được 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 về cảnh sẽ được thực thi tiếp theo. |
SlotFillingStatus
Biểu thị trạng thái hiện tại của vùng quảng cáo.
Enum | |
---|---|
UNSPECIFIED |
Giá trị dự phòng khi trường sử dụng không được điền. |
INITIALIZED |
Các ô đã được khởi chạy nhưng chưa bắt đầu lấp đầy ô. |
COLLECTING |
Hệ thống đang thu thập các giá trị vị trí. |
FINAL |
Tất cả giá trị vị trí đều là cuối cùng và không thể thay đổi. |
Khe
Đại diện cho một vị trí.
Biểu diễn dưới dạng JSON | |
---|---|
{ "mode": enum ( |
Trường | |
---|---|
mode |
Chế độ của vùng quảng cáo (bắt buộc hoặc không bắt buộc). Nhà phát triển có thể 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ị khi lấp đầy vùng. |
updated |
Cho biết liệu giá trị ô có được thu thập vào lượt cuối cùng hay không. Trường này ở chế độ chỉ đọc. |
prompt |
Không bắt buộc. Hệ thống sẽ gửi lời nhắc này cho người dùng khi họ cần lấp đầy một khoảng trống bắt buộc. Câu lệnh này sẽ ghi đè câu lệnh hiện có được xác định trong bảng điều khiển. Trường này không được đưa vào yêu cầu webhook. |
SlotMode
Biểu thị chế độ của một vị trí, tức là có 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 không bắt buộc phải hoàn tất khung giờ để lấp đầy khung giờ. |
REQUIRED |
Cho biết rằng khu vực cần quảng cáo để hoàn tất việc lấp đầy ô. |
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 vùng không có 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 giá trị của vị trí quảng cáo không hợp lệ. Bạn có thể đặt trạng thái này thông qua phản hồ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. |
Câu lệnh
Thể hiện một phản hồi cho người dùng. Hãy xem https://developers.google.com/assistant/conversational/prompts.
Biểu diễn dưới dạng JSON | |
---|---|
{ "override": boolean, "firstSimple": { object ( |
Trường | |
---|---|
override |
Không bắt buộc. Chế độ cho biết cách hợp nhất tin nhắn này với tin nhắn đã xác định trước đó. "đúng" xoá tất cả các thông báo đã xác định trước đó (đơn giản đầu tiên và cuối cùng, nội dung, đường liên kết đề xuất và canvas) đồng thời thêm các thông báo được xác định trong câu lệnh này. "sai" thêm thông báo được xác định trong câu lệnh này vào các tin nhắn đã xác định trong các câu trả lời trước đó. Để trường này thành "false" cũng cho phép thêm một số trường bên 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). Các nội dung 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. Câu trả lời đầu tiên chỉ có văn bản và giọng nói. |
content |
Không bắt buộc. Một nội dung như thẻ, danh sách hoặc nội dung nghe nhìn để hiển thị với người dùng. |
lastSimple |
Không bắt buộc. Câu trả lời gần đây nhất chỉ có văn bản và giọng nói. |
suggestions[] |
Không bắt buộc. Nội dung đề xuất sẽ hiển thị với người dùng và sẽ luôn xuất hiện ở cuối câu trả lời. Nếu giá trị "ghi đè" trường trong câu lệnh chứa là "false", tiêu đề được xác định trong trường này sẽ được thêm vào các tiêu đề được xác định trong mọi câu lệnh đề xuất đã xác định trước đó và các giá trị trùng lặp sẽ bị xoá. |
link |
Không bắt buộc. Mộ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)". 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 không bắt buộc phản hồi bằng OrderUpdate sau khi nhận được đơn đặt hàng trong luồng giao dịch. Khi nhận được điều 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ẽ cho thấy thẻ biên nhận cùng với TTS được gửi trên các thiết bị hiển thị. |
Đơn giản
Biểu thị một lời nhắc đơn giản cần gửi cho người dùng. Hãy xem https://developers.google.com/assistant/conversational/prompts-simple.
Biểu diễn dưới dạng JSON | |
---|---|
{ "speech": string, "text": string } |
Trường | |
---|---|
speech |
Không bắt buộc. Biểu thị lời nói sẽ được đọc với người dùng. Có thể là SSML hoặc chuyển văn bản sang lời nói. Nếu giá trị "ghi đè" trong câu lệnh chứa "true", lời nói được 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 hiển thị trong bong bóng trò chuyện. Nếu không cung cấp, hình ảnh kết xuất hiển thị của trường lời nói ở trên sẽ được sử dụng. Tối đa 640 ký tự. Nếu giá trị "ghi đè" trường trong câu lệnh chứa là "true", văn bản được xác định trong trường này sẽ thay thế thành 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 |
Trường | ||
---|---|---|
Trường kết hợp
|
||
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ẻ cho thấy một tập hợp các lựa chọn. |
|
list |
Một thẻ trình bày danh sách các lựa chọn để bạn lựa chọn. |
|
collectionBrowse |
Thẻ trình bày một tập hợp các trang web cần mở. |
Thẻ
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. 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 ( |
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 đánh dấu có giới hạn để định dạng. Bắt buộc, trừ phi 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ó một đườ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 truy cập vào 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 } |
Trường | |
---|---|
url |
URL nguồn của hình ảnh. Hình ảnh có thể ở định dạng JPG, PNG và GIF (ảnh động và tĩnh). Ví dụ: |
alt |
Nội dung mô tả bằng văn bản của hình ảnh dùng để tăng khả năng 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ể gây ảnh hưởng đến bản trình bày hình ảnh. Bạn nên sử dụng chế độ cài đặt này khi tỷ lệ cỡ ảnh của hình ảnh không khớp với tỷ lệ cỡ ả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 đầu và phần 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 phần 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. Chế độ 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
Mộ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 ( |
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 ( |
Trường | |
---|---|
url |
Trường URL có thể là bất kỳ trường hợp nào sau đây: – URL http/https để mở một Ứng dụng liên kết với ứng dụng hoặc một trang web |
hint |
Cho biết gợi ý về loại url. |
UrlHint
Các loại gợi ý URL khác nhau.
Enum | |
---|---|
LINK_UNSPECIFIED |
Không xác định |
AMP |
URL trỏ trực tiếp đến nội dung AMP hoặc đến một URL chính tắc tham chiếu đến nội dung AMP thông qua . Hãy xem tại https://amp.dev/. |
Bảng
Thẻ bảng để hiển thị 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 ( |
Trường | |
---|---|
title |
Tiêu đề chung của bảng. Không bắt buộc nhưng bạn phải đặt tiêu đề phụ 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ột. |
rows[] |
Dữ liệu về hàng của bảng. 3 hàng đầu tiên được đảm bảo sẽ xuất hiện, nhưng các hàng khác có thể bị cắt bớt trên một số nền tảng nhất định. Vui lòng kiểm tra với trình mô phỏng để xem những hàng nào sẽ hiển thị cho 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ể hướng 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 ( |
Trường | |
---|---|
header |
Văn bản tiêu đề cho cột. |
align |
Căn chỉnh theo chiều ngang của cột nội dung. Nếu bạn chưa chỉ định, nội dung sẽ được căn chỉnh theo cạnh trên. |
HorizontalAlignment
Căn chỉnh nội dung trong ô.
Enum | |
---|---|
UNSPECIFIED |
|
LEADING |
Cạnh trên cùng của ô. Đây là tuỳ 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 ( |
Trường | |
---|---|
cells[] |
Các ô trong hàng này. 3 ô đầu tiên được đảm bảo sẽ xuất hiện, nhưng các ô khác có thể bị cắt trên một số bề mặt. Vui lòng kiểm tra với trình mô phỏng để xem những ô nào sẽ hiển thị cho một bề mặt nhất định. |
divider |
Cho biết có cần có dải phân cách sau mỗi hàng hay không. |
TableCell
Mô tả một ô trong một hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "text": string } |
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 ( |
Trường | |
---|---|
mediaType |
|
startOffset |
Độ lệch bắt đầu của đối tượng nội dung nghe nhìn đầu tiên. Thời lượng tính bằng giây với 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 bạn đặt chính sách này, yêu cầu sẽ được gửi đến bên thứ ba khi một sự kiện đa phương tiện nhất định xảy ra. Nếu không được thiết lập, ứng dụng 3p vẫn phải xử lý hai loại điều khiển mặc định là FinishED (KẾT THÚC) 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 nội dung đa phương tiện. |
firstMediaObjectIndex |
chỉ mục dựa trên 0 của Đối tượng nội dung đa phương tiện đầu tiên trong mediaObjects để phát. Nếu chưa chỉ định, bằng 0 hoặc ngoài giới hạn, quá trình phát sẽ bắt đầu ở đối tượng nội dung nghe nhìn đầu tiên trong mediaObjects. |
MediaType
Loại nội dung nghe nhìn của câu trả lời này.
Enum | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
|
AUDIO |
Tệp âm thanh. |
MEDIA_STATUS_ACK |
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 chế độ điều khiển nội dung nghe nhìn (không bắt buộc) mà tính năng phản hồi của nội dung nghe nhìn có thể hỗ trợ
Enum | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Giá trị không xác định |
PAUSED |
Sự kiện đã tạm dừng. Được kích hoạt khi người dùng tạm dừng nội dung nghe nhìn. |
STOPPED |
Đã dừng sự kiện. Được kích hoạt khi người dùng thoát khỏi phiên 3p trong quá trình phát nội dung đa phương tiện. |
MediaObject
Đại diện cho một đối tượng nội dung nghe nhìn duy nhất
Biểu diễn dưới dạng JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
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 nghe nhìn này. |
url |
URL trỏ đến nội dung đa phương tiện. Tệp MP3 phải được lưu trữ trên máy chủ web và xuất hiện công khai thông qua một URL loại HTTPS. Tính năng phát trực tiếp chỉ được hỗ trợ cho định dạng MP3. |
image |
Hình ảnh sẽ hiển thị với thẻ nội dung nghe nhìn. |
MediaImage
Biểu diễn dưới dạng JSON | |
---|---|
{ // Union field |
Trường | ||
---|---|---|
Trường kết hợp
|
||
large |
Một hình ảnh lớn, chẳng hạn như ảnh bìa đĩa nhạc, v.v. |
|
icon |
Một biểu tượng hình ảnh nhỏ hiển thị ở bên phải tiêu đề. Kích thướ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 nghe nhìn.
Enum | |
---|---|
REPEAT_MODE_UNSPECIFIED |
Tương đương với 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 điểm bắt đầu của đối tượng nội dung nghe nhìn đầu tiên khi đạt đến điểm kết thúc của đối tượng nội dung nghe nhìn cuối cùng. |
Bộ sưu tập
Thẻ để trình bày một tập hợp các lựa chọn. Xem https://developers.google.com/assistant/conversational/prompts-selection#collection
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Trường | |
---|---|
title |
Tiêu đề của 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ó 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 } |
Trường | |
---|---|
key |
Bắt buộc. Khoá NLU khớp với tên khoá kết nối trong Loại được liên kết. |
Danh sách
Thẻ để trình bày danh sách các lựa chọn. Xem https://developers.google.com/assistant/conversational/prompts-selection#list
Biểu diễn dưới dạng JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Trường | |
---|---|
title |
Tiêu đề của 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. Mô hình tổ hợp tiếp thị có thể có 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 } |
Trường | |
---|---|
key |
Bắt buộc. Khoá NLU khớp với tên khoá kết nối trong Loại được liên kết. |
CollectionBrowse
Trình bày một nhóm tài liệu web dưới dạng tập hợp các mục ô lớn. Bạn có thể chọn các mục để chạy tài liệu trên web được liên kết trong trình xem trên 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 ( |
Trường | |
---|---|
items[] |
Danh sách các mục. Giá trị này có thể có tối thiểu là 2 và tối đa là 10. |
imageFill |
Loại hình ảnh hiển thị. |
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 ( |
Trường | |
---|---|
title |
Bắt buộc. Tiêu đề của mục trong bộ sưu tập. |
description |
Nội dung mô tả về mục trong bộ sưu tập. |
footer |
Văn bản chân trang cho mục bộ sưu tập, hiển thị bên dưới nội dung mô tả. Một dòng văn bản, được cắt ngắn bằng dấu ba chấm. |
image |
Hình ảnh cho mục bộ sưu tập. |
openUriAction |
Bắt buộc. URI sẽ mở nếu mục được chọn. |
Đề xuất
Các đề xuất sẽ cung cấp cho người dùng trên các thiết bị có khả năng hiển thị các khối đề xuất 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 được nhấn, khối đề xuất sẽ trả về nguyên văn văn bản hiển thị trong cuộc trò chuyệ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 } |
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 vào cuộc trò chuyện như thể người dùng đã nhập văn bản đó. Mỗi tiêu đề phải là duy nhất trong tập hợp các 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ể dùng lệnh này cùng với "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à 50k byte. Hãy xem https://developers.google.com/assistant/interactivecanvas.
Biểu diễn dưới dạng JSON | |
---|---|
{
"url": string,
"data": [
value
],
"suppressMic": boolean,
"continuousMatchConfig": {
object ( |
Trường | |
---|---|
url |
URL của ứng dụng canvas tương tác trên web cần tải. Nếu bạn không đặt chính sách này, thì URL của canvas đang hoạt động sẽ được sử dụng lại. |
data[] |
Không bắt buộc. Dữ liệu JSON được truyền đến trang web trải nghiệm sống động dưới dạng sự kiện. Nếu giá trị "ghi đè" trường trong câu lệnh chứa là "false" 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 giá trị dữ liệu được xác định trong các lời nhắc Canvas trước đó. |
suppressMic |
Không bắt buộc. Giá trị mặc định: false. |
continuousMatchConfig |
Cấu hình được dùng để kích hoạt chế độ so khớp liên tục. |
ContinuousMatchConfig
Cấu hình được dùng để kích hoạt chế độ so khớp liên tục.
Biểu diễn dưới dạng JSON | |
---|---|
{
"expectedPhrases": [
{
object ( |
Trường | |
---|---|
expectedPhrases[] |
Tất cả các cụm từ dự kiến có thể có trong phiên chế độ khớp liên tục này. |
durationSeconds |
Thời lượng để bật chế độ khớp liên tục. Nếu bạn chỉ định, micrô sẽ đóng khi hết thời gian. Giá trị tối đa được phép là 180. |
ExpectedPhrase
Biểu diễn dưới dạng JSON | |
---|---|
{ "phrase": string, "alternativePhrases": [ string ] } |
Trường | |
---|---|
phrase |
Cụm từ để khớp trong phiên chế độ khớp liên tục. |
alternativePhrases[] |
Mẫu giọng nói có thể nhận dạng sai một số cụm từ ngay cả khi có xu hướng giọng nói. Điều này cho phép nhà phát triển chỉ định trình kích hoạt thay thế cho các từ đồng âm. |
OrderUpdate
Cập nhật đơn đặt hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "type": enum ( |
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à thay đổi về trạng thái cấp đơn đặt hàng. Chỉ có order.last_update_time và trạng thái dọc này mới được chọn. Lưu ý: type.ORDER_STATUS chỉ hỗ trợ thông tin cập nhật về trạng thái của PurcahaseOrderExtension và không có kế hoạch gia hạn hỗ trợ này. Thay vào đó, bạn nên sử dụng updateMask vì API này có tính tổng quát, dễ mở rộng và có thể dùng cho tất cả các ngành dọc. |
order |
|
updateMask |
Lưu ý: Chúng tôi cần cân nhắc/đề xuất những 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 được cung cấp như một phần của 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, hệ thống sẽ hiển thị thông báo cho người dùng kèm theo tiêu đề và nội dung cụ thể. Việc chỉ định thông báo là đề xuất thông báo và không đảm bảo sẽ dẫn đến 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. Được phép cập nhật đơn đặt hàng.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Loại chưa xác định, không nên đặt tuỳ chọn 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 ảnh chụp nhanh đơn đặt hàng. |
Đặt
Thực thể đơn đặt hàng. Lưu ý: 1. Tất cả chuỗi ở mọi cấp độ phải nhỏ hơn 1000 ký tự trừ phi có quy định khác. 2. Số lượng trường lặp lại ở tất cả các cấp phải nhỏ hơn 50, trừ phi có quy định khác. 3. Tất cả dấu thời gian ở mọi 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 ( |
Trường | ||
---|---|---|
googleOrderId |
Mã đơn hàng được chỉ định của Google. |
|
merchantOrderId |
Bắt buộc: Mã đơn hàng nội bộ do người bán chỉ định. Mã nhận dạng này phải là duy nhất và bắt buộc phải 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 hoặc bất kỳ giá trị duy nhất nào khác mà bạn cung cấp. Xin lưu ý rằng mã nhận dạng mà người dùng nhìn thấy là userVisibleOrderId. Đây có thể là một giá trị khác và thân thiện với người dùng hơn. Độ 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 tham chiếu đến đơn đặt hàng hiện tại. Mã nhận dạng này phải nhất quán với mã nhận dạng 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 OrderExtension. Nhãn hiển thị cho người dùng 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 kết với đơn đặt hàng. |
|
createTime |
Bắt buộc: Ngày và giờ tạo đơn đặt hàng. Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: |
|
lastUpdateTime |
Ngày và giờ cập nhật đơn đặt hàng lần gần đây nhất. Bắt buộc đối với OrderUpdate. Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: |
|
transactionMerchant |
Người bán hỗ trợ thanh toán. Số lượng này có thể khác với nhà cung cấp cấp mục hàng. Ví dụ: Đơn đặt hàng trên Expedia có mục hàng của 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[] |
Hành động nối tiếp ở cấp đơn đặt hàng. |
|
paymentData |
Dữ liệu liên quan đến việc 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 kết với đơn đặt hàng này. |
|
disclosures[] |
Thông tin công bố liên quan đến đơn đặt hàng này. |
|
vertical |
Không dùng nữa: 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ừ phi 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ể có: Một đối tượng có chứa các trường thuộc loại tuỳ ý. Trường bổ sung |
|
Trường kết hợp verticals . Các thuộc tính này sẽ áp dụng cho mọi mục hàng, trừ phi 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 |
Đơn đặt vé |
UserInfo
Thông tin về người dùng. Thuộc tính này dùng để trình bày thông tin của người dùng liên quan đến đơn đặt hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{
"email": string,
"firstName": string,
"lastName": string,
"displayName": string,
"phoneNumbers": [
{
object ( |
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
Đại diện tiêu chuẩn bằng số điện thoại.
Biểu diễn dưới dạng JSON | |
---|---|
{ "e164PhoneNumber": string, "extension": string, "preferredDomesticCarrierCode": string } |
Trường | |
---|---|
e164PhoneNumber |
Số điện thoại ở định dạng E.164, theo định nghĩa trong Khuyến nghị E.164 của Liên minh Viễn thông Quốc tế (ITU). Đường liên kết đến wiki: 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 được định nghĩa là một chuỗi số có độ dài tối đa là 40 chữ số. Giá trị này được định nghĩa là một chuỗi ở đây để phù hợp với việc sử dụng có thể sử dụng số 0 ở đầu trong phần mở rộng (các tổ chức có toàn quyền làm như vậy, vì không có tiêu chuẩn được xác định). Ngoại trừ chữ số, một số ký tự quay số khác như "," (cho biết thời gian chờ) có thể được lưu trữ tại đây. Ví dụ: trong số máy lẻ xxx-xxx-xxxx. 123, "123" là phần mở rộng. |
preferredDomesticCarrierCode |
Mã chọn nhà mạng được ưu tiên khi gọi trong nước cho số điện thoại này. Quy định này cũng áp dụng cho mã cần quay số ở một số quốc gia khi gọi từ điện thoại cố định sang điện thoại di động hoặc ngược lại. Ví dụ: ở Columbia, "3" cần phải được gọi trước số điện thoại khi gọi từ điện thoại di động đến điện thoại cố định trong nước 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à "ư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 } |
Trường | |
---|---|
url |
URL nguồn của hình ảnh. Hình ảnh có thể ở định dạng JPG, PNG và GIF (ảnh động và tĩnh). Ví dụ: |
accessibilityText |
Nội dung mô tả bằng văn bản của hình ảnh dùng để tăng khả năng 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 cho 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 ( |
Trường | |
---|---|
id |
Mã nhận dạng 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ư "Bánh mì Panera". |
image |
Hình ảnh liên kết với 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 ( |
Trường | |
---|---|
coordinates |
Toạ độ địa lý. Yêu cầu [DEVICE_PRECISE_LOCATION] Quyền [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
formattedAddress |
Địa chỉ hiển thị, ví dụ: "1600 Amphitheatre Pkwy, Mountain View, CA 94043". Yêu cầu [DEVICE_PRECISE_LOCATION] Quyền [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
zipCode |
Mã bưu chính. Yêu cầu [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] hoặc [DEVICE_COARSE_LOCATION] Quyền [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
city |
Thành phố. Yêu cầu [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] hoặc [DEVICE_COARSE_LOCATION] Quyền [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
postalAddress |
Địa chỉ bưu chính. Yêu cầu [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] hoặc [DEVICE_COARSE_LOCATION] Quyền [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
name |
Tên địa điểm. |
phoneNumber |
Số điện thoại của vị trí, 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 |
locationId được sử dụng với Places API để tìm nạp thông tin chi tiết về một địa điểm. Hãy xem https://developers.google.com/places/web-service/place-id |
LatLng
Đối tượng đại diện cho cặp vĩ độ/kinh độ. Giá trị này được biểu thị bằng cặp số đại diện cho 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 } |
Trường | |
---|---|
latitude |
Vĩ độ tính bằng độ. Giá trị này phải nằm trong khoảng [-90.0, +90.0]. |
longitude |
Kinh độ tính bằng độ. Giá trị này phải nằm trong khoảng [-180.0, +180.0]. |
PostalAddress (Địa chỉ bưu điện)
Đại diện cho địa chỉ bưu chính, ví dụ: cho địa chỉ giao hàng qua bưu điện hoặc địa chỉ thanh toán. Khi có địa chỉ bưu chính, dịch vụ bưu chính có thể giao hàng đến trụ sở là P.O. Hộp hoặc thứ tự tương tự. Tính năng 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, một địa chỉ sẽ được tạo thông qua hoạt động đầu vào của người dùng hoặc từ việc 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ỉ hỗ trợ 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 phần tử trê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 đó.
Để biết thêm hướng dẫn 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 } |
Trường | |
---|---|
revision |
Bản sửa đổi giản đồ của Tất cả các bản sửa đổi mới phải tương thích ngược với các bản sửa đổi cũ. |
regionCode |
Bắt buộc. Mã vùng CLDR của quốc gia/khu vực trong địa chỉ. Điều này không bao giờ được dự đoán và việc đảm bảo giá trị chính xác là tuỳ thuộc vào người dùng. Hãy tham khả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 được yêu cầu khớp với một trong các ngôn ngữ được sử dụng trong địa chỉ quốc gia/khu vực hoặc từ tương đương được chuyển tự của chúng. Điều này có thể ảnh hưởng đến việc đị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ỳ hoạt động xác thực hoặc hoạt động nào khác không liên quan đến việc định dạng. Nếu không biết 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 yêu cầu mã bưu chính phải xuất hiện, nhưng ở Hoa Kỳ, các quốc gia đó 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 tại Hoa Kỳ). |
sortingCode |
Không bắt buộc. Mã phân loại bổ sung, theo quốc gia cụ thể. Thông tin này không được sử dụng ở hầu hết các khu vực. Khi giá trị được sử dụng, giá trị phải là một chuỗi như "CEDEX", có thể theo sau là một số (ví dụ: "CEDEX 7") hoặc chỉ một số, đại diện cho "mã lĩnh vực" (Jamaica), "chỉ báo khu vực giao hàng" (Malawi) hoặc "chỉ báo tại bưu điện" (ví dụ: Bờ Biển Ngà). |
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ụ: bạn có thể nhập 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 và không phải là 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ĩ thì không nên điền giá trị này. |
locality |
Không bắt buộc. Nói chung là phần thành phố/thị trấn của địa chỉ. Ví dụ: Thành phố ở Hoa Kỳ, xã CNTT, thị trấn có bưu điện của Vương quốc Anh. Trong các 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. Quận/phường 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ỉ phi cấu trúc mô tả các cấp thấp hơn của một địa chỉ. Do 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ự dòng phải rõ ràng. Thứ tự của các dòng địa chỉ phải là "thứ tự phong bì" cho quốc gia/khu vực trong địa chỉ. Ở những nơi giá trị này có thể thay đổi (ví dụ: Nhật Bản), address_language được sử 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 dựa trên ngôn ngữ. Cách 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ã vùng với tất cả thông tin còn lại được đặt trong Dòng địa chỉ. Có thể định dạng một địa chỉ như vậy gần như mà không cần mã hoá địa lý, nhưng không thể lập luận ngữ nghĩa về bất kỳ thành phần địa chỉ nào cho đến khi địa chỉ đó được giải quyết ít nhất một phần. Tạo một địa chỉ chỉ chứa mã vùng và addressLines, sau đó mã hóa địa lý là cách được khuyến nghị để xử lý các địa chỉ hoàn toàn không có cấu trúc (trái ngược với việc đoán phần nào của địa chỉ sẽ 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ụ: thẻ có thể chứa từ "chăm sóc" của bạn. |
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 ( |
Trường | |
---|---|
lineItems[] |
Danh sách mục hàng của đơn đặt hàng. Yêu cầu tối thiểu 1 mục hàng và tối đa là 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. Bạn nên xác định các mục hàng phụ/tiện ích bổ sung, v.v. trong các giao thức dọc tuỳ thuộc vào trường hợp sử dụng. Lưu ý: 1. Tất cả chuỗi ở mọi cấp độ phải nhỏ hơn 1000 ký tự trừ phi có quy định khác. 2. Số lượng trường lặp lại ở tất cả các cấp phải nhỏ hơn 50, trừ phi có quy định khác. 3. Tất cả dấu thời gian ở mọi 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 ( |
Trường | ||
---|---|---|
id |
Bắt buộc: Giá trị nhận dạng được chỉ định cho người bán 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ư 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àng, hãy sử dụng PurchaseOrderExtension.status. Nhãn hiển thị cho người dùng về 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 trên Expedia có 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[] |
Hành động theo dõi tại mục hàng. |
|
recipients[] |
Khách hàng cấp mục hàng, thông tin này 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 theo tên của người dùng Y. |
|
image |
Hình ảnh nhỏ liên kết với mặt hàng này, nếu có. |
|
description |
Mô tả mục hàng. |
|
notes[] |
Các lưu ý bổ sung áp dụng cho mục hàng cụ thể này, ví dụ: chính sách huỷ. |
|
disclosures[] |
Thông tin công bố liên quan đến mục hàng này. |
|
vertical |
Không dùng nữa: 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 của mục hàng. Mỗi ngành dọc nên bao gồm thông tin chi tiết về việc thực hiện đơn hàng riêng. Phải là một trong các giá trị sau: Một đối tượng có chứa các trường thuộc loại tuỳ ý. Trường bổ sung |
|
Trường kết hợp 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 của mục hàng. Mỗi ngành dọc nên bao gồm thông tin chi tiết về việc thực hiện đơn hàng 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 |
Đặt chỗ 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 ( |
Trường | ||
---|---|---|
type |
Bắt buộc: Thuộc tính loại tiền. |
|
name |
Bắt buộc: Chuỗi do người dùng hiển thị của thuộc tính giá. Email này do người bán gửi và bản địa hoá. |
|
id |
Không bắt buộc: Mã mục hàng tương ứng với giá này. |
|
state |
Bắt buộc: Tình trạng của giá: Ước tính so với thực tế. |
|
taxIncluded |
Liệu giá đã bao gồm thuế hay chưa. |
|
Trường kết hợp spec . Đại diện cho số tiền hoặc mili 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: 1/1000 Ví dụ: 8,750% được thể hiện là 8750, tỷ lệ phần trăm âm thể hiện tỷ lệ phần trăm chiết khấu. Không dùng trường này nữa. Có thể cân nhắc việc thêm lại ứng dụng khi cần có một trường hợp sử dụng vững chắc. |
Loại
Đại diện cho loại tiền.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Loại chưa được chỉ định, ứng dụng không cần phải đặt thông tin này một cách rõ ràng. |
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ần trừ vào tổng thành tiền. |
TAX |
Cần thêm vào thành tiền. |
DELIVERY |
Cần thêm vào thành tiền. |
SUBTOTAL |
Tổng phụ phí trước khi có thể được thêm vào một số khoản phí. |
FEE |
Mọi khoản phí bổ sung. |
GRATUITY |
Cần thêm vào thành tiền. |
TOTAL |
Giá hiển thị của đơn đặt hàng hoặc mục hàng. |
Tiểu bang
Biểu thị trạng thái giá.
Enum | |
---|---|
STATE_UNSPECIFIED |
Chưa chỉ đị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 biết 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
Đại diện cho số tiền kèm theo loại đơn vị tiền tệ.
Biểu diễn dưới dạng JSON | |
---|---|
{ "currencyCode": string, "amountInMicros": string } |
Trường | |
---|---|
currencyCode |
Mã đơn vị tiền tệ gồm 3 chữ cái được xác định trong ISO 4217. |
amountInMicros |
Số tiền tính bằng phần triệu. Ví dụ: trường này phải được đặt là 1990000 với giá $1, 99. |
Hành động
Một hành động tiếp theo được liên kết với đơn đặt hàng hoặc mục hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "type": enum ( |
Trường | |
---|---|
type |
Bắt buộc: Loại tác vụ. |
title |
Tiêu đề hoặc nhãn của thao tác, hiển thị cho người dùng. Độ dài tối đa cho phép là 100 ký tự. |
openUrlAction |
Việc cần làm. |
actionMetadata |
Siêu dữ liệu liên kết với một hành động. |
Loại
Những hành động tiếp theo có thể thực hiện.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Hành động không xác định. |
VIEW_DETAILS |
Thao tác xem chi tiết đơn đặt hàng. |
MODIFY |
Sửa đổi thao tác đối với đơn đặt hàng. |
CANCEL |
Thao tác huỷ đơn đặt hàng. |
RETURN |
Thao tác trả lại hàng. |
EXCHANGE |
Thao tác đặt hàng Exchange. |
EMAIL |
Hành động đối với email. Các loại EMAIL và CALL không được dùng nữa. Có thể sử dụng openUrlAction.url làm số điện thoại hoặc email. |
CALL |
Hành động gọi. |
REORDER |
Sắp xếp lại hành động. |
REVIEW |
Xem lại hành động đặt hàng. |
CUSTOMER_SERVICE |
Liên hệ với bộ phận dịch vụ khách hàng. |
FIX_ISSUE |
Hãy 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 đến đường đi. |
OpenUrlAction
Mở URL đã cho.
Biểu diễn dưới dạng JSON | |
---|---|
{ "url": string, "androidApp": { object ( |
Trường | |
---|---|
url |
Trường URL có thể là bất kỳ trường hợp nào sau đây: – URL http/https để mở một Ứng dụng 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 sẽ thực hiện URL. |
urlTypeHint |
Cho biết gợi ý về loại url. |
AndroidApp
Thông số kỹ thuật của Ứng dụng Android cho các quy tắc hạn chế về phương thức thực hiện
Biểu diễn dưới dạng JSON | |
---|---|
{
"packageName": string,
"versions": [
{
object ( |
Trường | |
---|---|
packageName |
Bạn phải chỉ định tên gói Tên gói 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
VersionFilter nên được bao gồm nếu yêu cầu (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 } |
Trường | |
---|---|
minVersion |
Mã phiên bản tối thiểu hoặc 0, bao gồm cả hai giá trị này. |
maxVersion |
Mã phiên bản tối đa, bao gồm cả hai giá trị này. Dải ô được xem xét là [minVersion:maxVersion]. Phạm vi rỗng ngụ ý mọi phiên bản. Ví dụ: Để chỉ định một phiên bản, hãy sử dụng: [target_version:target_version]. Để chỉ định một phiên bản bất kỳ, 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 ý URL khác nhau.
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 một 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 cho mỗi hành động.
Biểu diễn dưới dạng JSON | |
---|---|
{ "expireTime": string } |
Trường | |
---|---|
expireTime |
Thời điểm mà hành động này sẽ hết hạn. Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 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 ( |
Trường | |
---|---|
title |
Tiêu đề của thông tin công bố. Ví dụ: "Thông tin 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 lựa chọn trình bày về việc công bố thông tin. |
DisclosureText
Đại diện cho một văn bản thuần tuý có các đường liên kết trang web.
Biểu diễn dưới dạng JSON | |
---|---|
{
"template": string,
"textLinks": [
{
object ( |
Trường | |
---|---|
template |
Văn bản hiển thị, chứa phần giữ chỗ như "{0}" và "{1}" cho mỗi đường liên kết văn bản cần 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 được tiểu bang California xác định là gây ung thư. Để biết thêm thông tin, hãy truy cập {0}." Văn bản thông tin 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 tương tự quảng cáo nào. |
textLinks[] |
Các đường liên kết dạng văn bản cần được thay thế trong mẫu. Số đầu tiên sẽ được thay thế cho "{0}" trong chuỗi mẫu và chuỗi thứ hai cho "{1}", v.v. |
TextLink
Một đường liên kết văn bản sẽ được thay thế trong mẫu.
Biểu diễn dưới dạng JSON | |
---|---|
{ "displayText": string, "url": string } |
Trường | |
---|---|
displayText |
Văn bản sẽ hiển thị cho người dùng. |
url |
URL mà người dùng sẽ được chuyển đến khi đường liên kết được kích hoạt. |
DisclosurePresentationOptions
Các lựa chọn trình bày thông tin công bố.
Biểu diễn dưới dạng JSON | |
---|---|
{
"presentationRequirement": enum ( |
Trường | |
---|---|
presentationRequirement |
Yêu cầu về việc trình bày thông tin công bố. |
initiallyExpanded |
Liệu nội dung của thông tin công bố có nên được mở rộng ban đầu hay không. Theo mặc định, ban đầu, thanh này sẽ đượ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 xác đị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 thuộc tính này nếu thiết bị không hỗ trợ hiển thị thông tin công bố. |
REQUIREMENT_REQUIRED |
Bạn phải công bố thông tin. Cuộc trò chuyện sẽ được chuyển sang điện thoại nếu thiết bị của bạn 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 ( |
Trường | |
---|---|
status |
Bắt buộc: Trạng thái cấp mục hàng. |
userVisibleStatusLabel |
Bắt buộc: Nhãn/chuỗi 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 ưu đãi liên kết với mục hàng này. |
quantity |
Số lượng của mặt hàng. |
unitMeasure |
Số lượng đo lường đơn vị. Chỉ định kích thước của mặt hàng theo đơn vị đã chọn. Kích thước cùng với giá đang được sử 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, 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, mục hàng này sẽ kế thừa thông tin về việc thực hiện đơn đặt hàng ở 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ỳ vào trường hợp/tình huống sử dụng, hãy cân nhắc một trong những cách sau: 1. Xác định các trường trong PurchaseItemExtension nếu có thể dùng cho các trường hợp sử dụng khác (ví dụ: chức năng/chức năng chung). 2. Sử dụng portrait_extension nếu công cụ 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. Một đối tượng có chứa các trường thuộc loại tuỳ ý. Trường bổ sung |
PurchaseStatus
Trạng thái mua hàng 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 hàng. |
SHIPPED |
Đã giao hàng. |
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 nhau trong ngữ cảnh khác nhau. Đối với đơn đặt hàng THỰC PHẨM, đó có thể là thực phẩm đang được chuẩn bị. Đối với Nhà bán lẻ, đây 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 |
Mặt hàng đã được người dùng trả về. |
CANCELLED |
Đơn đặt hàng hoặc mục hàng đã bị người dùng huỷ. |
CHANGE_REQUESTED |
Người dùng đã yêu cầu thay đổi đơn đặt hàng và đối tác tích hợp đang xử lý thay đổi này. Đơn đặt hàng phải được chuyển sang một trạng thái khác sau khi yêu cầu được xử lý. |
PurchaseType
Danh mục giao dịch mua.
Enum | |
---|---|
PURCHASE_TYPE_UNSPECIFIED |
Giá trị không xác định. |
RETAIL |
Quy định này áp dụng cho cả các giao dịch mua như hàng hoá thực. |
FOOD |
Bao gồm cả giao dịch mua đơn đặt món ăn. |
GROCERY |
Mua hàng tạp hoá. |
MOBILE_RECHARGE |
Giao dịch mua 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 ( |
Trường | |
---|---|
measure |
Giá trị: Ví dụ 1.2. |
unit |
Đơn vị: Ví dụ: POUND, GRAM. |
Đơn vị
Enum | |
---|---|
UNIT_UNSPECIFIED |
Chưa xác định đơn vị. |
MILLIGRAM |
Miligam. |
GRAM |
Gram |
KILOGRAM |
Kilogam. |
OUNCE |
Ounce. |
POUND |
Bảng Anh. |
PurchaseReturnsInfo
Trả về thông tin 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 | |
---|---|
{ "isReturnable": boolean, "daysToReturn": integer, "policyUrl": string } |
Trường | |
---|---|
isReturnable |
Nếu giá trị là true, thì hệ thống sẽ cho phép trả về. |
daysToReturn |
Bạn được phép trả lại hàng trong vòng bao 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 đơn đặt hàng hoặc mục hàng cụ thể.
Biểu diễn dưới dạng JSON | |
---|---|
{ "id": string, "fulfillmentType": enum ( |
Trường | |
---|---|
id |
Giá trị nhận dạng duy nhất của dịch vụ này. |
fulfillmentType |
Bắt buộc: Loại phương thức thực hiện. |
expectedFulfillmentTime |
Một cửa sổ nếu phạm vi thời gian được chỉ định hoặc giờ đến dự kiến 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 |
Một cửa sổ nếu phạm vi thời gian được chỉ định hoặc giờ đến dự kiến nếu chỉ định một thời gian. Thời gian dự kiến để chuẩn bị món ăn. Ưu tiên thanh toán một lần. |
location |
Vị trí đến lấy hàng hoặc giao hàng. |
expireTime |
Thời gian mà tuỳ chọn thực hiện này hết hạn. Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 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 để thực hiện yêu cầu này. |
shippingMethodName |
Tên của phương thức vận chuyển do người dùng chọn. |
storeCode |
StoreCode của vị trí. Ví dụ: Walmart là merchant và storeCode là cửa hàng walmart nơi 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 loại phương thức thực hiện là PICKUP. |
Loại
Loại phương thức 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 biểu thị thời gian của một sự kiệ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 } |
Trường | |
---|---|
timeIso8601 |
Biểu thị thời gian sự kiện đặt hàng như thời gian đặt trước, thời gian giao hàng, v.v. Có thể là thời lượng (thời gian bắt đầu và kết thúc), chỉ 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 thức nhận đơn đặt hàng. Thông tin này bao gồm các thông tin chi tiết như loại hình đến lấy hàng và siêu dữ liệu bổ sung đi kèm với từng loại, nếu có.
Biểu diễn dưới dạng JSON | |
---|---|
{ "pickupType": enum ( |
Trường | |
---|---|
pickupType |
Phương pháp nhận hàng, chẳng hạn như INSTORE, CURBSIDE, v.v. |
curbsideInfo |
Thông tin chi tiết liên quan đến thông tin về lề đường. NếupickupType 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 đến lấy hàng được hỗ trợ.
Enum | |
---|---|
UNSPECIFIED |
Chưa xác định loại hình nhận hàng. |
INSTORE |
Đến lấy đồ ăn trong nhà hàng. |
CURBSIDE |
Đỗ xe ở một địa điểm được chỉ định bên ngoài nhà hàng và sẽ có người giao đồ ăn đến đó. |
CurbsideInfo
Thông tin chi tiết về việc tạo thuận lợi cho việc giữ chỗ ở lề đường.
Biểu diễn dưới dạng JSON | |
---|---|
{ "curbsideFulfillmentType": enum ( |
Trường | |
---|---|
curbsideFulfillmentType |
Đối tác cần thêm thông tin để hỗ trợ các đơn đặt hàng đến lấy hàng ở lề đường. Tuỳ thuộc vào loại phương thức thực hiện đơn hàng mà bạn chọn, thông tin chi tiết tương ứng sẽ được thu thập từ người dùng. |
userVehicle |
Thông tin chi tiết về xe của người dùng đặt hàng. |
CurbsideFulfillmentType
Giá trị có thể có của các kiểu thực hiện đơn hàng ở lề đường.
Enum | |
---|---|
UNSPECIFIED |
Chưa xác định loại phương thức thực hiện nhiệm vụ ở lề đường. |
VEHICLE_DETAIL |
Cần có thông tin về xe để hỗ trợ 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 ( |
Trường | |
---|---|
make |
Nhà sản xuất xe (ví dụ: "Honda"). Thông tin này sẽ hiển thị cho người dùng và phải được bản địa hoá. Bắt buộc. |
model |
Mẫu xe (ví dụ: "Grom"). Thông tin này sẽ hiển thị cho người dùng và 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 của xe, ví dụ: màu đen Tùy chọn. |
image |
URL dẫn đến ảnh chụp chiếc xe. Ảnh sẽ được hiển thị ở kích thước khoảng 256x256px. Phải ở định dạng jpg hoặc png. Không bắt buộc. |
CheckInInfo
Siêu dữ liệu do đối tác yêu cầu để hỗ trợ phương pháp xác nhận an toàn.
Biểu diễn dưới dạng JSON | |
---|---|
{
"checkInType": enum ( |
Trường | |
---|---|
checkInType |
Phương thức dùng để gửi hướng dẫn đăng ký. |
CheckInType
Các phương thức khác nhau được sử dụng để gửi hướng dẫn đăng ký.
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 tiện ích bổ sung hoặc mục con.
Biểu diễn dưới dạng JSON | |
---|---|
{ "id": string, "name": string, "prices": [ { object ( |
Trường | |
---|---|
id |
Đối với các lựa chọn là mặt hàng, hãy sử dụng mã mặt hàng duy nhất. |
name |
Tên lựa chọn. |
prices[] |
Tổng giá của 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, số lượng. |
productId |
Mã sản phẩm hoặc ư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, ... } } |
Trường | |
---|---|
productId |
Mã sản phẩm hoặc ưu đãi 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 biệt các 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ản phẩm từ sữa và Trứng > Sữa > Sữa nguyên chất" |
productAttributes |
Thông tin chi tiết về sản phẩm do người bán cung cấp, 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 ( |
Trường | |
---|---|
status |
Bắt buộc: Trạng thái đặt trước. |
userVisibleStatusLabel |
Bắt buộc: Nhãn/chuỗi 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 chỗ. Bạn có thể không đặt được nếu không áp dụng được bất kỳ loại nào. |
reservationTime |
Thời gian diễn ra dịch vụ/sự kiện theo lịch. Có thể là phạm vi thời gian, ngày tháng hoặc ngày giờ chính xác. |
userAcceptableTimeRange |
Phạm vi thời gian mà người dùng chấp nhận. |
confirmationCode |
Mã xác nhận cho lượt đặt chỗ này. |
partySize |
Số lượng người. |
staffFacilitators[] |
Nhân viên hỗ trợ sẽ phụ trách yêu cầu đặt chỗ. Ví dụ: Nhà tạo mẫu tóc. |
location |
Vị trí của dịch vụ/sự kiện. |
ReservationStatus
Trạng thái của yêu cầu đặt chỗ.
Enum | |
---|---|
RESERVATION_STATUS_UNSPECIFIED |
Trạng thái không xác định. |
PENDING |
Yêu cầu đặt chỗ đang chờ xử lý. |
CONFIRMED |
Yêu cầu đặt chỗ đã đượ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 |
Đã yêu cầu thay đổi yêu cầu đặt chỗ |
REJECTED |
Yêu cầu đặt chỗ đã hết hạn hoặc bị nhà tích hợp từ chối. |
ReservationType
Loại đặt chỗ.
Enum | |
---|---|
RESERVATION_TYPE_UNSPECIFIED |
Loại không xác định. |
RESTAURANT |
Đặt chỗ trước nhà hàng. |
HAIRDRESSER |
Đặt trước cho thợ làm tóc. |
StaffFacilitator
Thông tin về nhân viên cung cấp dịch vụ.
Biểu diễn dưới dạng JSON | |
---|---|
{
"name": string,
"image": {
object ( |
Trường | |
---|---|
name |
Tên của người điều phối là nhân viên. Ví dụ: "John Smith" |
image |
Hình ảnh của người thực hiệ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 ( |
Trườ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. Trường này sẽ được Actions on Google điền sẵn 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 trực tiếp với người dùng. |
PaymentResult
Kết quả thanh toán mà đơ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 |
Trường | ||
---|---|---|
Trường kết hợp result . Dữ liệu thanh toán của Google hoặc phương thức thanh toán của người bán sẽ được cung cấp. 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ó tên trong danh sách 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 qua đường liên kết để tìm hiểu thêm chi tiết. Nếu không, hãy tham khảo tài liệu sau để 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. Proto này thu thập thông tin hữu ích cho hoạt động tương tác trực tiếp của người dùng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "paymentMethodDisplayInfo": { object ( |
Trường | |
---|---|
paymentMethodDisplayInfo |
Thông tin hiển thị của phương thức thanh toán đã sử dụng cho giao dịch. |
paymentMethodProvenance |
Nguồn gốc của phương thức thanh toán được 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 mà đơ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 ( |
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ụ: Tài khoản thanh toán VISA **** 1234 **** 5678 |
paymentMethodVoiceName |
Tên phương thức thanh toán sẽ được đọc to cho người dùng trên các thiết bị chỉ có trợ lý thoại. Ví dụ: "visa kết thúc bằng một hai ba bốn" hoặc "kiểm tra tài khoản có các số cuối là 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 dùng thay cho paymentMethodDisplayName cho các thiết bị chỉ có trợ lý thoại. Nếu bạn không đặt chuỗi này, thì paymentMethodDisplayName sẽ được đọc với người dùng. |
PaymentType
PaymentType cho biết phương thức thanh toán được sử 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à một tài khoản ngân hàng. |
LOYALTY_PROGRAM |
Phương thức thanh toán là 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ụ: PayPal |
PaymentMethodProvenance
Thể hiện nguồn gốc của phương thức thanh toán được dùng cho giao dịch.
Enum | |
---|---|
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED |
Chứng từ chưa xác định. |
PAYMENT_METHOD_PROVENANCE_GOOGLE |
Provenance là của Google. |
PAYMENT_METHOD_PROVENANCE_MERCHANT |
Provenance là người bán. |
Khuyến mãi
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 } |
Trường | |
---|---|
coupon |
Bắt buộc: Mã giảm giá á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. Các thuộc tính này có thể áp dụng cho tất cả mục hàng bên trong đơn đặt hàng, trừ khi bị ghi đè trong mục hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "status": enum ( |
Trường | |
---|---|
status |
Bắt buộc: Trạng thái chung cho đơn đặt hàng. |
userVisibleStatusLabel |
Nhãn/chuỗi 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 trả lại hàng của đơn đặt hàng. |
fulfillmentInfo |
Thông tin thực hiện đơn đặt hàng. |
purchaseLocationType |
Địa điểm mua hàng (tại cửa hàng / trực tuyến) |
errors[] |
Không bắt buộc: Các lỗi khiến đơ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ỳ vào trường hợp/tình huống sử dụng, hãy cân nhắc một trong những cách sau: 1. Xác định các trường trong PurchaseOrderExtension nếu nó có thể được sử dụng cho các trường hợp sử dụng khác (ví dụ: chức năng/chức năng chung). 2. Sử dụng portrait_extension nếu công cụ 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. Một đối tượng có chứa các trường thuộc loại 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 được mua trực tuyến. |
INSTORE_PURCHASE |
Tất cả giao dịch mua tại cửa hàng. |
PurchaseError
Lỗi mà đơn đặt hàng có thể bị từ chối.
Biểu diễn dưới dạng JSON | |
---|---|
{ "type": enum ( |
Trường | |
---|---|
type |
Bắt buộc: Phần này cho biết lý do chi tiết khiến người bán từ chối đơn đặt hàng. |
description |
Nội dung mô tả bổ sung 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 |
Phù hợp trong trường hợp xảy ra loại lỗi PRICE_CHANGED / INTRUE_PRICE. |
availableQuantity |
Số lượng hàng hiện có. Có thể áp dụng trong trường hợp có long_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ể, có thể là Mục, FulfillmentOption, Quảng cáo. Cần có mã nhận dạng thực thể. |
INVALID |
Dữ liệu thực thể không hợp lệ. có thể là Item, FulfillmentOption, promotion. Cần có mã nhận dạng thực thể. |
AVAILABILITY_CHANGED |
Mặt hàng không có sẵn hoặc không có đủ mặt hàng để đáp ứng yêu cầu. Cần 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ể mặt hàng. Bạn phải cung cấp 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ạn phải cung cấp mã nhận dạng thực thể và giá mới. |
REQUIREMENTS_NOT_MET |
Những giới hạn khi chấp nhận đơn đặt hàng không đáp ứng yêu cầu – 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 áp dụng được loại lỗi chi tiết nào. |
NO_COURIER_AVAILABLE |
Không tìm thấy công ty chuyển phát nhanh nào. 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 (danh sách đen). |
OUT_OF_SERVICE_AREA |
Không thể giao hàng tới địa chỉ được 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 gọi món. |
PROMO_NOT_APPLICABLE |
Mã lỗi chung để phát hiện tất cả các 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 dưới dạng Mã nhận dạng thực thể. |
PROMO_NOT_RECOGNIZED |
Đối tác không nhận ra mã giảm giá. Thêm mã khuyến mãi dưới dạng 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 dưới dạng 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 dưới dạng 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 dưới dạng Mã nhận dạng thực thể. |
UNAVAILABLE_SLOT |
Không có khung giờ đặt hàng trước. |
FAILED_PRECONDITION |
Những giới hạn khi chấp nhận đơn đặt hàng không đáp ứng yêu cầu – 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ể liên hệ với 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 khi thực hiện. |
TicketOrderExtension
Đặt nội dung cho các đơn đặt hàng vé như phim, chương trình thể thao, v.v.
Biểu diễn dưới dạng JSON | |
---|---|
{
"ticketEvent": {
object ( |
Trường | |
---|---|
ticketEvent |
Sự kiện này đã á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 duy nhất.
Biểu diễn dưới dạng JSON | |
---|---|
{ "type": enum ( |
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 sự kiện. Ví dụ: nếu sự kiện là một bộ phim, đâ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 nơi sự kiện đang diễn ra hoặc có trụ sở của một tổ chức. |
eventCharacters[] |
Các nhân vật 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 điện ảnh hay 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 vào cửa, 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 giờ vào cửa là 8: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 ký 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 ( |
Trường | |
---|---|
type |
Loại ký 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 |
Actor (Diễn viên). |
PERFORMER |
Người thực hiện. |
DIRECTOR |
Đạo diễn. |
ORGANIZER |
Người tổ chức. |
UserNotification
Thông báo không bắt buộc dành cho người dùng để hiển thị trong quá trình cập nhật Đơn đặt hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "text": string } |
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 cần thực thi tiếp theo.
Biểu diễn dưới dạng JSON | |
---|---|
{ "name": string } |
Trường | |
---|---|
name |
Tên của cảnh sẽ được 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 ( |
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ế độ chỉ đọc. |
params |
Bắt buộc. Danh sách tất cả các thông số được thu thập từ các biểu mẫu và ý định trong phiên hoạt động. 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. Các thông số có giá trị rỗng sẽ bị xoá khỏi phiên hoạt động. Xem tài liệu về bộ nhớ 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. Loại phiên được xác định 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ữ IETF BCP-47 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 xử lý_response.expected.language_code được đặt, ngôn ngữ cuộc trò chuyện sẽ thay đổi trong tất cả các lượt tiếp theo. Điều này sẽ được phản ánh trong trường này. |
TypeOverride
Biểu thị cơ chế ghi đè cho một loại.
Biểu diễn dưới dạng JSON | |
---|---|
{ "name": string, "mode": enum ( |
Trường | |
---|---|
name |
Bắt buộc. Tên của loại cần bổ sung hoặc thay thế. |
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 chỉ định. Tuyệt đối không sử dụng giá trị này. |
TYPE_REPLACE |
Các định nghĩa về kiểu trong phản hồi này sẽ thay thế các định nghĩa về kiểu đã đượ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 đó. Các định nghĩa về loại mới sẽ thay thế các định nghĩa về loại hiện có. |
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 ( |
Trường | |
---|---|
entries[] |
Bắt buộc. Danh sách các mục cho loại từ đồng nghĩa. |
Mục nhập
Đạ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 ( |
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 công nhận 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. Mục này cho thấy thông tin của mặt hàng. |
EntryDisplay
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "description": string, "image": { object ( |
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 vào cuộc trò chuyện như thể người dùng đã nhập văn bản đó. Mỗi tiêu đề phải là duy nhất trong số 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, được hiển thị bên dưới mô tả. Một dòng văn bản, được 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 đang duyệt qua. Bắt buộc để duyệt qua băng chuyền. |
Người dùng
Thể hiện việc người dùng gửi yêu cầu đối với Hành động.
Biểu diễn dưới dạng JSON | |
---|---|
{ "locale": string, "params": { string: value, ... }, "accountLinkingStatus": enum ( |
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ữ 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. |
params |
Không bắt buộc. Danh sách tất cả các thông số được liên kết với 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ầ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 theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 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 lượt đăng ký ý đị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. Hãy 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 trên các cuộc trò chuyện bằng cách sử dụng trường thông số hoặc thông qua tính năng 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ế độ chỉ có thể đọc về những cơ chế tương tác mà người dùng hiện tại đã đăng ký. Ví dụ: bạn có thể biết được người dùng đã đăng ký những ý định nào để tránh yêu cầu họ đăng ký lại cùng một ý định. Tức là, bạn chỉ có thể dùng thông tin này để chuyển hướng có điều kiện đến một cảnh nhằm thiết lập Daily Updates 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 ( |
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 } |
Trường | |
---|---|
intent |
Tên của ý định được đăng ký. |
contentTitle |
Nội dung mô tả ngắn về gói thuê bao. Nhãn 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 kỹ thuật số cho hàng hoá: 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 ( |
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 đã cung cấp. |
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.
Biểu diễn dưới dạng JSON | |
---|---|
{ "sku": string, "skuType": enum ( |
Trường | |
---|---|
sku |
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. 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 |
Kênh đăng ký |
APP |
Ứng dụng có tính phí |
SignedData
Biểu diễn dưới dạng JSON | |
---|---|
{ "inAppPurchaseData": { object }, "inAppDataSignature": string } |
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 của https://developer.android.com/google/play/billing/billing_reference.html. |
inAppDataSignature |
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. |
Quyền
Các giá trị có thể dùng cho quyền.
Enum | |
---|---|
PERMISSION_UNSPECIFIED |
Quyền không xác định. |
DEVICE_PRECISE_LOCATION |
Yêu cầu người dùng cung cấp vị trí chính xác, vĩ độ/kinh độ và địa chỉ đã định 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 bản cập nhật. Hãy xem https://developers.google.com/assistant/engagement/daily. |
Trang chủ
Biểu thị cấu trúc HomeGraph chứa 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, ... } } |
Trường | |
---|---|
params |
Không bắt buộc. Danh sách các tham số liên kết với cấu trúc HomeGraph mà thiết bị mục tiêu thuộc về. Hãy xem tài liệu về bộ nhớ của 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ị
Biểu thị 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 ( |
Trường | |
---|---|
capabilities[] |
Bắt buộc. khả năng của thiết bị khi gửi yêu cầu đến 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í. Hãy xem thông báo về vị trí để biết thêm chi tiết về việc trường nào được đặt tùy thuộc vào quyền tương đối và quyền chi tiết. Hãy xem tài liệu về quyền: 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. Phương thức này có thể được dùng để phân giải giá trị ngày giờ. |
Chức năng
Các tính năng mà nền tảng thiết bị hỗ trợ tại thời điểm yêu cầu.
Enum | |
---|---|
UNSPECIFIED |
Chức năng thiết bị chưa xác định. |
SPEECH |
Thiết bị có thể nói chuyện 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ể cho thấy các câu trả lời đa dạng thức 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 phản hồ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ớ tại 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 ( |
Trường | |
---|---|
coordinates |
Toạ độ địa lý. Yêu cầu quyền [DEVICE_PRECISE_LOCATION]. |
postalAddress |
Địa chỉ bưu chính. Yêu cầu quyền [DEVICE_PRECISE_LOCATION] hoặc [DEVICE_COARSE_LOCATION]. Khi quyền truy cập thông tin vị trí tương đối được cấp, chỉ có "postalCode" và "địa phương" dự kiến sẽ được điền sẵn. 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 như "AdministrativeArea" và "addressLines". |
TimeZone
Biểu thị một múi giờ từ Cơ sở dữ liệu múi giờ IANA.
Biểu diễn dưới dạng JSON | |
---|---|
{ "id": string, "version": string } |
Trường | |
---|---|
id |
Múi giờ của cơ sở dữ liệu múi giờ IANA, ví dụ: "Mỹ/New_ York". |
version |
Không bắt buộc. Số phiên bản của Cơ sở dữ liệu múi giờ IANA, ví dụ: "2019a". |
Bối cảnh
Chứa thông tin về bối cảnh khi người dùng tìm kiếm. Bối cảnh đó bao gồm nhưng không giới hạn ở thông tin về phiên phát nội dung nghe nhìn đang hoạt động, trạng thái của ứng dụng web canvas, v.v.
Biểu diễn dưới dạng JSON | |
---|---|
{ "media": { object ( |
Trường | |
---|---|
media |
Chứa thông tin theo bối cảnh về phiên phát nội dung nghe nhì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 theo bối cảnh về phiên phát nội dung nghe nhìn đang hoạt động.
Biểu diễn dưới dạng JSON | |
---|---|
{ "progress": string, "index": integer } |
Trường | |
---|---|
progress |
Tiến trình phát nội dung nghe nhì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 với 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 tệp nội dung nghe nhìn trong phản hồi về 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 } |
Trường | |
---|---|
state |
Không bắt buộc. Trạng thái do ứng dụng Canvas tương tác 3P đặt. Tuỳ chọn này chỉ được đặt cho yêu cầu, chứ không phải cho phản hồi. Ví dụ: nếu đây là một ứng dụng cung cấp công thức nấu ăn, thì trạng thái có thể là giá trị của cấu trúc: { "current_page" : 5, "trang_cuối" : 3, } Giới hạn kích thước là 50KB. |
Dự kiến
Mô tả kỳ vọng cho vòng quay hộp thoại tiếp theo.
Biểu diễn dưới dạng JSON | |
---|---|
{ "speech": [ string ] } |
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 để xác định xu hướng lời nói. Bạn có thể nhập tối đa 1.000 cụm từ. Lưu ý: Trường này có ý nghĩa tương tự như múi dự kiến input.speech_biasing_hints trong API phiên bản 2. |