REST Resource: loyaltyobject

リソース: LoyaltyObject

JSON 表現 
{
  "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)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
フィールド
kind
(deprecated)

string

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

object (LoyaltyClass)

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

string

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

string

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

object (LoyaltyPoints)

特典ポイントのラベル、保有ポイント数、タイプ。
linkedOfferIds[]

string

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

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

object (LoyaltyPoints)

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

string

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

string

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

クラス ID は、issuer ID.identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。
version
(deprecated)

string (int64 format)

非推奨
state

enum (State)

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

object (Barcode)

バーコードのタイプと値。
messages[]

object (Message)

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

object (TimeInterval)

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

object (LatLongPoint)

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

boolean

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

string

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

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

boolean

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

boolean

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

現在、これは特典に対してのみ設定できます。
infoModuleData

object (InfoModuleData)

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

object (ImageModuleData)

画像モジュール データ。このフィールドが表示される数には上限があり、オブジェクト レベルから 1 個、クラス オブジェクト レベルでは 1 個が最大数になります。
textModulesData[]

object (TextModuleData)

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

object (RotatingBarcode)

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

object (Image)

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

object (GroupingInfo)

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

object (PassConstraints)

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

object (SaveRestrictions)

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

string

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

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

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

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

LoyaltyPoints

JSON 表現 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
フィールド
label

string

ポイントのラベル（「ポイント」など）。9 文字以下にすることをおすすめします。
balance

object (LoyaltyPointsBalance)

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

object (LocalizedString)

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

LoyaltyPointsBalance

JSON 表現 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
フィールド
string

string

文字列型の保有ポイント数。これらのサブタイプ（string、int、double、money）のいずれか 1 つのみにデータを入力する必要があります。
int

integer

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

number

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

object (Money)

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

メソッド

addmessage

 指定されたオブジェクト ID のポイント オブジェクトにメッセージを追加します。

get

 指定されたオブジェクト ID のポイント オブジェクトを返します。

insert

 指定された ID とプロパティのポイント オブジェクトを挿入します。

list

 指定された発行者 ID のすべてのポイント オブジェクトのリストを返します。

modifylinkedofferobjects

 指定された ID のポイント オブジェクトのリンク済みクーポン オブジェクトを修正します。

patch

 指定されたオブジェクト ID のポイント オブジェクトを更新します。

update

 指定されたオブジェクト ID のポイント オブジェクトを更新します。