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)
  }
}
フィールド
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 です。

メソッド

addmessage

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

get

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

insert

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

list

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

patch

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

update

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