Order

訂單實體。注意：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 指派的訂單 ID。

merchantOrderId

string

必填：商家指定的內部訂單 ID。此 ID 不得重複，而且是後續訂單更新作業的必要項目。這個 ID 可設為提供的 googleOrderId 或任何其他不重複的值。請注意，向使用者顯示的 ID 是 userVisibleOrderId，可能會是另一個更易用的值。長度上限為 128 個字元。

userVisibleOrderId

string

參照目前訂單的使用者 ID。這個 ID 應與這個訂單在其他內容 (包括網站、應用程式和電子郵件) 中顯示的 ID 一致。

userVisibleStateLabel
(deprecated)

string

已淘汰：請改用 OrderExtensions 狀態。此訂單狀態的使用者可見標籤。
buyerInfo

object (UserInfo)

買方資訊。

image

object (Image)

與訂單相關的圖片。

createTime

string (Timestamp format)

必填：訂單建立日期和時間。

RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位。範例："2014-10-02T15:01:23.045123456Z"。
lastUpdateTime

string (Timestamp format)

訂單上次更新日期和時間。對 OrderUpdate 來說為必填。

RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位。範例："2014-10-02T15:01:23.045123456Z"。
transactionMerchant

object (Merchant)

進行結帳的商家。這可能與委刊項層級供應商不同。範例：包含 ANA 委刊項的 Expedia 訂單。

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)

使用者的電話號碼。

PhoneNumber

標準電話號碼表示法。

JSON 表示法 
{
  "e164PhoneNumber": string,
  "extension": string,
  "preferredDomesticCarrierCode": string
}
欄位
e164PhoneNumber

string

E.164 格式的電話號碼，如國際電信聯盟 (ITU) 建議 E.164 所定義。維基連結：https://en.wikipedia.org/wiki/E.164

extension

string

ITU 建議並未標準化副檔名，但可定義為一系列長度上限為 40 位數的數字。它定義為字串，以在延伸中使用開頭的零 (組織完全自由，因為並未定義標準)。除數字外，其他某些撥號字元，例如「,」(表示等待) 可能會儲存在這裡。例如「xxx-xxx-xxxx ext」。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": number,
  "width": number
}
欄位
url

string

圖片的來源網址。圖片可以是 JPG、PNG 和 GIF (動畫及非動畫)。例如：https://www.agentx.com/logo.png。這是必要項目。

accessibilityText

string

用於無障礙的圖片文字說明，例如例如螢幕閱讀器和螢幕閱讀器等這是必要項目。

height

number

圖片的高度 (以像素為單位)。(選用)

width

number

圖片寬度 (以像素為單位)。(選用)

商家

購物車/訂單/委刊項的商家。

JSON 表示法 
{
  "id": string,
  "name": string,
  "image": {
    object (Image)
  },
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "address": {
    object (Location)
  }
}
欄位
id

string

指派給商家的選用 ID (如有)。

name

string

商家名稱，例如「Panera Bread」。

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.Permission.DEVICE_PRECISE_LOCATION] 權限。
formattedAddress

string

顯示地址，例如「110 臺北市信義區信義路五段 7 號」。需要 [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] 權限。
zipCode

string

郵遞區號。需要 [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] 或 [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] 權限。
city

string

市區鄉鎮。需要 [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] 或 [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] 權限。
postalAddress

object (PostalAddress)

