Method: fulfill

RPC ที่แสดง Fulfillment API

คำขอ HTTP

POST https://webhook_handler_service.googleapis.com/fulfill

URL ใช้ไวยากรณ์การแปลง gRPC

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "handler": {
    object (Handler)
  },
  "intent": {
    object (Intent)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "context": {
    object (Context)
  }
}
ช่อง
handler

object (Handler)

ต้องระบุ ข้อมูลที่จะดำเนินการตามคำขอเพื่อจัดการคำขอ เช่น คำขอที่ตั้งใจจะดึงข้อเท็จจริงอาจมีเครื่องจัดการที่ใช้ชื่อว่า "getFact"
intent

object (Intent)

ต้องระบุ แสดงความตั้งใจที่ตรงกันล่าสุด โปรดดู https://developers.google.com/assistant/conversational/intents
scene

object (Scene)

ไม่บังคับ ข้อมูลเกี่ยวกับฉากปัจจุบันและฉากถัดไปเมื่อมีการเรียกใช้ฟังก์ชัน จะได้รับการตอบสนองเมื่อเรียกใช้การดำเนินการตามคำสั่งซื้อภายในขอบเขตของฉาก โปรดดูที่ https://developers.google.com/assistant/conversational/scenes
session

object (Session)

ต้องระบุ เก็บข้อมูลเซสชัน เช่น รหัสเซสชันและพารามิเตอร์เซสชัน
user

object (User)

ต้องระบุ ผู้ใช้ที่เริ่มต้นการสนทนา
home

object (Home)

ไม่บังคับ ข้อมูลที่เกี่ยวข้องกับโครงสร้าง HomeGraph ที่มีอุปกรณ์เป้าหมายอยู่ โปรดดู https://developers.google.com/actions/smarthome/concepts/homegraph
device

object (Device)

ต้องระบุ ข้อมูลในอุปกรณ์ที่ผู้ใช้ใช้เพื่อโต้ตอบกับการดำเนินการ
context

object (Context)

ไม่บังคับ ข้อมูลบริบทปัจจุบันของคำขอ ซึ่งรวมถึงแต่ไม่จำกัดเพียงข้อมูลเซสชันสื่อที่ใช้งานอยู่หรือข้อมูล Canvas

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

หมายถึงคำตอบที่ส่งจากการดำเนินการตามการดำเนินการของนักพัฒนาแอปไปยัง Actions on Google

การแสดง JSON 
{
  "prompt": {
    object (Prompt)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "expected": {
    object (Expected)
  }
}
ช่อง
prompt

object (Prompt)

ไม่บังคับ แสดงข้อความแจ้งที่จะส่งไปยังผู้ใช้ ข้อความแจ้งเหล่านี้จะต่อท้ายข้อความที่เพิ่มก่อนหน้านี้ ยกเว้นกรณีที่มีการเขียนทับอย่างชัดเจน
scene

object (Scene)

ไม่บังคับ แสดงฉากปัจจุบันและฉากถัดไป หากตั้งค่า Scene.next ไว้ รันไทม์จะเปลี่ยนเป็นโหมดที่ระบุทันที
session

object (Session)

ไม่บังคับ อธิบายข้อมูลสำหรับเซสชันปัจจุบัน Fulfillment จะสร้าง อัปเดต หรือนำพารามิเตอร์เซสชันออกได้
user

object (User)

ไม่บังคับ ใช้เพื่อระบุพารามิเตอร์ผู้ใช้ที่จะส่งกลับ
home

object (Home)

ไม่บังคับ ใช้เพื่อระบุพารามิเตอร์ที่เกี่ยวข้องกับโครงสร้าง HomeGraph ที่มีอุปกรณ์เป้าหมายอยู่ โปรดดู https://developers.google.com/actions/smarthome/concepts/homegraph
device

object (Device)

ไม่บังคับ ใช้เพื่อย้ายไปมาระหว่างอุปกรณ์ Assistant ที่ผู้ใช้มีสิทธิ์เข้าถึง
expected

object (Expected)

ไม่บังคับ อธิบายความคาดหวังสำหรับการเปลี่ยนกล่องโต้ตอบครั้งถัดไป

ตัวแฮนเดิล

แสดงเครื่องจัดการการดำเนินการตามคำสั่งซื้อที่แมปข้อมูลเหตุการณ์จาก Actions on Google กับการดำเนินการตามคำสั่งซื้อ ใช้ชื่อเครื่องจัดการเพื่อกำหนดโค้ดที่คุณควรเรียกใช้ใน Fulfillment ตัวอย่างเช่น อาจมีการใช้เครื่องจัดการเพื่อรับข้อมูลเกี่ยวกับข้อมูลคำสั่งซื้อของผู้ใช้ที่มีชื่อตัวแฮนเดิล เช่น "OrderLookup" ในขณะที่อีกรายหนึ่งอาจรับข้อมูลผลิตภัณฑ์จากฐานข้อมูล โดยมีชื่อเครื่องจัดการ เช่น "GetProductInfo"

การแสดง JSON 
{
  "name": string
}
ช่อง
name

string

ไม่บังคับ ชื่อของเครื่องจัดการ

ความตั้งใจ

แสดงถึงความตั้งใจ โปรดดู https://developers.google.com/assistant/conversational/intents

การแสดง JSON 
{
  "name": string,
  "params": {
    string: {
      object (IntentParameterValue)
    },
    ...
  },
  "query": string
}
ช่อง
name

string

ต้องระบุ ชื่อของความตั้งใจที่ตรงกันล่าสุด
params

map (key: string, value: object (IntentParameterValue))

ต้องระบุ แสดงพารามิเตอร์ที่ระบุว่าเป็นส่วนหนึ่งของการจับคู่ Intent นี่คือการแมปชื่อพารามิเตอร์ที่ระบุกับค่าพารามิเตอร์ที่ระบุจากข้อมูลจากผู้ใช้ พารามิเตอร์ทั้งหมดที่กำหนดไว้ในความตั้งใจที่ตรงกันซึ่งระบุไว้จะแสดงที่นี่

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
query

string

ไม่บังคับ ข้อความที่พิมพ์หรือพูดจากผู้ใช้ปลายทางที่ตรงกับความตั้งใจนี้ ระบบจะป้อนข้อมูลนี้เมื่อมีการจับคู่ Intent ตามข้อมูลจากผู้ใช้

IntentParameterValue

แสดงค่าของพารามิเตอร์ Intent โปรดดู https://developers.google.com/assistant/conversational/types

การแสดง JSON 
{
  "original": string,
  "resolved": value
}
ช่อง
original

string

ต้องระบุ ค่าข้อความต้นฉบับที่ดึงมาจากคำพูดของผู้ใช้
resolved

value (Value format)

ต้องระบุ ค่าที่มีโครงสร้างสำหรับพารามิเตอร์ที่ดึงมาจากข้อมูลของผู้ใช้ ข้อมูลนี้จะแสดงก็ต่อเมื่อมีการกำหนดพารามิเตอร์ไว้ในความตั้งใจที่ตรงกันและระบุค่าพารามิเตอร์ได้ในระหว่างการจับคู่ Intent

บรรยากาศ

นำเสนอฉาก ฉากสามารถเรียกใช้ Fulfillment เพิ่มข้อความแจ้ง และรวบรวมค่าช่องโฆษณาจากผู้ใช้ ฉากจะทริกเกอร์ตามเหตุการณ์หรือ Intent และสามารถทริกเกอร์เหตุการณ์และจับคู่ Intent เพื่อเปลี่ยนไปเป็นฉากอื่นๆ ได้

การแสดง JSON 
{
  "name": string,
  "slotFillingStatus": enum (SlotFillingStatus),
  "slots": {
    string: {
      object (Slot)
    },
    ...
  },
  "next": {
    object (NextScene)
  }
}
ช่อง
name

string

ต้องระบุ ชื่อของฉากปัจจุบัน
slotFillingStatus

enum (SlotFillingStatus)

ต้องระบุ สถานะปัจจุบันของการเติมช่อง ช่องนี้เป็นแบบอ่านอย่างเดียว
slots

map (key: string, value: object (Slot))

สล็อตที่เชื่อมโยงกับฉากปัจจุบัน คำตอบของเครื่องจัดการไม่สามารถแสดงผลสล็อตที่ไม่ได้ส่งในคำขอ

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
next

object (NextScene)

ไม่บังคับ ข้อมูลในฉากที่ต้องดำเนินการเป็นลำดับถัดไป

SlotFillingStatus

แสดงสถานะปัจจุบันของการเติมช่องโฆษณา

Enum
UNSPECIFIED ค่าสำรองเมื่อไม่ได้ใส่ข้อมูลในช่องการใช้งาน
INITIALIZED เริ่มต้นสล็อตแล้ว แต่การเติมช่องโฆษณายังไม่เริ่ม
COLLECTING กำลังรวบรวมค่าของช่องโฆษณา
FINAL ค่าของช่องทั้งหมดเป็นค่าสุดท้ายและเปลี่ยนแปลงไม่ได้

สล็อต

แสดงช่องโฆษณา

การแสดง JSON 
{
  "mode": enum (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}
ช่อง
mode

enum (SlotMode)

โหมดของช่อง (จำเป็นหรือไม่บังคับ) ตั้งค่าได้โดยนักพัฒนาซอฟต์แวร์
status

enum (SlotStatus)

สถานะของช่องโฆษณา
value

value (Value format)

มูลค่าของช่อง การเปลี่ยนค่านี้ในคำตอบจะเป็นการแก้ไขค่าในการเติมช่องโฆษณา
updated

boolean

ระบุว่ามีการรวบรวมค่าช่องโฆษณาในการเลี้ยวล่าสุดหรือไม่ ช่องนี้เป็นแบบอ่านอย่างเดียว
prompt

object (Prompt)

ไม่บังคับ ระบบจะส่งข้อความแจ้งนี้ไปยังผู้ใช้เมื่อจำเป็นต้องเติมช่องโฆษณาลงในช่องที่กำหนด ข้อความแจ้งนี้จะลบล้างข้อความแจ้งที่มีอยู่ซึ่งกำหนดไว้ในคอนโซล ช่องนี้ไม่รวมอยู่ในคำขอเว็บฮุค

SlotMode

แสดงโหมดของช่อง นั่นคือ ระบุว่าจำเป็นหรือไม่

Enum
MODE_UNSPECIFIED ค่าสำรองเมื่อไม่ได้ใส่ข้อมูลในช่องการใช้งาน
OPTIONAL บ่งบอกว่าไม่จำเป็นต้องเติมช่องเพื่อเติมช่องให้สมบูรณ์
REQUIRED บ่งบอกว่าต้องเติมช่องเพื่อเติมช่องให้สมบูรณ์

SlotStatus

แสดงสถานะของช่องโฆษณา

Enum
SLOT_UNSPECIFIED ค่าสำรองเมื่อไม่ได้ใส่ข้อมูลในช่องการใช้งาน
EMPTY บ่งบอกว่าช่องโฆษณาไม่มีค่าใดๆ คุณจะแก้ไขสถานะนี้ผ่านคำตอบไม่ได้
INVALID บ่งบอกว่าค่าของช่องไม่ถูกต้อง คุณตั้งค่าสถานะนี้ได้ผ่านการตอบกลับ
FILLED บ่งบอกว่าช่องโฆษณามีค่า คุณจะแก้ไขสถานะนี้ผ่านคำตอบไม่ได้

พรอมต์

แสดงคำตอบต่อผู้ใช้ โปรดดูที่ https://developers.google.com/assistant/conversational/prompts

การแสดง JSON 
{
  "override": boolean,
  "firstSimple": {
    object (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  },
  "orderUpdate": {
    object (OrderUpdate)
  }
}
ช่อง
override

boolean

ไม่บังคับ โหมดสำหรับวิธีผสานข้อความนี้กับข้อความที่กำหนดไว้ก่อนหน้า "จริง" ล้างข้อความที่กำหนดไว้ก่อนหน้านี้ทั้งหมด (แบบง่ายและสุดท้ายคือเนื้อหา ลิงก์คำแนะนำ และ Canvas) และเพิ่มข้อความที่กำหนดไว้ในพรอมต์นี้ "เท็จ" เพิ่มข้อความที่ระบุไว้ในพรอมต์นี้ไปยังข้อความที่กำหนดไว้ในคำตอบก่อนหน้า ออกจากฟิลด์นี้เป็น "เท็จ" ยังเปิดใช้การต่อท้ายบางช่องภายในพรอมต์แบบง่าย พรอมต์คำแนะนำ และข้อความแจ้งของ Canvas (ส่วนหนึ่งของพรอมต์เนื้อหา) ด้วย ข้อความ "เนื้อหา" และ "ลิงก์" จะถูกเขียนทับเสมอหากมีการกำหนดไว้ในข้อความแจ้ง ค่าเริ่มต้นคือ "false"
firstSimple

object (Simple)

ไม่บังคับ คำตอบแรกที่เป็นเสียงและข้อความเท่านั้น
content

object (Content)

ไม่บังคับ เนื้อหา เช่น การ์ด รายการ หรือสื่อที่จะแสดงต่อผู้ใช้
lastSimple

object (Simple)

ไม่บังคับ คำตอบแบบเสียงและข้อความสุดท้าย
suggestions[]

object (Suggestion)

ไม่บังคับ คำแนะนำที่แสดงต่อผู้ใช้ซึ่งจะปรากฏท้ายคำตอบเสมอ หากปุ่ม "ลบล้าง" ในช่องของข้อความแจ้งที่มีค่าเป็น "เท็จ" ระบบจะเพิ่มชื่อที่ระบุไว้ในช่องนี้ลงในชื่อที่กำหนดไว้ในพรอมต์คำแนะนำที่กำหนดไว้ก่อนหน้านี้และค่าที่ซ้ำกันจะถูกนำออก
canvas

object (Canvas)

ไม่บังคับ แสดงการตอบกลับ Interactive Canvas ที่จะส่งไปให้ผู้ใช้
orderUpdate

object (OrderUpdate)

การดำเนินการที่ไม่บังคับจะตอบกลับด้วย OrderUpdate หลังจากได้รับคำสั่งซื้อในระหว่างขั้นตอนธุรกรรม เมื่อได้รับข้อมูลนี้ Google จะบันทึกการอัปเดตนี้ไปยังคำสั่งซื้อ และหากดำเนินการสำเร็จ จะแสดงการ์ดใบเสร็จพร้อมกับ TTS ที่ส่งในอุปกรณ์แสดงผล

เรียบง่าย

หมายถึงข้อความแจ้งง่ายๆ ที่จะส่งถึงผู้ใช้ โปรดดูที่ https://developers.google.com/assistant/conversational/prompts-simple

การแสดง JSON 
{
  "speech": string,
  "text": string
}
ช่อง
speech

string

ไม่บังคับ หมายถึงคำพูดที่ผู้ใช้พูด อาจเป็น SSML หรือการอ่านออกเสียงข้อความ หากปุ่ม "ลบล้าง" ในช่องพรอมต์ที่มี "true" เสียงพูดที่ระบุไว้ในช่องนี้จะแทนที่เสียงพูดของพรอมต์แบบง่ายก่อนหน้า โปรดดู https://developers.google.com/assistant/conversational/ssml
text

string

ข้อความที่ไม่บังคับที่จะแสดงในบับเบิลแชท หากไม่ระบุ ระบบจะใช้การแสดงผลฟิลด์เสียงพูดด้านบน มีอักขระได้ไม่เกิน 640 ตัว หากปุ่ม "ลบล้าง" ในช่องพรอมต์ที่มี "true" ข้อความที่ระบุไว้ในช่องนี้จะแทนที่ข้อความพรอมต์แบบง่ายก่อนหน้า

เนื้อหา

ออบเจ็กต์คอนเทนเนอร์สำหรับพรอมต์ Rich Prompt หรือพรอมต์การเลือก

การแสดง JSON 
{

  // Union field content can be only one of the following:
  "card": {
    object (Card)
  },
  "image": {
    object (Image)
  },
  "table": {
    object (Table)
  },
  "media": {
    object (Media)
  },
  "collection": {
    object (Collection)
  },
  "list": {
    object (List)
  },
  "collectionBrowse": {
    object (CollectionBrowse)
  }
  // End of list of possible types for union field content.
}
ช่อง

ช่องการรวม content

content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
card

object (Card)

บัตรพื้นฐาน
image

object (Image)

รูปภาพ
table

object (Table)

การ์ดตาราง
media

object (Media)

การตอบกลับที่ระบุชุดสื่อที่จะเล่น
collection

object (Collection)

การ์ดแสดงชุดตัวเลือกที่มีให้เลือก
list

object (List)

การ์ดแสดงรายการตัวเลือกที่มีให้เลือก
collectionBrowse

object (CollectionBrowse)

การ์ดแสดงคอลเล็กชันหน้าเว็บที่จะเปิด

การ์ด

การ์ดพื้นฐานสำหรับแสดงข้อมูลบางอย่าง เช่น รูปภาพและ/หรือข้อความ โปรดดู https://developers.google.com/assistant/conversational/prompts-rich#basic_card

การแสดง JSON 
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (Image)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (Link)
  }
}
ช่อง
title

string

ชื่อโดยรวมของการ์ด ไม่บังคับ
subtitle

string

ไม่บังคับ
text

string

ข้อความเนื้อหาของการ์ด รองรับชุดไวยากรณ์มาร์กดาวน์สำหรับการจัดรูปแบบแบบจำกัด ต้องระบุ ยกเว้นกรณีที่มีรูปภาพอยู่
image

object (Image)

รูปภาพหลักของการ์ด ความสูงจำกัดไว้ที่ 192dp ไม่บังคับ
imageFill

enum (ImageFill)

วิธีเติมพื้นหลังของรูปภาพ ไม่บังคับ
button

object (Link)

ปุ่มที่มีลิงก์ขาออก ไม่บังคับ

รูปภาพ

รูปภาพที่แสดงในการ์ด โปรดดู https://developers.google.com/assistant/conversational/prompts-rich#image-cards

การแสดง JSON 
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
ช่อง
url

string

URL แหล่งที่มาของรูปภาพ รูปภาพสามารถใช้เป็น JPG, PNG และ GIF (ทั้งเป็นภาพเคลื่อนไหวและไม่เคลื่อนไหว) ตัวอย่างเช่นhttps://www.agentx.com/logo.png ต้องระบุ
alt

string

ข้อความอธิบายของรูปภาพที่จะใช้เพื่อการเข้าถึง เช่น โปรแกรมอ่านหน้าจอ ต้องระบุ
height

integer

ความสูงของรูปภาพเป็นพิกเซล ไม่บังคับ
width

integer

ความกว้างของรูปภาพเป็นพิกเซล ไม่บังคับ

ImageFill

ตัวเลือกการแสดงรูปภาพที่เป็นไปได้ซึ่งจะส่งผลต่อการนำเสนอรูปภาพ ควรใช้เมื่อสัดส่วนภาพของรูปภาพไม่ตรงกับสัดส่วนภาพของคอนเทนเนอร์รูปภาพ

Enum
UNSPECIFIED
GRAY เติมช่องว่างระหว่างรูปภาพและคอนเทนเนอร์รูปภาพด้วยแถบสีเทา
WHITE เติมช่องว่างระหว่างรูปภาพและที่เก็บรูปภาพด้วยแถบสีขาว
CROPPED มีการปรับขนาดรูปภาพเพื่อให้ความกว้างและความสูงของรูปภาพตรงกับหรือเกินขนาดของคอนเทนเนอร์ การดำเนินการนี้อาจครอบตัดด้านบนและด้านล่างของรูปภาพหากความสูงของรูปภาพที่มีการปรับขนาดมากกว่าความสูงของคอนเทนเนอร์ หรือครอบตัดด้านซ้ายและขวาของรูปภาพหากความกว้างของรูปภาพที่มีการปรับขนาดมากกว่าความกว้างของคอนเทนเนอร์ ซึ่งคล้ายกับ "โหมดซูม" บนทีวีจอกว้าง เมื่อเล่นวิดีโอ 4:3

OpenUrl

การแสดง JSON 
{
  "url": string,
  "hint": enum (UrlHint)
}
ช่อง
url

string

ฟิลด์ URL อาจเป็นรายการใดก็ได้ต่อไปนี้ - URL http/https สำหรับเปิดแอปที่ลิงก์กับแอปหรือหน้าเว็บ
hint

enum (UrlHint)

เป็นคำแนะนำสำหรับประเภท URL

UrlHint

คำแนะนำ URL ประเภทต่างๆ

Enum
AMP URL ที่ชี้ไปยังเนื้อหา AMP โดยตรง หรือไปยัง Canonical URL ซึ่งอ้างถึงเนื้อหา AMP ผ่าน ดู https://amp.dev/

ตาราง

การ์ดตารางสำหรับแสดงตารางข้อความ โปรดดู https://developers.google.com/assistant/conversational/prompts-rich#table_cards

การแสดง JSON 
{
  "title": string,
  "subtitle": string,
  "image": {
    object (Image)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (Link)
  }
}
ช่อง
title

string

ชื่อโดยรวมของตาราง ไม่บังคับ แต่ต้องตั้งค่าหากมีการตั้งค่าคำบรรยาย
subtitle

string

ชื่อรองของตาราง ไม่บังคับ
image

object (Image)

รูปภาพที่เชื่อมโยงกับตาราง ไม่บังคับ
columns[]

object (TableColumn)

ส่วนหัวและการจัดแนวคอลัมน์
rows[]

object (TableRow)

ข้อมูลแถวของตาราง เรารับประกันว่าแถว 3 แถวแรกจะแสดงขึ้น แต่บางแถวอาจถูกตัดออกในบางแพลตฟอร์ม โปรดทดสอบกับเครื่องจำลองเพื่อดูว่าจะแสดงแถวใดสำหรับแพลตฟอร์มหนึ่งๆ บนแพลตฟอร์มที่รองรับความสามารถ WEB_BROWSER คุณสามารถชี้ผู้ใช้ไปยังหน้าเว็บที่มีข้อมูลเพิ่มเติม
button

object (Link)

ปุ่ม

TableColumn

การแสดง JSON 
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
ช่อง
header

string

ข้อความส่วนหัวของคอลัมน์
align

enum (HorizontalAlignment)

การจัดแนวแนวนอนของเนื้อหาในคอลัมน์ หากไม่ระบุ เนื้อหาจะอยู่ในแนวเดียวกับขอบนำหน้า

HorizontalAlignment

การจัดแนวเนื้อหาภายในเซลล์

Enum
UNSPECIFIED
LEADING ขอบด้านการนำของเซลล์ โดยตัวเลือกนี้คือค่าเริ่มต้น
CENTER เนื้อหาจัดแนวกึ่งกลางคอลัมน์
TRAILING เนื้อหาอยู่ในแนวเดียวกับขอบด้านท้ายของคอลัมน์

TableRow

อธิบายแถวในตาราง

การแสดง JSON 
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
ช่อง
cells[]

object (TableCell)

เซลล์ในแถวนี้ ระบบรับประกันว่าจะแสดง 3 เซลล์แรก แต่เซลล์อื่นๆ อาจถูกตัดออกในบางพื้นผิว โปรดทดสอบด้วยเครื่องมือจำลองเพื่อดูว่าจะแสดงเซลล์ใดบนพื้นผิวที่กำหนด
divider

boolean

ระบุว่าควรมีตัวแบ่งหลังจากแต่ละแถวหรือไม่

TableCell

อธิบายเซลล์ในแถว

การแสดง JSON 
{
  "text": string
}
ช่อง
text

string

เนื้อหาข้อความของเซลล์

สื่อ

แสดงออบเจ็กต์สื่อ 1 รายการ มีข้อมูลเกี่ยวกับสื่อ เช่น ชื่อ คำอธิบาย URL ฯลฯ ดู https://developers.google.com/assistant/conversational/prompts-media

การแสดง JSON 
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode),
  "firstMediaObjectIndex": integer
}
ช่อง
mediaType

