REST Resource: playAutoInstalls

Resource: PlayAutoInstall

A PlayAutoInstall contains configuration and information generated by server, for example, the play auto install id and application information. Next ID: 13

JSON representation
{
  "name": string,
  "id": string,
  "config": {
    object (PlayAutoInstallConfig)
  },
  "applications": [
    {
      object (Application)
    }
  ],
  "published": boolean,
  "packageName": string,
  "clientId": {
    string: string,
    ...
  },
  "carrierConfig": string,
  "apns": string,
  "atvTurnkeyConfig": {
    object (AtvTurnkeyConfig)
  },
  "rros": [
    {
      object (RRO)
    }
  ],
  "connectivityConfig": {
    object (CellularConnectivityConfig)
  }
}
Fields
name

string

Resource name of Play Auto Install. This field is assigned by server.

id

string

Unique id of each play auto install, for example. 83CF797E. This field is returned by server.

config

object (PlayAutoInstallConfig)

Configuration for this play auto install. This filed must be filled out by client in playAutoInstalls.create request.

applications[]

object (Application)

The list of packages to be preinstalled on matching devices. This filed is returned by server.

published

boolean

True if this configuration is currently published. This field is assigned by server.

packageName

string

The package name found in the uploaded apk. This field is for display purposes only and not needed for create or update requests.

clientId

map (key: string, value: string)

Configured K/V client IDs

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

carrierConfig
(deprecated)

string

The raw carrierconfig.xml - deprecated, use connectivityConfig

apns
(deprecated)

string

The raw apns.xml - deprecated, use connectivityConfig

atvTurnkeyConfig

object (AtvTurnkeyConfig)

ATV Turnkey config properties

rros[]

object (RRO)

The list of RRO apks

connectivityConfig

object (CellularConnectivityConfig)

Connectivity configs

PlayAutoInstallConfig

Key information represents play auto install configuration. Next ID: 20

JSON representation
{
  "name": string,
  "productId": string,
  "buildFingerprint": string,
  "countryCode": [
    string
  ],
  "carrierId": [
    string
  ],
  "enabled": boolean,
  "evaluationOrder": number,
  "roOemKey1": string,
  "hardwareId": [
    string
  ],
  "zeroRatingEnabled": boolean,
  "deviceIdType": string,
  "hardwareIdsFileBlobRef": string,
  "hardwareIdsFileHash": string,
  "uploadedHardwareIdsFileName": string,
  "uploadedAtvCustomizationFileName": string,
  "atvCustomizationFileBlobRef": string,
  "roOemKey2": string,
  "imeiRanges": [
    {
      object (ImeiRange)
    }
  ],
  "orderOfEvaluation": number
}
Fields
name

string

The name for this configuration.

productId

string

The related product id.

buildFingerprint

string

A build fingerprint, or build fingerprint prefix. e.g. google/shamu/shamu:5.1.1/LMY48X/2289732:user/release-keys or google/shamu/shamu.

countryCode[]

string

The list of countries where this play auto install should be enforced

carrierId[]

string (int64 format)

The list of carrier ids where this play auto install is enforced.

enabled

boolean

Optional. If this play auto install should be enforced.

evaluationOrder
(deprecated)

number

Optional. The order in which this configuration is evaluated at runtime.

roOemKey1

string

Optional. The value of ro.oem.key1 (an RO build property) that a device should contain in order to match this configuration.

hardwareId[]

string

Optional. A list of device hardware ids for which this play auto install rule is enforced.

zeroRatingEnabled

boolean

Optional. If this configuration should enforce zero rating.

deviceIdType

string

Optional. Type of device ID used for targeting configurations, either IMEI or Serial Number. All of the target hardware IDs will be parsed into the device ID type specified by this field. Therefore, the hardware IDs field should be populated with the device ID of the type specified by this field. Use "imei" to specify IMEI number or "serial" to specify device IDs are valid serial numbers. Defaults to serial if unspecified.

hardwareIdsFileBlobRef

string

Optional. Represents a reference to the hardware Ids file data.

hardwareIdsFileHash

string

Optional. The base64-encoded sha1 has of hardware ids file. Use to check for duplicate file uploads

uploadedHardwareIdsFileName

string

Optional. The file name of the uploaded hardware IDs file.

uploadedAtvCustomizationFileName

string

Optional. The file name of the uploaded atv customization file.

atvCustomizationFileBlobRef

string

Optional. Represents a reference to the atv customization file data.

roOemKey2

string

Optional. The value of ro.oem.key2 (an RO build property) that a device should contain in order to match this configuration.

imeiRanges[]

object (ImeiRange)

Optional. A list of IMEI ranges that specifies the set of targeted devices for this configuration.

orderOfEvaluation

number

Optional. The order in which this configuration is evaluated at runtime.

ImeiRange

LINT.IfChange(imei_range)

JSON representation
{
  "start": string,
  "end": string
}
Fields
start

string

end

string

Application

An Android application.