郵政地址。需要 [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] 或 [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.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

表示郵寄地址，如郵政快遞或付款地址。如果是郵寄地址，郵政服務可將貨品寄送到場所、郵政信箱或類似位置。此表示法並不適用於建立地理位置 (街道、鄉鎮或山區) 的模型。

在一般使用情況下，系統會根據處理作業的類型，以使用者輸入或匯入現有資料的方式來建立地址。

地址輸入/編輯的建議：- 使用支援 i18n 的地址小工具 (例如 https://github.com/google/libaddressinput) - 在使用者使用該欄位的國家/地區之外，不應向使用者顯示用於輸入或編輯欄位的 UI 元素。

如要進一步瞭解如何使用這個結構定義，請參閱：https://support.google.com/business/answer/6397478

JSON 表示法 
{
  "revision": number,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
欄位
revision

number

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

選用設定。一般是指地址的縣市/鄉鎮部分。例如：美國城市、義大利市鎮、英國郵鎮。如為未明確定義縣市或不適用於此結構的地區，請將 locality 留白並使用 addressLines。

sublocality

string

選用設定。地址的縣市以下行政區，例如社區、自治市鎮、行政區。

addressLines[]

string

非結構化的地址行，說明地址的低層級項目。

由於 addressLines 中的值不會有類型資訊，而且有時在單一欄位中可能會包含多個值 (例如「Austin, TX」)，因此地址行的順序務必要明確。地址行的順序應為該地址所在國家/地區的「信封書寫順序」。在信封書寫順序可能不盡相同的地區 (如日本)，可使用 address_language 讓地址更明確 (例如「ja」表示由大到小的排序，而「ja-Latn」或「en」則表示由小到大)。如此一來，您便可以根據語言來選取明確度最高的地址行。

地址允許的最小結構表示法是包含一個 regionCode，並將其餘所有資訊放置在 addressLines 中。您可以在幾乎不使用地理定位的情况下，設定這類地址的格式，但至少在地址局部解析完畢之前，您無法對地址的任何組成部分進行語意推論。

如要處理完全非結構化的地址，我們建議您只建立包含 regionCode 和 addressLines 的地址，並使用地理定位來進行 (而非猜測地址的哪些部分應該是縣市還是行政區)。
recipients[]

string

選用設定。地址的收件人。在某些情況下，這個欄位可能會包含多行資訊。例如，它可能包含「care of」可能不準確或不適當

organization

string

選用設定。地址中的機構名稱。

目錄

委刊項的包裝函式。

JSON 表示法 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
欄位
lineItems[]

object (LineItem)

訂單委刊項清單。至少須有 1 個 line_item，且上限為 50 個。所有委刊項必須屬於相同的產業。

LineItem

一個委刊項包含一個產業。單一訂單或購物車可包含多個同產業的委刊項。在垂直 proto 中，您應根據用途定義子委刊項/外掛程式等項目。注意：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

必填：商家指定的委刊項 ID。用於在套用部分更新時識別現有委刊項。長度上限為 64 個半形字元。

name

string

收據上顯示的明細項目名稱。長度上限為 100 個半形字元。

userVisibleStateLabel
(deprecated)

string

已淘汰，請改用產業層級狀態。舉例來說，如果是購物活動，請使用 PurchaseOrderExtension.status。這個委刊項狀態的使用者可見標籤。
provider

object (Merchant)

特定委刊項的供應商 (如果與整體訂單不同的話)。範例：包含委刊項供應商 ANA 的 Expedia 訂單。

priceAttributes[]

object (PriceAttribute)

委刊項層級的價格和調整項。

followUpActions[]

object (Action)

委刊項的後續操作。

recipients[]

object (UserInfo)

委刊項層級的客戶，可能與訂單層級買方不同。範例：使用者 X 使用使用者名稱 Y 向餐廳訂位。

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,
  "state": enum (State),
  "taxIncluded": boolean,

  // Union field spec can be only one of the following:
  "amount": {
    object (Money)
  },
  "amountMillipercentage": number
  // End of list of possible types for union field spec.
}
欄位
type

enum (Type)

必填：金額屬性類型。

name

string

必填：使用者顯示的價格屬性字串。由商家傳送並本地化。

state

enum (State)

必填：價格狀態：預估值與實際費用。

taxIncluded

boolean

是否含稅。

聯集欄位 spec。代表金額或毫秒百分比。spec 只能是下列其中一項：
amount

object (Money)

金額。

amountMillipercentage
(deprecated)

number

百分比規格到百分比的 1/1000。例如：8.750% 以 8750 表示，負百分比代表折扣百分比。淘汰這個欄位。如果需要具體的用途，可以考慮重新加入計畫。

類型

代表金額的類型。

列舉
TYPE_UNSPECIFIED 未指定類型，因此客戶不必明確設定。
REGULAR 一般顯示價格，未套用任何折扣價。
DISCOUNT 從小計減去。
TAX 要加到小計中。
DELIVERY 要加到小計中。
SUBTOTAL 小計將扣除部分費用前。
FEE 任何額外費用。
GRATUITY 要加到小計中。
TOTAL 訂單或委刊項的價格。

州

代表價格狀態。

列舉
STATE_UNSPECIFIED 不指定。
ESTIMATE 價格僅為預估值。
ACTUAL 要向使用者收取的實際價格。

金額

代表金額與其貨幣類型。

JSON 表示法 
{
  "currencyCode": string,
  "amountInMicros": string
}
欄位
currencyCode

string

ISO 4217 定義的貨幣代碼 (由 3 個英文字母組成)。

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)

與動作相關聯的中繼資料。

類型

可能的後續動作。

列舉
TYPE_UNSPECIFIED 未指定的動作。
VIEW_DETAILS 查看訂單詳細資料動作。
MODIFY 修改訂單動作。
CANCEL 取消訂單動作。
RETURN 退貨訂單動作。
EXCHANGE 換貨訂單動作。
EMAIL

電子郵件動作。EMAIL 和 CALL 類型已淘汰。openUrlAction.url 可做為電話號碼或電子郵件使用。
CALL

行動號召。
REORDER 重新排序動作。
REVIEW 查看訂單動作。
CUSTOMER_SERVICE 請與客服人員聯絡。
FIX_ISSUE 直接前往商家網站或應用程式修正問題。
DIRECTION 路線連結。

OpenUrlAction

開啟指定網址。

JSON 表示法 
{
  "url": string,
  "androidApp": {
    object (AndroidApp)
  },
  "urlTypeHint": enum (UrlTypeHint)
}
欄位
url

string

網址欄位，可能為下列任一值：- 用於開啟應用程式連結應用程式或網頁的 http/https 網址

androidApp

object (AndroidApp)

如果網址應由 Android 應用程式執行，則 Android 應用程式的相關資訊。

urlTypeHint

enum (UrlTypeHint)

用於表示網址類型的提示。

AndroidApp

Android 應用程式的執行要求限制規格

JSON 表示法 
{
  "packageName": string,
  "versions": [
    {
      object (VersionFilter)
    }
  ]
}
欄位
packageName

string

指定 Android 執行要求時，必須指定套件名稱套件名稱。

versions[]

object (VersionFilter)

指定多個篩選器時，只要有相符的篩選器，就會觸發應用程式。

VersionFilter

如果需要特定應用程式版本，則應加入 VersionFilter。

JSON 表示法 
{
  "minVersion": number,
  "maxVersion": number
}
欄位
minVersion

number

最低版本代碼為 0 或 0 (含首尾)。

maxVersion

number

最高版本代碼 (含頭尾)。這個評估範圍是 [minVersion:maxVersion]。空值的範圍代表任何版本。範例：如要指定單一版本，請使用：[target_version:target_version]。如要指定任何版本，請保留 minVersion 和 maxVersion。如要指定 maxVersion 之前的所有版本，請不要指定 minVersion。如要從 minVersion 指定所有版本，請不要指定 maxVersion。

UrlTypeHint

不同類型的網址提示。

列舉
URL_TYPE_HINT_UNSPECIFIED 未指定
AMP_CONTENT 直接指向 AMP 內容的網址，或是透過 <link rel="amphtml"> 參照 AMP 內容的標準網址。

ActionMetadata

每個動作的相關中繼資料。

JSON 表示法 
{
  "expireTime": string
}
欄位
expireTime

string (Timestamp format)

這個動作將於何時到期。

RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位。範例："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

揭露事項的必備條件。

列舉
REQUIREMENT_UNSPECIFIED 未指定需求。請勿明確設定這項設定。
REQUIREMENT_OPTIONAL 上述揭露聲明為選用功能。如果裝置不支援顯示揭露聲明，則可略過廣告。
REQUIREMENT_REQUIRED 必須提供揭露事項。如果裝置不支援顯示揭露事項，對話就會進入電話中斷狀態。

PurchaseItemExtension

購買產業的委刊項內容。

JSON 表示法 
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "productId": string,
  "quantity": number,
  "unitMeasure": {
    object (MerchantUnitMeasure)
  },
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "itemOptions": [
    {
      object (ItemOption)
    }
  ],
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "productDetails": {
    object (ProductDetails)
  }
}
欄位
status

