REST Resource: flightobject

リソース: FlightObject

JSON 表現 
{
  "kind": string,
  "classReference": {
    object (FlightClass)
  },
  "passengerName": string,
  "boardingAndSeatingInfo": {
    object (BoardingAndSeatingInfo)
  },
  "reservationInfo": {
    object (ReservationInfo)
  },
  "securityProgramLogo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
フィールド
kind
(deprecated)

string

リソースの種類を示します。値は固定文字列 "walletobjects#flightObject" です。
classReference

object (FlightClass)

親クラスの継承されたフィールドのコピー。このフィールドは、GET 中に取得されます。
passengerName

string

必須。搭乗券に表示される乗客名。

例: 「Dave M Gahan」、「Gahan/Dave」、「GAHAN/DAVEM」
boardingAndSeatingInfo

object (BoardingAndSeatingInfo)

搭乗と座席に関する乗客固有の情報。
reservationInfo

object (ReservationInfo)

必須。フライトの予約に関する情報。
hexBackgroundColor

string

カードの背景色。設定されていない場合は、ヒーロー画像の主要色が使用され、ヒーロー画像が設定されていない場合は、ロゴの主要色が使用されます。形式は #rrggbb です。ここで、rrggbb は 16 進数の RGB トリプレットです（例: #ffcc00）。#fc0 など、RGB トリプレットの省略形 #rgb も使用できます。
id

string

必須。オブジェクトの一意の識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。
classId

string

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

クラス ID は、issuer ID.identifier。前者は Google が発行し、後者は貴社が選択します。
version
(deprecated)

string (int64 format)

非推奨
state

enum (State)

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

object (Barcode)

バーコードのタイプと値。
messages[]

object (Message)

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

object (TimeInterval)

このオブジェクトが active になり、オブジェクトが使用可能である期間。この期間が経過すると、オブジェクトの状態は expired に変更されます。
locations[]
(deprecated)

object (LatLongPoint)

注: 現在、このフィールドで位置情報通知をトリガーすることはサポートされていません。
hasUsers

boolean

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

string

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

boolean

このオブジェクトが現在 1 つのデバイスにリンクされているかどうか。このフィールドは、ユーザーがオブジェクトを保存し、オブジェクトがデバイスにリンクされているときに、プラットフォームによって設定されます。一部のパートナーによる使用を想定しています。詳細についてはサポートにお問い合わせください。
disableExpirationNotification

boolean

通知を明示的に抑制するかどうかを示します。このフィールドを true に設定した場合、messages フィールドに関係なく、ユーザーへの有効期限通知が抑制されます。このフィールドはデフォルトで false に設定されています。

現在、これはフライトに対してのみ設定できます。
infoModuleData

object (InfoModuleData)

非推奨です。代わりに textModulesData を使用してください。
imageModulesData[]

object (ImageModuleData)

画像モジュールのデータ。このフィールドが表示される数には上限があり、オブジェクト レベルから 1 個、クラス オブジェクト レベルでは 1 個が最大数になります。
textModulesData[]

object (TextModuleData)

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

object (RotatingBarcode)

回転バーコードのタイプと値。
heroImage

object (Image)

カードの表面に表示されるオプションのバナー画像。何も存在しない場合は、クラスのヒーロー画像が表示されます（存在する場合）。クラスのヒーロー画像も存在しない場合、何も表示されません。
groupingInfo

object (GroupingInfo)

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

object (PassConstraints)

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

object (SaveRestrictions)

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

string

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

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

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

enum (NotificationSettingsForUpdates)

このオブジェクトのフィールドの更新を通知のトリガーにするかどうか。NOTIFY に設定すると、フィールドの更新通知がユーザーに送信されます。これらの通知は、フィールドが許可リストに含まれている場合にのみユーザーに送信されます。DO_NOT_NOTIFY または NOTIFICATION_SETTINGS_UNSPECIFIED に設定した場合、通知はトリガーされません。この設定は一時的な設定であり、PATCH リクエストまたは UPDATE リクエストごとに設定する必要があります。設定しない場合、通知はトリガーされません。
valueAddedModuleData[]

object (ValueAddedModuleData)

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

BoardingAndSeatingInfo

JSON 表現 
{
  "kind": string,
  "boardingGroup": string,
  "seatNumber": string,
  "seatClass": string,
  "boardingPrivilegeImage": {
    object (Image)
  },
  "boardingPosition": string,
  "sequenceNumber": string,
  "boardingDoor": enum (BoardingDoor),
  "seatAssignment": {
    object (LocalizedString)
  }
}
フィールド
kind
(deprecated)

string

リソースの種類を示します。値は固定文字列 "walletobjects#boardingAndSeatingInfo" です。
boardingGroup

string

乗客が搭乗する搭乗グループ（またはゾーン）の値。

例: 「B」

この値のラベルは、このオブジェクトが参照する flightClass の boardingPolicy フィールドによって決まります。
seatNumber

string

乗客の座席の値。特定の ID がない場合は、代わりに seatAssignment を使用します。

例: 「25A」
seatClass

string

座席クラスの値。

例: 「Economy」、「Economy Plus」
boardingPrivilegeImage

object (Image)

搭乗バーコードの上に表示される小さい画像。航空会社は、特別な搭乗特権を伝えるために使用できます。セキュリティ・プログラムのロゴも設定されている場合、この画像はそのセキュリティ・プログラムのロゴと並んで表示されます。
boardingPosition

string

搭乗位置の値。

例: 「76」
sequenceNumber

string

搭乗券の連続番号。これは通常、乗客のチェックイン順序と一致します。航空会社は、この番号を手動搭乗やかばんのタグに使用できます。

例: 「49」
boardingDoor

enum (BoardingDoor)

複数のドアやブリッジから搭乗するフライトで、搭乗券に搭乗するドアを明確に印刷する必要がある場合にのみ、このフィールドを設定します。ほとんどの航空会社は、seatClass で示されるドアやブリッジで、適切なドアまたはブリッジに乗客を誘導します。そのような場合、boardingDoor は設定しないでください。
seatAssignment

object (LocalizedString)

乗客の席の割り当て。seatNumber に使用する特定の ID がない場合に使用します。

例: 「assigned at gate」

BoardingDoor

列挙型
BOARDING_DOOR_UNSPECIFIED
FRONT
front

FRONT のレガシー エイリアス。サポート終了。
BACK
back

BACK のレガシー エイリアス。サポート終了。

ReservationInfo

JSON 表現 
{
  "kind": string,
  "confirmationCode": string,
  "eticketNumber": string,
  "frequentFlyerInfo": {
    object (FrequentFlyerInfo)
  }
}
フィールド
kind
(deprecated)

string

リソースの種類を示します。値は固定文字列 "walletobjects#reservationInfo" です。
confirmationCode

string

このフライトにチェックインするために必要な確認コード。

これは、乗客がフライトを検索して搭乗券を印刷するために、空港のキオスクで入力する番号です。
eticketNumber

string

e チケット番号。
frequentFlyerInfo

object (FrequentFlyerInfo)

マイレージ会員情報。

FrequentFlyerInfo

JSON 表現 
{
  "kind": string,
  "frequentFlyerProgramName": {
    object (LocalizedString)
  },
  "frequentFlyerNumber": string
}
フィールド
kind
(deprecated)

string

リソースの種類を示します。値は固定文字列 "walletobjects#frequentFlyerInfo" です。
frequentFlyerProgramName

object (LocalizedString)

マイレージ プログラム名。例: 「Lufthansa Miles & More」
frequentFlyerNumber

string

マイレージ会員番号。

種類が walletobjects#frequentFlyerInfo のネスト オブジェクトで必須です。

メソッド

addmessage

 指定されたオブジェクト ID のフライト オブジェクトにメッセージを追加します。

get

 指定されたオブジェクト ID のフライト オブジェクトを返します。

insert

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

list

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

patch

 指定されたオブジェクト ID のフライト オブジェクトを更新します。

update

 指定されたオブジェクト ID のフライト オブジェクトを更新します。