创建软件包

上传选项

借助 Android Over The Air API，您可以上传软件包数据以创建新的软件包资源。这些 OTA 软件包可与一项或多项配置相关联，以便将更新分发到设备。

我们为 Linux 和 Windows 提供了二进制文件，以便您可以免费使用可续传软件包上传，而无需实现下述协议。如果您希望进行更深入的集成，请使用下述协议之一。

Linux

下载适用于 Linux 的 Android Over The Air API v1 上传程序客户端。

Windows

下载适用于 Windows 的 Android Over The Air API v1 上传程序客户端。

要使用它，您首先需要创建一个服务帐号并获取该帐号的 JSON 密钥文件。请点击此处参阅我们的帐号创建指南。
获得二进制文件和密钥文件后，您可以使用命令行选项运行该文件，以指定密钥文件、您的部署和要上传的软件包。请使用 --help 查看所有选项。

上传协议

您可通过以下任一方式发出上传请求。 请使用 X-Goog-Upload-Protocol 请求标头指定您要使用的方法。

  • 多部分上传：X-Goog-Upload-Protocol: multipart。适用于快速传输较小的文件和元数据；需在同一个请求中传输相应文件以及对该文件进行说明的元数据。
  • 可续传上传：X-Goog-Upload-Protocol: resumable。用于进行可靠的传输；该方法对于传输较大的文件尤为重要。通过这种方法，您可以使用一个启动请求的会话，可以选择在其中包含元数据。对于大多数应用来说，这是一个很好的策略，因为该方法也适用于传输较小的文件（只不过每次上传时都要多发出一个 HTTP 请求）。

多部分上传

如果您要发送的数据非常小，就算连接失败需要再次完整上传也没关系，那么该方法便是您的理想之选。

如需使用多部分上传，请向 /upload/package URI 发出 POST 请求，并将 X-Goog-Upload-Protocol 设置为 multipart。

发出分段上传请求时要使用的顶级 HTTP 标头包含：

  • Content-Type。请将此项设为 multipart/related，并在其中添加您要用于标识请求各个部分的定界字符串。
  • Content-Length。请将此项设为请求正文包含的字节总数。

请求正文的格式为 multipart/related 内容类型 [RFC2387]，并且恰好包含两个部分。这两个部分由定界字符串标识，最后的定界字符串后跟两个连字符。

分段请求的每个部分都需要附加一个 Content-Type 标头：

  1. 元数据部分：必须位于第一部分，且 Content-Type 必须为 application/json。
  2. 媒体部分：必须位于第二部分，且 Content-Type 必须为 application/zip。

示例：分段上传

以下示例展示了针对 Android Over The Air API 的多部分上传请求。

POST /upload/package HTTP/1.1
Host: androidovertheair.googleapis.com
Authorization: Bearer your_auth_token
Content-Type: multipart/related; boundary=BOUNDARY
Content-Length: number_of_bytes_in_entire_request_body

--BOUNDARY
Content-Type: application/json; charset=UTF-8

{"deployment": "id", "package_title": "title" }
--BOUNDARY
Content-Type: application/zip; charset=UTF-8

Package ZIP
--BOUNDARY--

如果请求成功，服务器将返回 HTTP 200 OK 状态代码

HTTP/1.1 200

有一种方法可轻松完成此操作，那就是使用 curl 和 oauth2l。以下示例请求假设您使用的是服务密钥（有关详情，请参阅我们的授权方法）。

示例 curl 请求 
    JSON={"deployment": "id", "package_title": "title" }
    SERVICE_KEY_FILE=path to your service key json file
    curl \
    -H "$(./oauth2l header --json $SERVICE_KEY_FILE android_partner_over_the_air)" \
    -H "Host: androidovertheair.googleapis.com" \
    -H "X-Goog-Upload-Protocol: multipart" \
    -H "Content-Type: multipart/form-data" \
    -F "json=$JSON;type=application/json" \
    -F "data=@update.zip;type=application/zip" \
    androidovertheair.googleapis.com/upload/package

可续传上传

如需更可靠地上传数据文件，您可以使用“可续传上传”协议。利用该协议，您可以在因通信故障导致数据流中断之后恢复上传操作。如果您要传输大型文件，并且发生网络中断或某些其他传输故障的可能性较高（例如，通过移动客户端应用上传时），该协议特别实用。此外，它还可以在发生网络故障时减少带宽使用量，因为您不必从头开始重新上传大型文件。

可续传上传协议使用多个命令：

  1. 启动可续传会话。对包含元数据的上传 URI 发出初始请求，并建立唯一的可续传上传位置。
  2. 保存可续传会话 URI。保存初始请求的响应中返回的会话 URI；您将会在此会话的后续请求中用到此 URI。
  3. 上传文件。将全部或部分 ZIP 文件发送到可续传会话 URI。

