REST Resource: genericclass

リソース: GenericClass

汎用クラス

JSON 表現 
{
  "id": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "enableSmartTap": boolean,
  "redemptionIssuers": [
    string
  ],
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "messages": [
    {
      object (Message)
    }
  ]
}
フィールド
id

string

必須。クラスの一意の識別子。この ID は、発行者のすべての全体で一意である必要があります。この値は issuerID.identifier の形式にする必要があります。issuerID は Google が発行し、identifier はユーザーが選択します。一意の識別子には、英数字、.、_、- のみを使用できます。
classTemplateInfo

object (ClassTemplateInfo)

クラスの表示方法に関するテンプレート情報。設定しない場合、表示されるデフォルトのフィールド セットにフォールバックします。
imageModulesData[]

object (ImageModuleData)

画像モジュールのデータ。オブジェクトに imageModulesData も定義されている場合は、両方が表示されます。両方を設定すると、クラスの画像とオブジェクト レベルの画像のうち 1 つのみがレンダリングされます。
textModulesData[]

object (TextModuleData)

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

boolean

スマートタップ対応のパートナーのみご利用いただけます。詳しいガイダンスについては、サポートにお問い合わせください。
redemptionIssuers[]

string (int64 format)

スマートタップでパスを利用できるクーポン発行者を識別します。クーポン発行者は発行者 ID で識別されます。クーポン発行者には、少なくとも 1 つのスマートタップ キーが設定されている必要があります。

パスでスマートタップをサポートするには、enableSmartTap フィールドとオブジェクト レベルの smartTapRedemptionLevel フィールドも正しく設定する必要があります。
securityAnimation

object (SecurityAnimation)

セキュリティ アニメーションに関する省略可能な情報。これが設定されている場合、セキュリティ アニメーションがパスの詳細にレンダリングされます。
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

このクラスを参照する同じオブジェクトを複数のユーザーとデバイスで保存するかどうかを指定します。
callbackOptions

object (CallbackOptions)

エンドユーザーがこのクラスのオブジェクトを保存または削除するたびに、発行元をコールバックするために使用するコールバック オプション。このクラスのすべてのオブジェクトはコールバックの対象となります。
viewUnlockRequirement

enum (ViewUnlockRequirement)

汎用パスのロック解除要件オプションを表示します。
messages[]

object (Message)

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

Methods

addmessage

 指定されたクラス ID の汎用クラスにメッセージを追加します。

get

 指定されたクラス ID の汎用クラスを返します。

insert

 指定された ID とプロパティの汎用クラスを挿入します。

list

 指定された発行者 ID のすべての汎用クラスのリストを返します。

patch

 指定されたクラス ID の汎用クラスを更新します。

update

 指定されたクラス ID の汎用クラスを更新します。