REST Resource: giftcardobject

リソース: GiftCardObject

JSON 表現 
{
  "kind": string,
  "classReference": {
    object (GiftCardClass)
  },
  "cardNumber": string,
  "pin": string,
  "balance": {
    object (Money)
  },
  "balanceUpdateTime": {
    object (DateTime)
  },
  "eventNumber": string,
  "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)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
フィールド
kind
(deprecated)

string

リソースの種類を示します。値は固定文字列 "walletobjects#giftCardObject" です。
classReference

object (GiftCardClass)

親クラスの継承されたフィールドのコピー。このフィールドは、GET 中に取得されます。
cardNumber

string

必須。カードの番号。
pin

string

カードの PIN。
balance

object (Money)

カードの金額の残高。
balanceUpdateTime

object (DateTime)

残高が最後に更新された日時。

オフセットは必須です。

残高が更新され、このプロパティが指定されない場合、現在の時刻にデフォルト設定されます。
eventNumber

string

カードのイベント番号。一部のギフトカードで使用される省略可能なフィールドです。
id

string

必須。オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。
classId

string

必須。このオブジェクトに関連付けられたクラス。クラスはこのオブジェクトと同じ型で、すでに存在し、承認される必要があります。

クラス ID は、issuer ID.identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。
version
(deprecated)

string (int64 format)

非推奨
state

enum (State)

必須。オブジェクトの状態。このフィールドは、アプリでのオブジェクトの表示方法を決定するために使用されます。たとえば、inactive オブジェクトを「期限切れのパス」セクションに移動する場合に使用します。
barcode

object (Barcode)

バーコードのタイプと値。
messages[]

object (Message)

アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。このフィールドの最大数は 10 です。
validTimeInterval

object (TimeInterval)

このオブジェクトが active になり、オブジェクトが使用可能である期間。この期間が経過すると、オブジェクトの状態は expired に変更されます。
locations[]
(deprecated)

object (LatLongPoint)

注: 現在、このフィールドはジオフェンス通知のトリガーには対応していません。
hasUsers

boolean

オブジェクトにユーザーが存在するかどうかを示します。このフィールドはプラットフォームによって設定されます。
smartTapRedemptionValue

string

このオブジェクトのスマートタップ認定端末に NFC 経由で送信される値。パスがスマートタップをサポートするには、クラスレベルのフィールド enableSmartTap と redemptionIssuers も正しく設定する必要があります。サポートされているのは ASCII 文字のみです。
hasLinkedDevice

boolean

このオブジェクトが現在 1 つのデバイスにリンクされているかどうか。このフィールドは、ユーザーがオブジェクトを保存し、デバイスにリンクするときに、プラットフォームによって設定されます。一部のパートナーが使用することを想定しています。詳細については、サポートにお問い合わせください。
disableExpirationNotification

boolean

通知を明示的に止めるかどうかを示します。このフィールドを true に設定した場合、messages フィールドに関係なく、ユーザーへの有効期限通知が抑制されます。このフィールドはデフォルトで false に設定されています。

現在、これはクーポンにのみ設定できます。
infoModuleData

object (InfoModuleData)

非推奨です。代わりに textModulesData を使用してください。
imageModulesData[]

object (ImageModuleData)

画像モジュールのデータ。このフィールドが表示される数には上限があり、オブジェクト レベルから 1 個、クラス オブジェクト レベルでは 1 個が最大数になります。
textModulesData[]

object (TextModuleData)

テキスト モジュールのデータ。テキスト モジュールのデータがクラスにも定義されている場合、両方が表示されます。表示されるフィールドの最大数は、オブジェクトから 10 個、クラスから 10 個です。
rotatingBarcode

object (RotatingBarcode)

回転バーコードのタイプと値。
heroImage

object (Image)

カードの表面に表示されるオプションのバナー画像。存在しない場合、クラスのヒーロー画像（存在する場合）が表示されます。クラスのヒーロー画像も存在しない場合、何も表示されません。
groupingInfo

object (GroupingInfo)

パスのグループ化に関する情報。
passConstraints

object (PassConstraints)

オブジェクトの制約を渡します。NFC とスクリーンショットの動作の制限が含まれます。
saveRestrictions

object (SaveRestrictions)

ユーザーがパスを保存しようとする前に確認が必要なオブジェクトの制限。この制限は、保存時間中にのみ適用されます。ユーザーがパスを保存した後に制限が変更された場合、すでに保存されているパスには新しい制限は適用されません。
linkedObjectIds[]

string

linkedObjectIds は、このギフトカード オブジェクトに自動的に関連付けられる他のオブジェクト（イベント チケット、ポイントカード、クーポン、汎用、ギフトカード、交通機関のパス、搭乗券など）のリストです。ユーザーがこのギフトカードを保存していた場合、これらの linkedObjectId は、ユーザーがそのようなリンクされたパスを受け取る設定をオフにしていない限り、ユーザーのウォレットに自動的にプッシュされます。

linkObjectIds 内に存在するオブジェクトがすでに挿入されていることを確認します。挿入されていない場合、呼び出しは失敗します。リンクしたオブジェクトのリンクは解除できません。別のカード発行会社に属するオブジェクトをリンクすることはできません。1 つのオブジェクトにリンクできるオブジェクトの数には上限があります。上限に達すると、呼び出し内の新しくリンクされたオブジェクトは通知なく無視されます。

オブジェクト ID は issuer ID の形式にする必要があります。identifier。前者は Google が発行し、後者は貴社が選択します。
notifyPreference

enum (NotificationSettingsForUpdates)

このオブジェクトのフィールドの更新を通知のトリガーにするかどうか。NOTIFY に設定すると、ユーザーへのフィールド更新通知のトリガーが試行されます。これらの通知は、フィールドが許可リストに含まれている場合にのみユーザーに送信されます。DO_NOT_NOTIFY または NOTIFICATION_SETTINGS_UNSPECIFIED に設定した場合、通知はトリガーされません。この設定は一時的な設定であり、PATCH リクエストまたは UPDATE リクエストごとに設定する必要があります。設定しない場合、通知はトリガーされません。
valueAddedModuleData[]

object (ValueAddedModuleData)

オプションの付加価値モジュール データ。オブジェクトに最大 10 個。

メソッド

addmessage

 指定されたオブジェクト ID のギフトカード オブジェクトにメッセージを追加します。

get

 指定されたオブジェクト ID のギフトカード オブジェクトを返します。

insert

 指定された ID とプロパティのギフトカード オブジェクトを挿入します。

list

 指定された発行者 ID のすべてのギフトカード オブジェクトのリストを返します。

patch

 指定されたオブジェクト ID のギフトカード オブジェクトを更新します。

update

 指定されたオブジェクト ID のギフトカード オブジェクトを更新します。