REST Resource: sites.versions

Zasób: wersja

Plik Version to konfiguracja i zbiór plików statycznych, które określają sposób wyświetlania witryny.

Zapis 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
}
Pola
name

string

Pełna nazwa zasobu wersji w formacie:

sites/SITE_ID/versions/VERSION_ID

Ta nazwa jest podawana w treści odpowiedzi podczas wywoływania funkcji versions.create.

status

enum (VersionStatus)

Stan wdrożenia wersji.

Aby wdrożenie przebiegło pomyślnie, wywołaj metodę versions.create w celu utworzenia nowej wersji (stan CREATED), prześlij wszystkie żądane pliki do wersji, a następnie zaktualizuj wersję do stanu FINALIZED.

Pamiętaj, że jeśli pozostawisz wersję w stanie CREATED przez ponad 12 godzin, system automatycznie oznaczy ją jako ABANDONED.

Możesz też zmienić stan wersji na DELETED, dzwoniąc pod numer versions.delete.

config

object (ServingConfig)

Konfiguracja działania witryny. Ta konfiguracja znajduje się w pliku firebase.json.

labels

map (key: string, value: string)

Etykiety używane do dodatkowych metadanych lub filtrowania.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia wersji.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

createUser

object (ActingUser)

Tylko dane wyjściowe. Identyfikuje użytkownika, który utworzył daną wersję.

finalizeTime

string (Timestamp format)

Tylko dane wyjściowe. O tej godzinie wersja to FINALIZED.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

finalizeUser

object (ActingUser)

Tylko dane wyjściowe. Identyfikuje użytkownika, który FINALIZED wersję.

deleteTime

string (Timestamp format)

Tylko dane wyjściowe. O tej godzinie wersja to DELETED.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

deleteUser

object (ActingUser)

Tylko dane wyjściowe. Identyfikuje użytkownika, który DELETED wersję.

fileCount

string (int64 format)

Tylko dane wyjściowe. Łączna liczba plików powiązanych z wersją.

Ta wartość jest obliczana, gdy wersja ma wartość FINALIZED.

versionBytes

string (int64 format)

Tylko dane wyjściowe. Łączna liczba zapisanych bajtów w wersji.

Ta wartość jest obliczana, gdy wersja ma wartość FINALIZED.

Stan wersji

Bieżący znany stan określonej wersji w cyklu życia wdrażania.

Wartości w polu enum
VERSION_STATUS_UNSPECIFIED stan domyślny, nie powinny być używane celowo.
CREATED Wersja została utworzona, a jej treść jest obecnie dodawana.
FINALIZED Cała treść została dodana do wersji i nie można już zmienić wersji.
DELETED Wersja została usunięta.
ABANDONED Wersja nie została zaktualizowana do FINALIZED w ciągu 12 godzin i została automatycznie usunięta.
EXPIRED Wersja wykracza poza określony w witrynie limit liczby zachowywanych wersji, więc jej zawartość jest zaplanowana do usunięcia.
CLONING Kopiuję wersję z innej wersji. Cała zawartość jest nadal kopiowana.

Konfiguracja obsługi

Konfiguracja sposobu kierowania i przetwarzania żądań przychodzących do witryny przed udostępnieniem treści. Ścieżki żądań adresów URL są dopasowywane do określonych wzorców adresów URL w konfiguracji, a następnie Hosting stosuje odpowiednią konfigurację zgodnie z określoną kolejnością priorytetów.

.
Zapis JSON
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
Pola
headers[]

object (Header)

Tablica obiektów, w której każdy obiekt określa wzorzec adresu URL, który po dopasowaniu do ścieżki adresu URL żądania powoduje, że Hosting stosuje określone niestandardowe nagłówki odpowiedzi.

redirects[]

object (Redirect)

Tablica obiektów (nazywana regułami przekierowania), w której każda reguła określa wzorzec adresu URL, który po dopasowaniu do ścieżki adresu URL żądania powoduje, że Hosting odpowiada przekierowaniem na określoną ścieżkę docelową.

rewrites[]

object (Rewrite)

Tablica obiektów (nazywana regułami przepisywania), w której każda reguła określa wzorzec adresu URL, który po dopasowaniu do ścieżki adresu URL żądania powoduje, że Hosting odpowiada, jakby usługa otrzymała określony docelowy adres URL.

cleanUrls

boolean

Określa, czy usunąć rozszerzenie z przesłanych plików.

trailingSlashBehavior

enum (TrailingSlashBehavior)

Określa sposób obsługi ukośnika końcowego w ścieżce adresu URL.

i18n

object (I18nConfig)

Opcjonalnie. Definiuje działanie przepisywania i18n.

Header określa wzorzec adresu URL, który po dopasowaniu do ścieżki adresu URL żądania powoduje, że Hosting stosuje określone niestandardowe nagłówki odpowiedzi.

Zapis 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.
}
Pola
headers

map (key: string, value: string)

Wymagane. Dodatkowe nagłówki, które mają zostać dodane do odpowiedzi.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Pole sumy pattern.
Wymagane. Wzorzec adresu URL w postaci ciągu znaków dopasowywany do ścieżki adresu URL żądania w celu określenia, czy zastosować ten niestandardowy nagłówek odpowiedzi. Może to być glob w stylu Bash lub wyrażenie regularne RE2.

pattern może mieć tylko jedną z tych wartości:
glob

string

Podany przez użytkownika element glob dopasowany do ścieżki adresu URL żądania.

