Products Use Cases Pricing Docs Support
Go to console
Overview Guides Reference Samples Libraries

REST Resource: testEnvironmentCatalog

Resource: TestEnvironmentCatalog

A description of a test environment.

JSON representation 
{

  // Union field environment_catalog can be only one of the following:
  "androidDeviceCatalog": {
    object(AndroidDeviceCatalog)
  },
  "iosDeviceCatalog": {
    object(IosDeviceCatalog)
  },
  "networkConfigurationCatalog": {
    object(NetworkConfigurationCatalog)
  },
  "softwareCatalog": {
    object(ProvidedSoftwareCatalog)
  }
  // End of list of possible types for union field environment_catalog.
}
Fields
Union field environment_catalog. Output only. environment_catalog can be only one of the following:
androidDeviceCatalog

object(AndroidDeviceCatalog)

Supported Android devices.

iosDeviceCatalog

object(IosDeviceCatalog)

Supported iOS devices.

networkConfigurationCatalog

object(NetworkConfigurationCatalog)

Supported network configurations.

softwareCatalog

object(ProvidedSoftwareCatalog)

The software test environment provided by TestExecutionService.

AndroidDeviceCatalog

The currently supported Android devices.

JSON representation 
{
  "models": [
    {
      object(AndroidModel)
    }
  ],
  "versions": [
    {
      object(AndroidVersion)
    }
  ],
  "runtimeConfiguration": {
    object(AndroidRuntimeConfiguration)
  }
}
Fields
models[]

object(AndroidModel)

The set of supported Android device models.

versions[]

object(AndroidVersion)

The set of supported Android OS versions.

runtimeConfiguration

object(AndroidRuntimeConfiguration)

The set of supported runtime configurations.

AndroidModel

A description of an Android device tests may be run on.

JSON representation 
{
  "id": string,
  "name": string,
  "manufacturer": string,
  "brand": string,
  "codename": string,
  "form": enum(DeviceForm),
  "formFactor": enum(DeviceFormFactor),
  "screenX": number,
  "screenY": number,
  "screenDensity": number,
  "lowFpsVideoRecording": boolean,
  "supportedVersionIds": [
    string
  ],
  "supportedAbis": [
    string
  ],
  "tags": [
    string
  ]
}
Fields
id

string

The unique opaque id for this model. Use this for invoking the TestExecutionService.

name

string

The human-readable marketing name for this device model. Examples: "Nexus 5", "Galaxy S5".

manufacturer

string

The manufacturer of this device.

brand

string

The company that this device is branded with. Example: "Google", "Samsung".

codename

string

The name of the industrial design. This corresponds to android.os.Build.DEVICE.

form

enum(DeviceForm)

Whether this device is virtual or physical.

formFactor

enum(DeviceFormFactor)

Whether this device is a phone, tablet, wearable, etc.

screenX

number

Screen size in the horizontal (X) dimension measured in pixels.

screenY

number

Screen size in the vertical (Y) dimension measured in pixels.

screenDensity

number

Screen density in DPI. This corresponds to ro.sf.lcd_density

lowFpsVideoRecording

boolean

True if and only if tests with this model are recorded by stitching together screenshots. See use_low_spec_video_recording in device config.

supportedVersionIds[]

string

The set of Android versions this device supports.

supportedAbis[]

string

The list of supported ABIs for this device. This corresponds to either android.os.Build.SUPPORTED_ABIS (for API level 21 and above) or android.os.Build.CPU_ABI/CPU_ABI2. The most preferred ABI is the first element in the list.

Elements are optionally prefixed by "version_id:" (where version_id is the id of an AndroidVersion), denoting an ABI that is supported only on a particular version.
tags[]

string

Tags for this dimension. Examples: "default", "preview", "deprecated".

DeviceForm

Whether the device is physical or virtual.

Enums
DEVICE_FORM_UNSPECIFIED Do not use. For proto versioning only.
VIRTUAL A software stack that simulates the device.
PHYSICAL Actual hardware.

DeviceFormFactor

Enums
DEVICE_FORM_FACTOR_UNSPECIFIED Do not use. For proto versioning only.
PHONE This device has the shape of a phone.
TABLET This device has the shape of a tablet.
WEARABLE This device has the shape of a watch or other wearable.

AndroidVersion

A version of the Android OS.

JSON representation 
{
  "id": string,
  "versionString": string,
  "apiLevel": number,
  "codeName": string,
  "releaseDate": {
    object(Date)
  },
  "distribution": {
    object(Distribution)
  },
  "tags": [
    string
  ]
}
Fields
id

string

An opaque id for this Android version. Use this id to invoke the TestExecutionService.

