- リソース: OfferObject
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- メソッド
リソース: OfferObject
JSON 表現 |
---|
{ "kind": string, "classReference": { object ( |
フィールド | |
---|---|
kind |
リソースの種類を指定します。値: 固定文字列 |
classReference |
親クラスの継承されたフィールドのコピー。これらのフィールドは GET 中に取得されます。 |
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 の動作の制限やスクリーンショットの動作などが含まれています。 |
saveRestrictions |
ユーザーがパスの保存を試みる前に確認する必要があるオブジェクトに関する制限。この制限は保存時にのみ適用されます。ユーザーがパスを保存した後に制限が変更された場合、すでに保存されているパスに新しい制限は適用されません。 |
メソッド |
|
---|---|
|
指定されたオブジェクト ID のクーポン オブジェクトにメッセージを追加します。 |
|
指定されたオブジェクト ID のクーポン オブジェクトを返します。 |
|
指定された ID とプロパティのクーポン オブジェクトを挿入します。 |
|
指定された発行者 ID のすべてのクーポン オブジェクトのリストを返します。 |
|
指定されたオブジェクト ID のクーポン オブジェクトを更新します。 |
|
指定されたオブジェクト ID のクーポン オブジェクトを更新します。 |