enum (PurchaseStatus)

必要：委刊項層級狀態。

userVisibleStatusLabel

string

必要：使用者可見的狀態標籤/字串。長度上限為 50 個半形字元。

type

enum (PurchaseType)

必填：購買類型。

productId
(deprecated)

string

與這個委刊項相關聯的產品或優惠 ID。
quantity

number

商品數量。

unitMeasure

object (MerchantUnitMeasure)

測量單位。以所選單位指定項目大小。尺寸和有效價格會用來決定單位價格。

returnsInfo

object (PurchaseReturnsInfo)

傳回這個委刊項的資訊。如未設定，這個委刊項會沿用訂單層級傳回資訊。

fulfillmentInfo

object (PurchaseFulfillmentInfo)

這個委刊項的執行要求資訊。如未設定，這個委刊項會沿用訂單層級的出貨資訊。

itemOptions[]

object (ItemOption)

其他外掛程式或子項目。

extension

object

商家與 Google 之間交換的任何額外欄位。

含有任意類型欄位的物件。額外的 "@type" 欄位則包含能辨識類型的 URI。範例：{ "id": 1234, "@type": "types.example.com/standard/id" }。
productDetails

object (ProductDetails)

產品詳細資料。

PurchaseStatus

與訂購單或特定明細項目相關聯的購買狀態。