enum (MediaType)
startOffset

string (Duration format)

ออฟเซ็ตเริ่มต้นของออบเจ็กต์สื่อแรก

ระยะเวลาเป็นวินาทีโดยมีเลขเศษส่วนไม่เกิน 9 หลัก สิ้นสุดด้วย "s" ตัวอย่างเช่น "3.5s"
optionalMediaControls[]

enum (OptionalMediaControls)

ประเภทการควบคุมสื่อที่ไม่บังคับที่เซสชันการตอบสนองสื่อนี้รองรับได้ หากตั้งค่าไว้ จะมีการส่งคำขอไปยัง 3p เมื่อมีเหตุการณ์สื่อบางอย่างเกิดขึ้น หากไม่ได้ตั้งค่า 3p ยังคงต้องจัดการประเภทการควบคุมเริ่มต้น 2 ประเภท ได้แก่ FINISHED และ FAILED
mediaObjects[]

object (MediaObject)

รายการออบเจ็กต์สื่อ
repeatMode

enum (RepeatMode)

โหมดทำซ้ำสำหรับรายการออบเจ็กต์สื่อ
firstMediaObjectIndex

integer

ดัชนีแบบ 0 ของ Media Object แรกใน mediaObjects ที่จะเล่น หากไม่ระบุ ค่าเป็น 0 หรืออยู่นอกขอบเขต การเล่นจะเริ่มต้นที่ออบเจ็กต์สื่อแรกใน mediaObjects

MediaType

ประเภทสื่อของคำตอบนี้

Enum
MEDIA_TYPE_UNSPECIFIED
AUDIO ไฟล์เสียง
MEDIA_STATUS_ACK ตอบกลับเพื่อรับทราบรายงานสถานะสื่อ

OptionalMediaControls

ประเภทตัวควบคุมสื่อที่ไม่บังคับซึ่งการตอบกลับสื่อจะรองรับได้

Enum
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED ไม่ได้ระบุค่า
PAUSED เหตุการณ์ที่หยุดชั่วคราว ทริกเกอร์เมื่อผู้ใช้หยุดสื่อชั่วคราว
STOPPED หยุดกิจกรรมแล้ว ทริกเกอร์เมื่อผู้ใช้ออกจากเซสชัน 3p ระหว่างการเล่นสื่อ

MediaObject

แสดงออบเจ็กต์สื่อเดียว

การแสดง JSON 
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
ช่อง
name

string

ชื่อออบเจ็กต์สื่อนี้
description

string

คำอธิบายของออบเจ็กต์สื่อนี้
url

string

URL ที่ชี้ไปยังเนื้อหาสื่อ ไฟล์ MP3 ต้องโฮสต์บนเว็บเซิร์ฟเวอร์และเข้าถึงได้แบบสาธารณะผ่าน HTTPS URL สตรีมมิงแบบสดรองรับเฉพาะรูปแบบ MP3 เท่านั้น
image

object (MediaImage)

รูปภาพที่จะแสดงพร้อมการ์ดสื่อ

MediaImage

การแสดง JSON 
{

  // Union field image can be only one of the following:
  "large": {
    object (Image)
  },
  "icon": {
    object (Image)
  }
  // End of list of possible types for union field image.
}
ช่อง

ช่องการรวม image

image ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
large

object (Image)

รูปภาพขนาดใหญ่ เช่น ปกอัลบั้ม ฯลฯ
icon

object (Image)

ไอคอนรูปภาพขนาดเล็กที่แสดงอยู่ด้านขวาจากชื่อ โดยปรับขนาดเป็น 36x36 dp

RepeatMode

ประเภทของโหมดการเล่นซ้ำสำหรับรายการออบเจ็กต์สื่อ

Enum
REPEAT_MODE_UNSPECIFIED เทียบเท่ากับ "ปิด"
OFF สิ้นสุดเซสชันสื่อที่ตอนท้ายของออบเจ็กต์สื่อรายการสุดท้าย
ALL วนซ้ำไปยังจุดเริ่มต้นของออบเจ็กต์สื่อแรกเมื่อถึงจุดสิ้นสุดของออบเจ็กต์สื่อรายการสุดท้าย

คอลเล็กชัน

การ์ดสำหรับนำเสนอชุดตัวเลือกให้เลือก โปรดดู https://developers.google.com/assistant/conversational/prompts-selection#collection

การแสดง JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
ช่อง
title

string

ชื่อคอลเล็กชัน ไม่บังคับ
subtitle

string

คำบรรยายของคอลเล็กชัน ไม่บังคับ
items[]

object (CollectionItem)

รายการข้อมูล โดยมีค่าต่ำสุดเป็น 2 และไม่เกิน 10 รายการ
imageFill

enum (ImageFill)

วิธีเติมพื้นหลังรูปภาพของรายการคอลเล็กชัน ไม่บังคับ

CollectionItem

รายการในคอลเล็กชัน

การแสดง JSON 
{
  "key": string
}
ช่อง
key

string

ต้องระบุ คีย์ NLU ที่ตรงกับชื่อคีย์รายการในประเภทที่เชื่อมโยง

รายการ

การ์ดสำหรับแสดงรายการตัวเลือกที่มีให้เลือก ดู https://developers.google.com/assistant/conversational/prompts-selection#list

การแสดง JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
ช่อง
title

string

ชื่อรายการ ไม่บังคับ
subtitle

string

คำบรรยายของรายการ ไม่บังคับ
items[]

object (ListItem)

รายการข้อมูล โดยมีค่าต่ำสุดเป็น 2 และไม่เกิน 30 รายการ

ListItem

รายการข้อมูลในรายการ

การแสดง JSON 
{
  "key": string
}
ช่อง
key

string

ต้องระบุ คีย์ NLU ที่ตรงกับชื่อคีย์รายการในประเภทที่เชื่อมโยง

CollectionBrowse

นำเสนอชุดของเอกสารบนเว็บเป็นคอลเล็กชันของรายการขนาดใหญ่ อาจมีการเลือกรายการเพื่อเปิดเอกสารบนเว็บที่เกี่ยวข้องในโปรแกรมดูเว็บ โปรดดู https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse

การแสดง JSON 
{
  "items": [
    {
      object (Item)
    }
  ],
  "imageFill": enum (ImageFill)
}
ช่อง
items[]

object (Item)

รายการข้อมูล โดยมีค่าต่ำสุดเป็น 2 และไม่เกิน 10 รายการ
imageFill

enum (ImageFill)

ตัวเลือกประเภทการแสดงรูปภาพ

รายการ

รายการในคอลเล็กชัน

การแสดง JSON 
{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (Image)
  },
  "openUriAction": {
    object (OpenUrl)
  }
}
ช่อง
title

string

ต้องระบุ ชื่อรายการคอลเล็กชัน
description

string

คำอธิบายรายการคอลเล็กชัน
footer

string

ข้อความส่วนท้ายสำหรับรายการคอลเล็กชัน แสดงอยู่ด้านล่างคำอธิบาย ข้อความบรรทัดเดียวที่ตัดให้สั้นลงด้วยจุดไข่ปลา
image

object (Image)

รูปภาพสำหรับรายการคอลเล็กชัน
openUriAction

object (OpenUrl)

ต้องระบุ URI ที่จะเปิดหากรายการที่เลือก

คำแนะนำ

คำแนะนำช่วยให้ผู้ใช้ในอุปกรณ์ที่จอแสดงผลมีชิปคำแนะนำเมื่อ Assistant แสดงข้อความแจ้ง ใช้ชิปคำแนะนำเพื่อบอกใบ้คำตอบของผู้ใช้เพื่อทำต่อหรือสร้าง Pivot การสนทนา เมื่อแตะ ชิปคำแนะนำจะแสดงข้อความที่แสดงไปยังการสนทนาแบบคำต่อคำ ราวกับว่าผู้ใช้ได้พิมพ์ข้อความลงไป โปรดดู https://developers.google.com/assistant/conversational/prompts#suggestions

การแสดง JSON 
{
  "title": string
}
ช่อง
title

string

ต้องระบุ ข้อความที่แสดงในชิปคำแนะนำ เมื่อแตะ ข้อความนี้จะโพสต์กลับไปที่การสนทนาแบบคำต่อคำราวกับว่าผู้ใช้ได้พิมพ์ลงไป ชื่อแต่ละรายการต้องไม่ซ้ำกันในชุดชิปคำแนะนำ สูงสุด 25 อักขระ

ผ้าใบ

แสดงการตอบกลับ Interactive Canvas ที่จะส่งไปให้ผู้ใช้ ค่านี้สามารถใช้ร่วมกับ "firstSimple" ในข้อความแจ้งที่มีคำสั่งให้พูดกับผู้ใช้นอกเหนือจากการแสดงการตอบกลับ Canvas แบบอินเทอร์แอกทีฟ ขนาดสูงสุดของการตอบกลับคือ 50 กิโลไบต์ โปรดดู https://developers.google.com/assistant/interactivecanvas

การแสดง JSON 
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "continuousMatchConfig": {
    object (ContinuousMatchConfig)
  }
}
ช่อง
url

string

URL ของเว็บแอป Canvas แบบอินเทอร์แอกทีฟที่จะโหลด หากไม่ได้ตั้งค่า ระบบจะนำ URL จากแคนวาสที่ใช้งานอยู่มาใช้ซ้ำ
data[]

value (Value format)

ไม่บังคับ ข้อมูล JSON ที่จะส่งไปยังหน้าเว็บประสบการณ์แบบสมจริงเป็นเหตุการณ์ หากปุ่ม "ลบล้าง" ในช่องพรอมต์ที่มีอยู่มีค่าเป็น "เท็จ" ระบบจะเพิ่มค่าข้อมูลที่กําหนดไว้ในข้อความแจ้งของ Canvas นี้หลังจากค่าข้อมูลที่กําหนดไว้ในข้อความแจ้งก่อนหน้าของ Canvas
suppressMic

