REST Resource: loyaltyobject

{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "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)
  }
}

string

リソースのタイプを示します。値: 固定文字列 "walletobjects#loyaltyObject"。

object (LoyaltyClass)

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

string

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

string

ポイント プログラムのアカウント ID。推奨される最大文字数は 20 文字です。

object (LoyaltyPoints)

ポイント プログラムのポイントのラベル、残高、種類。

string

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

特典のオブジェクト ID は、issuer ID の形式で指定します。identifier: 前者が Google が発行し、後者がお客様を選択します。

object (LoyaltyPoints)

2 番目のポイント特典のラベル、残高、種類。主なポイントに加えて表示されます。

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)

パートナー アプリのリンクに関する任意の情報です。

object (RotatingBarcode)

ローテーション バーコードのタイプと値。

object (Image)

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

object (GroupingInfo)

パスのグループ化方法を制御する情報。

object (PassConstraints)

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

{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}

string

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

object (LoyaltyPointsBalance)

アカウント所有者のポイント残高（「500」や「$10.00」など）。最大文字数は 7 文字です。これは loyaltyPoints と secondaryLoyaltyPoints の必須フィールドです。

object (LocalizedString)

ラベルの翻訳された文字列。推奨される最大文字数は 9 文字です。

{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}

string

残高の文字列形式です。サブタイプ（string、int、double、money）のいずれか 1 つのみが入力されている必要があります。

integer

残高の整数の形式。サブタイプ（string、int、double、money）のいずれか 1 つのみが入力されている必要があります。

number

2 倍の残高の残高。サブタイプ（string、int、double、money）のいずれか 1 つのみが入力されている必要があります。

object (Money)

残高。サブタイプ（string、int、double、money）のいずれか 1 つのみが入力されている必要があります。