このページは Cloud Translation API によって翻訳されました。

REST Resource: transitclass

リソース: TransitClass
メソッド

リソース: TransitClass

JSON 表現

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)
  },
  "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)` 交通事業者の名前。
`logo`	`object (Image)` 必須。チケットのロゴ画像。この画像は、アプリのカード情報ビューに表示されます。
`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 個が最大数になります。
`linksModuleData`	`object (LinksModuleData)` リンクモジュールのデータ。リンクモジュールのデータがオブジェクトにも定義されている場合、両方が表示されます。
`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)` 交通機関のチケットのロック解除要件のオプションを表示します。
`wideLogo`	`object (Image)` チケットのワイドロゴ。指定すると、カードビューの左上にロゴの代わりに使用されます。
`notifyPreference`	`enum (NotificationSettingsForUpdates)` このクラスのフィールドの更新で通知をトリガーするかどうか。NOTIFY に設定すると、フィールドの更新通知がユーザーに送信されます。これらの通知は、フィールドが許可リストに含まれている場合にのみユーザーに送信されます。DO_NOT_NOTIFY または NOTIFICATION_SETTINGS_UNSPECIFIED に設定した場合、通知はトリガーされません。この設定は一時的な設定であり、PATCH リクエストまたは UPDATE リクエストごとに設定する必要があります。設定しない場合、通知はトリガーされません。
`appLinkData`	`object (AppLinkData)` パスの表面にボタンとして表示される、アプリまたはウェブサイトのリンク（省略可）。対応するオブジェクトに AppLinkData が指定されている場合は、代わりにそれが使用されます。
`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 であっても、リクエストされたデバイスが現在のデバイスと異なる場合でも、クライアントは有効な有効化ボタンをレンダリングできます。

activationUrl

string

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

allowReactivation

boolean

ユーザーが別のデバイスから有効化呼び出しを行えるようにするフラグ。これにより、activationStatus が ACTIVATED であっても、リクエストされたデバイスが現在のデバイスと異なる場合でも、クライアントは有効な有効化ボタンをレンダリングできます。

メソッド
`addmessage`	指定されたクラス ID の交通機関クラスにメッセージを追加します。
`get`	指定されたクラス ID の交通機関クラスを返します。
`insert`	指定された ID とプロパティの交通機関クラスを挿入します。
`list`	指定された発行者 ID のすべての交通機関クラスのリストを返します。
`patch`	指定されたクラス ID の交通機関クラスを更新します。
`update`	指定されたクラス ID の交通機関クラスを更新します。

REST Resource: transitclass

リソース: TransitClass

TransitType

ActivationOptions

メソッド

`addmessage`

`get`

`insert`

`list`

`patch`

`update`