列舉
PURCHASE_STATUS_UNSPECIFIED 未指定狀態。
READY_FOR_PICKUP 已可取貨。
SHIPPED 已出貨。
DELIVERED 已送達。
OUT_OF_STOCK 缺貨中。
IN_PREPARATION 「IN_PREPARATION」在不同情境下可能有不同的含義若是 FOOD 訂單，它可能正在準備食物。以零售業來說，這可能是包裝商品。
CREATED 建立訂單。
CONFIRMED 商家已確認訂單。
REJECTED 商家拒絕訂單或委刊項。
RETURNED 使用者已退回商品。
CANCELLED 使用者已取消訂單或委刊項。
CHANGE_REQUESTED 使用者已要求變更訂單，而整合商正在處理這項變更。處理要求後，應將此訂單移至其他狀態。

PurchaseType

購買類別。

列舉
PURCHASE_TYPE_UNSPECIFIED 未知的值。
RETAIL 包括實體商品等交易。
FOOD 包括訂購餐點。
GROCERY 雜貨採購。
MOBILE_RECHARGE 購買預付行動儲值。

MerchantUnitMeasure

商家計價單位。

JSON 表示法 
{
  "measure": number,
  "unit": enum (Unit)
}
欄位
measure

number

值：範例 1.2。

unit

enum (Unit)

Unit：範例 POUND，GRAM。

單位

列舉
UNIT_UNSPECIFIED 未指定單位。
MILLIGRAM 毫克。
GRAM 。
KILOGRAM 公斤。
OUNCE 嗶，
POUND 英鎊。

PurchaseReturnsInfo

傳回與訂單或特定委刊項相關聯的資訊。

JSON 表示法 
{
  "isReturnable": boolean,
  "daysToReturn": number,
  "policyUrl": string
}
欄位
isReturnable

boolean

如果為 true，則允許傳回。

daysToReturn

number

退貨期限為這段時間內。

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

這個服務選項的專屬 ID。

fulfillmentType

enum (Type)

必填：執行要求類型。

expectedFulfillmentTime

object (Time)

指定時間範圍時會顯示時間範圍；如果指定單一時間，則為預計到達時間。預計送達或取貨時間。

expectedPreparationTime

object (Time)

指定時間範圍時會顯示時間範圍；如果指定單一時間，則為預計到達時間。預計的準備時間。建議設為單次使用，

location

object (Location)

提供取貨或送貨地點。

expireTime

string (Timestamp format)

這個執行要求選項的效期。

RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位。範例："2014-10-02T15:01:23.045123456Z"。
price

object (PriceAttribute)

此選項的費用。

fulfillmentContact

object (UserInfo)

