リソース: OfferObject
JSON 表現 |
---|
{ "kind": string, "classReference": { object ( |
フィールド | |
---|---|
kind |
リソースの種類を示します。値は固定文字列 |
class |
親クラスの継承されたフィールドのコピー。このフィールドは、GET 中に取得されます。 |
id |
必須。オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトで一意である必要があります。この値には issuer ID.identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意の識別子には、英数字、「.」、「_」、「-」のみを使用してください。 |
class |
必須。このオブジェクトに関連付けられたクラス。クラスはこのオブジェクトと同じ型で、すでに存在し、承認されている必要があります。 クラス ID は、issuer ID.identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。 |
version |
非推奨 |
state |
必須。オブジェクトの状態。このフィールドは、アプリでのオブジェクトの表示方法を決定するために使用されます。たとえば、 |
barcode |
バーコードのタイプと値。 |
messages[] |
アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。このフィールドの最大数は 10 です。 |
valid |
このオブジェクトが |
locations[] |
注: 現在、このフィールドはジオフェンス通知のトリガーには対応していません。 |
has |
オブジェクトにユーザーが含まれているかどうかを示します。このフィールドはプラットフォームによって設定されます。 |
smart |
このオブジェクトのスマートタップ認定端末に NFC 経由で送信される値。パスがスマートタップをサポートするには、クラスレベルのフィールド |
has |
このオブジェクトが現在 1 つのデバイスにリンクされているかどうか。このフィールドは、ユーザーがオブジェクトを保存し、デバイスにリンクするときに、プラットフォームによって設定されます。一部のパートナーによる使用を想定しています。詳細については、サポートにお問い合わせください。 |
disable |
通知を明示的に止めるかどうかを示します。このフィールドが true に設定されている場合、 現在、これはクーポンにのみ設定できます。 |
info |
非推奨です。代わりに textModulesData を使用してください。 |
image |
画像モジュールのデータ。このフィールドが表示される数には上限があり、オブジェクト レベルから 1 個、クラス オブジェクト レベルでは 1 個が最大数になります。 |
text |
テキスト モジュールのデータ。テキスト モジュールのデータがクラスにも定義されている場合、両方が表示されます。このフィールドが表示される数には上限があり、オブジェクトから 10 個、クラスから 10 個が最大数になります。 |
links |
リンク モジュールのデータ。リンク モジュールのデータがクラスにも定義されている場合、両方が表示されます。 |
app |
パスの表面にボタンとして表示される、アプリまたはウェブサイトのリンク(省略可)。対応するクラスに AppLinkData が指定されている場合、オブジェクト AppLinkData のみが表示されます。 |
rotating |
回転バーコードのタイプと値。 |
hero |
カードの表面に表示されるオプションのバナー画像。何も存在しない場合は、クラスのヒーロー画像が表示されます(存在する場合)。クラスのヒーロー画像も存在しない場合、何も表示されません。 |
grouping |
パスのグループ化に関する情報。 |
pass |
オブジェクトの制約を渡します。NFC とスクリーンショットの動作の制限が含まれます。 |
save |
ユーザーがパスを保存しようとする前に確認が必要なオブジェクトの制限。この制限は、保存時間中にのみ適用されます。ユーザーがパスを保存した後に制限が変更された場合、すでに保存されているパスには新しい制限は適用されません。 |
linked |
linkObjectIds は、このクーポン オブジェクトに自動的に付加される必要がある、イベント チケット、ポイント、クーポン、汎用、ギフトカード、交通機関、搭乗券などの他のオブジェクトのリストです。ユーザーがこの特典を保存していた場合、これらの linkedObjectId は、ユーザーがそのようなリンクされたパスを受け取る設定をオフにしていない限り、ユーザーのウォレットに自動的にプッシュされます。 linkedObjectIds に存在するオブジェクトがすでに挿入されていることを確認します。挿入されていない場合、呼び出しは失敗します。リンクしたオブジェクトのリンクは解除できません。別のカード発行会社に属するオブジェクトをリンクすることはできません。1 つのオブジェクトにリンクできるオブジェクトの数には上限があります。上限に達すると、呼び出し内の新しいリンクされたオブジェクトは通知なく無視されます。 オブジェクト ID は issuer ID 形式にする必要があります。identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。 |
notify |
このオブジェクトのフィールドの更新を通知のトリガーにするかどうか。NOTIFY に設定すると、ユーザーへのフィールド更新通知のトリガーが試行されます。これらの通知は、フィールドが許可リストに含まれている場合にのみユーザーに送信されます。DO_NOT_NOTIFY または NOTIFICATION_SETTINGS_UNSPECIFIED に設定した場合、通知はトリガーされません。この設定は一時的な設定であり、PATCH リクエストまたは UPDATE リクエストごとに設定する必要があります。設定しない場合、通知はトリガーされません。 |
value |
オプションの付加価値モジュール データ。オブジェクトに最大 10 個。 |
メソッド |
|
---|---|
|
指定されたオブジェクト ID のクーポン オブジェクトにメッセージを追加します。 |
|
指定されたオブジェクト ID のクーポン オブジェクトを返します。 |
|
指定された ID とプロパティのクーポン オブジェクトを挿入します。 |
|
指定された発行者 ID のすべてのクーポン オブジェクトのリストを返します。 |
|
指定されたオブジェクト ID のクーポン オブジェクトを更新します。 |
|
指定されたオブジェクト ID のクーポン オブジェクトを更新します。 |