boolean

ไม่บังคับ ค่าเริ่มต้น: false
continuousMatchConfig

object (ContinuousMatchConfig)

การกำหนดค่าที่ใช้เพื่อเริ่มโหมดการจับคู่แบบต่อเนื่อง

ContinuousMatchConfig

การกำหนดค่าที่ใช้เพื่อเริ่มโหมดการจับคู่แบบต่อเนื่อง

การแสดง JSON 
{
  "expectedPhrases": [
    {
      object (ExpectedPhrase)
    }
  ],
  "durationSeconds": integer
}
ช่อง
expectedPhrases[]

object (ExpectedPhrase)

วลีที่คาดหวังทั้งหมดที่เป็นไปได้ในเซสชันโหมดการจับคู่แบบต่อเนื่องนี้
durationSeconds

integer

ระยะเวลาที่อยู่ในโหมดจับคู่แบบต่อเนื่อง หากระบุ ไมโครโฟนจะปิดเมื่อหมดเวลา ค่าสูงสุดที่อนุญาตคือ 180

ExpectedPhrase

การแสดง JSON 
{
  "phrase": string,
  "alternativePhrases": [
    string
  ]
}
ช่อง
phrase

string

วลีที่จะจับคู่ระหว่างเซสชันโหมดการจับคู่แบบต่อเนื่อง
alternativePhrases[]

string

บางวลีอาจจดจำคำพูดไม่ถูกต้องแม้ว่าจะมีการให้น้ำหนักพิเศษในการพูดก็ตาม วิธีนี้ช่วยให้นักพัฒนาซอฟต์แวร์ระบุทริกเกอร์อื่นๆ สำหรับคำพ้องความหมายได้

OrderUpdate

การอัปเดตคำสั่งซื้อ

การแสดง JSON 
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
ช่อง
type
(deprecated)

enum (Type)

เลิกใช้งานแล้ว: ใช้ OrderUpdate.update_mask แทน หากประเภท = SNAPSHOT นั้น OrderUpdate.order ควรเป็นคำสั่งซื้อทั้งหมด หากประเภท = ORDER_STATUS นี่เป็นการเปลี่ยนแปลงสถานะระดับการสั่งซื้อ ระบบจะเลือกเฉพาะ order.last_update_time และสถานะประเภทธุรกิจนี้ หมายเหตุ: type.ORDER_STATUS สนับสนุนเฉพาะการอัปเดตสถานะ PurcahaseOrderExtension และไม่มีแผนที่จะขยายการสนับสนุนนี้ แต่เราขอแนะนำให้ใช้ updateMask แทน เนื่องจากมีความแพร่หลาย ขยายการใช้งานได้ และใช้ได้กับธุรกิจทุกประเภท
order

object (Order)
updateMask

string (FieldMask format)

หมายเหตุ: มีข้อควรพิจารณา/คำแนะนำต่อไปนี้สำหรับช่องพิเศษต่อไปนี้ 1. order.last_update_time จะอัปเดตเป็นส่วนหนึ่งของคำขออัปเดตเสมอ 2. order.create_time, order.google_order_id และ order.merchant_order_id จะถูกละเว้นถ้าระบุไว้เป็นส่วนหนึ่งของ updateMask

ซึ่งเป็นรายการชื่อที่ตรงตามเกณฑ์ทั้งหมดของช่องที่คั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"
userNotification

object (UserNotification)

หากระบุไว้ จะแสดงการแจ้งเตือนแก่ผู้ใช้พร้อมด้วยชื่อและข้อความที่ระบุ การระบุการแจ้งเตือนเป็นคำแนะนำในการแจ้งเตือน และไม่รับประกันว่าจะทำให้คุณได้รับการแจ้งเตือน
reason

string

เหตุผลในการเปลี่ยนแปลง/อัปเดต

ประเภท

เลิกใช้งานแล้ว: ใช้ OrderUpdate.update_mask แทน อนุญาตให้อัปเดตคำสั่งซื้อ

Enum
TYPE_UNSPECIFIED ยังไม่ระบุประเภท ไม่ควรตั้งค่าอย่างชัดแจ้ง
ORDER_STATUS อัปเดตสถานะของคำสั่งซื้อเท่านั้น
SNAPSHOT อัปเดตภาพรวมคำสั่งซื้อ

สั่งซื้อ

เอนทิตีคำสั่งซื้อ หมายเหตุ: 1. สตริงทั้งหมดในทุกระดับต้องมีอักขระน้อยกว่า 1,000 ตัว เว้นแต่จะระบุไว้เป็นอย่างอื่น 2. ช่องที่ซ้ำทั้งหมดในทุกระดับต้องมีจำนวนน้อยกว่า 50 รายการ เว้นแต่จะระบุไว้เป็นอย่างอื่น 3. หากระบุไว้ การประทับเวลาทั้งหมดในทุกระดับจะต้องเป็นการประทับเวลาที่ถูกต้อง

การแสดง JSON 
{
  "googleOrderId": string,
  "merchantOrderId": string,
  "userVisibleOrderId": string,
  "userVisibleStateLabel": string,
  "buyerInfo": {
    object (UserInfo)
  },
  "image": {
    object (Image)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "transactionMerchant": {
    object (Merchant)
  },
  "contents": {
    object (Contents)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "paymentData": {
    object (PaymentData)
  },
  "termsOfServiceUrl": string,
  "note": string,
  "promotions": [
    {
      object (Promotion)
    }
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseOrderExtension)
  },
  "ticket": {
    object (TicketOrderExtension)
  }
  // End of list of possible types for union field verticals.
}
ช่อง
googleOrderId

string

รหัสคำสั่งซื้อที่ Google กำหนด
merchantOrderId

string

ต้องระบุ: รหัสคำสั่งซื้อภายในที่ผู้ขายกำหนด รหัสนี้ต้องไม่ซ้ำกัน และจำเป็นสำหรับการดำเนินการอัปเดตคำสั่งซื้อในครั้งต่อๆ ไป โดยอาจกำหนดเป็น googleOrderId ที่ระบุ หรือค่าที่ไม่ซ้ำกันอื่นๆ โปรดทราบว่ารหัสที่แสดงแก่ผู้ใช้คือ userVisibleOrderId ซึ่งอาจจะเป็นค่าอื่นที่ใช้งานง่ายกว่า ความยาวสูงสุดคือ 128 อักขระ
userVisibleOrderId

string

รหัสที่แสดงต่อผู้ใช้ซึ่งอ้างอิงถึงคำสั่งซื้อปัจจุบัน รหัสนี้ควรสอดคล้องกับรหัสที่แสดงสำหรับคำสั่งซื้อนี้ในบริบทอื่นๆ รวมถึงเว็บไซต์ แอป และอีเมล
userVisibleStateLabel
(deprecated)

string

เลิกใช้งานแล้ว: ใช้สถานะ Orderชิ้นงานแทน ป้ายกำกับที่ปรากฏต่อผู้ใช้สำหรับสถานะของคำสั่งซื้อนี้
buyerInfo

object (UserInfo)

ข้อมูลเกี่ยวกับผู้ซื้อ
image

object (Image)

รูปภาพที่เชื่อมโยงกับคำสั่งซื้อ
createTime

string (Timestamp format)

ต้องระบุ: วันที่และเวลาที่สร้างคำสั่งซื้อ

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
lastUpdateTime

string (Timestamp format)

วันที่และเวลาอัปเดตคำสั่งซื้อครั้งล่าสุด จำเป็นสำหรับการอัปเดตคำสั่งซื้อ

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
transactionMerchant

object (Merchant)

ผู้ขายที่อำนวยความสะดวกในการชำระเงิน ซึ่งอาจแตกต่างจากผู้ให้บริการระดับรายการโฆษณา ตัวอย่าง: คำสั่งซื้อ Expedia พร้อมรายการโฆษณาจาก ANA
contents

object (Contents)

ต้องระบุ: สั่งซื้อเนื้อหาที่เป็นกลุ่มรายการโฆษณา
priceAttributes[]

object (PriceAttribute)

ราคา ส่วนลด ภาษี และอื่นๆ
followUpActions[]

object (Action)

ติดตามผลที่ระดับคำสั่งซื้อ
paymentData

object (PaymentData)

ข้อมูลที่เกี่ยวข้องกับการชำระเงินสำหรับคำสั่งซื้อ
termsOfServiceUrl

string

ลิงก์ไปยังข้อกำหนดในการให้บริการที่ใช้กับคำสั่งซื้อ/คำสั่งซื้อที่เสนอ
note

string

แนบโน้ตไปกับคำสั่งซื้อแล้ว
promotions[]

object (Promotion)

โปรโมชันทั้งหมดที่เชื่อมโยงกับคำสั่งซื้อนี้
disclosures[]

object (Disclosure)

การเปิดเผยข้อมูลที่เชื่อมโยงกับคำสั่งซื้อนี้
vertical
(deprecated)

object

เลิกใช้งานแล้ว: ใช้ประเภทธุรกิจแทน พร็อพเพอร์ตี้เหล่านี้จะมีผลกับรายการโฆษณาทั้งหมด เว้นแต่จะมีการลบล้างในรายการโฆษณาบางรายการ ประเภทธุรกิจนี้ต้องตรงกับประเภทประเภทธุรกิจระดับรายการโฆษณา ค่าที่เป็นไปได้: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

ออบเจ็กต์ที่มีช่องประเภทที่กำหนดเอง ช่องเพิ่มเติม "@type" จะมี URI ที่ระบุประเภท ตัวอย่างเช่น { "id": 1234, "@type": "types.example.com/standard/id" }
ช่องการรวม verticals พร็อพเพอร์ตี้เหล่านี้จะมีผลกับรายการโฆษณาทั้งหมด เว้นแต่จะมีการลบล้างในรายการโฆษณาบางรายการ ประเภทธุรกิจนี้ต้องตรงกับประเภทแนวตั้งระดับรายการโฆษณา verticals ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
purchase

object (PurchaseOrderExtension)

ใบสั่งซื้อ
ticket

object (TicketOrderExtension)

ลำดับตั๋ว

UserInfo

ข้อมูลเกี่ยวกับผู้ใช้ ใช้เพื่อแสดงข้อมูลของผู้ใช้ที่เชื่อมโยงกับคำสั่งซื้อ

การแสดง JSON 
{
  "email": string,
  "firstName": string,
  "lastName": string,
  "displayName": string,
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ]
}
ช่อง
email

string

อีเมลของผู้ใช้ เช่น janedoe@gmail.com
firstName

string

ชื่อของผู้ใช้
lastName

string

นามสกุลของผู้ใช้
displayName

string

ชื่อที่แสดงของผู้ใช้อาจต่างจากชื่อหรือนามสกุล
phoneNumbers[]

object (PhoneNumber)

หมายเลขโทรศัพท์ของผู้ใช้

หมายเลขโทรศัพท์

หมายเลขโทรศัพท์มาตรฐาน

การแสดง JSON 
{
  "e164PhoneNumber": string,
  "extension": string,
  "preferredDomesticCarrierCode": string
}
ช่อง
e164PhoneNumber

string

หมายเลขโทรศัพท์ในรูปแบบ E.164 ตามที่กำหนดไว้ใน International Telecommunication Union (ITU) Recommendation E.164 ลิงก์ wiki: https://en.wikipedia.org/wiki/E.164
extension

string

ส่วนขยายไม่มีการกำหนดมาตรฐานในคำแนะนำของ ITU ยกเว้นการกำหนดเป็นชุดตัวเลขโดยมีความยาวได้สูงสุด 40 หลัก พารามิเตอร์ได้รับการกำหนดให้เป็นสตริงนี้เพื่อรองรับการใช้เลข 0 นำหน้าในส่วนขยาย (องค์กรมีอิสระเต็มที่ในการทำเช่นนั้น เนื่องจากไม่มีการกำหนดมาตรฐาน) นอกเหนือจากตัวเลขแล้ว อักขระโทรออกอื่นๆ เช่น "," (แจ้งว่ากำลังรอ) อาจจัดเก็บไว้ที่นี่ เช่น ในชิ้นงาน xxx-xxx-xxxx 123, "123" เป็นส่วนขยาย
preferredDomesticCarrierCode

string

รหัสการเลือกผู้ให้บริการที่ต้องใช้เมื่อโทรหาหมายเลขโทรศัพท์นี้ภายในประเทศ ซึ่งรวมถึงรหัสที่ต้องโทรในบางประเทศเมื่อโทรจากโทรศัพท์บ้านไปยังโทรศัพท์มือถือ หรือกลับกัน เช่น ในโคลัมเบีย เครื่องหมาย "3" จะต้องกดหมายเลขก่อนหมายเลขโทรศัพท์เมื่อโทรจากโทรศัพท์มือถือไปยังโทรศัพท์บ้านในประเทศหรือในทางกลับกัน https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code

โปรดทราบว่าตัวเลือกนี้คือ "แนะนำ" ซึ่งหมายความว่า รหัสอื่นๆ อาจใช้งานได้ด้วยเช่นกัน

รูปภาพ

รูปภาพที่แสดงในการ์ด

การแสดง JSON 
{
  "url": string,
  "accessibilityText": string,
  "height": integer,
  "width": integer
}
ช่อง
url

string

URL แหล่งที่มาของรูปภาพ รูปภาพสามารถใช้เป็น JPG, PNG และ GIF (ทั้งเป็นภาพเคลื่อนไหวและไม่เคลื่อนไหว) ตัวอย่างเช่นhttps://www.agentx.com/logo.png ต้องระบุ
accessibilityText

string

ข้อความอธิบายของรูปภาพที่จะใช้เพื่อการเข้าถึง เช่น โปรแกรมอ่านหน้าจอ ต้องระบุ
height

integer

ความสูงของรูปภาพเป็นพิกเซล ไม่บังคับ
width

integer

ความกว้างของรูปภาพเป็นพิกเซล ไม่บังคับ

ผู้ขาย

ผู้ขายสินค้าในรถเข็น/คำสั่งซื้อ/รายการโฆษณา

การแสดง JSON 
{
  "id": string,
  "name": string,
  "image": {
    object (Image)
  },
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "address": {
    object (Location)
  }
}
ช่อง
id

string

รหัสที่ไม่บังคับซึ่งกำหนดให้กับผู้ขาย (หากมี)
name

string

ชื่อผู้ขาย เช่น "ขนมปัง Panera"
image

object (Image)

รูปภาพที่เชื่อมโยงกับผู้ขาย
phoneNumbers[]

object (PhoneNumber)

หมายเลขโทรศัพท์ของผู้ขาย
address

object (Location)

ที่อยู่ของผู้ขาย

ตำแหน่ง

คอนเทนเนอร์ที่แสดงสถานที่ตั้ง

การแสดง JSON 
{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "name": string,
  "phoneNumber": string,
  "notes": string,
  "placeId": string
}
ช่อง
coordinates

object (LatLng)

พิกัดทางภูมิศาสตร์ ต้องมี [DEVICE_PRECISE_LOCATION] สิทธิ์ [google.actions.v2.Permissions.DEVICE_PRECISE_LOCATION]
formattedAddress

string

ที่อยู่ที่แสดง เช่น "1600 Amphitheatre Pkwy, Mountain View, CA 94043" ต้องมี [DEVICE_PRECISE_LOCATION] สิทธิ์ [google.actions.v2.Permissions.DEVICE_PRECISE_LOCATION]
zipCode

string

รหัสไปรษณีย์ ต้องมี [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permissions.DEVICE_PRECISE_LOCATION] หรือ [DEVICE_COARSE_LOCATION] สิทธิ์ [google.actions.v2.Permissions.DEVICE_COARSE_LOCATION]
city

string

เมือง ต้องมี [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permissions.DEVICE_PRECISE_LOCATION] หรือ [DEVICE_COARSE_LOCATION] สิทธิ์ [google.actions.v2.Permissions.DEVICE_COARSE_LOCATION]
postalAddress

object (PostalAddress)

ที่อยู่ทางไปรษณีย์ ต้องมี [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permissions.DEVICE_PRECISE_LOCATION] หรือ [DEVICE_COARSE_LOCATION] สิทธิ์ [google.actions.v2.Permissions.DEVICE_COARSE_LOCATION]
name

string

ชื่อสถานที่
phoneNumber

string

หมายเลขโทรศัพท์ของสถานที่ตั้ง เช่น หมายเลขติดต่อของที่ตั้งธุรกิจ หรือหมายเลขโทรศัพท์สำหรับสถานที่จัดส่ง
notes

string

หมายเหตุเกี่ยวกับสถานที่
placeId

string

PlaceId จะใช้กับ Places API เพื่อดึงข้อมูลรายละเอียดของสถานที่ โปรดดู https://developers.google.com/places/web-service/place-id

LatLng

