Method: projects.histories.executions.steps.thumbnails.list

ステップに添付された画像のサムネイルを一覧表示します。

次のいずれかの正規のエラーコードを返すことができます。- PERMISSION_DENIED - プロジェクトまたはいずれかの画像からの読み取りがユーザーに許可されていない場合 - INVALID_ARGUMENT - リクエストの形式が正しくない場合 - NOT_FOUND - ステップが存在しない場合、または画像が存在しない場合

HTTP リクエスト

GET https://toolresults.googleapis.com/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
projectId

string

プロジェクト ID。

必須。
historyId

string

履歴 ID。

必須。
executionId

string

実行 ID。

必須。
stepId

string

Step ID。

必須。

クエリ パラメータ

パラメータ
pageToken

string

次の項目でクエリを再開するための継続トークン。

省略可。
pageSize

integer

取得するサムネイルの最大数。

デフォルト値: 50。フィールドが設定されていない場合、またはフィールドの値が 0 の場合、サーバーはこのデフォルトを使用します。

省略可。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

ステップのサムネイルを含むレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "thumbnails": [
    {
      object (Image)
    }
  ],
  "nextPageToken": string
}
フィールド
thumbnails[]

object (Image)

画像データのリスト。

画像は決定的な順序で返されます。重要な順に、以下の要素に並べ替えられています。* まず、関連するテストケースで並べ替えます。テストケースのない画像は、1 つある画像よりも大きいとみなされます。* 2 つ目は、作成日時です。作成日時が指定されていない画像は、作成日時が指定されている画像より大きくなります。* 3 つ目は、steps.create または steps.patch の呼び出しによってステップに追加された順序です。
nextPageToken

string

次の項目でクエリを再開するための継続トークン。

設定されている場合は、pageToken フィールドにこの値を指定して list を再度呼び出し、読み取るサムネイルがまだあることを示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

画像

メイン画像へのリンクとサムネイルを含む画像。

JSON 表現 
{
  "stepId": string,
  "sourceImage": {
    object (ToolOutputReference)
  },

  // Union field thumbnail_or_error can be only one of the following:
  "thumbnail": {
    object (Thumbnail)
  },
  "error": {
    object (Status)
  }
  // End of list of possible types for union field thumbnail_or_error.
}
フィールド
stepId

string

画像が添付されるステップ。

常に設定。
sourceImage

object (ToolOutputReference)

フルサイズの元の画像への参照。

これは、Step にある画像の toolOutputs エントリと同じです。

常に設定。
共用体フィールド thumbnail_or_error。画像のサムネイル、またはサムネイルをレンダリングできなかった理由を説明するエラー。thumbnail_or_error は次のいずれかになります。
thumbnail

object (Thumbnail)

サムネイル。
error

object (Status)

サムネイルをレンダリングできなかった理由を説明するエラー。

サムネイル

サイズと形式を含む 1 つのサムネイル。

JSON 表現 
{
  "contentType": string,
  "heightPx": integer,
  "widthPx": integer,
  "data": string
}
フィールド
contentType

string

サムネイルのコンテンツ タイプ（「image/png」など）。

常に設定。
heightPx

integer

サムネイルの高さ（ピクセル単位）。

常に設定。
widthPx

integer

サムネイルの幅（ピクセル単位）。

常に設定。
data

string (bytes format)

サムネイル ファイル。

つまり、ここに表示されるバイトは、正確にサムネイル ファイルを構成するバイトです。（適切なコンテンツ タイプを使用して）画像としてそのまま配信できます。

常に設定。

Base64 でエンコードされた文字列。

ステータス

Status 型は、REST API や RPC API など、さまざまなプログラミング環境に適した論理エラーモデルを定義します。gRPC により使用されます。各 Status メッセージには、エラーコード、エラー メッセージ、エラーの詳細という 3 種類のデータが含まれます。

このエラーモデルと操作方法について詳しくは、API 設計ガイドをご覧ください。

JSON 表現 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
フィールド
code

integer

ステータス コード。google.rpc.Code の列挙値である必要があります。
message

string

デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして google.rpc.Status.details フィールドで送信するか、クライアントでローカライズする必要があります。
details[]

object

エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。

任意のデータ型のフィールドを含むオブジェクト。型を識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }