REST Resource: genericobject

{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}

enum (GenericType)

カードが属する GenericType を指定します。

object (LocalizedString)

必須。パスのヘッダー。通常は、「XXX Gym」、「AAA Insurance」などの会社名です。このフィールドは必須で、パスの一番上のヘッダー行に表示されます。

object (LocalizedString)

パスのタイトルラベル（このパスを使用できる場所など）。パスの詳細ビューのタイトル行のタイトルのすぐ上に表示されます。

object (LocalizedString)

必須。パスのタイトル（「50% オフクーポン」など）「ライブラリ カード」または「クーポン」です。このフィールドは必須で、パス詳細ビューのタイトル行に表示されます。

object (Image)

パスのロゴ画像。この画像は、左上のカード情報ビューのほか、リストビューやサムネイル ビューにも表示されます。ロゴが存在しない場合、cardTitle の最初の文字がロゴとして表示されます。

string

カードの背景色。設定しない場合、ヒーロー画像の主要色が使用されます。ヒーロー画像が設定されていない場合はロゴの主要な色が使用され、ロゴが設定されていない場合は Google によって色が選択されます。

object (Notifications)

このオブジェクトで有効になっている通知設定。

string

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

string

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

クラス ID は issuerID.identifier の形式にする必要があります。issuerID は Google が発行し、identifier はユーザーが選択したものです。

object (Barcode)

バーコードのタイプと値。パスにバーコードがない場合は、カード発行会社が Barcode.alternate_text を設定してそれだけを表示できます。

object (Image)

カードの前面に表示されるバナー画像（存在する場合）。画像は 100% 幅で表示されます。

object (TimeInterval)

このオブジェクトが有効または使用可能と見なされる期間。この期間を過ぎると、オブジェクトは期限切れと見なされ、ユーザーのデバイスでのレンダリングに影響します。

object (ImageModuleData)

画像モジュール データ。両方を設定した場合、クラスの画像とオブジェクト レベルの画像のうち 1 つだけがレンダリングされます。

object (TextModuleData)

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

object (LinksModuleData)

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

object (AppLinkData)

アプリまたはウェブサイトへのリンク。パスの前面にボタンとして表示されるオプションです。AppLinkData が対応するクラスに提供されている場合は、オブジェクト AppLinkData のみが表示されます。

object (GroupingInfo)

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

string

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

object (RotatingBarcode)

ローテーション バーコードの設定/詳細。

enum (State)

オブジェクトの状態。このフィールドは、アプリでのオブジェクトの表示方法を決定するために使用されます。たとえば、inactive オブジェクトは「期限切れのパス」に移動されます。。指定されていない場合、オブジェクトは ACTIVE とみなされます。

boolean

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

object (PassConstraints)

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

object (Image)

パスのワイドロゴ。指定した場合、カードビューの左上にあるロゴの代わりに使用されます。

object (SaveRestrictions)

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

{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}

object (ExpiryNotification)

通知は、カードの有効期限が切れる前の特定の時刻にトリガーされます。

object (UpcomingNotification)

カードが使用可能になる前の特定の時刻に通知がトリガーされます。

{
  "enableNotification": boolean
}

boolean

オブジェクトの有効期限通知を有効にする必要があるかどうかを示します。

{
  "enableNotification": boolean
}

boolean

オブジェクトで今後の通知を有効にする必要があるかどうかを示します。