วัตถุที่แสดงคู่ละติจูด/ลองจิจูด ค่านี้จะแสดงเป็นคู่ของค่าคู่เพื่อแสดงองศาละติจูดและลองจิจูด ออบเจ็กต์นี้ต้องเป็นไปตามมาตรฐาน WGS84 เว้นแต่จะระบุไว้เป็นอย่างอื่น ค่าต้องอยู่ในช่วงมาตรฐาน

การแสดง JSON 
{
  "latitude": number,
  "longitude": number
}
ช่อง
latitude

number

ละติจูด หน่วยเป็นองศา โดยต้องอยู่ในช่วง [-90.0, +90.0]
longitude

number

ลองจิจูด หน่วยเป็นองศา โดยต้องอยู่ในช่วง [-180.0, +180.0]

PostalAddress

แสดงที่อยู่ไปรษณีย์ เช่น สำหรับที่อยู่ไปรษณีย์หรือที่อยู่การชำระเงิน หากใช้ที่อยู่ไปรษณีย์ บริการไปรษณีย์จะนำส่งสินค้าไปยังสถานที่ตั้งของ P.O ได้ กล่องหรือสิ่งอื่นที่คล้ายกัน ไม่ได้มีไว้เพื่อสร้างแบบจำลองตำแหน่งทางภูมิศาสตร์ (ถนน เมือง ภูเขา)

ในการใช้งานโดยทั่วไป ที่อยู่จะสร้างขึ้นผ่านข้อมูลจากผู้ใช้หรือจากการนำเข้าข้อมูลที่มีอยู่ ทั้งนี้ขึ้นอยู่กับประเภทของกระบวนการ

คําแนะนําเกี่ยวกับการป้อน / การแก้ไขที่อยู่: - ใช้วิดเจ็ตที่อยู่ที่พร้อมใช้งาน i18n เช่น https://github.com/google/libaddressinput) - ผู้ใช้ไม่ควรแสดงองค์ประกอบ UI สําหรับการป้อนข้อมูลหรือแก้ไขช่องนอกประเทศที่ใช้ช่องดังกล่าว

ดูคำแนะนำเพิ่มเติมเกี่ยวกับวิธีใช้สคีมานี้ได้ที่ https://support.google.com/business/answer/6397478

การแสดง JSON 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
ช่อง
revision

integer

การแก้ไขสคีมาของ PostalAddress โดยต้องตั้งค่าเป็น 0 ซึ่งเป็นรุ่นล่าสุด

การแก้ไขใหม่ทั้งหมดต้องเข้ากันได้กับการแก้ไขเก่า
regionCode

string

ต้องระบุ รหัสภูมิภาค CLDR ของประเทศ/ภูมิภาคของที่อยู่ ข้อมูลนี้ไม่ได้มีการอนุมานแต่อย่างใด และขึ้นอยู่กับผู้ใช้ที่จะตรวจสอบว่าค่าถูกต้อง ดูรายละเอียดได้ที่ http://cldr.unicode.org/ และ http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html ตัวอย่างเช่น "CH" สำหรับสวิตเซอร์แลนด์
languageCode

string

ไม่บังคับ รหัสภาษา BCP-47 ของเนื้อหาในที่อยู่นี้ (หากทราบ) ซึ่งมักเป็นภาษา UI ของแบบฟอร์มอินพุต หรือคาดว่าจะตรงกับภาษาใดภาษาหนึ่งที่ใช้ในที่อยู่ ประเทศ/ภูมิภาค หรือคำทับศัพท์ที่เทียบเท่า ซึ่งอาจส่งผลต่อการจัดรูปแบบในบางประเทศ แต่ไม่สำคัญต่อความถูกต้องของข้อมูล และจะไม่ส่งผลต่อการตรวจสอบความถูกต้องหรือการดำเนินการอื่นๆ ที่ไม่เกี่ยวข้องกับการจัดรูปแบบ

หากไม่ทราบค่านี้ ก็ควรละเว้น (แทนที่จะระบุค่าเริ่มต้นที่อาจไม่ถูกต้อง)

เช่น "zh-Hant", "ja", "ja-Latn", "en"
postalCode

string

ไม่บังคับ รหัสไปรษณีย์ของที่อยู่ บางประเทศอาจไม่ได้ใช้หรือกำหนดให้มีการแสดงรหัสไปรษณีย์ แต่ประเทศที่ใช้รหัสเหล่านี้อาจทำให้มีการตรวจสอบเพิ่มเติมกับส่วนอื่นๆ ของที่อยู่ (เช่น การตรวจสอบรัฐ/รหัสไปรษณีย์ในสหรัฐอเมริกา)
sortingCode

string

ไม่บังคับ รหัสการจัดเรียงเพิ่มเติม รหัสเฉพาะประเทศ ซึ่งไม่มีใช้ในภูมิภาคส่วนใหญ่ ในที่ที่ใช้ ค่าอาจเป็นสตริง เช่น "CEDEX" ซึ่งอาจจะตามด้วยตัวเลข (เช่น "CEDEX 7") หรือเป็นเพียงตัวเลขเพียงอย่างเดียวซึ่งเป็นตัวแทนของ "รหัสเซกเตอร์" (จาเมกา), "ดัชนีพื้นที่นำส่ง" (มาลาวี) หรือ "ตัวบ่งชี้ที่ทำการไปรษณีย์" (เช่น โกตดิวัวร์)
administrativeArea

string

ไม่บังคับ เขตการปกครองสูงสุด ซึ่งใช้สำหรับที่อยู่ทางไปรษณีย์ของประเทศหรือภูมิภาค ตัวอย่างเช่น อาจเป็นรัฐ จังหวัด แคว้น หรือจังหวัด โดยเฉพาะอย่างยิ่งสำหรับสเปน ประเทศนี้เป็นจังหวัด ไม่ใช่ชุมชนปกครองตนเอง (เช่น "บาร์เซโลนา" ไม่ใช่ "คาตาโลเนีย") มีหลายประเทศไม่ใช้เขตบริหารในที่อยู่ทางไปรษณีย์ เช่น ในสวิตเซอร์แลนด์ ข้อมูลนี้ไม่ควรถูกปล่อยไว้
locality

string

ไม่บังคับ โดยทั่วไปหมายถึงส่วนเมืองของที่อยู่ ตัวอย่าง: เมืองในสหรัฐอเมริกา, เขตไอที, เมืองไปรษณีย์ของสหราชอาณาจักร ในภูมิภาคของโลกที่ไม่มีการกำหนดพื้นที่ไว้อย่างดีหรือไม่เหมาะสมกับโครงสร้างนี้ ให้ปล่อยย่านนั้นว่างไว้และใช้บรรทัดที่อยู่
sublocality

string

ไม่บังคับ สถานที่ตั้งย่อยของที่อยู่ ตัวอย่างเช่น ย่านใกล้เคียง เขตเมือง เขตต่างๆ
addressLines[]

string

บรรทัดที่อยู่ที่ไม่มีโครงสร้างซึ่งอธิบายถึงระดับที่ต่ำกว่าของที่อยู่

เนื่องจากค่าใน addressLines ไม่มีข้อมูลประเภท และบางครั้งอาจมีค่าหลายค่าในช่องเดียว (เช่น "Austin, TX") ดังนั้นจึงจำเป็นที่การเรียงลำดับบรรทัดจะต้องชัดเจน ลำดับของบรรทัดที่อยู่ควรเป็น "ลำดับซองจดหมาย" สำหรับประเทศ/ภูมิภาคของที่อยู่ ในพื้นที่ที่อาจแตกต่างกันไป (เช่น ญี่ปุ่น) ระบบจะใช้ address_language เพื่อทำให้ชัดเจน (เช่น "ja" สำหรับการสั่งซื้อจากใหญ่ไปเล็ก และ "ja-Latn" หรือ "en" สำหรับเล็กไปใหญ่) วิธีนี้จะช่วยให้เลือกบรรทัดของที่อยู่ที่เจาะจงที่สุดตามภาษาได้

การแสดงโครงสร้างต่ำสุดที่ได้รับอนุญาตของที่อยู่ประกอบด้วยรหัสภูมิภาคพร้อมกับข้อมูลที่เหลืออยู่ทั้งหมดในบรรทัดที่อยู่ รูปแบบที่อยู่เช่นนี้สามารถทำได้อย่างคร่าวๆ โดยไม่ต้องมีการเข้ารหัสพิกัดภูมิศาสตร์ แต่ไม่มีการให้เหตุผลเชิงความหมายเกี่ยวกับองค์ประกอบที่อยู่ใดๆ จนกว่าจะได้รับการแก้ไขบางส่วนเป็นอย่างน้อย

การสร้างที่อยู่ที่มีเพียงรหัสภูมิภาคและบรรทัดที่อยู่ การใช้รหัสพิกัดภูมิศาสตร์เป็นวิธีที่แนะนำในการจัดการที่อยู่ที่ไม่มีโครงสร้างโดยสิ้นเชิง (แทนที่จะคาดเดาว่าส่วนใดของที่อยู่ควรเป็นย่านหรือเขตบริหาร)
recipients[]

string

ไม่บังคับ ผู้รับในที่อยู่ ในบางกรณี ช่องนี้อาจมีข้อมูลหลายบรรทัด เช่น อาจมีคำว่า "ดูแล"

organization

string

ไม่บังคับ ชื่อขององค์กรตามที่อยู่

เนื้อหา

Wrapper สำหรับรายการโฆษณา

การแสดง JSON 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
ช่อง
lineItems[]

object (LineItem)

รายชื่อรายการโฆษณาของคำสั่งซื้อ โดยต้องมีอย่างน้อย 1 บรรทัดรายการ แต่ไม่เกิน 50 บรรทัด รายการโฆษณาทั้งหมดต้องอยู่ในประเภทธุรกิจเดียวกัน

LineItem

รายการโฆษณา 1 รายการมีประเภทธุรกิจ 1 รายการ คำสั่งซื้อหรือรถเข็นอาจมีรายการโฆษณาแนวตั้งหลายรายการ ควรกำหนดรายการโฆษณาย่อย/ส่วนเสริม ฯลฯ ในโปรโตแนวตั้งโดยขึ้นอยู่กับกรณีการใช้งาน หมายเหตุ: 1. สตริงทั้งหมดในทุกระดับต้องมีอักขระน้อยกว่า 1,000 ตัว เว้นแต่จะระบุไว้เป็นอย่างอื่น 2. ช่องที่ซ้ำทั้งหมดในทุกระดับต้องมีจำนวนน้อยกว่า 50 รายการ เว้นแต่จะระบุไว้เป็นอย่างอื่น 3. หากระบุไว้ การประทับเวลาทั้งหมดในทุกระดับจะต้องเป็นการประทับเวลาที่ถูกต้อง

การแสดง JSON 
{
  "id": string,
  "name": string,
  "userVisibleStateLabel": string,
  "provider": {
    object (Merchant)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "recipients": [
    {
      object (UserInfo)
    }
  ],
  "image": {
    object (Image)
  },
  "description": string,
  "notes": [
    string
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseItemExtension)
  },
  "reservation": {
    object (ReservationItemExtension)
  }
  // End of list of possible types for union field verticals.
}
ช่อง
id

string

ต้องระบุ: ตัวระบุที่ผู้ขายกำหนดสำหรับรายการโฆษณา ใช้เพื่อระบุรายการโฆษณาที่มีอยู่ในการนำการอัปเดตบางส่วนไปใช้ ความยาวสูงสุดคือ 64 อักขระ
name

string

ชื่อบรรทัดรายการตามที่แสดงในใบเสร็จ ความยาวสูงสุดคือ 100 อักขระ
userVisibleStateLabel
(deprecated)

string

เลิกใช้งานแล้ว โปรดใช้สถานะระดับแนวตั้งแทน เช่น ใช้ PurchaseOrderExtension.status สำหรับการซื้อ ป้ายกำกับที่ผู้ใช้มองเห็นได้สำหรับสถานะของรายการโฆษณานี้
provider

object (Merchant)

ผู้ให้บริการของรายการโฆษณาหนึ่งๆ หากแตกต่างจากคำสั่งซื้อโดยรวม ตัวอย่าง: คำสั่งซื้อด้วย ANA ผู้ให้บริการรายการโฆษณาของ Expedia
priceAttributes[]

object (PriceAttribute)

ราคาและการปรับระดับรายการโฆษณา
followUpActions[]

object (Action)

ติดตามผลการดำเนินการที่รายการโฆษณา
recipients[]

object (UserInfo)

ลูกค้าระดับรายการโฆษณา ซึ่งไม่ใช่ผู้ซื้อระดับคำสั่งซื้อ ตัวอย่าง: ผู้ใช้ X จองร้านอาหารโดยใช้ชื่อผู้ใช้ ข
image

object (Image)

รูปภาพขนาดเล็กที่เชื่อมโยงกับรายการนี้ (หากมี)
description

string

คำอธิบายรายการโฆษณา
notes[]

string

หมายเหตุเพิ่มเติมที่เกี่ยวข้องกับรายการโฆษณานี้ เช่น นโยบายการยกเลิก
disclosures[]

object (Disclosure)

การเปิดเผยข้อมูลที่เชื่อมโยงกับรายการโฆษณานี้
vertical
(deprecated)

object

เลิกใช้งานแล้ว: ใช้ประเภทธุรกิจแทน ต้องระบุ: เนื้อหาเชิงความหมายของรายการโฆษณาตามประเภท/ประเภทธุรกิจ ธุรกิจทุกประเภทควรมีรายละเอียดการดำเนินการตามคำสั่งซื้อของตัวเอง ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ google.actions.orders.v3.verticals.purchase.PurchaseItemExtension google.actions.orders.v3.verticals.reservation.ReservationItemExtension google.actions.orders.v3.verticals.ticket.TicketItemExtension

ออบเจ็กต์ที่มีช่องประเภทที่กำหนดเอง ช่องเพิ่มเติม "@type" จะมี URI ที่ระบุประเภท ตัวอย่างเช่น { "id": 1234, "@type": "types.example.com/standard/id" }
ช่องการรวม verticals ต้องระบุ: เนื้อหาเชิงความหมายของรายการโฆษณาตามประเภท/ประเภทธุรกิจ ธุรกิจทุกประเภทควรมีรายละเอียดการดำเนินการตามคำสั่งซื้อของตัวเอง verticals ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
purchase

object (PurchaseItemExtension)

คำสั่งซื้อ เช่น สินค้า อาหาร ฯลฯ
reservation

object (ReservationItemExtension)

การสั่งจอง เช่น ร้านอาหาร ตัดผม ฯลฯ

PriceAttribute

แอตทริบิวต์ราคาของคำสั่งซื้อหรือรายการโฆษณา

การแสดง JSON 
{
  "type": enum (Type),
  "name": string,
  "id": string,
  "state": enum (State),
  "taxIncluded": boolean,

  // Union field spec can be only one of the following:
  "amount": {
    object (Money)
  },
  "amountMillipercentage": integer
  // End of list of possible types for union field spec.
}
ช่อง
type

enum (Type)

ต้องระบุ: แอตทริบิวต์ประเภทเงิน
name

string

ต้องระบุ: สตริงแอตทริบิวต์ราคาที่ผู้ใช้แสดง ซึ่งผู้ขายส่งและแปลข้อมูลนี้
id

string

ไม่บังคับ: รหัสของรายการโฆษณาที่เกี่ยวข้องกับราคานี้
state

enum (State)

ต้องระบุ: สถานะของราคา: ราคาโดยประมาณเทียบกับราคาจริง
taxIncluded

boolean

ราคารวมภาษีหรือไม่
ช่องการรวม spec แสดงจํานวนเงินหรือเปอร์เซ็นต์มิลลิลิตร spec ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
amount

object (Money)

จำนวนเงิน
amountMillipercentage
(deprecated)

integer

ข้อกำหนดเปอร์เซ็นต์ไปจนถึง 1/1000 ของเปอร์เซ็นต์ เช่น 8.750% จะแสดงเป็น 8750 เปอร์เซ็นต์ติดลบหมายถึงเปอร์เซ็นต์ส่วนลด กำลังเลิกใช้งานช่องนี้ พิจารณาเพิ่มข้อมูลกลับคืนได้เมื่อต้องมีกรณีการใช้งานที่มั่นคง

ประเภท

แสดงประเภทของเงิน

Enum
TYPE_UNSPECIFIED ไม่ได้ระบุประเภท ไคลเอ็นต์ไม่ควรต้องตั้งค่าข้อมูลนี้อย่างชัดแจ้ง
REGULAR ราคาที่แสดงปกติ ก่อนใช้ส่วนลดและอื่นๆ
DISCOUNT ซึ่งจะถูกหักออกจากยอดรวมย่อย
TAX เพื่อเพิ่มลงในยอดรวมย่อย
DELIVERY เพื่อเพิ่มลงในยอดรวมย่อย
SUBTOTAL ยอดรวมย่อยก่อนคิดค่าธรรมเนียมบางอย่าง
FEE ค่าธรรมเนียมเพิ่มเติม
GRATUITY เพื่อเพิ่มลงในยอดรวมย่อย
TOTAL ราคาคำสั่งซื้อหรือรายการโฆษณาที่แสดง

