Cloud Tool Results API

用于发布和访问开发者工具中的结果的 API。

服务:toolresults.googleapis.com

如要调用此服务,我们建议您使用 Google 提供的客户端库。如果您的应用需要使用您自己的库来调用此服务,则在发出 API 请求时应使用以下信息。

发现文档

发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。此服务提供了以下发现文档:

服务端点

服务端点是指定 API 服务的网络地址的基本网址。一项服务可能有多个服务端点。此服务具有以下服务端点,下面的所有 URI 都与此服务端点相关:

  • https://toolresults.googleapis.com

REST 资源:v1beta3.projects

方法
getSettings GET /toolresults/v1beta3/projects/{projectId}/settings
) 获取项目的工具结果设置。
initializeSettings POST /toolresults/v1beta3/projects/{projectId}:initializeSettings
) 为尚未设定的设置创建资源。

REST 资源:v1beta3.projects.hicustomers

方法
create POST /toolresults/v1beta3/projects/{projectId}/histories
) 创建历史记录。
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}
) 获取历史记录。
list GET /toolresults/v1beta3/projects/{projectId}/histories
) 列出给定项目的历史记录。

REST 资源:v1beta3.projects.hiages.executions

方法
create POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions
) 创建执行。
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}
) 获取执行作业。
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions
) 列出给定历史记录的执行作业。
patch PATCH /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}
) 使用提供的部分实体更新现有执行。

REST 资源:v1beta3.projects.hiages.executions.clusters

方法
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters/{clusterId}
) 根据 ID 检索单个屏幕截图集群
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters

列出屏幕截图集群

返回与执行作业对应的屏幕截图集群列表。

REST 资源:v1beta3.projects.hicustomers.executions.environments

方法
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments/{environmentId}
) 获取环境。
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments
) 列出给定执行的环境。

REST 资源:v1beta3.projects.hicustomers.executions.steps

方法
accessibilityClusters GET /toolresults/v1beta3/{name=projects/*/histories/*/executions/*/steps/*}:accessibilityClusters

列出给定步骤的无障碍功能集群

系统可能会返回以下任一规范错误代码:

  • PERMISSION_DENIED - 如果用户无权读取项目
  • INVALID_ARGUMENT - 如果请求格式错误
  • FAILED_PRECONDITION - 如果请求中的参数无效;例如
create POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps
) 创建步骤。
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}
) 获取步骤。
getPerfMetricsSummary GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary
) 检索 PerfMetricsSummary。
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps
) 列出给定执行的步骤。
patch PATCH /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}
) 使用提供的部分实体更新现有步骤。
publishXunitXmlFiles POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles
) 将 xml 文件发布到现有步骤。

REST 资源:v1beta3.projects.hiprofiles.executions.steps.perfMetricsSummary

方法
create POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary
) 创建 PerfMetricsSummary 资源。

REST 资源:v1beta3.projects.hicustomers.executions.steps.perfSampleSeries

方法
create POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries
) 创建 PerfSampleSeries。
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}
) 获取 PerfSampleSeries。
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries
) 列出给定步骤的 PerfSampleSeries。

REST 资源:v1beta3.projects.hiprofiles.executions.steps.perfSampleSeries.samples

方法
batchCreate POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples:batchCreate
) 创建一批 PerfSample - 客户端可以通过重复调用此方法来提交多个批次的 Perf 样本,以拆分较大的请求负载,重复项和现有时间戳条目将被忽略。
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples

列出给定样本系列的性能样本 - 列表结果按时间戳升序排序。默认页面大小为 500 个样本;和允许的大小上限 5000 - 响应令牌表示上次返回的 PerfSample 时间戳 - 当结果大小超出页面大小时,请提交包含页面令牌的后续请求,以返回剩余的页面,直至达到页面上限

可能会返回以下任意一种规范错误代码:- OUT_OF_RANGE - 指定的请求 page_token 超出有效范围 - NOT_FOUND - 包含的 PerfSampleSeries 不存在

REST 资源:v1beta3.projects.hicustomers.executions.steps.testCases

方法
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases/{testCaseId}
) 获取步骤测试用例的详细信息。
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases
) 列出附加到某个步骤的测试用例。

REST 资源:v1beta3.projects.hihistory.executions.steps.thumbnails

方法
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails
) 列出附加到步骤的图片的缩略图。