REST Resource: genericobject

リソース: GenericObject

汎用オブジェクト

JSON 表現 
{
  "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,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
フィールド
genericType

enum (GenericType)

カードの GenericType を指定します。
cardTitle

object (LocalizedString)

必須。パスのヘッダー。通常はビジネス名（「XXX ジム」、「AAA 保険」など）です。このフィールドは必須で、パスの一番上にあるヘッダー行に表示されます。
subheader

object (LocalizedString)

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

object (LocalizedString)

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

string

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

object (Notifications)

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

string

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

string

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

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

object (Barcode)

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

object (Image)

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

object (TimeInterval)

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

object (ImageModuleData)

画像モジュールのデータ。両方が設定されている場合、クラスレベルとオブジェクト レベルの画像のどちらか一方のみがレンダリングされます。
textModulesData[]

object (TextModuleData)

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

object (GroupingInfo)

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

string

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

object (RotatingBarcode)

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

enum (State)

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

boolean

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

object (Message)

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

object (PassConstraints)

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

object (SaveRestrictions)

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

object (ValueAddedModuleData)

オプションの付加価値モジュール データ。オブジェクトに最大 10 個。
linkedObjectIds[]

string

linkedObjectIds は、この汎用オブジェクトに自動的に関連付けられる他のオブジェクト（イベント チケット、ポイントカード、クーポン、汎用、ギフトカード、交通機関のパス、搭乗券など）のリストです。ユーザーがこの汎用カードを保存していた場合、これらの linkedObjectId は、ユーザーがそのようなリンクされたパスを受け取る設定をオフにしていない限り、ユーザーのウォレットに自動的にプッシュされます。

linkedObjectIds に存在するオブジェクトがすでに挿入されていることを確認します。挿入されていない場合、呼び出しは失敗します。リンクしたオブジェクトのリンクを解除することはできません。別のカード発行会社に属するオブジェクトをリンクすることはできません。1 つのオブジェクトにリンクできるオブジェクトの数には上限があります。上限に達すると、呼び出し内の新しいリンク済みオブジェクトは無視されます。

オブジェクト ID は issuer ID 形式にする必要があります。identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。

GenericType

汎用カードのタイプ。

列挙型
GENERIC_TYPE_UNSPECIFIED 未指定の汎用型。
GENERIC_SEASON_PASS シーズンパス
GENERIC_UTILITY_BILLS 公共料金の明細書
GENERIC_PARKING_PASS 駐車パス
GENERIC_VOUCHER クーポン
GENERIC_GYM_MEMBERSHIP ジムの会員カード
GENERIC_LIBRARY_MEMBERSHIP 図書館カード
GENERIC_RESERVATIONS 予約
GENERIC_AUTO_INSURANCE 自動車保険カード
GENERIC_HOME_INSURANCE 住宅保険証
GENERIC_ENTRY_TICKET 入場券
GENERIC_RECEIPT 領収書
GENERIC_LOYALTY_CARD ポイントカード。この汎用タイプではなく、専用のポイントカード パスタイプを使用することをおすすめします。専用のポイントカード パスタイプには、汎用パスタイプよりも多くの機能があります。
GENERIC_OTHER その他のタイプ

通知

オブジェクトで通知を有効にする必要があるかどうかを示します。ExpiryNotification と UpcomingNotification のどちらか一方のみがサポートされます。expiryNotification は upcomingNotification より優先されます。つまり、expiryNotification が設定されている場合、upcomingNotification フィールドは無視されます。

JSON 表現 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
フィールド
expiryNotification

object (ExpiryNotification)

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

object (UpcomingNotification)

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

ExpiryNotification

カード発行会社が、カードの有効期限が切れる 2 日前に Google ウォレットから有効期限切れ通知を送信することを希望していることを示します。

JSON 表現 
{
  "enableNotification": boolean
}
フィールド
enableNotification

boolean

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

UpcomingNotification

カードが有効になる/使用可能になる 1 日前に、Google ウォレットからカードの有効期限に関する通知を送信するよう、カード発行会社が希望していることを示します。

JSON 表現 
{
  "enableNotification": boolean
}
フィールド
enableNotification

boolean

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

メソッド

addmessage

 指定されたオブジェクト ID の参照先の汎用オブジェクトにメッセージを追加します。

get

 指定されたオブジェクト ID の汎用オブジェクトを返します。

insert

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

list

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

patch

 指定されたオブジェクト ID によって参照される汎用オブジェクトを更新します。

update

 指定されたオブジェクト ID によって参照される汎用オブジェクトを更新します。