此外，使用可续传上传的应用需要通过代码来恢复中断的上传。如果上传中断，请查看已成功接收了多少数据，然后从中断处恢复上传。

注意 ：上传 URI 的有效期为 3 天。

第 1 步：启动可续传会话

如需启动可续传上传，请向 /upload/package URI 发出 POST 请求，并将 X-Goog-Upload-Protocol 设置为 resumable。

对于此启动请求，正文必须仅包含元数据；您将在后续请求中传输要上传的文件的实际内容。

请在初始请求中使用以下 HTTP 标头：

  • X-Goog-Upload-Header-Content-Type。这是要上传的文件的内容类型，必须设置为 application/zip。
  • X-Goog-Upload-Command。设置为 start
  • X-Goog-Upload-Header-Content-Length。请将此项设为要在后续请求中传输的上传数据的字节数。在发起此请求时，如果内容长度未知，那么您可以忽略此标头。
  • Content-Type。这是元数据的内容类型，必须设置为 application/json。
  • Content-Length。请将此项设为该初始请求的正文中提供的字节数。
示例：可续传会话的启动请求

以下示例展示了如何针对 Android Over The Air API 启动可续传会话。

POST /upload/package HTTP/1.1
Host: android/over-the-air.googleapis.com
Authorization: Bearer your_auth_token
Content-Length: 38
Content-Type: application/json; charset=UTF-8
X-Goog-Upload-Command: start
X-Goog-Upload-Header-Content-Type: application/zip
X-Goog-Upload-Header-Content-Length: 2000000

{"deployment": "id", "package_title": "title" }

下一个部分将介绍如何处理响应。

第 2 步：保存可续传会话 URI

如果会话启动请求成功，API 服务器会返回 HTTP 200 OK 状态代码。 此外，它还会提供 X-Goog-Upload-URL 标头来指定您的可续传会话 URI。以下示例中显示的 X-Goog-Upload-URL 标头包含 upload_id 查询参数部分，该部分提供了要用于此会话的唯一上传 ID。响应中还包含 X-Goog-Upload-Status 标头，如果上传请求有效并且已被接受，该标头将为 active。如果上传遭到拒绝，此状态可能为 final。

示例：可续传会话的启动响应

下面是对第 1 步中的请求的响应：

HTTP/1.1 200 OK
X-Goog-Upload-Status: active
X-Goog-Upload-URL: androidovertheair.googleapis.com/?upload_id=xa298sd_sdlkj2
Content-Length: 0

在上面的响应示例中，所显示的 X-Goog-Upload-URL 标头的值即是您将用作 HTTP 端点以上传实际文件或查询上传状态的会话 URI。

请复制并保存该会话 URI，以便在后续请求中使用。

第 3 步：上传文件

如需上传文件，请向您在上一步中获取的上传 URI 发送 POST 请求。上传请求的格式如下所示：

POST session_uri

发出可续传文件上传请求时要使用的 HTTP 标头包括：

  1. Content-Length。请将此项设为您要在该请求中上传的字节数（通常为上传文件大小）。
  2. X-Goog-Upload-Command。将此项设置为 upload 和 finalize。
  3. X-Goog-Upload-Offset。这指定了应写入字节的偏移量。请注意，客户端必须串行上传字节。
示例：可续传文件上传请求

下面是一个可续传请求，用于针对当前示例上传大小为 200 万字节的完整 ZIP 文件。

POST /?upload_id=xa298sd_sdlkj2 HTTP/1.1
Host: androidovertheair.googleapis.com
X-Goog-Upload-Protocol: resumable
X-Goog-Upload-Command: upload, finalize
X-Goog-Upload-Offset: 0
Content-Length: 2000000
Content-Type: application/zip

bytes 0-1999999

如果请求成功，服务器会返回 HTTP 200 Ok 响应。

如果上传请求被中断，或者服务器返回了 HTTP 503 Service Unavailable 或任何其他 5xx 响应，请按照恢复中断的上传部分中列出的步骤进行操作。

分块上传文件

借助可续传上传，您可以将一个文件分成几块，然后发送一系列请求，按顺序上传每个分块。这并不是首选方法，因为发送更多请求会降低性能，而且通常也不需要这样做。建议客户端上传载荷的所有剩余字节，并在每个 upload 命令中添加 finalize 命令。

但是，您可能需要使用分块来减少单个请求中传输的数据量。对于默认情况下不支持上传进度的旧版浏览器，该方法还可以让您提供上传进度指示。

恢复中断的上传