รัฐ

แสดงสถานะราคา

Enum
STATE_UNSPECIFIED ไม่ได้ระบุ
ESTIMATE ราคาเป็นเพียงค่าประมาณ แต่จำนวนเงินสุดท้ายจะใกล้เคียงกับจำนวนเงินนี้ ตัวอย่าง: ในกรณีที่ไม่ทราบภาษีอย่างถูกต้อง ณ เวลาที่ทำธุรกรรม ยอดรวมจะมีมูลค่าเท่ากับ ESTIMATE
ACTUAL ราคาจริงที่จะเรียกเก็บจากผู้ใช้

เงินทอง

แสดงจำนวนเงินพร้อมประเภทสกุลเงิน

การแสดง JSON 
{
  "currencyCode": string,
  "amountInMicros": string
}
ช่อง
currencyCode

string

รหัสสกุลเงิน 3 ตัวอักษรที่กำหนดไว้ใน ISO 4217
amountInMicros

string (int64 format)

จำนวนเงินในหน่วยไมโคร ตัวอย่างเช่น ควรตั้งค่าช่องนี้เป็น 1990000 สำหรับ $1.99

การดำเนินการ

การดำเนินการติดตามผลที่เชื่อมโยงกับคำสั่งซื้อหรือรายการโฆษณา

การแสดง JSON 
{
  "type": enum (Type),
  "title": string,
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "actionMetadata": {
    object (ActionMetadata)
  }
}
ช่อง
type

enum (Type)

จำเป็น: ประเภทการทำงาน
title

string

ชื่อหรือป้ายกำกับของการดำเนินการที่แสดงต่อผู้ใช้ ความยาวสูงสุดคือ 100 อักขระ
openUrlAction

object (OpenUrlAction)

สิ่งที่ต้องดำเนินการ
actionMetadata

object (ActionMetadata)

ข้อมูลเมตาที่เชื่อมโยงกับการดำเนินการ

ประเภท

การดำเนินการติดตามผลที่เป็นไปได้

Enum
TYPE_UNSPECIFIED การกระทำที่ไม่ได้ระบุ
VIEW_DETAILS ดูรายละเอียดคำสั่งซื้อ
MODIFY แก้ไขการดำเนินการคำสั่งซื้อ
CANCEL ยกเลิกการดำเนินการคำสั่งซื้อ
RETURN คืนสินค้า
EXCHANGE การดำเนินการคำสั่งซื้อการแลกเปลี่ยน
EMAIL

การดำเนินการกับอีเมล เลิกใช้งานประเภท EMAIL และ CALL แล้ว openUrlAction.url สามารถใช้เป็นหมายเลขโทรศัพท์หรืออีเมลได้
CALL

คำกระตุ้นให้ดำเนินการ (Call-Action)
REORDER เรียงลำดับการดำเนินการใหม่
REVIEW ตรวจสอบการดำเนินการสั่งซื้อ
CUSTOMER_SERVICE โปรดติดต่อฝ่ายบริการลูกค้า
FIX_ISSUE นำไปยังเว็บไซต์หรือแอปของผู้ขายเพื่อแก้ไขปัญหาโดยตรง
DIRECTION ลิงก์เส้นทาง

OpenUrlAction

เปิด URL ที่ระบุ

การแสดง JSON 
{
  "url": string,
  "androidApp": {
    object (AndroidApp)
  },
  "urlTypeHint": enum (UrlTypeHint)
}
ช่อง
url

string

ฟิลด์ URL อาจเป็นรายการใดก็ได้ต่อไปนี้ - URL http/https สำหรับเปิดแอปที่ลิงก์กับแอปหรือหน้าเว็บ
androidApp

object (AndroidApp)

ข้อมูลเกี่ยวกับแอป Android ในกรณีที่ URL คาดว่าจะมาจากแอป Android
urlTypeHint

enum (UrlTypeHint)

เป็นคำแนะนำสำหรับประเภท URL

AndroidApp

ข้อกําหนดของแอป Android สําหรับข้อจํากัดการดำเนินการตามคำสั่งซื้อ

การแสดง JSON 
{
  "packageName": string,
  "versions": [
    {
      object (VersionFilter)
    }
  ]
}
ช่อง
packageName

string

ต้องระบุชื่อแพ็กเกจชื่อแพ็กเกจเมื่อระบุ Android Fulfillment
versions[]

object (VersionFilter)

เมื่อระบุตัวกรองหลายรายการ การจับคู่ตัวกรองใดก็ตามจะทริกเกอร์แอป

VersionFilter

ควรรวม VersionFilter หากจำเป็นต้องใช้เวอร์ชันที่เจาะจงของแอป

การแสดง JSON 
{
  "minVersion": integer,
  "maxVersion": integer
}
ช่อง
minVersion

integer

รหัสเวอร์ชันต่ำสุดหรือ 0 (รวม 0 ด้วย)
maxVersion

integer

รวมรหัสเวอร์ชันสูงสุด ช่วงที่นำมาพิจารณาคือ [minVersion:maxVersion] ช่วง Null หมายถึงเวอร์ชันใดก็ตาม ตัวอย่าง: หากต้องการระบุการใช้เวอร์ชันเดียว: [target_version:target_version] หากต้องการระบุเวอร์ชัน ไม่ต้องระบุ minVersion และ maxVersion หากต้องการระบุทุกเวอร์ชันจนถึง maxVersion ไม่ต้องระบุ minVersion หากต้องการระบุทุกเวอร์ชันจาก minVersion ไม่ต้องระบุ maxVersion

UrlTypeHint

คำแนะนำ URL ประเภทต่างๆ

Enum
URL_TYPE_HINT_UNSPECIFIED ไม่ระบุ
AMP_CONTENT URL ที่ชี้ไปยังเนื้อหา AMP โดยตรง หรือไปยัง Canonical URL ซึ่งอ้างถึงเนื้อหา AMP ผ่านทาง <link rel="amphtml">

ActionMetadata

ข้อมูลเมตาที่เกี่ยวข้องต่อการดำเนินการ

การแสดง JSON 
{
  "expireTime": string
}
ช่อง
expireTime

string (Timestamp format)

เวลาที่การกระทำนี้จะหมดอายุ

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

การเปิดเผย

การเปิดเผยผลิตภัณฑ์ บริการ หรือนโยบายที่แสดงต่อผู้ใช้

การแสดง JSON 
{
  "title": string,
  "disclosureText": {
    object (DisclosureText)
  },
  "presentationOptions": {
    object (DisclosurePresentationOptions)
  }
}
ช่อง
title

string

ชื่อเอกสารการเปิดเผยข้อมูล ตัวอย่างเช่น "ข้อมูลด้านความปลอดภัย"
disclosureText

object (DisclosureText)

เนื้อหาของการเปิดเผยข้อมูล อนุญาตให้ใช้เว็บลิงก์
presentationOptions

object (DisclosurePresentationOptions)

ตัวเลือกการนำเสนอสำหรับการเปิดเผยข้อมูล

DisclosureText

แสดงข้อความธรรมดาที่มีเว็บลิงก์

การแสดง JSON 
{
  "template": string,
  "textLinks": [
    {
      object (TextLink)
    }
  ]
}
ช่อง
template

string

ข้อความที่จะแสดง ซึ่งมีตัวยึดตำแหน่ง เช่น "{0}" และ "{1}" สำหรับแต่ละลิงก์ข้อความที่ควรแทรก ตัวอย่าง: "คำเตือน: ผลิตภัณฑ์นี้อาจทำให้คุณได้รับสารเคมีที่รัฐแคลิฟอร์เนียทราบว่าเป็นสาเหตุของมะเร็ง โปรดดูข้อมูลเพิ่มเติมที่ {0}" ข้อความเปิดเผยนี้ต้องไม่มีเนื้อหาส่งเสริมการขายหรือเนื้อหาที่มีลักษณะคล้ายโฆษณา

DisclosurePresentationOptions

ตัวเลือกสำหรับการนำเสนอการเปิดเผยข้อมูล

การแสดง JSON 
{
  "presentationRequirement": enum (PresentationRequirement),
  "initiallyExpanded": boolean
}
ช่อง
presentationRequirement

enum (PresentationRequirement)

ข้อกำหนดในการแสดงการเปิดเผยข้อมูล
initiallyExpanded

boolean

ควรขยายเนื้อหาของการเปิดเผยข้อมูลในตอนแรกหรือไม่ ซึ่งจะมีการยุบไว้โดยค่าเริ่มต้น

PresentationRequirement

ข้อกำหนดสำหรับการนำเสนอการเปิดเผยข้อมูล

Enum
REQUIREMENT_UNSPECIFIED ไม่ได้ระบุข้อกำหนด ไม่ควรตั้งค่าอย่างชัดแจ้ง
REQUIREMENT_OPTIONAL คุณจะเปิดเผยข้อมูลนี้หรือไม่ก็ได้ ระบบอาจข้ามข้อมูลนี้ได้หากอุปกรณ์ไม่รองรับการแสดงการเปิดเผยข้อมูล
REQUIREMENT_REQUIRED ต้องมีการเปิดเผยข้อมูล การสนทนาจะถูกเตะไปที่โทรศัพท์หากอุปกรณ์ไม่รองรับการแสดงการเปิดเผย

PurchaseItemExtension

เนื้อหาของรายการโฆษณาของประเภทธุรกิจการซื้อ

