- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy uprawnień
- Obraz
- Miniaturka
- Status
- Spróbuj!
Wyświetla miniatury obrazów dołączonych do kroku.
Może zwrócić dowolny z następujących kanonicznych kodów błędów: - PERMISSION_DENIED - jeśli użytkownik nie ma uprawnień do odczytu projektu lub któregokolwiek z obrazów - INVALID_ARGUMENT - jeśli żądanie jest źle sformułowane - NOT_FOUND - jeśli krok nie istnieje, lub jeśli którykolwiek z obrazów nie istnieje
Żądanie HTTP
GET https://toolresults.googleapis.com/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails
Adres URL używa składni transkodowania gRPC .
Parametry ścieżki
Parametry | |
---|---|
projectId | Identyfikator projektu. Wymagany. |
historyId | Identyfikator historii. Wymagany. |
executionId | Identyfikator wykonania. Wymagany. |
stepId | Identyfikator kroku. Wymagany. |
Parametry zapytania
Parametry | |
---|---|
pageToken | Token kontynuacji umożliwiający wznowienie zapytania w następnym elemencie. Opcjonalny. |
pageSize | Maksymalna liczba miniatur do pobrania. Wartość domyślna: 50. Serwer użyje tej wartości domyślnej, jeśli pole nie jest ustawione lub ma wartość 0. Opcjonalny. |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Odpowiedź zawierająca miniatury w kroku.
Jeśli się powiedzie, treść odpowiedzi zawiera dane o następującej strukturze:
Reprezentacja JSON |
---|
{
"thumbnails": [
{
object ( |
Pola | |
---|---|
thumbnails[] | Lista danych obrazu. Obrazy są zwracane w kolejności deterministycznej; są one uporządkowane według następujących czynników w kolejności ważności: * Po pierwsze, według powiązanego z nimi przypadku testowego. Obrazy bez przypadku testowego są uważane za lepsze niż obrazy z takim przypadkiem testowym. * Po drugie, według czasu ich stworzenia. Obrazy bez czasu utworzenia są większe niż obrazy z nim. * Po trzecie, według kolejności dodania ich do kroku (poprzez wywołania kroki.create lub kroki.patch). |
nextPageToken | Token kontynuacji umożliwiający wznowienie zapytania w następnym elemencie. Jeśli jest ustawiony, wskazuje, że jest więcej miniatur do przeczytania, wywołując ponownie listę z tą wartością w polu pageToken. |
Zakresy uprawnień
Wymaga następującego zakresu OAuth:
-
https://www.googleapis.com/auth/cloud-platform
Aby uzyskać więcej informacji, zobacz Omówienie uwierzytelniania .
Obraz
Obrazek z linkiem do obrazu głównego i miniaturą.
Reprezentacja JSON |
---|
{ "stepId": string, "sourceImage": { object ( |
Pola | |
---|---|
stepId | Krok, do którego dołączony jest obraz. Zawsze ustawione. |
sourceImage | Odniesienie do pełnowymiarowego, oryginalnego obrazu. Jest to to samo, co wpis ToolOutputs dla obrazu w jego kroku. Zawsze ustawione. |
Pole związku thumbnail_or_error . Albo miniatura obrazu, albo błąd wyjaśniający, dlaczego miniatura nie mogła zostać wyrenderowana. thumbnail_or_error może mieć tylko jedną z następujących wartości: | |
thumbnail | Miniaturka. |
error | Wystąpił błąd wyjaśniający, dlaczego nie można było wyrenderować miniatury. |
Miniaturka
Pojedyncza miniatura, z jej rozmiarem i formatem.
Reprezentacja JSON |
---|
{ "contentType": string, "heightPx": integer, "widthPx": integer, "data": string } |
Pola | |
---|---|
contentType | Typ zawartości miniatury, np. „image/png”. Zawsze ustawione. |
heightPx | Wysokość miniatury w pikselach. Zawsze ustawione. |
widthPx | Szerokość miniatury w pikselach. Zawsze ustawione. |
data | Sam plik miniatury. Oznacza to, że bajty tutaj są dokładnie tymi bajtami, które tworzą plik miniatury; mogą być wyświetlane jako obraz w niezmienionej postaci (z odpowiednim typem treści). Zawsze ustawione. Ciąg zakodowany w formacie base64. |
Status
Typ Status
definiuje model błędów logicznych odpowiedni dla różnych środowisk programistycznych, w tym interfejsów API REST i interfejsów API RPC. Jest używany przez gRPC . Każdy komunikat Status
zawiera trzy elementy danych: kod błędu, komunikat o błędzie i szczegóły błędu.
Więcej informacji na temat tego modelu błędów i sposobu pracy z nim można znaleźć w Przewodniku projektowania interfejsu API .
Reprezentacja JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Pola | |
---|---|
code | Kod stanu, który powinien być wartością wyliczeniową |
message | Komunikat o błędzie skierowany do programisty, który powinien być w języku angielskim. Każdy komunikat o błędzie wyświetlany użytkownikowi powinien zostać zlokalizowany i przesłany w polu |
details[] | Lista komunikatów zawierających szczegóły błędu. Istnieje wspólny zestaw typów komunikatów, z których mogą korzystać interfejsy API. Obiekt zawierający pola dowolnego typu. Dodatkowe pole |