REST Resource: deployments.configs.packages

  • PackageConfig defines the configuration for an OTA update package, including the package name, download options, and zero-cost APN capability.

  • DownloadOptions specify how the OTA package should be downloaded, offering choices like Google servers, zero-cost downloads, or custom URLs.

  • DownloadType further categorizes the download method, with options such as normal downloads, zero-cost downloads through Google's VIP, or downloads from a custom server.

  • You can use the list method to retrieve a list of packages associated with a specific configuration.

Resource: PackageConfig

A package config.

JSON representation 
{
  "packageName": string,
  "downloadOptions": {
    object (DownloadOptions)
  },
  "zeroCostApnCapability": string
}
Fields
packageName

string

The name of the package.
downloadOptions

object (DownloadOptions)

Download options for package.
zeroCostApnCapability

string

If set, this will be the capability used to select the APN of the cellular network for downloading the update on a metered network. If not, no special APN will be selected for download. Note that Google Play Services must hold the correct system permissions to select this APN, and the carrier generally has to make sure traffic is whitelisted. For this reason, this option is typically coupled with the ZERO_COST download type.

DownloadOptions

The OTA downloadType. For CUSTOM type, a customDownloadUrl must also be provided.

JSON representation 
{
  "downloadType": enum (DownloadType),
  "customDownloadUrl": string,
  "currentDownloadUrl": string
}
Fields
downloadType

enum (DownloadType)

Download type to serve the OTA file through Google.
customDownloadUrl

string

Download URL to serve the OTA file through non-Google servers. Must be provided only with CUSTOM downloadType.
currentDownloadUrl

string

Output only. The current URL that devices use to download the package. This value will match customDownloadUrl when downloadType is CUSTOM. Note this is informational only and may change. It should not be stored or used off of the device.

DownloadType

The type of download for OTA packages.

Enums
DOWNLOAD_TYPE_UNSPECIFIED Not specified.
NORMAL Through Google servers.
ZERO_COST Through Google's specific VIP for zero-cost OTAs.
CUSTOM Through an external server. customDownloadUrl should be set along with this option.

Methods

list

 Lists packages of the config.