REST Resource: transitclass

リソース: TransitClass

JSON 表現 
{
  "transitOperatorName": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "transitType": enum (TransitType),
  "watermark": {
    object (Image)
  },
  "languageOverride": string,
  "customTransitTerminusNameLabel": {
    object (LocalizedString)
  },
  "customTicketNumberLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsDetailsLabel": {
    object (LocalizedString)
  },
  "customTimeRestrictionsLabel": {
    object (LocalizedString)
  },
  "customOtherRestrictionsLabel": {
    object (LocalizedString)
  },
  "customPurchaseReceiptNumberLabel": {
    object (LocalizedString)
  },
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "customPurchaseFaceValueLabel": {
    object (LocalizedString)
  },
  "customPurchasePriceLabel": {
    object (LocalizedString)
  },
  "customDiscountMessageLabel": {
    object (LocalizedString)
  },
  "customCarriageLabel": {
    object (LocalizedString)
  },
  "customSeatLabel": {
    object (LocalizedString)
  },
  "customCoachLabel": {
    object (LocalizedString)
  },
  "customPlatformLabel": {
    object (LocalizedString)
  },
  "customZoneLabel": {
    object (LocalizedString)
  },
  "customFareClassLabel": {
    object (LocalizedString)
  },
  "customConcessionCategoryLabel": {
    object (LocalizedString)
  },
  "customFareNameLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "enableSingleLegItinerary": boolean,
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "activationOptions": {
    object (ActivationOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
フィールド
transitOperatorName

object (LocalizedString)

交通事業者の名前。
transitType

enum (TransitType)

必須。このクラスが表す交通機関のタイプ（「バス」など）。
watermark

object (Image)

ユーザーのデバイスに表示する透かし画像。
languageOverride

string

このフィールドが存在する場合、ユーザーのデバイスに配信される乗車券は常にこの言語で表示されます。BCP 47 言語タグを表します。値の例: 「en-US」、「en-GB」、「de」、「de-AT」。
customTransitTerminusNameLabel

object (LocalizedString)

終点名の値（transitObject.ticketLeg.transitTerminusName）に使用するカスタムラベル。
customTicketNumberLabel

object (LocalizedString)

チケット番号の値（transitObject.ticketNumber）に使用するカスタムラベル。
customRouteRestrictionsLabel

object (LocalizedString)

利用ルート制限の値（transitObject.ticketRestrictions.routeRestrictions）に使用するカスタムラベル。
customRouteRestrictionsDetailsLabel

object (LocalizedString)

利用ルート制限の詳細値（transitObject.ticketRestrictions.routeRestrictionsDetails）に使用するカスタムラベル。
customTimeRestrictionsLabel

object (LocalizedString)

時間制限の詳細値（transitObject.ticketRestrictions.timeRestrictions）に使用するカスタムラベル。
customOtherRestrictionsLabel

object (LocalizedString)

他の制限値（transitObject.ticketRestrictions.otherRestrictions）に使用するカスタムラベル。
customPurchaseReceiptNumberLabel

object (LocalizedString)

購入領収書番号の値（transitObject.purchaseDetails.purchaseReceiptNumber）に使用するカスタムラベル。
customConfirmationCodeLabel

object (LocalizedString)

確認コードの値（transitObject.purchaseDetails.confirmationCode）に使用するカスタムラベル。
customPurchaseFaceValueLabel

object (LocalizedString)

購入額面金額（transitObject.purchaseDetails.ticketCost.faceValue）に使用するカスタムラベル。
customPurchasePriceLabel

object (LocalizedString)

購入価格の値（transitObject.purchaseDetails.ticketCost.purchasePrice）に使用するカスタムラベル。
customDiscountMessageLabel

object (LocalizedString)

交通機関割引メッセージの値（transitObject.purchaseDetails.ticketCost.discountMessage）に使用するカスタムラベル。
customCarriageLabel

object (LocalizedString)

車両の値（transitObject.ticketLeg.carriage）に使用するカスタムラベル。
customSeatLabel

object (LocalizedString)

座席位置の値（transitObject.ticketLeg.ticketSeat.seat）に使用するカスタムラベル。
customCoachLabel

object (LocalizedString)

コーチの値（transitObject.ticketLeg.ticketSeat.coach）に使用するカスタムラベル。
customPlatformLabel

object (LocalizedString)

乗車プラットフォームの値（transitObject.ticketLeg.platform）に使用するカスタムラベル。
customZoneLabel

object (LocalizedString)

乗車ゾーンの値（transitObject.ticketLeg.zone）に使用するカスタムラベル。
customFareClassLabel

object (LocalizedString)

運賃クラス値（transitObject.ticketLeg.ticketSeat.fareClass）に使用するカスタムラベル。
customConcessionCategoryLabel

object (LocalizedString)

乗車割引カテゴリの値（transitObject.concessionCategory）に使用するカスタムラベル。
customFareNameLabel

object (LocalizedString)

運賃名の値（transitObject.ticketLeg.fareName）に使用するカスタムラベル。
classTemplateInfo

object (ClassTemplateInfo)

クラスの表示方法に関するテンプレート情報。設定しない場合、デフォルトのフィールド セットが表示されます。
enableSingleLegItinerary

boolean

このクラスの片道旅程の表示を制御します。デフォルトでは、旅程は往復のみ表示されます。
id

string

必須。クラスの一意の識別子。この ID は、発行者のすべてのクラスで一意である必要があります。この値には issuer ID.identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意の識別子には、英数字、「.」、「_」、「-」のみを使用してください。
version
(deprecated)

string (int64 format)

非推奨
issuerName

string

必須。発行者の名前。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。
messages[]

object (Message)

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

boolean

非推奨です。multipleDevicesAndHoldersAllowedStatus を代わりに使用してください。

homepageUri

object (Uri)

アプリケーションのホームページの URI。このフィールドに URI を設定すると、linksModuleData に URI を設定した場合の動作はまったく同じになります（オブジェクトがレンダリングされると、通常はオブジェクトの linksModuleData セクションと考えられる場所にホームページへのリンクが表示されます）。
locations[]
(deprecated)

object (LatLongPoint)

注: 現在、このフィールドはジオフェンス通知のトリガーには対応していません。
reviewStatus

enum (ReviewStatus)

必須。クラスのステータス。このフィールドは、挿入、パッチ、更新の API 呼び出しを使用して draft または underReview に設定できます。レビュー ステータスが draft から変更されると、その後 draft に戻すことはできません。

クラスが開発中の場合は、このフィールドを draft のままにしてください。draft クラスはオブジェクトの作成には使用できません。

クラス使用の準備が整ったら、このフィールドを underReview に設定する必要があります。このフィールドは自動的に approved に設定され、オブジェクトの作成や移行にすぐに使用できます。

すでに approved とマークされたクラスを更新する場合、このフィールドを underReview に設定しておく必要があります。
review

object (Review)

クラスが approved または rejected とマークされたときにプラットフォームによって設定されるレビュー コメント。
infoModuleData
(deprecated)

object (InfoModuleData)

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

object (ImageModuleData)

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

object (TextModuleData)

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

string (int64 format)

スマートタップ経由でパスを利用できるクーポン発行者を特定します。クーポン発行者は発行者 ID で識別されます。クーポン発行元には、少なくとも 1 つのスマートタップ キーが設定されている必要があります。

パスでスマートタップをサポートするには、enableSmartTap フィールドとオブジェクト レベルの smartTapRedemptionLevel フィールドを正しく設定することも必要です。
countryCode

string

カードの国を表示する（ユーザーがその国にいない場合）およびユーザーの言語 / 地域でコンテンツが利用できないときにローカライズされたコンテンツを表示するために使用される国コード。
heroImage

object (Image)

カードの表面に表示されるオプションのバナー画像。バナー画像がない場合は、何も表示されません。画像は 100% 幅で表示されます。
wordMark
(deprecated)

object (Image)

サポート終了。
enableSmartTap

boolean

このクラスがスマートタップをサポートしているかどうかを識別します。パスでスマートタップをサポートするには、redemptionIssuers フィールドとオブジェクト レベルの smartTapRedemptionLevel フィールドも正しく設定する必要があります。
hexBackgroundColor

string

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

object (LocalizedString)

issuerName の翻訳文字列。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

複数のユーザーやデバイスについて、このクラスを参照する同じオブジェクトを保存しているかどうかを示します。
callbackOptions

object (CallbackOptions)

コールバック オプション。エンドユーザーがこのクラスのオブジェクトを保存または削除するたびに発行者をコールバックするために使用します。このクラスのすべてのオブジェクトはコールバックの対象となります。
securityAnimation

object (SecurityAnimation)

セキュリティ アニメーションに関する情報（省略可）。設定すると、パスの詳細にセキュリティ アニメーションが表示されます。
activationOptions

object (ActivationOptions)

有効化可能なチケットの有効化オプション。
viewUnlockRequirement

enum (ViewUnlockRequirement)

乗車券のロック解除要件オプションを表示します。
notifyPreference

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

TransitType

列挙型
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

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

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

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

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

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

ActivationOptions

クラスの ActivationOptions

JSON 表現 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
フィールド
activationUrl

string

REST セマンティクスをサポートする HTTPS URL。ユーザーによってトリガーされる、特定の価値についてパートナーに有効化をリクエストするために使用されます。
allowReactivation

boolean

ユーザーが別のデバイスからアクティベーション コールを行うことを許可するフラグ。これにより、activationStatus が ACTIVATED になっているが、リクエストされたデバイスが現在のデバイスと異なる場合でも、クライアントはアクティベーション ボタンを有効なレンダリングにレンダリングできます。

メソッド

addmessage

 指定されたクラス ID の交通機関クラスにメッセージを追加します。

get

 指定されたクラス ID の交通機関クラスを返します。

insert

 指定された ID とプロパティの交通機関クラスを挿入します。

list

 指定された発行者 ID のすべての交通機関クラスのリストを返します。

patch

 指定されたクラス ID の交通機関クラスを更新します。

update

 指定されたクラス ID の交通機関クラスを更新します。