REST Resource: deployments.configs.packages
Stay organized with collections
Save and categorize content based on your preferences.
Resource: PackageConfig
| 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 |
|
|
Lists packages of the config. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003ePackageConfig defines the configuration for an OTA update package, including the package name, download options, and zero-cost APN capability.\u003c/p\u003e\n"],["\u003cp\u003eDownloadOptions specify how the OTA package should be downloaded, offering choices like Google servers, zero-cost downloads, or custom URLs.\u003c/p\u003e\n"],["\u003cp\u003eDownloadType further categorizes the download method, with options such as normal downloads, zero-cost downloads through Google's VIP, or downloads from a custom server.\u003c/p\u003e\n"],["\u003cp\u003eYou can use the \u003ccode\u003elist\u003c/code\u003e method to retrieve a list of packages associated with a specific configuration.\u003c/p\u003e\n"]]],["The core content defines `PackageConfig`, outlining package details with a JSON representation. Key fields include `packageName`, `downloadOptions`, and `zeroCostApnCapability`. `DownloadOptions` specifies the `downloadType` (enum with values: `NORMAL`, `ZERO_COST`, `CUSTOM`) and URLs (`customDownloadUrl`, `currentDownloadUrl`). `DownloadType` determines how packages are downloaded (e.g., through Google, zero-cost VIP, or external servers). Methods include listing packages via the `list` method.\n"],null,["# REST Resource: deployments.configs.packages\n\n- [Resource: PackageConfig](#PackageConfig)\n - [JSON representation](#PackageConfig.SCHEMA_REPRESENTATION)\n - [DownloadOptions](#PackageConfig.DownloadOptions)\n - [JSON representation](#PackageConfig.DownloadOptions.SCHEMA_REPRESENTATION)\n - [DownloadType](#PackageConfig.DownloadType)\n- [Methods](#METHODS_SUMMARY)\n\nResource: PackageConfig\n-----------------------\n\nA package config.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"packageName\": string, \"downloadOptions\": { object (/android/over-the-air/reference/rest/v1/deployments.configs.packages#PackageConfig.DownloadOptions) }, \"zeroCostApnCapability\": string } ``` |\n\n| Fields ||\n|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `packageName` | `string` The name of the package. |\n| `downloadOptions` | `object (`[DownloadOptions](/android/over-the-air/reference/rest/v1/deployments.configs.packages#PackageConfig.DownloadOptions)`)` Download options for package. |\n| `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. |\n\n### DownloadOptions\n\nThe OTA `downloadType`. For `CUSTOM` type, a `customDownloadUrl` must also be provided.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"downloadType\": enum (/android/over-the-air/reference/rest/v1/deployments.configs.packages#PackageConfig.DownloadType), \"customDownloadUrl\": string, \"currentDownloadUrl\": string } ``` |\n\n| Fields ||\n|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `downloadType` | `enum (`[DownloadType](/android/over-the-air/reference/rest/v1/deployments.configs.packages#PackageConfig.DownloadType)`)` Download type to serve the OTA file through Google. |\n| `customDownloadUrl` | `string` Download URL to serve the OTA file through non-Google servers. Must be provided only with `CUSTOM` downloadType. |\n| `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. |\n\n### DownloadType\n\nThe type of download for OTA packages.\n\n| Enums ||\n|-----------------------------|---------------------------------------------------------------------------------------|\n| `DOWNLOAD_TYPE_UNSPECIFIED` | Not specified. |\n| `NORMAL` | Through Google servers. |\n| `ZERO_COST` | Through Google's specific VIP for zero-cost OTAs. |\n| `CUSTOM` | Through an external server. `customDownloadUrl` should be set along with this option. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------|-------------------------------|\n| ### [list](/android/over-the-air/reference/rest/v1/deployments.configs.packages/list) | Lists packages of the config. |"]]