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)
    }
  ],
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
フィールド
id

string

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

object (ClassTemplateInfo)

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

object (ImageModuleData)

画像モジュールのデータ。imageModulesData がオブジェクトにも定義されている場合、両方が表示されます。両方が設定されている場合、クラスレベルとオブジェクト レベルの画像のどちらか一方のみがレンダリングされます。
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 です。
valueAddedModuleData[]

object (ValueAddedModuleData)

オプションの付加価値モジュール データ。クラスあたりの最大数は 10 です。パスの場合は 10 個のみが表示され、オブジェクトのパスから優先的に表示されます。

メソッド

addmessage

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

get

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

insert

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

list

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

patch

 指定されたクラス ID で参照される汎用クラスを更新します。

update

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