如果上传请求在收到响应之前被终止，或者您收到来自服务器的 HTTP 503 Service Unavailable 响应，那么您将需要恢复中断的上传。操作方法如下：

  1. 请求状态。通过向上传 URI 发出请求并将 X-Goog-Upload-Command 设置为 query，查询上传的当前状态。

    注意：您不仅可以请求查询上传是否已被中断，还可以请求查询分块之间的状态。例如，如果您想在旧版浏览器上显示上传进度指示，此请求会非常实用。

  2. 获取已上传的字节数。处理服务器针对状态查询返回的响应。服务器会在其响应中使用 X-Goog-Upload-Size-Received 标头来指明目前已收到多少字节。
  3. 上传剩余的数据。最后，在您知道应从何处恢复请求后，请发送剩余的数据或当前分块。请注意，无论在何种情况下，您都需要将剩余的数据视为单独的分块。因此，在恢复上传时，您需要将 X-Goog-Upload-Offset 标头设置为适当的偏移量。
示例：恢复中断的上传

1) 请求了解上传状态。

POST /?upload_id=xa298sd_sdlkj2 HTTP/1.1
Host: androidovertheair.googleapis.com
X-Goog-Upload-Command: query

与所有命令一样，客户端必须检查查询命令的 HTTP 响应中的 X-Goog-Upload-Status 标头。 如果标头存在，但值不是 active，则表示上传已经终止。

2) 从响应中提取目前已上传的字节数。

服务器的响应使用 X-Goog-Upload-Size-Received 标头来指明目前已收到文件的前 43 个字节。

HTTP/1.1 200 OK
X-Goog-Upload-Status: active
X-Goog-Upload-Size-Received: 42

3) 从中断处恢复上传。

下面的请求通过发送文件中的剩余字节（从第 43 个字节开始）来恢复上传。

POST /?upload_id=xa298sd_sdlkj2 HTTP/1.1
Host: androidovertheair.googleapis.com
X-Goog-Upload-Command: upload, finalize
Content-Length: 1999957
X-Goog-Upload-Offset: 43

bytes 43-1999999

最佳实践

在上传媒体时，了解错误处理方面的一些最佳做法很有帮助。

  • 恢复或重试由于连接中断或任何 5xx 错误而失败的上传，此类错误包括：
    • 500 Internal Server Error
    • 502 Bad Gateway
    • 503 Service Unavailable
    • 504 Gateway Timeout
  • 如果在恢复或重试上传请求时收到任何 5xx 服务器错误，请使用指数退避算法策略。如果服务器发生超载，则可能会出现此类错误。在出现大量请求或网络流量拥堵期间，指数退避有助于缓解这类问题。
  • 您不能通过指数退避算法来处理其他类型的请求，但仍然可以重试其中的许多请求。重试这些请求时，请限制重试的次数。例如，您的代码可以限制为重试 10 次或更少的次数就会报告错误。
  • 执行可续传上传时，通过从头开始整个上传过程来处理 404 Not Found 错误。

指数退避算法

指数退避是网络应用的标准错误处理策略，在此过程中，客户端按照不断增加的时间间隔定期重试失败的请求。如果因大量的请求或网络流量拥堵而导致服务器返回错误，指数退避策略能够很好地处理此类错误。相反，此策略并不适合处理与网络流量或响应时间无关的错误，例如授权凭据无效或找不到文件这样的错误。

如果使用得当，指数退避还能提高带宽使用效率、减少获得成功响应所需的请求数，并最大程度地提高并发环境中的请求吞吐量。

实现简单指数退避的流程如下：

  1. 向 API 发出请求。
  2. 收到 HTTP 503 响应，指出您应重试该请求。
  3. 等待 1 秒 + random_number_milliseconds 毫秒，然后重试该请求。
  4. 收到 HTTP 503 响应，指出您应重试该请求。
  5. 等待 2 秒 + random_number_milliseconds 毫秒，然后重试该请求。
  6. 收到 HTTP 503 响应，指出您应重试该请求。
  7. 等待 4 秒 + random_number_milliseconds 毫秒，然后重试该请求。
  8. 收到 HTTP 503 响应（指示您应该重试该请求）。
  9. 等待 8 秒 + random_number_milliseconds 毫秒，然后重试该请求。
  10. 收到 HTTP 503 响应（指示您应该重试该请求）。
  11. 等待 16 秒 + random_number_milliseconds 毫秒，然后重试该请求。
  12. 停止。报告或记录错误。

在上述流程中，random_number_milliseconds 是一个小于或等于 1000 的随机毫秒数。这是一项很有必要的机制，因为引入一个较小的随机延迟时间有助于更均匀地分布负载，并降低服务器发生拥堵的可能性。random_number_milliseconds 的值必须在每次等待后重新定义。

注意：等待时间始终是 (2 ^ n) 秒 + random_number_milliseconds 毫秒，其中 n 是单调递增的整数，初始值为 0。整数 n 在每次迭代（每次请求）后递增 1。

该算法设置为 n 等于 5 时终止。设置此上限的目的在于防止客户端无止尽地重试；在请求被视为“不可恢复的错误”之前，它使延迟总时间达到约 32 秒。重试更多次数是可以接受的，特别是在大数量上传正在进行的情况下；只需确保重试延迟时间的上限设置合理即可（比如说少于 1 分钟）。