リソース: GiftCardObject
JSON 表現 |
---|
{ "kind": string, "classReference": { object ( |
フィールド | |
---|---|
kind |
リソースの種類を指定します。値: 固定文字列 |
classReference |
親クラスの継承されたフィールドのコピー。これらのフィールドは GET 中に取得されます。 |
cardNumber |
必須。カードの番号。 |
pin |
カードの PIN。 |
balance |
カードの残高。 |
balanceUpdateTime |
残高が最後に更新された日時。 オフセットが必要です。 残高が更新され、このプロパティが指定されなかった場合、システムはデフォルトで現在の時刻に設定されます。 |
eventNumber |
カードのイベント番号。一部のギフトカードで使用される省略可能なフィールドです。 |
id |
必須。オブジェクトの一意の識別子。この ID は、発行者のすべてのオブジェクトで一意である必要があります。この値は issuer ID の形式にする必要があります。identifier: 前者は Google が発行し、後者はユーザーが選択したものです。一意の識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
classId |
必須。このオブジェクトに関連付けられたクラス。クラスは、このオブジェクトと同じ型で、すでに存在し、承認されている必要があります。 クラス ID は issuer ID の形式にする必要があります。identifier: 前者は Google が発行し、後者はユーザーが選択したものです。 |
version |
非推奨 |
state |
必須。オブジェクトの状態。このフィールドは、アプリでのオブジェクトの表示方法を決定するために使用されます。たとえば、 |
barcode |
バーコードのタイプと値。 |
messages[] |
アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。これらのフィールドの最大数は 10 です。 |
validTimeInterval |
このオブジェクトが |
locations[] |
注: 現在、このフィールドは位置情報に関する通知のトリガーに対応していません。 |
hasUsers |
オブジェクトにユーザーがいるかどうかを示します。このフィールドはプラットフォームによって設定されます。 |
smartTapRedemptionValue |
このオブジェクトについて、NFC 経由でスマートタップ認定端末に送信される値。パスでスマートタップをサポートするには、クラスレベルのフィールド |
hasLinkedDevice |
このオブジェクトが現在 1 つのデバイスにリンクされているかどうか。このフィールドは、ユーザーがオブジェクトを保存してデバイスにリンクしたときに、プラットフォームによって設定されます。一部のパートナー様による使用を想定しています。詳しくはサポートにお問い合わせください。 |
disableExpirationNotification |
通知を明示的に抑制するかどうかを示します。このフィールドを true に設定すると、 現在、これはオファーに対してのみ設定できます。 |
infoModuleData |
非推奨です。代わりに textModulesData を使用してください。 |
imageModulesData[] |
画像モジュールのデータ。表示されるこれらのフィールドの最大数は、オブジェクト レベルで 1 個、クラス オブジェクト レベルで 1 個です。 |
textModulesData[] |
テキスト モジュールのデータ。テキスト モジュール データもクラスで定義されている場合は、両方が表示されます。表示されるこれらのフィールドの最大数は、オブジェクトから 10 個、クラスから 10 個です。 |
linksModuleData |
リンク モジュールのデータ。リンク モジュールのデータもクラスで定義されている場合は、両方が表示されます。 |
appLinkData |
パスの前面にボタンとして表示される、省略可能なアプリまたはウェブサイトのリンク。対応するクラスに AppLinkData が指定されている場合は、AppLinkData オブジェクトのみが表示されます。 |
rotatingBarcode |
ローテーション バーコードのタイプと値。 |
heroImage |
カードの表面に表示されるオプションのバナー画像。クラスのヒーロー画像が存在しない場合は、表示されます(存在する場合)。クラスのヒーロー画像も存在しない場合は、何も表示されません。 |
groupingInfo |
パスのグループ化に関する情報。 |
passConstraints |
オブジェクトの制約を渡します。NFC とスクリーンショットの動作の制限も含まれます。 |
メソッド |
|
---|---|
|
指定されたオブジェクト ID のギフトカード オブジェクトにメッセージを追加します。 |
|
指定されたオブジェクト ID のギフトカード オブジェクトを返します。 |
|
指定された ID とプロパティのギフトカード オブジェクトを挿入します。 |
|
指定された発行者 ID のすべてのギフトカード オブジェクトのリストを返します。 |
|
指定されたオブジェクト ID のギフトカード オブジェクトを更新します。 |
|
指定されたオブジェクト ID のギフトカード オブジェクトを更新します。 |