การแสดง JSON 
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "productId": string,
  "quantity": integer,
  "unitMeasure": {
    object (MerchantUnitMeasure)
  },
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "itemOptions": [
    {
      object (ItemOption)
    }
  ],
  "productDetails": {
    object (ProductDetails)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
ช่อง
status

enum (PurchaseStatus)

ต้องระบุ: สถานะระดับรายการโฆษณา
userVisibleStatusLabel

string

จำเป็น: ป้ายกำกับ/สตริงที่มองเห็นได้สำหรับผู้ใช้สำหรับสถานะ ความยาวสูงสุดคือ 50 อักขระ
type

enum (PurchaseType)

ต้องระบุ: ประเภทของการซื้อ
productId
(deprecated)

string

รหัสผลิตภัณฑ์หรือข้อเสนอที่เชื่อมโยงกับรายการโฆษณานี้
quantity

integer

จำนวนสินค้า
unitMeasure

object (MerchantUnitMeasure)

มาตรวัดหน่วย ระบุขนาดของรายการในหน่วยที่เลือก ระบบจะใช้ขนาดร่วมกับราคาที่ใช้งานอยู่เพื่อกำหนดราคาต่อหน่วย
returnsInfo

object (PurchaseReturnsInfo)

แสดงข้อมูลสำหรับรายการโฆษณานี้ หากไม่ได้ตั้งค่า รายการโฆษณานี้จะรับค่าข้อมูลการคืนสินค้าระดับคำสั่งซื้อ
fulfillmentInfo

object (PurchaseFulfillmentInfo)

ข้อมูลการดำเนินการตามรายการโฆษณานี้ หากไม่ได้ตั้งค่า รายการโฆษณานี้จะรับค่าข้อมูลการดำเนินการตามคำสั่งซื้อระดับคำสั่งซื้อ
itemOptions[]

object (ItemOption)

ส่วนเสริมหรือรายการย่อยเพิ่มเติม
productDetails

object (ProductDetails)

รายละเอียดเกี่ยวกับผลิตภัณฑ์
extension
(deprecated)

object

ฟิลด์พิเศษใดๆ ที่แลกเปลี่ยนระหว่างผู้ขายกับ Google หมายเหตุ: เราไม่แนะนำให้ใช้ส่วนขยายนี้ พิจารณาข้อใดข้อหนึ่งต่อไปนี้ตามกรณีการใช้งาน/สถานการณ์ 1. กำหนดช่องใน PurchaseItemExtension หากสามารถนำไปใช้สำหรับกรณีการใช้งานอื่นๆ (เช่น ความสามารถ/ฟังก์ชันการทำงานทั่วไป) 2. ใช้ vertical_extension หากเฉพาะเจาะจงสําหรับกรณีการใช้งาน/ฟีเจอร์ที่กําหนดเองซึ่งไม่ใช่ทั่วไป

ออบเจ็กต์ที่มีช่องประเภทที่กำหนดเอง ช่องเพิ่มเติม "@type" จะมี URI ที่ระบุประเภท ตัวอย่างเช่น { "id": 1234, "@type": "types.example.com/standard/id" }

PurchaseStatus

สถานะการซื้อที่เชื่อมโยงกับใบสั่งซื้อหรือรายการโฆษณาที่เจาะจง

Enum
PURCHASE_STATUS_UNSPECIFIED ไม่ระบุสถานะ
READY_FOR_PICKUP พร้อมให้มารับแล้ว
SHIPPED จัดส่งแล้ว
DELIVERED นำส่งแล้ว
OUT_OF_STOCK สินค้าหมด
IN_PREPARATION "IN_PREPARATION" อาจมีความหมายต่างกันในบริบทที่ต่างกัน สำหรับการสั่งอาหาร อาจเป็นอาหารที่กำลังปรุงอยู่ สำหรับการค้าปลีก อาจหมายถึงสินค้ากำลังอยู่ในบรรจุภัณฑ์
CREATED สร้างคำสั่งซื้อแล้ว
CONFIRMED ผู้ขายยืนยันคำสั่งซื้อแล้ว
REJECTED ผู้ขายปฏิเสธคำสั่งซื้อหรือรายการโฆษณา
RETURNED ผู้ใช้ส่งคืนสินค้าแล้ว
CANCELLED ผู้ใช้ยกเลิกคำสั่งซื้อหรือรายการโฆษณา
CHANGE_REQUESTED ผู้ใช้ได้ส่งคำขอเปลี่ยนแปลงคำสั่งซื้อ และผู้ผสานรวมระบบกำลังประมวลผลการเปลี่ยนแปลงนี้ ควรย้ายคำสั่งซื้อไปยังสถานะอื่นหลังจากจัดการคำขอแล้ว

PurchaseType

หมวดหมู่การซื้อ

Enum
PURCHASE_TYPE_UNSPECIFIED ค่าที่ไม่รู้จัก
RETAIL ซึ่งรวมถึงการซื้อสินค้า เช่น สินค้าที่จับต้องได้
FOOD ประกอบด้วยการซื้ออาหาร
GROCERY การซื้อของชำ
MOBILE_RECHARGE การซื้อการเติมเงินมือถือแบบชำระล่วงหน้า

MerchantUnitMeasure

มาตรวัดราคาต่อหน่วยของผู้ขาย

การแสดง JSON 
{
  "measure": number,
  "unit": enum (Unit)
}
ช่อง
measure

number

ค่า: ตัวอย่าง 1.2
unit

enum (Unit)

หน่วย: ตัวอย่าง POUND, GRAM

หน่วย

Enum
UNIT_UNSPECIFIED ไม่ได้ระบุหน่วย
MILLIGRAM มิลลิกรัม
GRAM กรัม
KILOGRAM กิโลกรัม
OUNCE ออนซ์
POUND ปอนด์

PurchaseReturnsInfo

แสดงผลข้อมูลที่เชื่อมโยงกับคำสั่งซื้อหรือรายการโฆษณาที่เจาะจง

การแสดง JSON 
{
  "isReturnable": boolean,
  "daysToReturn": integer,
  "policyUrl": string
}
ช่อง
isReturnable

boolean

หากเป็น "จริง" อนุญาตให้คืนสินค้าได้
daysToReturn

integer

อนุญาตให้คืนสินค้าได้ภายในหลายวัน
policyUrl

string

ลิงก์ไปยังนโยบายคืนสินค้า

PurchaseFulfillmentInfo

ข้อมูลการดำเนินการคำสั่งซื้อที่เชื่อมโยงกับใบสั่งซื้อหรือรายการโฆษณาที่เฉพาะเจาะจง

การแสดง JSON 
{
  "id": string,
  "fulfillmentType": enum (Type),
  "expectedFulfillmentTime": {
    object (Time)
  },
  "expectedPreparationTime": {
    object (Time)
  },
  "location": {
    object (Location)
  },
  "expireTime": string,
  "price": {
    object (PriceAttribute)
  },
  "fulfillmentContact": {
    object (UserInfo)
  },
  "shippingMethodName": string,
  "storeCode": string,
  "pickupInfo": {
    object (PickupInfo)
  }
}
ช่อง
id

string

ตัวระบุที่ไม่ซ้ำกันสำหรับตัวเลือกบริการนี้
fulfillmentType

enum (Type)

ต้องระบุ: ประเภทของการดำเนินการตามคำสั่งซื้อ
expectedFulfillmentTime

object (Time)

กรอบเวลาหากมีการระบุช่วงเวลา หรือเวลาถึงโดยประมาณหากระบุช่วงเวลาเดียว เวลานำส่งหรือเวลาไปรับที่คาดไว้
expectedPreparationTime

object (Time)

กรอบเวลาหากมีการระบุช่วงเวลา หรือเวลาถึงโดยประมาณหากระบุช่วงเวลาเดียว ถึงเวลาเตรียมอาหารแล้ว แนะนำให้ทำแบบครั้งเดียว
location

object (Location)

สถานที่รับสินค้าหรือจัดส่ง
expireTime

string (Timestamp format)

เวลาที่ตัวเลือกการดำเนินการตามคำสั่งซื้อนี้จะหมดอายุ

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
price

object (PriceAttribute)

ค่าใช้จ่ายของตัวเลือกนี้
fulfillmentContact

object (UserInfo)

ข้อมูลติดต่อของผู้ใช้สำหรับการดำเนินการตามคำสั่งซื้อนี้
shippingMethodName

string

ชื่อของวิธีการจัดส่งที่ผู้ใช้เลือก
storeCode

string

รหัสร้านค้าของสถานที่ตั้ง ตัวอย่างเช่น Walmart เป็นผู้ขายและ storeCode คือร้านค้า Walmart ที่มีการดำเนินการตามคำสั่งซื้อ https://support.google.com/business/answer/3370250?ref_topic=4596653.
pickupInfo

object (PickupInfo)

ข้อมูลเพิ่มเติมเกี่ยวกับวิธีเลือกคำสั่งซื้อ ช่องนี้จะใช้ได้ก็ต่อเมื่อประเภทการดำเนินการเป็น PICKUP เท่านั้น

ประเภท

ประเภทการดำเนินการตามคำสั่งซื้อ

Enum
TYPE_UNSPECIFIED ยังไม่ระบุประเภท
DELIVERY ระบบจะส่งคำสั่งซื้อนี้
PICKUP ต้องไปรับสินค้าที่สั่งซื้อนี้

เวลา

โครงสร้างเวลาเพื่อแสดงเวลาของเหตุการณ์ที่จะใช้เมื่อแสดงคำสั่งซื้อแก่ผู้ใช้

การแสดง JSON 
{
  "timeIso8601": string
}
ช่อง
timeIso8601

string

แสดงเวลากิจกรรมการสั่งซื้อ เช่น เวลาจอง เวลานำส่ง และอื่นๆ อาจเป็นระยะเวลา (เวลาเริ่มต้นและเวลาสิ้นสุด) วันที่ วันที่และเวลา เป็นต้น โปรดดู https://en.wikipedia.org/wiki/ISO_8601 สำหรับรูปแบบทั้งหมดที่รองรับ

PickupInfo

รายละเอียดเกี่ยวกับวิธีรับสินค้าที่สั่งซื้อ ซึ่งจะมีรายละเอียดต่างๆ เช่น ประเภทการรับสินค้าและข้อมูลเมตาเพิ่มเติมที่แนบมากับแต่ละประเภท (หากมี)

การแสดง JSON 
{
  "pickupType": enum (PickupType),
  "curbsideInfo": {
    object (CurbsideInfo)
  },
  "checkInInfo": [
    {
      object (CheckInInfo)
    }
  ]
}
ช่อง
pickupType

enum (PickupType)

วิธีรับสินค้า เช่น INSTORE, CURBSIDE ฯลฯ
curbsideInfo

object (CurbsideInfo)

รายละเอียดที่เกี่ยวข้องกับข้อมูลริมทางโดยเฉพาะ หากpickupType ไม่ใช่ "CURBSIDE" ระบบจะไม่สนใจช่องนี้
checkInInfo[]

object (CheckInInfo)

รายการวิธีการต่างๆ ที่พาร์ทเนอร์รองรับเพื่อรองรับการเช็คอิน

PickupType

รายการประเภทการรับสินค้าที่รองรับ

Enum
UNSPECIFIED ไม่ได้ระบุประเภทการรับสินค้า
INSTORE เข้าไปรับอาหารในร้าน
CURBSIDE จอดรถในจุดที่กำหนดไว้ด้านนอกร้านอาหารและมีคนมาส่งอาหารที่นั่น

CurbsideInfo

รายละเอียดเกี่ยวกับวิธีการอำนวยความสะดวกให้กับการสั่งซื้อโดยไม่ต้องลงจากรถ

การแสดง JSON 
{
  "curbsideFulfillmentType": enum (CurbsideFulfillmentType),
  "userVehicle": {
    object (Vehicle)
  }
}
ช่อง
curbsideFulfillmentType

enum (CurbsideFulfillmentType)

พาร์ทเนอร์ต้องการข้อมูลเพิ่มเติมเพื่ออำนวยความสะดวกสำหรับคำสั่งซื้อแบบไปรับเองโดยไม่ต้องลงจากรถ ระบบจะรวบรวมรายละเอียดที่เกี่ยวข้องจากผู้ใช้ โดยขึ้นอยู่กับประเภทการจำหน่าย
userVehicle

object (Vehicle)

รายละเอียดยานพาหนะของผู้ใช้ที่สั่งซื้อ

CurbsideFulfillmentType

ค่าที่เป็นไปได้ของประเภทการดำเนินการโดยไม่ต้องลงจากรถ

Enum
UNSPECIFIED ไม่ได้ระบุประเภทการจำหน่ายโดยไม่ต้องลงจากรถ
VEHICLE_DETAIL ต้องมีรายละเอียดของยานพาหนะเพื่ออำนวยความสะดวกในการรับสินค้าโดยไม่ต้องลงจากรถ

ยานพาหนะ

รายละเอียดเกี่ยวกับยานพาหนะ

การแสดง JSON 
{
  "make": string,
  "model": string,
  "licensePlate": string,
  "colorName": string,
  "image": {
    object (Image)
  }
}
ช่อง
make

string

ยี่ห้อยานพาหนะ (เช่น "ฮอนด้า") ซึ่งจะแสดงต่อผู้ใช้และต้องแปลเป็นภาษาท้องถิ่น ต้องระบุ
model

string

รุ่นของยานพาหนะ (เช่น "Grom") ซึ่งจะแสดงต่อผู้ใช้และต้องแปลเป็นภาษาท้องถิ่น ต้องระบุ
licensePlate

string

หมายเลขป้ายทะเบียนยานพาหนะ (เช่น "1ABC234") ต้องระบุ
colorName

string

ชื่อสีของยานพาหนะ เช่น สีดำ (ไม่บังคับ)
image

object (Image)

URL ไปยังรูปภาพของยานพาหนะ รูปภาพจะแสดงขนาดประมาณ 256x256px ต้องเป็น jpg หรือ png ไม่บังคับ

CheckInInfo

พาร์ทเนอร์ต้องระบุข้อมูลเมตาเพื่อรองรับวิธีเช็คอิน

การแสดง JSON 
{
  "checkInType": enum (CheckInType)
}
ช่อง
checkInType

enum (CheckInType)

เมธอดที่ใช้ส่งวิธีการเช็คอิน

CheckInType

วิธีการต่างๆ ที่ใช้ในการส่งวิธีการเช็คอิน

Enum
CHECK_IN_TYPE_UNSPECIFIED ค่าที่ไม่รู้จัก
EMAIL ระบบจะส่งข้อมูลการเช็คอินทางอีเมล
SMS ระบบจะส่งข้อมูลการเช็คอินทาง SMS

ItemOption

แสดงส่วนเสริมหรือรายการย่อย

การแสดง JSON 
{
  "id": string,
  "name": string,
  "prices": [
    {
      object (PriceAttribute)
    }
  ],
  "note": string,
  "quantity": integer,
  "productId": string,
  "subOptions": [
    {
      object (ItemOption)
    }
  ]
}
ช่อง
id

string

สำหรับตัวเลือกที่เป็นสินค้า ให้ระบุรหัสสินค้าที่ไม่ซ้ำกัน
name

string

ชื่อตัวเลือก
prices[]

object (PriceAttribute)

ราคารวมของตัวเลือก
note

string

หมายเหตุที่เกี่ยวข้องกับตัวเลือก
quantity

integer

สำหรับตัวเลือกที่เป็นสินค้า จำนวน
productId

string

รหัสผลิตภัณฑ์หรือข้อเสนอที่เชื่อมโยงกับตัวเลือกนี้
subOptions[]

object (ItemOption)

เพื่อกำหนดตัวเลือกย่อยอื่นๆ ที่ฝังอยู่

ProductDetails

รายละเอียดเกี่ยวกับผลิตภัณฑ์

การแสดง JSON 
{
  "productId": string,
  "gtin": string,
  "plu": string,
  "productType": string,
  "productAttributes": {
    string: string,
    ...
  }
}
ช่อง
productId

string

รหัสผลิตภัณฑ์หรือข้อเสนอที่เชื่อมโยงกับรายการโฆษณานี้
gtin

string

หมายเลขสินค้าการค้าสากลของผลิตภัณฑ์ มีประโยชน์หากไม่มีรหัสข้อเสนอใน Merchant Center ไม่บังคับ
plu

string

รหัสค้นหาราคาหรือที่เรียกกันโดยทั่วไปว่ารหัส PLU, หมายเลข PLU, PLU, รหัสการผลิต หรือฉลากผลิต เป็นระบบตัวเลขที่ใช้ระบุผลิตภัณฑ์จำนวนมากซึ่งจำหน่ายในซูเปอร์มาร์เก็ตและซูเปอร์มาร์เก็ตโดยไม่ซ้ำกัน
productType

string

หมวดหมู่ผลิตภัณฑ์ที่กำหนดโดยผู้ขาย เช่น "หน้าแรก > ร้านขายของชำ > ผลิตภัณฑ์จากนมและ ไข่ > นม > นมเต็ม"
productAttributes

map (key: string, value: string)

รายละเอียดผลิตภัณฑ์ที่ผู้ขายระบุ เช่น { &quot;allergen&quot;: &quot;peanut&quot; } มีประโยชน์หากไม่มีรหัสข้อเสนอใน Merchant Center ไม่บังคับ

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

ReservationItemExtension

เนื้อหาของรายการโฆษณาสำหรับการสั่งซื้อการจอง เช่น ร้านอาหาร การตัดผม ฯลฯ

การแสดง JSON 
{
  "status": enum (ReservationStatus),
  "userVisibleStatusLabel": string,
  "type": enum (ReservationType),
  "reservationTime": {
    object (Time)
  },
  "userAcceptableTimeRange": {
    object (Time)
  },
  "confirmationCode": string,
  "partySize": integer,
  "staffFacilitators": [
    {
      object (StaffFacilitator)
    }
  ],
  "location": {
    object (Location)
  }
}
ช่อง
status

enum (ReservationStatus)

ต้องระบุ: สถานะการจอง
userVisibleStatusLabel

string

จำเป็น: ป้ายกำกับ/สตริงที่มองเห็นได้สำหรับผู้ใช้สำหรับสถานะ ความยาวสูงสุดคือ 50 อักขระ
type

enum (ReservationType)

ประเภทการจอง ยกเลิกการตั้งค่าหากไม่มีตัวเลือกประเภทที่เกี่ยวข้อง
reservationTime

object (Time)

เวลาที่กำหนดให้บริการ/เหตุการณ์เกิดขึ้น อาจเป็นช่วงเวลา วันที่ หรือวันที่และเวลาที่แน่นอน
userAcceptableTimeRange

object (Time)

ช่วงเวลาที่ผู้ใช้ยอมรับได้
confirmationCode

string

รหัสยืนยันสำหรับการจองนี้
partySize

integer

จำนวนคน
staffFacilitators[]

object (StaffFacilitator)

ผู้อำนวยความสะดวกพนักงานที่จะให้บริการจอง เช่น ช่างทำผม
location

object (Location)

ตำแหน่งของบริการ/กิจกรรม

ReservationStatus

สถานะการจอง

Enum
RESERVATION_STATUS_UNSPECIFIED สถานะที่ไม่ได้ระบุ
PENDING การจองนี้อยู่ระหว่างรอดำเนินการ
CONFIRMED ยืนยันการจองแล้ว
CANCELLED ผู้ใช้ยกเลิกการจองนี้
FULFILLED การจองได้รับการดำเนินการแล้ว
CHANGE_REQUESTED ส่งคำขอเปลี่ยนการจองแล้ว
REJECTED การจองหมดอายุหรือปฏิเสธโดยผู้รวมบริการ

ReservationType

ประเภทการจอง

Enum
RESERVATION_TYPE_UNSPECIFIED ไม่ได้ระบุประเภท
RESTAURANT การจองร้านอาหาร
HAIRDRESSER การจองสำหรับช่างทำผม

StaffFacilitator

ข้อมูลเกี่ยวกับพนักงานบริการ

การแสดง JSON 
{
  "name": string,
  "image": {
    object (Image)
  }
}
ช่อง
name

string

ชื่อวิทยากรของพนักงาน เช่น "จอห์น สมิธ"
image

object (Image)

รูปภาพของผู้แสดง

PaymentData

ข้อมูลการชำระเงินที่เกี่ยวข้องกับคำสั่งซื้อ

การแสดง JSON 
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
ช่อง
paymentResult

object (PaymentResult)

ผลลัพธ์การชำระเงินที่ผู้รวมระบบใช้เพื่อดำเนินการธุรกรรมให้เสร็จสมบูรณ์ Actions on Google จะป้อนข้อมูลในช่องนี้ หากการดำเนินการชำระเงินนั้นจัดการโดย Actions-on-Google
paymentInfo

object (PaymentInfo)

ข้อมูลการชำระเงินเกี่ยวกับคำสั่งซื้อที่เป็นประโยชน์ในการโต้ตอบที่แสดงต่อผู้ใช้

PaymentResult

ผลการชำระเงินที่ผู้รวมระบบใช้เพื่อทำธุรกรรมให้เสร็จสมบูรณ์

การแสดง JSON 
{

  // Union field result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}
ช่อง
ช่องการรวม result มีการระบุข้อมูลการชำระเงินของ Google หรือวิธีการชำระเงินของผู้ขาย result ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
googlePaymentData

string

ข้อมูลวิธีการชำระเงินที่ Google ระบุ หากผู้ประมวลผลการชำระเงินของคุณอยู่ในรายการผู้ประมวลผลการชำระเงินที่ Google รองรับที่นี่ https://developers.google.com/pay/api/ ไปที่ผู้ประมวลผลการชำระเงินผ่านลิงก์เพื่อดูรายละเอียดเพิ่มเติม หรือดูรายละเอียดเพย์โหลดในเอกสารประกอบต่อไปนี้ https://developers.google.com/pay/api/payment-data-cryptography
merchantPaymentMethodId

string

ผู้ขาย/การดำเนินการระบุวิธีการชำระเงินที่ผู้ใช้เลือก

PaymentInfo

ข้อมูลการชำระเงินเกี่ยวกับคำสั่งซื้อ Proto นี้จะบันทึกข้อมูลที่เป็นประโยชน์ในการโต้ตอบที่แสดงต่อผู้ใช้

การแสดง JSON 
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
ช่อง
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

ข้อมูลที่แสดงของวิธีการชำระเงินที่ใช้สำหรับธุรกรรม
paymentMethodProvenance

enum (PaymentMethodProvenance)

แหล่งที่มาของวิธีการชำระเงินที่ใช้สำหรับธุรกรรม ผู้ใช้อาจลงทะเบียนวิธีการชำระเงินเดียวกันกับทั้ง Google และผู้ขายแล้ว

PaymentMethodDisplayInfo

ผลการชำระเงินที่ผู้รวมระบบใช้เพื่อทำธุรกรรมให้เสร็จสมบูรณ์

การแสดง JSON 
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string,
  "paymentMethodVoiceName": string
}
ช่อง
paymentType

enum (PaymentType)

ประเภทของการชำระเงิน
paymentMethodDisplayName

string

ชื่อวิธีการชำระเงินที่ผู้ใช้มองเห็นได้ เช่น VISA **** 1234 บัญชีกระแสรายวัน **** 5678
paymentMethodVoiceName

string

สำหรับอุปกรณ์ Assistant ที่ใช้เสียงเท่านั้น เพื่อพูดชื่อวิธีการชำระเงินให้ผู้ใช้ทราบ ตัวอย่างเช่น "วีซ่าที่ลงท้ายด้วย 1234" หรือ "การตรวจสอบบัญชีที่ลงท้ายด้วย 5678" หมายเหตุ: นี่คือสตริงที่เพิ่มประสิทธิภาพเสียงที่จะใช้แทน paymentMethodDisplayName สำหรับอุปกรณ์ Assistant แบบเสียงเท่านั้น หากไม่ได้ตั้งค่าสตริงไว้ ระบบจะพูดออกเสียง paymentMethodDisplayName กับผู้ใช้แทน

PaymentType

PaymentType จะระบุรูปแบบการชำระเงินที่ใช้สำหรับวิธีการชำระเงินที่ผู้ขายระบุ การดำเนินการต้องระบุชื่อที่แสดงของวิธีการชำระเงินด้วย

Enum
PAYMENT_TYPE_UNSPECIFIED รูปแบบการชำระเงินที่ไม่ได้ระบุ
PAYMENT_CARD บัตรเครดิต/บัตรเดบิตหรือบัตรแบบชำระเงินล่วงหน้า
BANK วิธีการชำระเงินคือบัญชีธนาคาร
LOYALTY_PROGRAM วิธีการชำระเงินคือโปรแกรมสะสมคะแนน
CASH วิธีการชำระเงินเป็นเงินสด
GIFT_CARD วิธีการชำระเงินคือบัตรของขวัญ
WALLET Wallet ของบุคคลที่สาม เช่น PayPal

PaymentMethodProvenance

แสดงแหล่งที่มาของวิธีการชำระเงินที่ใช้สำหรับธุรกรรม

Enum
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED ไม่ได้ระบุแหล่งที่มา
PAYMENT_METHOD_PROVENANCE_GOOGLE แหล่งที่มาคือ Google
PAYMENT_METHOD_PROVENANCE_MERCHANT แหล่งที่มาคือผู้ขาย

โปรโมชัน

โปรโมชัน/ข้อเสนอที่เพิ่มลงในรถเข็น

การแสดง JSON 
{
  "coupon": string
}
ช่อง
coupon

string

ต้องระบุ: รหัสคูปองที่ใช้กับข้อเสนอนี้

PurchaseOrderExtension

ส่วนขยายคำสั่งซื้อสำหรับประเภทธุรกิจการซื้อ คุณสมบัติเหล่านี้จะมีผลกับรายการโฆษณาทั้งหมดในคำสั่งซื้อ เว้นแต่จะมีการลบล้างในรายการโฆษณา

การแสดง JSON 
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ],
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
ช่อง
status

