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)
  }
}
フィールド
kind
(deprecated)

string

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

object (LoyaltyClass)

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

string

ポイント アカウントの所有者名（「田中太郎」など）。小さな画面でも文字列全体が表示されるように、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[]

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 とスクリーンショットの動作の制限が含まれます。

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）のいずれか 1 つのみにデータを入力する必要があります。
double

number

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

object (Money)

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

Methods

addmessage

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

get

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

insert

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

list

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

modifylinkedofferobjects

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

patch

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

update

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