REST 資源:offerobject

資源:OfferObject

JSON 表示法

{
      "kind": string,
      "classReference": {
        object (OfferClass)
      },
      "id": string,
      "classId": string,
      "version": string,
      "state": enum (State),
      "barcode": {
        object (Barcode)
      },
      "messages": [
        {
          object (Message)
        }
      ],
      "validTimeInterval": {
        object (TimeInterval)
      },
      "locations": [
        {
          object (LatLongPoint)
        }
      ],
      "hasUsers": boolean,
      "smartTapRedemptionValue": string,
      "hasLinkedDevice": boolean,
      "disableExpirationNotification": boolean,
      "infoModuleData": {
        object (InfoModuleData)
      },
      "imageModulesData": [
        {
          object (ImageModuleData)
        }
      ],
      "textModulesData": [
        {
          object (TextModuleData)
        }
      ],
      "linksModuleData": {
        object (LinksModuleData)
      },
      "appLinkData": {
        object (AppLinkData)
      }
    }
欄位
kind
(deprecated)

string

表示資源的種類。值:固定字串 "walletobjects#offerObject"

classReference

OfferClassobject ()

父項類別的沿用欄位複本。這類欄位是在 GET 執行期間擷取的。

id

string

必要。物件的專屬 ID。發卡機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由您指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。

classId

string

必要。與這個物件相關聯的類別,必須是與這個物件同類型、已存在,並且經過核准的類別。

類別 ID 應依循「issuer ID.identifier」的格式,其中前者是由 Google 核發,後者則由您指定。

version
(deprecated)

string (int64 format)

已淘汰

state

Stateenum ()

必要。物件的狀態。這個欄位是用來判斷物件在應用程式中的顯示情形。舉例來說,inactive 物件不會再顯示於 Google Pay 應用程式中。

barcode

Barcodeobject ()

條碼類型和值。

messages[]

Messageobject ()

應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到與該物件相關聯的訊息。這類欄位的數量上限是 10 個。

validTimeInterval

TimeIntervalobject ()

這個物件處於 active 狀態且可供使用的時間範圍。如果過了這段時間範圍,物件的狀態會變成 expired

locations[]

LatLongPointobject ()

可以使用物件的位置清單。平台會使用這項資訊以觸發向使用者顯示的地理位置通知。請注意,物件中的位置會覆寫類別中的位置,類別中的位置會覆寫 Google 地方資訊 ID 的位置。

hasUsers

boolean

表示這個物件是否有使用者。這個欄位是由平台所設定。

smartTapRedemptionValue

string

僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。

hasLinkedDevice

boolean

表示這個物件目前是否已連結至單一裝置。當使用者儲存物件以將物件連結到裝置時,平台會設定這個欄位。適用於特定合作夥伴。詳情請聯絡支援小組。

disableExpirationNotification

boolean

表示是否應明確封鎖通知。如果將這個欄位設為 true,無論 messages 欄位的值為何,向使用者發出的到期通知都會遭封鎖。根據預設,這個欄位是設為 false。

目前此項目只能針對優惠進行設定。

infoModuleData

InfoModuleDataobject ()

已淘汰,請改用 textModulesData。

imageModulesData[]

ImageModuleDataobject ()

圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個,以及類別物件層級 1 個。

textModulesData[]

TextModuleDataobject ()

文字模組資料。如果類別中也定義了文字模組資料,則兩項資料都會顯示。這類欄位的顯示數量上限為來自物件的 10 個,以及來自類別的 10 個。

方法

addmessage

新增訊息至指定物件 ID 參照的優惠物件。

get

傳回具有指定物件 ID 的優惠物件。

insert

插入具有指定 ID 和屬性的優惠物件。

list

傳回指定核發機構 ID 的所有優惠物件清單。

patch

更新指定物件 ID 參照的優惠物件。

update

更新指定物件 ID 參照的優惠物件。