此執行要求的使用者聯絡資訊。

shippingMethodName

string

使用者所選運送方式的名稱。

storeCode

string

地點的 StoreCode。範例：Walmart 是商家，storeCode 是執行出貨的 Walmart 商店。https://support.google.com/business/answer/3370250?ref_topic=4596653.

pickupInfo

object (PickupInfo)

關於挑選訂單的其他資訊。只有在執行要求類型為 PICKUP 時，才能使用這個欄位。

類型

完成類型。

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

支援的取貨類型清單。

列舉
UNSPECIFIED 未指定上車類型。
INSTORE 在餐廳內取餐。
CURBSIDE 將車輛停在餐廳外的指定地點，有人會在當地送餐。

CurbsideInfo

店外取貨方式的詳細資料。

JSON 表示法 
{
  "curbsideFulfillmentType": enum (CurbsideFulfillmentType),
  "userVehicle": {
    object (Vehicle)
  }
}
欄位
curbsideFulfillmentType

enum (CurbsideFulfillmentType)

合作夥伴需要額外資訊，才能協助店外取貨。視選取的執行要求類型而定，系統會向使用者收集相應的詳細資料。

userVehicle

object (Vehicle)

下單使用者的車輛詳細資料。

CurbsideFulfillmentType

店外出貨類型可能的值。

列舉
UNSPECIFIED 未指定店外出貨類型。
VEHICLE_DETAIL 必須提供車輛詳細資料，才能協助店外取貨。

車輛

車輛詳細資料

JSON 表示法 
{
  "make": string,
  "model": string,
  "licensePlate": string,
  "colorName": string,
  "image": {
    object (Image)
  }
}
欄位
make

string

車輛廠牌 (例如「Honda」)。這會向使用者顯示，而且必須本地化。這是必要項目。

model

string

車輛型號 (例如「Grom」)。這會向使用者顯示，而且必須本地化。這是必要項目。

licensePlate

string

車牌號碼 (例如「1ABC234」)。這是必要項目。

colorName

string

交通工具顏色名稱，例如黑色選用。

image

object (Image)

車輛相片的網址。相片顯示大小約為 256 x 256 像素。必須是 jpg 或 png。(選用)

CheckInInfo

合作夥伴支援登記方法所需的中繼資料。

JSON 表示法 
{
  "checkInType": enum (CheckInType)
}
欄位
checkInType

enum (CheckInType)

寄送簽到指示的方法。

CheckInType

傳送登記指示的各種方法。

列舉
CHECK_IN_TYPE_UNSPECIFIED 未知的值。
EMAIL 會透過電子郵件傳送 CheckIn 資訊。
SMS 系統將透過簡訊傳送 CheckIn 資訊。

ItemOption

代表外掛程式或子項目。

JSON 表示法 
{
  "id": string,
  "name": string,
  "prices": [
    {
      object (PriceAttribute)
    }
  ],
  "note": string,
  "quantity": number,
  "productId": string,
  "subOptions": [
    {
      object (ItemOption)
    }
  ]
}
欄位
id

string

至於屬於項目的選項，請使用專屬項目 ID。

name

string

選項名稱。

prices[]

object (PriceAttribute)

選項總價。

note

string

與選項相關的附註。

quantity

number

「item_quantity」選項。

productId

string

與這個選項相關聯的產品或優惠 ID。

subOptions[]

object (ItemOption)

定義其他巢狀子選項。

ProductDetails

產品詳細資料。

JSON 表示法 
{
  "productId": string,
  "gtin": string,
  "plu": string,
  "productType": string,
  "productAttributes": {
    string: string,
    ...
  }
}
欄位
productId

string

與這個委刊項相關聯的產品或優惠 ID。

gtin

string

產品的全球交易品項識別碼。在 Merchant Center 中沒有 OfferId 時相當實用。(選用)

plu

string

價格查詢代碼通常稱為 PLU 代碼、PLU 號碼、PLU、產生代碼或農產品標籤，是一組專屬編號系統，可用於識別雜貨店和超市販售的大量農產品。

productType

string

商家定義的產品類別。例如：「首頁 >雜貨 >乳製品能量蛋 >牛奶 >全牛奶」

