REST Resource: sites.versions

リソース: バージョン

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_ID /versions/ VERSION_ID

この名前は、 versions.createを呼び出すときに応答本文で提供されます。

status

enum ( VersionStatus )

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

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

バージョンを 12 時間以上CREATED状態のままにすると、システムは自動的にそのバージョンを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」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

createUser

object ( ActingUser )

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

finalizeTime

string ( Timestamp format)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

finalizeUser

object ( ActingUser )

出力のみ。バージョンFINALIZEDユーザーを識別します。

deleteTime

string ( Timestamp format)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

deleteUser

object ( ActingUser )

出力のみ。バージョンDELETEDユーザーを識別します。

fileCount

string ( int64 format)

出力のみ。バージョンに関連付けられたファイルの総数。

この値は、バージョンがFINALIZEDなった後に計算されます。

versionBytes

string ( int64 format)

出力のみ。バージョンの合計保存バイトサイズ。

この値は、バージョンがFINALIZEDなった後に計算されます。

バージョンステータス

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

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

ServingConfig

コンテンツを提供する前に、サイトへの受信リクエストをルーティングおよび処理する方法の構成。 URL リクエスト パスが構成内の指定された URL パターンと照合され、ホスティングは特定の優先順位に従って該当する構成を適用します。

JSON表現
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
田畑
headers[]

object ( Header )

オブジェクトの配列。各オブジェクトは、リクエスト URL パスと一致した場合に、指定されたカスタム応答ヘッダーを適用するようにホスティングをトリガーする URL パターンを指定します。

redirects[]

object ( Redirect )

オブジェクトの配列 (リダイレクト ルールと呼ばれます)。各ルールは URL パターンを指定します。このパターンが要求 URL パスに一致すると、指定された宛先パスへのリダイレクトでホスティングが応答します。

rewrites[]

object ( Rewrite )

オブジェクトの配列 (書き換えルールと呼ばれます)。各ルールは URL パターンを指定します。このパターンがリクエスト URL パスに一致すると、指定された宛先 URL がサービスに与えられたかのようにホスティングが応答します。

cleanUrls

boolean

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

trailingSlashBehavior

enum ( TrailingSlashBehavior )

URL パスの末尾のスラッシュを処理する方法を定義します。

i18n

object ( I18nConfig )

オプション。 i18n 書き換え動作を定義します。

Header 、リクエスト URL パスと一致する場合、指定されたカスタム応答ヘッダーを適用するようにホスティングをトリガーする URL パターンを指定します。

JSON表現
{
  "headers": {
    string: string,
    ...
  },

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
田畑
headers

map (key: string, value: string)

必須。応答に追加する追加ヘッダー。

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

ユニオンフィールドpattern
必須。このカスタム応答ヘッダーを適用するかどうかを決定するために、要求 URL パスと照合する文字列 URL パターン。 Bash スタイルのグロブまたは RE2 正規表現のいずれかを使用できます。

pattern次のいずれか 1 つだけです。
glob

string

リクエスト URL パスと照合するユーザー指定のglob

regex

string

リクエスト URL パスと照合するためのユーザー指定の RE2 正規表現。

リダイレクト

Redirect 、リクエスト URL パスに一致する場合、ホスティングが指定された宛先パスへのリダイレクトで応答するようにトリガーする URL パターンを指定します。

JSON表現
{
  "statusCode": integer,
  "location": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
田畑
statusCode

integer

必須。応答で返されるステータス HTTP コード。有効な 3xx ステータス コードである必要があります。

location

string

必須。応答の HTTP ロケーション ヘッダーに含める値。

この場所には、セグメントを識別するための:プレフィックスと URL の残りの部分をキャプチャするためのオプションの*を使用したパターンからのキャプチャ グループ値を含めることができます。例えば:

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

ユニオンフィールドpattern
必須。このリダイレクトを適用するかどうかを決定するために、リクエスト URL パスと照合する文字列 URL パターン。 Bash スタイルのグロブまたは RE2 正規表現のいずれかを使用できます。

pattern次のいずれか 1 つだけです。
glob

string

リクエスト URL パスと照合するユーザー指定のglob

regex

string

リクエスト URL パスと照合するためのユーザー指定の RE2 正規表現。

リライト

Rewrite 、リクエスト URL パスに一致する場合、サービスに指定された宛先 URL が与えられたかのようにホスティングが応答するようにトリガーする URL パターンを指定します。

JSON表現
{
  "functionRegion": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.

  // 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.
}
田畑
functionRegion

string

オプション。書き換えられた Functions 呼び出し用のクラウド リージョンを指定します。指定しない場合、デフォルトは us-central1 になります。

ユニオンフィールドpattern
必須。この書き換えを適用するかどうかを決定するために、リクエスト URL パスと照合する文字列 URL パターン。 Bash スタイルのグロブまたは RE2 正規表現のいずれかを使用できます。

pattern次のいずれか 1 つだけです。
glob

string

リクエスト URL パスと照合するユーザー指定のglob

regex

string

リクエスト URL パスと照合するためのユーザー指定の RE2 正規表現。

ユニオンフィールドのbehavior
必須。書き換えの動作。

behavior次のいずれか 1 つだけです。
path

string

リクエストを書き換える URL パス。

function

string

リクエストをプロキシする関数。エクスポートされた関数名と正確に一致する必要があります。

run

object ( CloudRunRewrite )

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

CloudRunRewrite

リクエストを Cloud Run サービスに送信するように構成されたリライト。 Firebase Hosting 構成の設定または更新時に Cloud Run サービスが存在しない場合、リクエストは失敗します。 Cloud Run サービスからのエラーはすべてエンドユーザーに渡されます(たとえば、サービスを削除すると、そのサービスに送信されたリクエストはすべて404エラーを受け取ります)。

JSON表現
{
  "serviceId": string,
  "region": string,
  "tag": string
}
田畑
serviceId

string

必須。 Cloud Run サービスのユーザー定義 ID。

region

string

オプション。 Cloud Run サービスがホストされるユーザー指定のリージョン。

指定しない場合、デフォルトはus-central1になります。

tag

string

オプション。トラフィックの送信先となるユーザー指定の TrafficConfig タグ。

省略すると、トラフィックはサービス全体の URI に送信されます。

トレーリングスラッシュの動作

リクエスト URL パスに末尾のスラッシュを追加するか削除するかを定義します。

列挙型
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

動作は指定されていません。

ファイルは正確な場所でのみ提供され、末尾のスラッシュはディレクトリ インデックスにのみ追加されます。

ADD末尾のスラッシュは、ディレクトリ インデックスおよびファイル拡張子で終わらない URL パスに追加されます
REMOVE末尾のスラッシュは、ディレクトリ インデックスおよびファイル拡張子で終わらない URL パスから削除されます

I18nConfig

指定すると、i18n 書き換えが有効になります。

JSON表現
{
  "root": string
}
田畑
root

string

必須。パブリック ディレクトリ内で国および言語固有のコンテンツが検索されるユーザー指定のパス。

メソッド

clone

指定されたバージョンのコンテンツを使用して、指定されたターゲット サイトに新しいバージョンを作成します。

create

指定されたサイトの新しいバージョンを作成します。

delete

指定したバージョンを削除します。

get

指定されたサイト用に作成された指定されたバージョンを取得します。

list

指定したサイト用に作成されたバージョンを一覧表示します。

patch

指定されたバージョンの指定されたメタデータを更新します。

populateFiles

コンテンツ ファイルを指定されたバージョンに追加します。