JSON representation
{
  "packageName": string,
  "requiredPreload": boolean,
  "installByDefault": boolean,
  "groupId": string,
  "installBeforeSetupComplete": boolean,
  "imageUrl": string,
  "utmCampaign": string
}
Fields
packageName

string

The full package name of the apk.

requiredPreload

boolean

If not provided or false, this package is optional (user choice). Otherwise it is required (always / immediately installed.)

installByDefault

boolean

If not provided or true, the initial state should be “do install”. If false, the initial state should be “do not install”.

groupId

string (int64 format)

If not provided, this package will be presented at the “top level”. If provided, this package should be displayed within the indicated group.

installBeforeSetupComplete

boolean

If true, the package must be installed before setup wizard is completed.

imageUrl

string

Document.image (HIRES_PREVIEW image type) from App documents. See google3/wireless/android/finsky/proto/document.proto and google3/wireless/android/vending/common/protos/android_app.proto

utmCampaign

string

The UTM (Urchin Tracking Module) campaign associated with this preload.

AtvTurnkeyConfig

Contains dynamically defined configuration for Android TV Turnkey devices

JSON representation
{
  "tvAppPackageName": string,
  "tvAppSignature": string,
  "nrdpModelgroup": string,
  "nrdpTokenhandlerPackagename": string,
  "nrdpTokenhandlerSignature": string,
  "tvOperator": string
}
Fields
tvAppPackageName

string

Name of the package name that will be used as operator TV app

tvAppSignature

string

Signature of the app that will be used as operator TV app

nrdpModelgroup

string

Dynamically set modelgroup value for metrics.

nrdpTokenhandlerPackagename

string

Name of the package that will handle token exchange process on device.

nrdpTokenhandlerSignature

string

Signature of the app that will handle token exchange process on device.

tvOperator

string

Operator identifier for internal and tracking purposes.

RRO

A runtime resource overlay Next ID: 9

JSON representation
{
  "rroType": enum (RROType),
  "packageName": string,
  "versionCode": string,
  "rroApkBlobRef": string,
  "rroMetadata": {
    object (Application)
  },
  "zeroRatingEnabled": boolean,
  "rroApkRef": string,
  "rroId": string
}
Fields
rroType

enum (RROType)

Required. Type of the RRO.

packageName

string

Required. The package name found in the uploaded apk.

versionCode

string

Required. The version code found in the uploaded apk.

rroApkBlobRef
(deprecated)

string

Required. The base 64 encoded blobstore ref for the uploaded RRO apk.

rroMetadata

object (Application)

The RRO package to be preinstalled on matching devices.

zeroRatingEnabled

boolean

If enabled, RRO here qualify for zero-rating transfers.

rroApkRef

string

An uniqe id that references an already uploaded APK. The rroApkRef is returned by server by calling playAutoInstalls.startUploadApk.

rroId

string

Unique id of each rro, for example. 83CF797E. This field is returned by server.

RROType

Type of above-the-line RRO components LINT.IfChange

Enums
UNSPECIFIED RRO type is unspecified. This should never happen.
RINGTONE Ringtone
WALLPAPER Wallpaper
START_ANIMATION Start Animation
SHUTDOWN_ANIMATION Shutdown Animation
NOTIFICATION Notification
ALARM Alarm
OTHER Other

CellularConnectivityConfig

Connectivity configuration files

JSON representation
{
  "carrierconfigXml": string,
  "apnsXml": string,
  "version": string,
  "tier1Carriers": string,
  "carrierList": string,
  "carrierSettings": [
    string
  ],
  "othersCarrierSettings": string
}
Fields
carrierconfigXml

string

The content of carrierconfig.xml file.

apnsXml

string

The content of apns.xml file.

version

string (int64 format)

The version number for converted pb files. If unspecified, one will be auto generated based on timestamp.

tier1Carriers

string (bytes format)

The definition of tier-1 carriers, in binary proto message CarrierList.

A base64-encoded string.

carrierList

string (bytes format)

The updated carrier list (of all carriers), in binary proto message CarrierList.

A base64-encoded string.

carrierSettings[]

string (bytes format)

The updated carrier settings for individual tier-1 carriers, in binary proto message CarrierSettings.

A base64-encoded string.

othersCarrierSettings

string (bytes format)

The updated carrier settings for carriers other than tier-1, in binary proto message MultiCarrierSettings.

A base64-encoded string.

Methods

create

Creates a new play auto install.

delete

Deletes a play auto install.

downloadApk

Downloads an Apk for a given play auto install ID.

downloadAtvCustomizationFile

Downloads the customization file for a given play auto install ID.

downloadHardwareIdsFile

Downloads the hardwareIds file for a given play auto install ID.

get

Gets an existing play auto install.

list

Lists play auto installs for a product.

publish

Pushes a play auto install to play store.

startAtvUploadCustomizationFile

Creates an upload session to start uploading a customization file.

startUploadApk

Creates an upload session to start uploading apk data.

startUploadHardwareIdsFile

Creates an upload session to start uploading hardwareIds file.

update

Updates a play auto install.