productAttributes

map (key: string, value: string)

商家提供的產品詳細資料，例如{ &quot;allergen&quot;: &quot;peanut&quot;}。在 Merchant Center 中沒有 OfferId 時相當實用。選填。

這個物件中包含 "key": value 組合的清單，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

ReservationItemExtension

預訂訂單 (例如餐廳、剪髮等) 的委刊項內容。下一個 ID：15。

JSON 表示法 
{
  "status": enum (ReservationStatus),
  "userVisibleStatusLabel": string,
  "type": enum (ReservationType),
  "reservationTime": {
    object (Time)
  },
  "userAcceptableTimeRange": {
    object (Time)
  },
  "confirmationCode": string,
  "partySize": number,
  "staffFacilitators": [
    {
      object (StaffFacilitator)
    }
  ],
  "location": {
    object (Location)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
欄位
status

enum (ReservationStatus)

必填：預訂狀態。

userVisibleStatusLabel

string

必要：使用者可見的狀態標籤/字串。長度上限為 50 個半形字元。

type

enum (ReservationType)

預留項目類型。如果所有類型選項都不適用，則可未設定。

reservationTime

object (Time)

排定服務/事件的執行時間。可以是時間範圍、日期或確切的日期時間。

userAcceptableTimeRange

object (Time)

使用者可接受的時間範圍。

confirmationCode

string

此預訂的確認碼。

partySize

number

人數。

staffFacilitators[]

object (StaffFacilitator)

將提供預訂服務的員工協助人員。例如：髮型師。

location

object (Location)

服務/事件的地點。

extension

object

商家與 Google 之間交換的任何額外欄位。

含有任意類型欄位的物件。額外的 "@type" 欄位則包含能辨識類型的 URI。範例：{ "id": 1234, "@type": "types.example.com/standard/id" }。

ReservationStatus

預訂狀態。

列舉
RESERVATION_STATUS_UNSPECIFIED 未指定狀態。
PENDING 這筆預留項目尚待處理。
CONFIRMED 預訂已確認。
CANCELLED 使用者已取消預訂。
FULFILLED 已完成預訂。
CHANGE_REQUESTED 要求變更預留項目
REJECTED 預訂要求已過期或遭整合商拒絕。

ReservationType

預留項目類型。

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

要在使用語音功能的助理裝置上，向使用者讀出的付款方式名稱。例如：「末碼為一二三四的簽證」或「支票帳戶結尾為五六七八次」。注意：這是語音最佳化字串，如果是語音專用助理裝置，則會使用這個字串，而非 paymentsMethodDisplayName。如未設定這個字串，系統會將 paymentsMethodDisplayName 朗讀給使用者。

PaymentType

PaymentType 代表用於商家提供的付款方式的付款方式。動作也必須為付款方式提供顯示名稱。

列舉
PAYMENT_TYPE_UNSPECIFIED 未指定的付款方式。
PAYMENT_CARD 信用卡/簽帳金融卡或預付卡。
BANK 付款方式為銀行帳戶。
LOYALTY_PROGRAM 付款方式為會員方案。
CASH 付款方式為現金。
GIFT_CARD 付款方式為禮物卡。
WALLET 第三方錢包，例如 PayPal

PaymentMethodProvenance

代表該筆交易使用的付款方式來源。

列舉
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)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ]
}
欄位
status

enum (PurchaseStatus)

必填：訂單的整體狀態。

userVisibleStatusLabel

string

使用者看到的狀態標籤/字串。長度上限為 50 個半形字元。

type

enum (PurchaseType)

必填：購買類型。

returnsInfo

object (PurchaseReturnsInfo)

傳回訂單資訊。

fulfillmentInfo

object (PurchaseFulfillmentInfo)

訂單的出貨資訊。

extension

object

商家與 Google 之間交換的任何額外欄位。

含有任意類型欄位的物件。額外的 "@type" 欄位則包含能辨識類型的 URI。範例：{ "id": 1234, "@type": "types.example.com/standard/id" }。
purchaseLocationType

enum (PurchaseLocationType)

購買地點 (店內 / 線上)

errors[]

object (PurchaseError)