enum (PurchaseStatus)

ต้องระบุ: สถานะโดยรวมสำหรับคำสั่งซื้อ
userVisibleStatusLabel

string

ป้ายกำกับ/สตริงที่ผู้ใช้เห็นสำหรับสถานะ ความยาวสูงสุดคือ 50 อักขระ
type

enum (PurchaseType)

ต้องระบุ: ประเภทของการซื้อ
returnsInfo

object (PurchaseReturnsInfo)

ข้อมูลการคืนสินค้าสำหรับคำสั่งซื้อ
fulfillmentInfo

object (PurchaseFulfillmentInfo)

ข้อมูลการดำเนินการสำหรับคำสั่งซื้อ
purchaseLocationType

enum (PurchaseLocationType)

สถานที่ซื้อ (ในร้าน / ออนไลน์)
errors[]

object (PurchaseError)

ไม่บังคับ: ข้อผิดพลาดเนื่องจากคำสั่งซื้อนี้ถูกปฏิเสธ
extension
(deprecated)

object

ฟิลด์พิเศษใดๆ ที่แลกเปลี่ยนระหว่างผู้ขายกับ Google หมายเหตุ: เราไม่แนะนำให้ใช้ส่วนขยายนี้ พิจารณาข้อใดข้อหนึ่งต่อไปนี้ตามกรณีการใช้งาน/สถานการณ์ 1. กำหนดฟิลด์ใน PurchaseOrderExtension หากสามารถนำไปใช้สำหรับ Use Case อื่นๆ (เช่น ความสามารถ/ฟังก์ชันทั่วไป) 2. ใช้ vertical_extension หากเฉพาะเจาะจงสําหรับกรณีการใช้งาน/ฟีเจอร์ที่กําหนดเองซึ่งไม่ใช่ทั่วไป

ออบเจ็กต์ที่มีช่องประเภทที่กำหนดเอง ช่องเพิ่มเติม "@type" จะมี URI ที่ระบุประเภท ตัวอย่างเช่น { "id": 1234, "@type": "types.example.com/standard/id" }

PurchaseLocationType

ประเภทสถานที่ของการซื้อ

Enum
UNSPECIFIED_LOCATION ค่าที่ไม่รู้จัก
ONLINE_PURCHASE การซื้อทั้งหมดที่ซื้อทางออนไลน์
INSTORE_PURCHASE การซื้อในร้านค้าทั้งหมด

PurchaseError

ข้อผิดพลาดที่อาจปฏิเสธใบสั่งซื้อ

การแสดง JSON 
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}
ช่อง
type

enum (ErrorType)

ต้องระบุ: ข้อมูลนี้เป็นเหตุผลอย่างละเอียดที่ผู้ขายปฏิเสธคำสั่งซื้อ
description

string

คำอธิบายข้อผิดพลาดเพิ่มเติม
entityId

string

รหัสเอนทิตีที่สอดคล้องกับข้อผิดพลาด ตัวอย่างนี้อาจสอดคล้องกับ LineItemId / ItemOptionId
updatedPrice

object (PriceAttribute)

เกี่ยวข้องในกรณีของข้อผิดพลาดประเภท PRICE_CHANGED / INCORRECT_PRICE
availableQuantity

integer

จำนวนสินค้าที่พร้อมจำหน่ายในขณะนี้ ใช้ได้ในกรณี AVAILABILITY_CHANGED

ErrorType

ประเภทข้อผิดพลาดที่เป็นไปได้

Enum
ERROR_TYPE_UNSPECIFIED ข้อผิดพลาดที่ไม่รู้จัก
NOT_FOUND ไม่พบเอนทิตี ซึ่งอาจเป็น Item, FulfillmentOption, promotion ต้องระบุรหัสเอนทิตี
INVALID ข้อมูลเอนทิตีไม่ถูกต้อง อาจเป็น Item, FulfillmentOption, Promotion ต้องระบุรหัสเอนทิตี
AVAILABILITY_CHANGED สินค้าไม่พร้อมจำหน่าย หรือมีสินค้าไม่เพียงพอที่จะดำเนินการตามคำขอ ต้องระบุรหัสเอนทิตี
PRICE_CHANGED ราคาสินค้าแตกต่างจากราคาในเอนทิตีสินค้า ต้องระบุรหัสเอนทิตีและราคาที่อัปเดตแล้ว
INCORRECT_PRICE ข้อผิดพลาดด้านราคาในส่วนค่าธรรมเนียม ยอดรวม ต้องระบุรหัสเอนทิตีและราคาที่อัปเดตแล้ว
REQUIREMENTS_NOT_MET ไม่เป็นไปตามข้อจำกัดสำหรับการรับคำสั่งซื้อ - ขนาดตะกร้าขั้นต่ำ ฯลฯ
TOO_LATE FulfillmentOption หมดอายุแล้ว
NO_CAPACITY ไม่มีความจุที่ใช้ได้ ใช้รหัสข้อผิดพลาดนี้หากไม่มีประเภทข้อผิดพลาดแบบละเอียดที่เกี่ยวข้อง
NO_COURIER_AVAILABLE ไม่พบผู้ให้บริการจัดส่ง ประเภทข้อผิดพลาดแบบละเอียดที่อาจจัดอยู่ในหมวดหมู่ NO_CAPACITY
INELIGIBLE ผู้ใช้ไม่มีสิทธิ์สั่งซื้อ (อยู่ในรายการที่ไม่อนุญาต)
OUT_OF_SERVICE_AREA ไม่สามารถส่งไปยังที่อยู่ที่ขอได้เนื่องจากกฎเกี่ยวกับพรมแดนและอื่นๆ
CLOSED ร้านอาหารปิดทำการในช่วงเวลาสั่งอาหาร
PROMO_NOT_APPLICABLE รหัสข้อผิดพลาดทั่วไปสำหรับตรวจจับกรณีทั้งหมดของการไม่ใช้รหัสโปรโมชัน หากไม่มีข้อใดที่เหมาะสม เพิ่มรหัสโปรโมชันเป็นรหัสเอนทิตี
PROMO_NOT_RECOGNIZED พาร์ทเนอร์ไม่รู้จักรหัสคูปอง เพิ่มรหัสโปรโมชันเป็นรหัสเอนทิตี
PROMO_EXPIRED สมัครไม่ได้เนื่องจากโปรโมชันหมดอายุแล้ว เพิ่มรหัสโปรโมชันเป็นรหัสเอนทิตี
PROMO_USER_INELIGIBLE ผู้ใช้ปัจจุบันไม่มีสิทธิ์รับคูปองนี้ เพิ่มรหัสโปรโมชันเป็นรหัสเอนทิตี
PROMO_ORDER_INELIGIBLE คำสั่งซื้อปัจจุบันไม่มีสิทธิ์ใช้คูปองนี้ เพิ่มรหัสโปรโมชันเป็นรหัสเอนทิตี
UNAVAILABLE_SLOT ช่วงเวลาการสั่งจองล่วงหน้าไม่พร้อมใช้งาน
FAILED_PRECONDITION ไม่เป็นไปตามข้อจำกัดสำหรับการรับคำสั่งซื้อ - ขนาดตะกร้าขั้นต่ำ ฯลฯ
PAYMENT_DECLINED การชำระเงินไม่ถูกต้อง
MERCHANT_UNREACHABLE ไม่สามารถเข้าถึงผู้ขายได้ ซึ่งจะมีประโยชน์เมื่อพาร์ทเนอร์เป็นผู้รวบรวมข้อมูลและไม่สามารถเข้าถึงผู้ขายได้
ACCOUNT_LINKING_FAILED ผู้ขายพยายามลิงก์บัญชี Google ของผู้ใช้กับบัญชีในระบบ แต่พบข้อผิดพลาดขณะดำเนินการ

TicketOrderExtension

สั่งซื้อเนื้อหาสำหรับคำสั่งซื้อตั๋ว เช่น ภาพยนตร์ กีฬา ฯลฯ

การแสดง JSON 
{
  "ticketEvent": {
    object (TicketEvent)
  }
}
ช่อง
ticketEvent

object (TicketEvent)

มีการใช้เหตุการณ์กับตั๋วรายการโฆษณาทั้งหมด

TicketEvent

แสดงเหตุการณ์เดียว

การแสดง JSON 
{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}
ช่อง
type

enum (Type)

ต้องระบุ: ประเภทตั๋วกิจกรรม เช่น ภาพยนตร์ คอนเสิร์ต
name

string

ต้องระบุ: ชื่อเหตุการณ์ ตัวอย่างเช่น หากกิจกรรมเป็นภาพยนตร์ ก็ควรเป็นชื่อภาพยนตร์
description

string

คำอธิบายกิจกรรม
url

string

URL ไปยังข้อมูลกิจกรรม
location

object (Location)

สถานที่ที่จัดกิจกรรมหรือองค์กรอยู่
eventCharacters[]

object (EventCharacter)

ตัวละครที่เกี่ยวข้องกับกิจกรรมนี้ อาจเป็นผู้กำกับหรือนักแสดงกิจกรรมภาพยนตร์ หรือผู้แสดงคอนเสิร์ต เป็นต้น
startDate

object (Time)

เวลาเริ่มต้น
endDate

object (Time)

เวลาสิ้นสุด
doorTime

object (Time)

เวลาเริ่มงาน ซึ่งอาจต่างจากเวลาเริ่มต้นของกิจกรรม เช่น กิจกรรมเริ่มเวลา 9.00 น. แต่เริ่มงานเวลา 8.30 น.

ประเภท

ประเภทของเหตุการณ์

Enum
EVENT_TYPE_UNKNOWN ประเภทเหตุการณ์ที่ไม่รู้จัก
MOVIE ภาพยนตร์
CONCERT คอนเสิร์ต
SPORTS กีฬา

EventCharacter

อักขระเหตุการณ์ 1 ตัว เช่น ผู้จัดงาน นักแสดง ฯลฯ

การแสดง JSON 
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
ช่อง
type

enum (Type)

ประเภทอักขระของเหตุการณ์ เช่น นักแสดงหรือผู้กำกับ
name

string

ชื่อตัวละคร
image

object (Image)

รูปภาพของตัวละคร

ประเภท

ประเภทอักขระ

Enum
TYPE_UNKNOWN ประเภทที่ไม่รู้จัก
ACTOR ผู้ดำเนินการ
PERFORMER ผู้แสดง
DIRECTOR ผู้กำกับ
ORGANIZER ผู้จัด

UserNotification

การแจ้งเตือนผู้ใช้ที่ไม่บังคับที่จะแสดงเป็นส่วนหนึ่งของการอัปเดตคำสั่งซื้อ

การแสดง JSON 
{
  "title": string,
  "text": string
}
ช่อง
title

string

ชื่อการแจ้งเตือนผู้ใช้ ความยาวสูงสุดคือ 30 อักขระ
text

string

เนื้อหาของการแจ้งเตือน ความยาวสูงสุดคือ 100 อักขระ

NextScene

แสดงฉากที่จะดำเนินการถัดไป

การแสดง JSON 
{
  "name": string
}
ช่อง
name

string

ชื่อฉากที่จะดำเนินการถัดไป

เซสชัน

มีข้อมูลของเซสชันการสนทนาปัจจุบัน

การแสดง JSON 
{
  "id": string,
  "params": {
    string: value,
    ...
  },
  "typeOverrides": [
    {
      object (TypeOverride)
    }
  ],
  "languageCode": string
}
ช่อง
id

string

ต้องระบุ รหัสที่ไม่ซ้ำกันทั่วโลกของเซสชันการสนทนาปัจจุบัน ช่องนี้เป็นแบบอ่านอย่างเดียว
params

map (key: string, value: value (Value format))

ต้องระบุ รายการพารามิเตอร์ทั้งหมดที่รวบรวมจากแบบฟอร์มและ Intent ระหว่างเซสชัน คีย์คือชื่อพารามิเตอร์ พารามิเตอร์ที่กำหนดไว้ที่นี่จะรวมเข้ากับพารามิเตอร์ที่กำหนดไว้แล้วในเซสชัน ระบบจะนำพารามิเตอร์ที่มีค่า Null ออกจากเซสชัน ดูเอกสารประกอบเกี่ยวกับพื้นที่เก็บข้อมูลเซสชันที่ https://developers.google.com/assistant/conversational/storage-session

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
typeOverrides[]

object (TypeOverride)

ไม่บังคับ ประเภทที่กำหนดขอบเขตเฉพาะเซสชัน การกำหนดประเภทเซสชันเป็นส่วนเสริมหรือแทนที่ประเภทที่มีอยู่ได้ ชื่อประเภทต้องไม่ซ้ำกัน
languageCode

string

ภาษาของเซสชันการสนทนาปัจจุบัน เป็นไปตามรหัสภาษา IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt ซึ่งอาจแตกต่างจากภาษาของผู้ใช้หากการดำเนินการใช้ฟีเจอร์หลายภาษา ตัวอย่างเช่น เมื่อมีการตั้งค่าเครื่องจัดการ_response.expected.language_code ระบบจะเปลี่ยนภาษาการสนทนาสำหรับการเลี้ยวทั้งหมดหลังจากนั้น ซึ่งจะแสดงในช่องนี้

TypeOverride

แทนการลบล้างสำหรับประเภท

การแสดง JSON 
{
  "name": string,
  "mode": enum (TypeOverrideMode),
  "synonym": {
    object (SynonymType)
  }
}
ช่อง
name

string

ต้องระบุ ชื่อของประเภทที่จะเสริมหรือลบล้าง
mode

enum (TypeOverrideMode)

ต้องระบุ วิธีผสานประเภทนี้กับค่าประเภทอื่น
synonym

object (SynonymType)

TypeOverrideMode

ประเภทของการแก้ไขสำหรับประเภทเอนทิตีของเซสชัน

Enum
TYPE_UNSPECIFIED ไม่ได้ระบุ ไม่ควรใช้ค่านี้
TYPE_REPLACE คำจำกัดความของประเภทในการตอบกลับนี้จะแทนที่คำจำกัดความของประเภทที่กำหนดไว้ก่อนหน้านี้
TYPE_MERGE คำจำกัดความของประเภทในคำตอบนี้จะผสานกับคำจำกัดความของประเภทที่กำหนดไว้ก่อนหน้านี้ คําจํากัดความประเภทใหม่จะเขียนทับคําจํากัดความประเภทที่มีอยู่

SynonymType

แสดงประเภทที่มีคำพ้องความหมาย

การแสดง JSON 
{
  "entries": [
    {
      object (Entry)
    }
  ]
}
ช่อง
entries[]

object (Entry)

ต้องระบุ รายการรายการสำหรับประเภทคำพ้องความหมาย

รายการ

แสดงรายการสำหรับประเภทคำพ้องความหมาย

การแสดง JSON 
{
  "name": string,
  "synonyms": [
    string
  ],
  "display": {
    object (EntryDisplay)
  }
}
ช่อง
name

string

ต้องระบุ ชื่อของรายการ (เช่น "จักรยาน") รายการในช่องนี้ต้องรวมอยู่ในช่องคำพ้องความหมายที่ซ้ำกัน จึงจะถือว่าเป็นค่าประเภทที่ถูกต้อง
synonyms[]

