REST Resource: loyaltyobject

string

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

object (LoyaltyClass)

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

string

ポイント プログラムのアカウント所有者の名前（「John Smith」など）。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。

string

ポイント プログラムのアカウントの識別子。20 文字以下にすることをおすすめします。

object (LoyaltyPoints)

ポイント特典ポイントのラベル、残高、種類。

string

このポイントカードにリンクされているクーポン オブジェクトのリスト。クーポン オブジェクトは、すでに存在している必要があります。

クーポン オブジェクト ID は issuer ID.identifier。前者は Google が発行し、後者は貴社が選択します。

object (LoyaltyPoints)

予備の特典ポイントのラベル、保有ポイント数、タイプ。一次的なポイントに加えて表示されます。

string

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

string

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

クラス ID は issuer ID の形式にする必要があります。identifier。前者は Google が発行し、後者は貴社が選択します。

string (int64 format)

非推奨

enum (State)

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

object (Barcode)

バーコードのタイプと値。

object (Message)

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

object (TimeInterval)

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

object (LatLongPoint)

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

boolean

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

string

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

この値が設定されておらず、クラスレベルのフィールド enableSmartTap と redemptionIssuers が正しく設定されている場合、barcode.value フィールドまたは accountId フィールド（存在する場合）がフォールバックとして使用されます。

boolean

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

boolean

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

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

object (InfoModuleData)

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

object (ImageModuleData)

画像モジュール データ。表示されるフィールドの最大数は、オブジェクト レベルでは 1 個、クラス オブジェクト レベルでは 1 個です。

object (TextModuleData)

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

object (LinksModuleData)

リンク モジュールのデータ。リンク モジュールのデータがクラスにも定義されている場合、両方が表示されます。

object (AppLinkData)

パスの表面にボタンとして表示される、アプリまたはウェブサイトのリンク（省略可）。対応するクラスに AppLinkData が指定されている場合、オブジェクト AppLinkData のみが表示されます。

object (RotatingBarcode)

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

object (Image)

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

object (GroupingInfo)

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

object (PassConstraints)

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

object (SaveRestrictions)

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

string

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

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

オブジェクト ID は issuer ID 形式にする必要があります。identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

string

ポイントのラベル（「ポイント」など）。推奨される最大文字数は 9 文字です。

object (LoyaltyPointsBalance)

アカウント所有者の保有ポイント数（「500」や「$10.00」など）。7 文字以下にすることをおすすめします。これは、loyaltyPoints と secondaryLoyaltyPoints の必須フィールドです。

object (LocalizedString)

ラベルの翻訳文字列。9 文字以下にすることをおすすめします。

string

文字列型の保有ポイント数。値は、これらのサブタイプ（string、int、double、money）のいずれかに設定する必要があります。

integer

整数型の保有ポイント数。値は、これらのサブタイプ（string、int、double、money）のいずれかに設定する必要があります。

number

2 倍の形態の残高。値は、これらのサブタイプ（string、int、double、money）のいずれかに設定する必要があります。

object (Money)

通貨型の保有ポイント数。値は、これらのサブタイプ（string、int、double、money）のいずれかに設定する必要があります。