選用：訂單遭拒而發生錯誤。

PurchaseLocationType

購買地點類型。

列舉
UNSPECIFIED_LOCATION 未知的值。
ONLINE_PURCHASE 所有線上購買。
INSTORE_PURCHASE 所有店內交易。

PurchaseError

導致訂購單可能遭拒的錯誤。

JSON 表示法 
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": number
}
欄位
type

enum (ErrorType)

必填：這是商家拒絕訂單的詳細原因。

description

string

其他錯誤說明。

entityId

string

與錯誤對應的實體 ID。此範例可對應至 LineItemId / ItemOptionId。

updatedPrice

object (PriceAttribute)

發生 PRICE_CHANGED / INCORRECT_PRICE 錯誤類型時的相關。

availableQuantity

number

現貨數量。適用於 AVAILABILITY_CHANGED。

ErrorType

可能的錯誤類型。

列舉
ERROR_TYPE_UNSPECIFIED 不明的錯誤
NOT_FOUND 找不到實體，可能為「Item」、「FulfillmentOption」、「促銷活動」。必須提供實體 ID。
INVALID 實體資料無效。可能是商品、FulfillmentOption 和促銷活動必須提供實體 ID。
AVAILABILITY_CHANGED 無法購買商品，或商品不足，無法完成要求。必須提供實體 ID。
PRICE_CHANGED 商品價格與商品實體中的價格不同。必須提供實體 ID 和更新後的價格。
INCORRECT_PRICE 費用 (總計) 中的價格錯誤。必須提供實體 ID 和更新後的價格。
REQUIREMENTS_NOT_MET 無法接受訂單的限制 - 購物車商品數量下限等
TOO_LATE FulfillmentOption 已過期。
NO_CAPACITY 沒有可用的服務容量。
INELIGIBLE 使用者不符合下單資格 (列入黑名單)。
OUT_OF_SERVICE_AREA 基於邊界規則等規定，無法傳送至要求的地址。
CLOSED 餐廳在營業時間時不營業。
PROMO_NOT_APPLICABLE 一組通用的錯誤代碼，會找出無法套用促銷代碼的所有情況 (如果下方都不適用)。將促銷代碼新增為實體 ID。
PROMO_NOT_RECOGNIZED 合作夥伴無法辨識優待券代碼。將促銷代碼新增為實體 ID。
PROMO_EXPIRED 優惠已過期，因此無法套用。將促銷代碼新增為實體 ID。
PROMO_USER_INELIGIBLE 目前的使用者不符合這張優待券的資格。將促銷代碼新增為實體 ID。
PROMO_ORDER_INELIGIBLE 目前訂單不適用於這張優待券。將促銷代碼新增為實體 ID。
UNAVAILABLE_SLOT 超前預訂時段無法使用。
FAILED_PRECONDITION 無法接受訂單的限制 - 購物車商品數量下限等
PAYMENT_DECLINED 付款無效。
MERCHANT_UNREACHABLE 無法聯絡商家，如果合作夥伴是集結網站，且無法聯絡商家，這項功能就能派上用場。

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

活動資訊的網址。

location

object (Location)

活動舉辦地點或機構所在位置。

eventCharacters[]

object (EventCharacter)

與這個事件相關的角色。可能是電影活動的導演或演員，或是音樂會的表演者等。

startDate

object (Time)

開始時間。

endDate

object (Time)

結束時間。

doorTime

object (Time)

進入時間，可能與活動開始時間不同。例如：活動是從上午 9 點開始，但報名時間為上午 8:30

類型

事件的類型。

列舉
EVENT_TYPE_UNKNOWN 未知的事件類型。
MOVIE 電影。
CONCERT 音樂會/演唱會。
SPORTS 體育賽事。

EventCharacter

一個事件字元，例如主辦單位、表演者等

JSON 表示法 
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
欄位
type

enum (Type)

事件字元的類型，例如：或導演

name

string

字元名稱。

image

object (Image)

人物的圖片。

類型

字元類型。

列舉
TYPE_UNKNOWN 類型不明。
ACTOR 執行者。
PERFORMER 表演者。
DIRECTOR 導演。
ORGANIZER 主辦人。