コンソールへ移動

REST リソース: sites.versions

リソース: Version

Version とは、サイトの表示方法を決定する構成と静的ファイルのコレクションです。

JSON 表現

{
  "name": string,
  "status": enum (VersionStatus),
  "config": {
    object (ServingConfig)
  },
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "createUser": {
    object (ActingUser)
  },
  "finalizeTime": string,
  "finalizeUser": {
    object (ActingUser)
  },
  "deleteTime": string,
  "deleteUser": {
    object (ActingUser)
  },
  "fileCount": string,
  "versionBytes": string
}
フィールド
name

string

バージョンの一意の識別子。以下の形式です。

sites/site-name/versions/versionID

この名前は、versions.create エンドポイントを呼び出したときにレスポンス本文で指定されます。

status

enum (VersionStatus)

バージョンのデプロイ ステータス。

デプロイを成功させるには、versions.create エンドポイントを呼び出して新しいバージョンを作成し(CREATED ステータス)、必要なすべてのファイルをそのバージョンにアップロードし、そのバージョンのステータスを FINALIZED更新します。

バージョンを CREATED 状態のまま 12 時間以上放置すると、バージョンには自動的に ABANDONED のマークが付けられるので注意してください。

versions.delete エンドポイントを呼び出すことでバージョンのステータスを DELETED に変更することもできます。

config

object (ServingConfig)

サイトの動作の構成。この構成は、firebase.json ファイルに存在します。

labels

map (key: string, value: string)

追加のメタデータやフィルタリングに使用されるラベル。

"key": value ペアのリストが含まれるオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

createTime

string (Timestamp format)

出力のみ。バージョンが作成された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

createUser

object (ActingUser)

出力のみ。バージョンを作成したユーザーを示します。

finalizeTime

string (Timestamp format)

出力のみ。バージョンが FINALIZED になった時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

finalizeUser

object (ActingUser)

出力のみ。バージョンを FINALIZED にしたユーザーを示します。

deleteTime

string (Timestamp format)

出力のみ。バージョンが DELETED になった時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

deleteUser

object (ActingUser)

出力のみ。バージョンを DELETED にしたユーザーを示します。

fileCount

string (int64 format)

出力のみ。バージョンに関連付けられたファイルの総数。
この値は、バージョンが FINALIZED になった後に計算されます。

versionBytes

string (int64 format)

出力のみ。バージョンの総保存バイトサイズです。
この値は、バージョンが FINALIZED になった後に計算されます。

VersionStatus

特定のバージョンのデプロイ ライフサイクルにおける現在の既知のステータス。

列挙値
VERSION_STATUS_UNSPECIFIED デフォルトのステータス。意図的に使用しないでください。
CREATED バージョンは作成されており、コンテンツを現在バージョンに追加しています。
FINALIZED すべてのコンテンツがバージョンに追加され、バージョンは変更できなくなりました。
DELETED バージョンは削除されました。
ABANDONED バージョンは 12 時間以内に FINALIZED に更新されず、自動的に削除されました。
EXPIRED サイトで構成された保持バージョン数の制限を超過しているため、バージョンのコンテンツは削除するようにスケジュールされています。

ServingConfig

サイトに送られてくるリクエストを、コンテンツを提供する前にどのようにルーティングして処理するかに関する構成。パターンは、特定の優先順位に従ってマッチングされて適用されます。

JSON 表現

{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior)
}
フィールド
headers[]

object (Header)

リクエスト URL パスが glob に一致する場合にコンテンツに追加されるカスタム レスポンス ヘッダーのリスト。

redirects[]

object (Redirect)

レスポンスを別の場所へリダイレクトさせるための glob のリスト。

rewrites[]

object (Rewrite)

サービスに宛先 URL が指定されているかのように振る舞う rewrite のリスト。

cleanUrls

boolean

アップロードしたファイルからファイル拡張子を削除するかどうかを定義します。

trailingSlashBehavior

enum (TrailingSlashBehavior)

URL パスで末尾のスラッシュをどう処理するかを定義します。

Header

header は、リクエスト URL パスがパターンと一致する場合にレスポンスに追加するカスタム ヘッダーを定義します。

JSON 表現

{
  "glob": string,
  "headers": {
    string: string,
    ...
  }
}
フィールド
glob

string

必須。ユーザーが指定する、リクエスト URL パスと照合するための glob パターン

headers

map (key: string, value: string)

必須。レスポンスに追加するヘッダー。

"key": value ペアのリストが含まれるオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

Redirect

redirect は、リクエスト URL パスが一致する場合に HTTP リダイレクト レスポンスを返すための構成を表します。

JSON 表現

{
  "glob": string,
  "statusCode": number,
  "location": string
}
フィールド
glob

string

必須。ユーザーが指定する、リクエスト URL パスと照合するための glob パターン

statusCode

number

必須。レスポンスで返すステータス HTTP コード。有効な 3xx ステータス コードでなければなりません。

location

string

必須。レスポンスの HTTP location ヘッダーに入れる値。
location には、: プレフィックスでセグメントを表すパターンから取得したキャプチャ グループの値を入れることもできます。このパターンでは、* で URL の残りの部分をキャプチャすることもできます。例:

"glob": "/:capture*",
"statusCode": 301,
"location": "https://example.com/foo/:capture"

Rewrite

rewrite は、バージョンにおける内部コンテンツ リライトを表します。パターンが一致する場合、リクエストは構成内で指定された宛先パスに対するものであるかのように処理されます。

JSON 表現

{
  "glob": string,

  // Union field behavior can be only one of the following:
  "path": string,
  "function": string,
  "run": {
    object (CloudRunRewrite)
  }
  // End of list of possible types for union field behavior.
}
フィールド
glob

string

必須。ユーザーが指定する、リクエスト URL パスと照合するための glob パターン

共用体フィールド behavior。必須。リライトの動作。behavior は次のいずれかになります。
path

string

この URL パスにリクエストをリライトします。

function

string

リクエストのプロキシ先の関数。エクスポートされた関数名と正確に一致しなければなりません。

run

object (CloudRunRewrite)

リクエストは Cloud Run に転送されます。

CloudRunRewrite

リクエストを Cloud Run サービスに転送するように構成された書き換え。Firebase Hosting の構成を設定または更新するときに、Cloud Run サービスが存在しないと、リクエストが失敗します。Cloud Run サービスからのエラーは、すべてエンドユーザーに渡されます(たとえば、サービスを