string

ต้องระบุ รายการคำพ้องความหมายสำหรับข้อความ (เช่น "จักรยาน", "จักรยาน")
display

object (EntryDisplay)

ไม่บังคับ แสดงข้อมูลของรายการ

EntryDisplay

การแสดง JSON 
{
  "title": string,
  "description": string,
  "image": {
    object (Image)
  },
  "footer": string,
  "openUrl": {
    object (OpenUrl)
  }
}
ช่อง
title

string

ต้องระบุ ชื่อของสินค้า เมื่อแตะ ข้อความนี้จะโพสต์กลับไปที่การสนทนาแบบคำต่อคำราวกับว่าผู้ใช้ได้พิมพ์ลงไป แต่ละชื่อต้องไม่ซ้ำกันในชุดรายการคอลเล็กชัน
description

string

ไม่บังคับ ข้อความเนื้อหาของการ์ด
image

object (Image)

ไม่บังคับ รูปภาพที่จะแสดง
footer

string

ไม่บังคับ ข้อความส่วนท้ายสำหรับรายการคอลเล็กชันการเรียกดู แสดงใต้คำอธิบาย ข้อความบรรทัดเดียวที่ตัดให้สั้นลงด้วยจุดไข่ปลา
openUrl

object (OpenUrl)

URL ของเอกสารที่เชื่อมโยงกับรายการภาพสไลด์ จำเป็นสำหรับการเรียกดูภาพสไลด์

ผู้ใช้

แสดงถึงผู้ใช้ที่ส่งคำขอไปยังการดำเนินการ

การแสดง JSON 
{
  "locale": string,
  "params": {
    string: value,
    ...
  },
  "accountLinkingStatus": enum (AccountLinkingStatus),
  "verificationStatus": enum (UserVerificationStatus),
  "lastSeenTime": string,
  "engagement": {
    object (Engagement)
  },
  "packageEntitlements": [
    {
      object (PackageEntitlements)
    }
  ],
  "permissions": [
    enum (Permission)
  ]
}
ช่อง
locale

string

การตั้งค่าภาษาหลักของผู้ใช้ที่ส่งคำขอ เป็นไปตามรหัสภาษา IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt อย่างไรก็ตาม จะไม่มีแท็กย่อยของสคริปต์รวมอยู่ด้วย
params

map (key: string, value: value (Value format))

ไม่บังคับ รายการพารามิเตอร์ทั้งหมดที่เชื่อมโยงกับผู้ใช้ปัจจุบัน ดูเอกสารเกี่ยวกับพื้นที่เก็บข้อมูลของผู้ใช้ได้ที่ https://developers.google.com/assistant/conversational/storage-user

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
accountLinkingStatus

enum (AccountLinkingStatus)

บัญชีผู้ใช้ลิงก์กับแอปหรือไม่
verificationStatus

enum (UserVerificationStatus)

ระบุสถานะการยืนยันของผู้ใช้
lastSeenTime

string (Timestamp format)

การประทับเวลาการโต้ตอบครั้งล่าสุดกับผู้ใช้รายนี้ ระบบจะละช่องนี้ไว้หากผู้ใช้ไม่เคยโต้ตอบกับตัวแทนมาก่อน

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
engagement

object (Engagement)

การมีส่วนร่วมของผู้ใช้ปัจจุบัน รวมถึงการสมัครใช้บริการ Intent
packageEntitlements[]

object (PackageEntitlements)

การให้สิทธิ์ของผู้ใช้ที่เกี่ยวข้องกับแพ็กเกจ Android ที่เชื่อมโยงกับการดำเนินการปัจจุบัน
permissions[]

enum (Permission)

มีสิทธิ์ที่ผู้ใช้มอบให้สำหรับการดำเนินการนี้

AccountLinkingStatus

ระบุว่าผู้ใช้ปลายทางลิงก์บัญชีกับแอปนี้หรือไม่ ดูเอกสารการลิงก์บัญชีที่ https://developers.google.com/assistant/identity

Enum
ACCOUNT_LINKING_STATUS_UNSPECIFIED ไม่รู้จัก
NOT_LINKED ผู้ใช้ยังไม่ได้ลิงก์บัญชีกับแอปนี้
LINKED ผู้ใช้ได้ลิงก์บัญชีกับแอปนี้

UserVerificationStatus

ระบุว่า Google ได้ยืนยันผู้ใช้แล้วหรือไม่ สถานะ "ยืนยันแล้ว" บ่งบอกว่าคุณบันทึกข้อมูลในการสนทนาต่างๆ ได้โดยใช้ช่องพารามิเตอร์หรือการลิงก์บัญชี

Enum
USER_VERIFICATION_STATUS_UNSPECIFIED ไม่รู้จัก
GUEST ผู้ใช้ที่เป็นผู้มาเยือน
VERIFIED ผู้ใช้ที่ผ่านการยืนยัน

การมีส่วนร่วม

ให้ข้อมูลเพิ่มเติมแบบอ่านอย่างเดียวเกี่ยวกับกลไกการมีส่วนร่วมที่ผู้ใช้ปัจจุบันลงทะเบียนไว้ ตัวอย่างเช่น การทราบความตั้งใจที่ผู้ใช้สมัครใช้บริการแล้วอาจเป็นประโยชน์เพื่อหลีกเลี่ยงการขอให้ผู้ใช้สมัครใช้บริการด้วยความตั้งใจเดิมอีก เช่น ระบบสามารถใช้ข้อมูลนี้เพื่อกำหนดเส้นทางไปยังฉากตามเงื่อนไขเพื่อตั้งค่า DailyUpdates หรือ PushNotifications เฉพาะในกรณีที่ผู้ใช้ยังไม่ได้สมัครใช้บริการ ดูเอกสารเกี่ยวกับการมีส่วนร่วมของผู้ใช้ที่ https://developers.google.com/assistant/engagement

การแสดง JSON 
{
  "pushNotificationIntents": [
    {
      object (IntentSubscription)
    }
  ],
  "dailyUpdateIntents": [
    {
      object (IntentSubscription)
    }
  ]
}
ช่อง
pushNotificationIntents[]

object (IntentSubscription)

มีรายการของ Intent ที่ผู้ใช้เปิดใช้ข้อความ Push ไว้
dailyUpdateIntents[]

object (IntentSubscription)

มีรายการ Intent ที่ผู้ใช้เปิดใช้การอัปเดตรายวัน

IntentSubscription

อธิบาย IntentSubscription ที่มีอยู่

การแสดง JSON 
{
  "intent": string,
  "contentTitle": string
}
ช่อง
intent

string

ชื่อของ Intent ที่สมัครใช้บริการ
contentTitle

string

คำอธิบายสั้นๆ ของการสมัครใช้บริการ ซึ่งจะใช้เป็นป้ายกำกับของการแจ้งเตือนและเมื่อ Assistant ขอสิทธิ์จากผู้ใช้

PackageEntitlements

รายการการให้สิทธิ์ของผู้ใช้ที่เกี่ยวข้องกับชื่อแพ็กเกจ ดูเอกสารประกอบเกี่ยวกับธุรกรรมสินค้าดิจิทัลที่ https://developers.google.com/assistant/transactions/digital/dev-guide-digital-non-consumables

การแสดง JSON 
{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}
ช่อง
packageName

string

ชื่อแพ็กเกจ Android ที่ระบุในแพ็กเกจการดำเนินการ
entitlements[]

object (Entitlement)

การให้สิทธิ์ของผู้ใช้สำหรับแพ็กเกจที่ระบุ

การให้สิทธิ์

กำหนดการให้สิทธิ์ดิจิทัลของผู้ใช้

การแสดง JSON 
{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
ช่อง
sku

string

SKU ของผลิตภัณฑ์ ชื่อแพ็กเกจสำหรับแอปที่ต้องซื้อ คำต่อท้ายของ Finsky docid สำหรับการซื้อในแอปและการสมัครใช้บริการในแอป จับคู่ getSku() ใน Play InApp Billing API ดูเอกสารประกอบการเรียกเก็บเงินในแอปของ Play ได้ที่ https://developer.android.com/google/play/billing
skuType

enum (SkuType)

ประเภทของ SKU
inAppDetails

object (SignedData)

นำเสนอสำหรับการซื้อในแอปและการสมัครใช้บริการในแอปเท่านั้น

SkuType

Enum
SKU_TYPE_UNSPECIFIED
IN_APP ทำการซื้อในแอป
SUBSCRIPTION การสมัครใช้บริการ
APP แอปที่ต้องซื้อ

SignedData

การแสดง JSON 
{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}
ช่อง
inAppPurchaseData

object (Struct format)

มีข้อมูลการซื้อในแอปทั้งหมดในรูปแบบ JSON ดูรายละเอียดในตารางที่ 6 ของ https://developer.android.com/google/play/billing/billing_reference.html
inAppDataSignature

string

ตรงกับ IN_APP_DATA_SIGNATURE จากเมธอด getPurchases() ใน Play InApp Billing API

สิทธิ์

ค่าที่เป็นไปได้สำหรับสิทธิ์

Enum
PERMISSION_UNSPECIFIED สิทธิ์ที่ไม่ได้ระบุ
DEVICE_PRECISE_LOCATION ขอตำแหน่งที่แน่นอนของผู้ใช้ ละติจูด/ลองจิจูด และที่อยู่ที่จัดรูปแบบ
DEVICE_COARSE_LOCATION ขอตำแหน่งคร่าวๆ รหัสไปรษณีย์ เมือง และรหัสประเทศของผู้ใช้
UPDATE ขอสิทธิ์เพื่อส่งการอัปเดต โปรดดูที่ https://developers.google.com/assistant/engagement/daily

เคหสถาน

แสดงโครงสร้าง HomeGraph ที่มีอุปกรณ์เป้าหมายของผู้ใช้

การแสดง JSON 
{
  "params": {
    string: value,
    ...
  }
}
ช่อง
params

map (key: string, value: value (Value format))

ไม่บังคับ รายการพารามิเตอร์ที่เชื่อมโยงกับโครงสร้าง HomeGraph ที่มีอุปกรณ์เป้าหมายอยู่ ดูเอกสารเกี่ยวกับพื้นที่เก็บข้อมูลในบ้านได้ที่ https://developers.google.com/assistant/conversational/storage-home

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

อุปกรณ์

แสดงอุปกรณ์ที่ผู้ใช้ใช้เพื่อส่งคำขอไปยังการดำเนินการ

การแสดง JSON 
{
  "capabilities": [
    enum (Capability)
  ],
  "currentLocation": {
    object (Location)
  },
  "timeZone": {
    object (TimeZone)
  }
}
ช่อง
capabilities[]

enum (Capability)

ต้องระบุ ความสามารถของอุปกรณ์ในการส่งคำขอไปยังการดำเนินการ
currentLocation

object (Location)

ไม่บังคับ ตำแหน่งอุปกรณ์ของผู้ใช้ โปรดทราบว่าระบบจะป้อนข้อมูลนี้หลังจากผู้ใช้ปลายทางให้สิทธิ์เข้าถึงตำแหน่งแล้วเท่านั้น ดูข้อความตำแหน่งเพื่อดูรายละเอียดเพิ่มเติมเกี่ยวกับการตั้งค่าช่องตามสิทธิ์คร่าวๆ กับสิทธิ์แบบละเอียด ดูเอกสารเกี่ยวกับสิทธิ์ที่ https://developers.google.com/assistant/conversational/permissions
timeZone

object (TimeZone)

ไม่บังคับ เขตเวลาที่เชื่อมโยงกับอุปกรณ์ไคลเอ็นต์ ซึ่งสามารถใช้เพื่อแก้ไขค่าวันที่และเวลา

ความสามารถ

ความสามารถของแพลตฟอร์มของอุปกรณ์ ณ เวลาที่ขอ

Enum
UNSPECIFIED ความสามารถของอุปกรณ์ที่ไม่ระบุ
SPEECH อุปกรณ์พูดคุยกับผู้ใช้ผ่านการอ่านออกเสียงข้อความหรือ SSML ได้
RICH_RESPONSE อุปกรณ์สามารถแสดงคำตอบที่สมบูรณ์ เช่น การ์ด รายการ และตาราง
LONG_FORM_AUDIO อุปกรณ์เล่นสื่อเสียงแบบยาวได้ เช่น เพลงและพอดแคสต์
INTERACTIVE_CANVAS อุปกรณ์แสดงการตอบกลับแคนวาสแบบอินเทอร์แอกทีฟได้
HOME_STORAGE อุปกรณ์รองรับการบันทึกและดึงข้อมูลพื้นที่เก็บข้อมูลในบ้าน

ตำแหน่ง

คอนเทนเนอร์ที่แสดงสถานที่ตั้ง

การแสดง JSON 
{
  "coordinates": {
    object (LatLng)
  },
  "postalAddress": {
    object (PostalAddress)
  }
}
ช่อง
coordinates

object (LatLng)

พิกัดทางภูมิศาสตร์ ต้องมีสิทธิ์ [DEVICE_PRECISE_LOCATION]
postalAddress

object (PostalAddress)

ที่อยู่ทางไปรษณีย์ ต้องมีสิทธิ์ [DEVICE_PRECISE_LOCATION] หรือ [DEVICE_COARSE_LOCATION] เมื่อให้สิทธิ์เข้าถึงตำแหน่งคร่าวๆ แล้ว จะมีเพียง "รหัสไปรษณีย์" เท่านั้น และ "locality" จะมีการป้อนข้อมูลในฟิลด์ต่างๆ สิทธิ์เข้าถึงตําแหน่งที่แน่นอนจะแสดงช่องเพิ่มเติม เช่น "administrativeArea" และ "addressLines"

TimeZone

แสดงเขตเวลาจากฐานข้อมูลเขตเวลาของ IANA

การแสดง JSON 
{
  "id": string,
  "version": string
}
ช่อง
id

string

เขตเวลาของฐานข้อมูลเขตเวลา IANA เช่น "America/New_York"
version

string

ไม่บังคับ หมายเลขเวอร์ชันฐานข้อมูลเขตเวลาของ IANA เช่น "2019a"

บริบท

มีข้อมูลบริบทเมื่อผู้ใช้ทำการค้นหา บริบทดังกล่าวรวมถึงแต่ไม่จำกัดเพียงข้อมูลเกี่ยวกับเซสชันสื่อที่มีการใช้งาน สถานะของเว็บแอป Canvas ฯลฯ

การแสดง JSON 
{
  "media": {
    object (MediaContext)
  },
  "canvas": {
    object (CanvasContext)
  }
}
ช่อง
media

object (MediaContext)

มีข้อมูลบริบทเกี่ยวกับเซสชันสื่อที่ใช้งานอยู่ในปัจจุบัน
canvas

object (CanvasContext)

มีข้อมูลบริบทเกี่ยวกับ Canvas ปัจจุบัน

MediaContext

มีข้อมูลบริบทเกี่ยวกับเซสชันสื่อที่ใช้งานอยู่ในปัจจุบัน

การแสดง JSON 
{
  "progress": string,
  "index": integer
}
ช่อง
progress

string (Duration format)

ความคืบหน้าของสื่อของไฟล์สื่อที่ใช้งานอยู่ในปัจจุบัน

ระยะเวลาเป็นวินาทีโดยมีเลขเศษส่วนไม่เกิน 9 หลัก สิ้นสุดด้วย "s" ตัวอย่างเช่น "3.5s"
index

integer

ดัชนีแบบ 0 ของไฟล์สื่อที่ใช้งานอยู่ในปัจจุบันในรายการไฟล์สื่อในการตอบกลับสื่อ

CanvasContext

มีข้อมูลบริบทเกี่ยวกับ Canvas ปัจจุบัน

การแสดง JSON 
{
  "state": value
}
ช่อง
state

value (Value format)

ไม่บังคับ สถานะที่กำหนดโดยแอป 3P Interactive Canvas การตั้งค่านี้ตั้งไว้สำหรับคำขอเท่านั้น ไม่ใช่สำหรับการตอบกลับ ตัวอย่างเช่น หากนี่เป็นแอปสูตรอาหาร สถานะอาจเป็นค่าของ struct : { "current_page" : 5, "last_page" : 3, } ขนาดสูงสุดคือ 50 KB

ที่คาดไว้

อธิบายความคาดหวังสำหรับการเปลี่ยนกล่องโต้ตอบครั้งถัดไป

การแสดง JSON 
{
  "speech": [
    string
  ]
}
ช่อง
speech[]

string

รายการวลีที่การดำเนินการนี้คาดหวังจากเสียงพูดของผู้ใช้สำหรับการให้น้ำหนักคำพูด มีวลีได้ไม่เกิน 1,000 รายการ หมายเหตุ: ช่องนี้มีความหมายเดียวกับ ExpectInput.speech_biasing_hints ใน API v2