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

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

string

ポイント アカウントの ID。推奨される最大文字数は 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)

パートナー アプリリンクに関する省略可能な情報。

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

二重形の残高。これらのサブタイプ（string、int、double、money）のいずれか 1 つのみにデータを入力する必要があります。

object (Money)

金銭的な形の残高。これらのサブタイプ（string、int、double、money）のいずれか 1 つのみにデータを入力する必要があります。