versionString

string

A string representing this version of the Android OS. Examples: "4.3", "4.4".

apiLevel

number

The API level for this Android version. Examples: 18, 19.

codeName

string

The code name for this Android version. Examples: "JellyBean", "KitKat".

releaseDate

object(Date)

The date this Android version became available in the market.

distribution

object(Distribution)

Market share for this version.

tags[]

string

Tags for this dimension. Examples: "default", "preview", "deprecated".

Date

Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent:

  • A full date, with non-zero year, month and day values
  • A month and day value, with a zero year, e.g. an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, e.g. a credit card expiration date

Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

JSON representation 
{
  "year": number,
  "month": number,
  "day": number
}
Fields
year

number

Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

month

number

Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

day

number

Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

Distribution

Data about the relative number of devices running a given configuration of the Android platform.

JSON representation 
{
  "measurementTime": string,
  "marketShare": number
}
Fields
measurementTime

string (Timestamp format)

Output only. The time this distribution was measured.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
marketShare

number

Output only. The estimated fraction (0-1) of the total market with this configuration.

AndroidRuntimeConfiguration

Android configuration that can be selected at the time a test is run.

JSON representation 
{
  "locales": [
    {
      object(Locale)
    }
  ],
  "orientations": [
    {
      object(Orientation)
    }
  ]
}
Fields
locales[]

object(Locale)

The set of available locales.

orientations[]

object(Orientation)

The set of available orientations.

Locale

A location/region designation for language.

JSON representation 
{
  "id": string,
  "name": string,
  "region": string,
  "tags": [
    string
  ]
}
Fields
id

string

The id for this locale. Example: "en_US".

name

string

A human-friendly name for this language/locale. Example: "English".

region

string

A human-friendly string representing the region for this locale. Example: "United States". Not present for every locale.

tags[]

string

Tags for this dimension. Example: "default".

Orientation

Screen orientation of the device.

JSON representation 
{
  "id": string,
  "name": string,
  "tags": [
    string
  ]
}
Fields
id

string

The id for this orientation. Example: "portrait".

name

string

A human-friendly name for this orientation. Example: "portrait".

tags[]

string

Tags for this dimension. Example: "default".

IosDeviceCatalog

The currently supported iOS devices.

JSON representation 
{
  "models": [
    {
      object(IosModel)
    }
  ],
  "versions": [
    {
      object(IosVersion)
    }
  ],
  "xcodeVersions": [
    {
      object(XcodeVersion)
    }
  ],
  "runtimeConfiguration": {
    object(IosRuntimeConfiguration)
  }
}
Fields
models[]

object(IosModel)

The set of supported iOS device models.

versions[]

object(IosVersion)

The set of supported iOS software versions.

xcodeVersions[]

object(XcodeVersion)

The set of supported Xcode versions.

runtimeConfiguration

object(IosRuntimeConfiguration)

The set of supported runtime configurations.

IosModel

A description of an iOS device tests may be run on.

JSON representation 
{
  "id": string,
  "name": string,
  "supportedVersionIds": [
    string
  ],
  "tags": [
    string
  ],
  "deviceCapabilities": [
    string
  ],
  "formFactor": enum(DeviceFormFactor)
}
Fields
id

string

The unique opaque id for this model. Use this for invoking the TestExecutionService.

name

string

The human-readable name for this device model. Examples: "iPhone 4s", "iPad Mini 2".

supportedVersionIds[]

string

The set of iOS major software versions this device supports.

tags[]

string

Tags for this dimension. Examples: "default", "preview", "deprecated".

deviceCapabilities[]

string

Device capabilities. Copied from https://developer.apple.com/library/archive/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/DeviceCompatibilityMatrix/DeviceCompatibilityMatrix.html

formFactor

enum(DeviceFormFactor)

Whether this device is a phone, tablet, wearable, etc.

IosVersion

An iOS version.

JSON representation 
{
  "id": string,
  "majorVersion": number,
  "minorVersion": number,
  "tags": [
    string
  ],
  "supportedXcodeVersionIds": [
    string
  ]
}
Fields
id

string

An opaque id for this iOS version. Use this id to invoke the TestExecutionService.

majorVersion

number

An integer representing the major iOS version. Examples: "8", "9".

minorVersion

number

An integer representing the minor iOS version. Examples: "1", "2".

tags[]

string

Tags for this dimension. Examples: "default", "preview", "deprecated".

supportedXcodeVersionIds[]

string

The available Xcode versions for this version.

XcodeVersion

An Xcode version that an iOS version is compatible with.

JSON representation 
{
  "version": string,
  "tags": [
    string
  ]
}