regex

string

Dostarczone przez użytkownika wyrażenie regularne RE2 do dopasowywania do ścieżki adresu URL żądania.

Przekierowanie

Redirect określa wzorzec adresu URL, który po dopasowaniu do ścieżki adresu URL żądania powoduje, że Hosting wysyła w odpowiedzi przekierowanie na określoną ścieżkę docelową.

Zapis 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.
}
Pola
statusCode

integer

Wymagane. Kod HTTP stanu do zwrócenia w odpowiedzi. Musi to być prawidłowy kod stanu 3xx.

location

string

Wymagane. Wartość do umieszczenia w nagłówku lokalizacji HTTP odpowiedzi.

Lokalizacja może zawierać wartości grup przechwytywania ze wzorca – prefiks : wskazuje segment i opcjonalny * do przechwytywania reszty adresu URL. Przykład:

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

Pole sumy pattern.
Wymagane. Wzorzec adresu URL w postaci ciągu znaków dopasowywany do ścieżki adresu URL żądania w celu określenia, czy należy zastosować to przekierowanie. Może to być glob w stylu Bash lub wyrażenie regularne RE2.

pattern może mieć tylko jedną z tych wartości:
glob

string

Podany przez użytkownika element glob dopasowany do ścieżki adresu URL żądania.

regex

string

Dostarczone przez użytkownika wyrażenie regularne RE2 do dopasowywania do ścieżki adresu URL żądania.

Modyfikacja

Rewrite określa wzorzec adresu URL, który po dopasowaniu do ścieżki adresu URL żądania powoduje, że Hosting odpowiada, jakby usługa otrzymała określony docelowy adres URL.

Zapis 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.
}
Pola
functionRegion

string

Opcjonalnie. Podaj region Cloud na potrzeby przepisywanych wywołań funkcji. Jeśli nie zostanie podana, domyślna wartość to us-central1.

Pole sumy pattern.
Wymagane. Wzorzec adresu URL w postaci ciągu znaków dopasowywany do ścieżki adresu URL żądania w celu określenia, czy przepisywanie ma zostać zastosowane. Może to być glob w stylu Bash lub wyrażenie regularne RE2.

pattern może mieć tylko jedną z tych wartości:
glob

string

Podany przez użytkownika element glob dopasowany do ścieżki adresu URL żądania.

regex

string

Dostarczone przez użytkownika wyrażenie regularne RE2 do dopasowywania do ścieżki adresu URL żądania.

Pole sumy behavior.
Wymagane. Sposób przepisywania.

behavior może mieć tylko jedną z tych wartości:
path

string

Ścieżka adresu URL, na którą należy przepisać żądanie.

function

string

Funkcja do serwera proxy. Musi być identyczna z nazwą wyeksportowanej funkcji.

run

object (CloudRunRewrite)

Żądanie zostanie przekierowane do Cloud Run.

CloudRunRewrite

Skonfigurowane przepisywanie, które kierują żądania do usługi Cloud Run. Jeśli podczas ustawiania lub aktualizowania konfiguracji Hostingu Firebase usługa Cloud Run nie istnieje, żądanie się nie powiedzie. Wszystkie błędy z Cloud Run są przekazywane do użytkownika (jeśli na przykład usuniesz usługę, wszystkie żądania kierowane do tej usługi będą zwracały błąd 404).

Zapis JSON
{
  "serviceId": string,
  "region": string,
  "tag": string
}
Pola
serviceId

string

Wymagane. Zdefiniowany przez użytkownika identyfikator usługi Cloud Run.

region

string

Opcjonalnie. Region podany przez użytkownika, w którym jest hostowana usługa Cloud Run.

Jeśli nie zostanie podany, domyślna wartość to us-central1.

tag

string

Opcjonalnie. Dostarczony przez użytkownika tag TrafficConfig do kierowania ruchu.

W przypadku pominięcia tego pola ruch jest wysyłany do identyfikatora URI całej usługi

Śledzenie po ukośnikach

Określa, czy ukośnik na końcu ścieżki adresu URL żądania ma zostać dodany czy usunięty.

Wartości w polu enum
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

Nie określono zachowania.

Pliki są udostępniane wyłącznie w ich dokładnej lokalizacji, a końcowe ukośniki są dodawane tylko do indeksów katalogów.

ADD Końcowe ukośniki są dodawane do indeksów katalogów oraz do wszystkich ścieżek adresów URL, które nie kończą się rozszerzeniem pliku.
REMOVE Końcowe ukośniki są usuwane z indeksów katalogów oraz ze wszystkich ścieżek adresów URL niekończących się rozszerzeniem pliku.

Konfiguracja I18n

Przepisywanie i18n jest włączone, jeśli ta opcja jest dostępna.

Zapis JSON
{
  "root": string
}
Pola
root

string

Wymagane. Podana przez użytkownika ścieżka, w której w katalogu publicznym będą wyszukiwane treści specyficzne dla danego kraju i języka.

Metody

clone

Tworzy nową wersję w podanej witrynie docelowej na podstawie zawartości określonej wersji.

create

Tworzy nową wersję określonej witryny.

delete

Usuwa określoną wersję.

get

Pobierz określoną wersję, która została utworzona dla określonej witryny.

list

Zawiera listę wersji, które zostały utworzone dla określonej witryny.

patch

Aktualizuje określone metadane określonej wersji.

populateFiles

Dodaje pliki treści do określonej wersji.