{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
},
"basePath": "",
"baseUrl": "https://testing.googleapis.com/",
"batchPath": "batch",
"description": "Allows developers to run automated tests for their mobile applications on Google infrastructure.",
"discoveryVersion": "v1",
"documentationLink": "https://firebase.google.com/docs/test-lab/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "testing:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://testing.mtls.googleapis.com/",
"name": "testing",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"applicationDetailService": {
"methods": {
"getApkDetails": {
"description": "Gets the details of an Android application APK.",
"flatPath": "v1/applicationDetailService/getApkDetails",
"httpMethod": "POST",
"id": "testing.applicationDetailService.getApkDetails",
"parameterOrder": [],
"parameters": {
"bundleLocation.gcsPath": {
"description": "A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding)",
"location": "query",
"type": "string"
}
},
"path": "v1/applicationDetailService/getApkDetails",
"request": {
"$ref": "FileReference"
},
"response": {
"$ref": "GetApkDetailsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"projects": {
"resources": {
"deviceSessions": {
"methods": {
"cancel": {
"description": "POST /v1/projects/{project_id}/deviceSessions/{device_session_id}:cancel Changes the DeviceSession to state FINISHED and terminates all connections. Canceled sessions are not deleted and can be retrieved or listed by the user until they expire based on the 28 day deletion policy.",
"flatPath": "v1/projects/{projectsId}/deviceSessions/{deviceSessionsId}:cancel",
"httpMethod": "POST",
"id": "testing.projects.deviceSessions.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the DeviceSession, e.g. \"projects/{project_id}/deviceSessions/{session_id}\"",
"location": "path",
"pattern": "^projects/[^/]+/deviceSessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "CancelDeviceSessionRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "POST /v1/projects/{project_id}/deviceSessions",
"flatPath": "v1/projects/{projectsId}/deviceSessions",
"httpMethod": "POST",
"id": "testing.projects.deviceSessions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The Compute Engine project under which this device will be allocated. \"projects/{project_id}\"",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/deviceSessions",
"request": {
"$ref": "DeviceSession"
},
"response": {
"$ref": "DeviceSession"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "GET /v1/projects/{project_id}/deviceSessions/{device_session_id} Return a DeviceSession, which documents the allocation status and whether the device is allocated. Clients making requests from this API must poll GetDeviceSession.",
"flatPath": "v1/projects/{projectsId}/deviceSessions/{deviceSessionsId}",
"httpMethod": "GET",
"id": "testing.projects.deviceSessions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the DeviceSession, e.g. \"projects/{project_id}/deviceSessions/{session_id}\"",
"location": "path",
"pattern": "^projects/[^/]+/deviceSessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "DeviceSession"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "GET /v1/projects/{project_id}/deviceSessions Lists device Sessions owned by the project user.",
"flatPath": "v1/projects/{projectsId}/deviceSessions",
"httpMethod": "GET",
"id": "testing.projects.deviceSessions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. If specified, responses will be filtered by the given filter. Allowed fields are: session_state.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of DeviceSessions to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A continuation token for paging.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the parent to request, e.g. \"projects/{project_id}\"",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/deviceSessions",
"response": {
"$ref": "ListDeviceSessionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "PATCH /v1/projects/{projectId}/deviceSessions/deviceSessionId}:updateDeviceSession Updates the current device session to the fields described by the update_mask.",
"flatPath": "v1/projects/{projectsId}/deviceSessions/{deviceSessionsId}",
"httpMethod": "PATCH",
"id": "testing.projects.deviceSessions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Optional. Name of the DeviceSession, e.g. \"projects/{project_id}/deviceSessions/{session_id}\"",
"location": "path",
"pattern": "^projects/[^/]+/deviceSessions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The list of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "DeviceSession"
},
"response": {
"$ref": "DeviceSession"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"testMatrices": {
"methods": {
"cancel": {
"description": "Cancels unfinished test executions in a test matrix. This call returns immediately and cancellation proceeds asynchronously. If the matrix is already final, this operation will have no effect. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist",
"flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel",
"httpMethod": "POST",
"id": "testing.projects.testMatrices.cancel",
"parameterOrder": [
"projectId",
"testMatrixId"
],
"parameters": {
"projectId": {
"description": "Cloud project that owns the test.",
"location": "path",
"required": true,
"type": "string"
},
"testMatrixId": {
"description": "Test matrix that will be canceled.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel",
"response": {
"$ref": "CancelTestMatrixResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates and runs a matrix of tests according to the given specifications. Unsupported environments will be returned in the state UNSUPPORTED. A test matrix is limited to use at most 2000 devices in parallel. The returned matrix will not yet contain the executions that will be created for this matrix. Execution creation happens later on and will require a call to GetTestMatrix. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed or if the matrix tries to use too many simultaneous devices.",
"flatPath": "v1/projects/{projectId}/testMatrices",
"httpMethod": "POST",
"id": "testing.projects.testMatrices.create",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "The GCE project under which this job will run.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "A string id used to detect duplicated requests. Ids are automatically scoped to a project, so users should ensure the ID is unique per-project. A UUID is recommended. Optional, but strongly recommended.",
"location": "query",
"type": "string"
}
},
"path": "v1/projects/{projectId}/testMatrices",
"request": {
"$ref": "TestMatrix"
},
"response": {
"$ref": "TestMatrix"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Checks the status of a test matrix and the executions once they are created. The test matrix will contain the list of test executions to run if and only if the resultStorage.toolResultsExecution fields have been populated. Note: Flaky test executions may be added to the matrix at a later stage. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist",
"flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}",
"httpMethod": "GET",
"id": "testing.projects.testMatrices.get",
"parameterOrder": [
"projectId",
"testMatrixId"
],
"parameters": {
"projectId": {
"description": "Cloud project that owns the test matrix.",
"location": "path",
"required": true,
"type": "string"
},
"testMatrixId": {
"description": "Unique test matrix id which was assigned by the service.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/testMatrices/{testMatrixId}",
"response": {
"$ref": "TestMatrix"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
}
}
},
"testEnvironmentCatalog": {
"methods": {
"get": {
"description": "Gets the catalog of supported test environments. May return any of the following canonical error codes: - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the environment type does not exist - INTERNAL - if an internal error occurred",
"flatPath": "v1/testEnvironmentCatalog/{environmentType}",
"httpMethod": "GET",
"id": "testing.testEnvironmentCatalog.get",
"parameterOrder": [
"environmentType"
],
"parameters": {
"environmentType": {
"description": "Required. The type of environment that should be listed.",
"enum": [
"ENVIRONMENT_TYPE_UNSPECIFIED",
"ANDROID",
"IOS",
"NETWORK_CONFIGURATION",
"PROVIDED_SOFTWARE",
"DEVICE_IP_BLOCKS"
],
"enumDescriptions": [
"Do not use. For proto versioning only.",
"A device running a version of the Android OS.",
"A device running a version of iOS.",
"A network configuration to use when running a test.",
"The software environment provided by TestExecutionService.",
"The IP blocks used by devices in the test environment."
],
"location": "path",
"required": true,
"type": "string"
},
"includeViewableModels": {
"description": "Optional. Whether to include viewable only models in the response. This is only applicable for Android models.",
"location": "query",
"type": "boolean"
},
"projectId": {
"description": "For authorization, the cloud project requesting the TestEnvironmentCatalog.",
"location": "query",
"type": "string"
}
},
"path": "v1/testEnvironmentCatalog/{environmentType}",
"response": {
"$ref": "TestEnvironmentCatalog"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
}
},
"revision": "20251111",
"rootUrl": "https://testing.googleapis.com/",
"schemas": {
"Account": {
"description": "Identifies an account and how to log into it.",
"id": "Account",
"properties": {
"googleAuto": {
"$ref": "GoogleAuto",
"description": "An automatic google login account."
}
},
"type": "object"
},
"AndroidDevice": {
"description": "A single Android device.",
"id": "AndroidDevice",
"properties": {
"androidModelId": {
"description": "Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.",
"type": "string"
},
"androidVersionId": {
"description": "Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.",
"type": "string"
},
"locale": {
"description": "Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.",
"type": "string"
},
"orientation": {
"description": "Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.",
"type": "string"
}
},
"type": "object"
},
"AndroidDeviceCatalog": {
"description": "The currently supported Android devices.",
"id": "AndroidDeviceCatalog",
"properties": {
"models": {
"description": "The set of supported Android device models.",
"items": {
"$ref": "AndroidModel"
},
"type": "array"
},
"runtimeConfiguration": {
"$ref": "AndroidRuntimeConfiguration",
"description": "The set of supported runtime configurations."
},
"versions": {
"description": "The set of supported Android OS versions.",
"items": {
"$ref": "AndroidVersion"
},
"type": "array"
}
},
"type": "object"
},
"AndroidDeviceList": {
"description": "A list of Android device configurations in which the test is to be executed.",
"id": "AndroidDeviceList",
"properties": {
"androidDevices": {
"description": "Required. A list of Android devices.",
"items": {
"$ref": "AndroidDevice"
},
"type": "array"
}
},
"type": "object"
},
"AndroidInstrumentationTest": {
"description": "A test of an Android application that can control an Android component independently of its normal lifecycle. Android instrumentation tests run an application APK and test APK inside the same process on a virtual or physical AndroidDevice. They also specify a test runner class, such as com.google.GoogleTestRunner, which can vary on the specific instrumentation framework chosen. See for more information on types of Android tests.",
"id": "AndroidInstrumentationTest",
"properties": {
"appApk": {
"$ref": "FileReference",
"description": "The APK for the application under test."
},
"appBundle": {
"$ref": "AppBundle",
"description": "A multi-apk app bundle for the application under test."
},
"appPackageId": {
"description": "The java package for the application under test. The default value is determined by examining the application's manifest.",
"type": "string"
},
"orchestratorOption": {
"description": "The option of whether running each test within its own invocation of instrumentation with Android Test Orchestrator or not. ** Orchestrator is only compatible with AndroidJUnitRunner version 1.1 or higher! ** Orchestrator offers the following benefits: - No shared state - Crashes are isolated - Logs are scoped per test See for more information about Android Test Orchestrator. If not set, the test will be run without the orchestrator.",
"enum": [
"ORCHESTRATOR_OPTION_UNSPECIFIED",
"USE_ORCHESTRATOR",
"DO_NOT_USE_ORCHESTRATOR"
],
"enumDescriptions": [
"Default value: the server will choose the mode. Currently implies that the test will run without the orchestrator. In the future, all instrumentation tests will be run with the orchestrator. Using the orchestrator is highly encouraged because of all the benefits it offers.",
"Run test using orchestrator. ** Only compatible with AndroidJUnitRunner version 1.1 or higher! ** Recommended.",
"Run test without using orchestrator."
],
"type": "string"
},
"shardingOption": {
"$ref": "ShardingOption",
"description": "The option to run tests in multiple shards in parallel."
},
"testApk": {
"$ref": "FileReference",
"description": "Required. The APK containing the test code to be executed."
},
"testPackageId": {
"description": "The java package for the test to be executed. The default value is determined by examining the application's manifest.",
"type": "string"
},
"testRunnerClass": {
"description": "The InstrumentationTestRunner class. The default value is determined by examining the application's manifest.",
"type": "string"
},
"testTargets": {
"description": "Each target must be fully qualified with the package name or class name, in one of these formats: - \"package package_name\" - \"class package_name.class_name\" - \"class package_name.class_name#method_name\" If empty, all targets in the module will be run.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AndroidMatrix": {
"description": "A set of Android device configuration permutations is defined by the the cross-product of the given axes. Internally, the given AndroidMatrix will be expanded into a set of AndroidDevices. Only supported permutations will be instantiated. Invalid permutations (e.g., incompatible models/versions) are ignored.",
"id": "AndroidMatrix",
"properties": {
"androidModelIds": {
"description": "Required. The ids of the set of Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.",
"items": {
"type": "string"
},
"type": "array"
},
"androidVersionIds": {
"description": "Required. The ids of the set of Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.",
"items": {
"type": "string"
},
"type": "array"
},
"locales": {
"description": "Required. The set of locales the test device will enable for testing. Use the TestEnvironmentDiscoveryService to get supported options.",
"items": {
"type": "string"
},
"type": "array"
},
"orientations": {
"description": "Required. The set of orientations to test with. Use the TestEnvironmentDiscoveryService to get supported options.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AndroidModel": {
"description": "A description of an Android device tests may be run on.",
"id": "AndroidModel",
"properties": {
"accessDeniedReasons": {
"description": "Reasons for access denial. This model is accessible if this list is empty, otherwise the model is viewable only.",
"items": {
"enum": [
"ACCESS_DENIED_REASON_UNSPECIFIED",
"EULA_NOT_ACCEPTED"
],
"enumDescriptions": [
"Do not use. For proto versioning only.",
"The model is for viewing purposes only. Access and utilization require acceptance of an End User License Agreement (EULA)."
],
"type": "string"
},
"type": "array"
},
"brand": {
"description": "The company that this device is branded with. Example: \"Google\", \"Samsung\".",
"type": "string"
},
"codename": {
"description": "The name of the industrial design. This corresponds to android.os.Build.DEVICE.",
"type": "string"
},
"form": {
"description": "Whether this device is virtual or physical.",
"enum": [
"DEVICE_FORM_UNSPECIFIED",
"VIRTUAL",
"PHYSICAL",
"EMULATOR"
],
"enumDescriptions": [
"Do not use. For proto versioning only.",
"Android virtual device using Compute Engine native virtualization. Firebase Test Lab only.",
"Actual hardware.",
"Android virtual device using emulator in nested virtualization. Equivalent to Android Studio."
],
"type": "string"
},
"formFactor": {
"description": "Whether this device is a phone, tablet, wearable, etc.",
"enum": [
"DEVICE_FORM_FACTOR_UNSPECIFIED",
"PHONE",
"TABLET",
"WEARABLE",
"TV",
"AUTOMOTIVE",
"DESKTOP",
"XR"
],
"enumDescriptions": [
"Do not use. For proto versioning only.",
"This device has the shape of a phone.",
"This device has the shape of a tablet.",
"This device has the shape of a watch or other wearable.",
"This device has a television form factor.",
"This device has an automotive form factor.",
"This device has a desktop form factor.",
"This device has an Extended Reality form factor."
],
"type": "string"
},
"id": {
"description": "The unique opaque id for this model. Use this for invoking the TestExecutionService.",
"type": "string"
},
"labInfo": {
"$ref": "LabInfo",
"description": "Output only. Lab info of this device.",
"readOnly": true
},
"lowFpsVideoRecording": {
"description": "True if and only if tests with this model are recorded by stitching together screenshots. See use_low_spec_video_recording in device config.",
"type": "boolean"
},
"manufacturer": {
"description": "The manufacturer of this device.",
"type": "string"
},
"name": {
"description": "The human-readable marketing name for this device model. Examples: \"Nexus 5\", \"Galaxy S5\".",
"type": "string"
},
"perVersionInfo": {
"description": "Version-specific information of an Android model.",
"items": {
"$ref": "PerAndroidVersionInfo"
},
"type": "array"
},
"screenDensity": {
"description": "Screen density in DPI. This corresponds to ro.sf.lcd_density",
"format": "int32",
"type": "integer"
},
"screenX": {
"description": "Screen size in the horizontal (X) dimension measured in pixels.",
"format": "int32",
"type": "integer"
},
"screenY": {
"description": "Screen size in the vertical (Y) dimension measured in pixels.",
"format": "int32",
"type": "integer"
},
"supportedAbis": {
"description": "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.",
"items": {
"type": "string"
},
"type": "array"
},
"supportedVersionIds": {
"description": "The set of Android versions this device supports.",
"items": {
"type": "string"
},
"type": "array"
},
"tags": {
"description": "Tags for this dimension. Examples: \"default\", \"preview\", \"deprecated\".",
"items": {
"type": "string"
},
"type": "array"
},
"thumbnailUrl": {
"description": "URL of a thumbnail image (photo) of the device.",
"type": "string"
}
},
"type": "object"
},
"AndroidRoboTest": {
"description": "A test of an android application that explores the application on a virtual or physical Android Device, finding culprits and crashes as it goes.",
"id": "AndroidRoboTest",
"properties": {
"appApk": {
"$ref": "FileReference",
"description": "The APK for the application under test."
},
"appBundle": {
"$ref": "AppBundle",
"description": "A multi-apk app bundle for the application under test."
},
"appInitialActivity": {
"description": "The initial activity that should be used to start the app.",
"type": "string"
},
"appPackageId": {
"description": "The java package for the application under test. The default value is determined by examining the application's manifest.",
"type": "string"
},
"maxDepth": {
"deprecated": true,
"description": "The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50.",
"format": "int32",
"type": "integer"
},
"maxSteps": {
"deprecated": true,
"description": "The max number of steps Robo can execute. Default is no limit.",
"format": "int32",
"type": "integer"
},
"roboDirectives": {
"description": "A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided.",
"items": {
"$ref": "RoboDirective"
},
"type": "array"
},
"roboMode": {
"description": "The mode in which Robo should run. Most clients should allow the server to populate this field automatically.",
"enum": [
"ROBO_MODE_UNSPECIFIED",
"ROBO_VERSION_1",
"ROBO_VERSION_2"
],
"enumDeprecated": [
false,
false,
true
],
"enumDescriptions": [
"This means that the server should choose the mode. Recommended.",
"Runs Robo in UIAutomator-only mode without app resigning",
"Deprecated: Use ROBO_VERSION_1 instead for all use cases. Runs Robo in standard Espresso with UIAutomator fallback"
],
"type": "string"
},
"roboScript": {
"$ref": "FileReference",
"description": "A JSON file with a sequence of actions Robo should perform as a prologue for the crawl."
},
"startingIntents": {
"description": "The intents used to launch the app for the crawl. If none are provided, then the main launcher activity is launched. If some are provided, then only those provided are launched (the main launcher activity must be provided explicitly).",
"items": {
"$ref": "RoboStartingIntent"
},
"type": "array"
}
},
"type": "object"
},
"AndroidRuntimeConfiguration": {
"description": "Android configuration that can be selected at the time a test is run.",
"id": "AndroidRuntimeConfiguration",
"properties": {
"locales": {
"description": "The set of available locales.",
"items": {
"$ref": "Locale"
},
"type": "array"
},
"orientations": {
"description": "The set of available orientations.",
"items": {
"$ref": "Orientation"
},
"type": "array"
}
},
"type": "object"
},
"AndroidTestLoop": {
"description": "A test of an Android Application with a Test Loop. The intent \\ will be implicitly added, since Games is the only user of this api, for the time being.",
"id": "AndroidTestLoop",
"properties": {
"appApk": {
"$ref": "FileReference",
"description": "The APK for the application under test."
},
"appBundle": {
"$ref": "AppBundle",
"description": "A multi-apk app bundle for the application under test."
},
"appPackageId": {
"description": "The java package for the application under test. The default is determined by examining the application's manifest.",
"type": "string"
},
"scenarioLabels": {
"description": "The list of scenario labels that should be run during the test. The scenario labels should map to labels defined in the application's manifest. For example, player_experience and com.google.test.loops.player_experience add all of the loops labeled in the manifest with the com.google.test.loops.player_experience name to the execution. Scenarios can also be specified in the scenarios field.",
"items": {
"type": "string"
},
"type": "array"
},
"scenarios": {
"description": "The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
}
},
"type": "object"
},
"AndroidVersion": {
"description": "A version of the Android OS.",
"id": "AndroidVersion",
"properties": {
"apiLevel": {
"description": "The API level for this Android version. Examples: 18, 19.",
"format": "int32",
"type": "integer"
},
"codeName": {
"description": "The code name for this Android version. Examples: \"JellyBean\", \"KitKat\".",
"type": "string"
},
"distribution": {
"$ref": "Distribution",
"description": "Market share for this version."
},
"id": {
"description": "An opaque id for this Android version. Use this id to invoke the TestExecutionService.",
"type": "string"
},
"releaseDate": {
"$ref": "Date",
"description": "The date this Android version became available in the market."
},
"tags": {
"description": "Tags for this dimension. Examples: \"default\", \"preview\", \"deprecated\".",
"items": {
"type": "string"
},
"type": "array"
},
"versionString": {
"description": "A string representing this version of the Android OS. Examples: \"4.3\", \"4.4\".",
"type": "string"
}
},
"type": "object"
},
"Apk": {
"description": "An Android package file to install.",
"id": "Apk",
"properties": {
"location": {
"$ref": "FileReference",
"description": "The path to an APK to be installed on the device before the test begins."
},
"packageName": {
"description": "The java package for the APK to be installed. Value is determined by examining the application's manifest.",
"type": "string"
}
},
"type": "object"
},
"ApkDetail": {
"description": "Android application details based on application manifest and archive contents.",
"id": "ApkDetail",
"properties": {
"apkManifest": {
"$ref": "ApkManifest"
}
},
"type": "object"
},
"ApkManifest": {
"description": "An Android app manifest. See http://developer.android.com/guide/topics/manifest/manifest-intro.html",
"id": "ApkManifest",
"properties": {
"applicationLabel": {
"description": "User-readable name for the application.",
"type": "string"
},
"intentFilters": {
"items": {
"$ref": "IntentFilter"
},
"type": "array"
},
"maxSdkVersion": {
"description": "Maximum API level on which the application is designed to run.",
"format": "int32",
"type": "integer"
},
"metadata": {
"description": "Meta-data tags defined in the manifest.",
"items": {
"$ref": "Metadata"
},
"type": "array"
},
"minSdkVersion": {
"description": "Minimum API level required for the application to run.",
"format": "int32",
"type": "integer"
},
"packageName": {
"description": "Full Java-style package name for this application, e.g. \"com.example.foo\".",
"type": "string"
},
"services": {
"description": "Services contained in the tag.",
"items": {
"$ref": "Service"
},
"type": "array"
},
"targetSdkVersion": {
"description": "Specifies the API Level on which the application is designed to run.",
"format": "int32",
"type": "integer"
},
"usesFeature": {
"description": "Feature usage tags defined in the manifest.",
"items": {
"$ref": "UsesFeature"
},
"type": "array"
},
"usesPermission": {
"items": {
"type": "string"
},
"type": "array"
},
"usesPermissionTags": {
"description": "Permissions declared to be used by the application",
"items": {
"$ref": "UsesPermissionTag"
},
"type": "array"
},
"versionCode": {
"description": "Version number used internally by the app.",
"format": "int64",
"type": "string"
},
"versionName": {
"description": "Version number shown to users.",
"type": "string"
}
},
"type": "object"
},
"ApkSplits": {
"description": "A single dynamic feature apk.",
"id": "ApkSplits",
"properties": {
"bundleSplits": {
"description": "A list of .apk files generated by bundletool to install to the device under test as a single android app with adb install-multiple. If specified, requires one or more bundle_splits. The first split specified represents the base APK, while subsequent splits represent feature apks.",
"items": {
"$ref": "FileReference"
},
"type": "array"
}
},
"type": "object"
},
"AppBundle": {
"description": "An Android App Bundle file format, containing a BundleConfig.pb file, a base module directory, zero or more dynamic feature module directories. See https://developer.android.com/guide/app-bundle/build for guidance on building App Bundles.",
"id": "AppBundle",
"properties": {
"apks": {
"$ref": "ApkSplits",
"description": ".apk files generated by bundletool to install as a single android app."
},
"bundleLocation": {
"$ref": "FileReference",
"description": ".aab file representing the app bundle under test."
}
},
"type": "object"
},
"CancelDeviceSessionRequest": {
"description": "The request object for cancelling a Device Session.",
"id": "CancelDeviceSessionRequest",
"properties": {},
"type": "object"
},
"CancelTestMatrixResponse": {
"description": "Response containing the current state of the specified test matrix.",
"id": "CancelTestMatrixResponse",
"properties": {
"testState": {
"description": "The current rolled-up state of the test matrix. If this state is already final, then the cancelation request will have no effect.",
"enum": [
"TEST_STATE_UNSPECIFIED",
"VALIDATING",
"PENDING",
"RUNNING",
"FINISHED",
"ERROR",
"UNSUPPORTED_ENVIRONMENT",
"INCOMPATIBLE_ENVIRONMENT",
"INCOMPATIBLE_ARCHITECTURE",
"CANCELLED",
"INVALID"
],
"enumDescriptions": [
"Do not use. For proto versioning only.",
"The execution or matrix is being validated.",
"The execution or matrix is waiting for resources to become available.",
"The execution is currently being processed. Can only be set on an execution.",
"The execution or matrix has terminated normally. On a matrix this means that the matrix level processing completed normally, but individual executions may be in an ERROR state.",
"The execution or matrix has stopped because it encountered an infrastructure failure.",
"The execution was not run because it corresponds to a unsupported environment. Can only be set on an execution.",
"The execution was not run because the provided inputs are incompatible with the requested environment. Example: requested AndroidVersion is lower than APK's minSdkVersion Can only be set on an execution.",
"The execution was not run because the provided inputs are incompatible with the requested architecture. Example: requested device does not support running the native code in the supplied APK Can only be set on an execution.",
"The user cancelled the execution. Can only be set on an execution.",
"The execution or matrix was not run because the provided inputs are not valid. Examples: input file is not of the expected type, is malformed/corrupt, or was flagged as malware"
],
"type": "string"
}
},
"type": "object"
},
"ClientInfo": {
"description": "Information about the client which invoked the test.",
"id": "ClientInfo",
"properties": {
"clientInfoDetails": {
"description": "The list of detailed information about client.",
"items": {
"$ref": "ClientInfoDetail"
},
"type": "array"
},
"name": {
"description": "Required. Client name, such as gcloud.",
"type": "string"
}
},
"type": "object"
},
"ClientInfoDetail": {
"description": "Key-value pair of detailed information about the client which invoked the test. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}.",
"id": "ClientInfoDetail",
"properties": {
"key": {
"description": "Required. The key of detailed client information.",
"type": "string"
},
"value": {
"description": "Required. The value of detailed client information.",
"type": "string"
}
},
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "Date",
"properties": {
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"DeviceFile": {
"description": "A single device file description.",
"id": "DeviceFile",
"properties": {
"obbFile": {
"$ref": "ObbFile",
"description": "A reference to an opaque binary blob file."
},
"regularFile": {
"$ref": "RegularFile",
"description": "A reference to a regular file."
}
},
"type": "object"
},
"DeviceIpBlock": {
"description": "A single device IP block",
"id": "DeviceIpBlock",
"properties": {
"addedDate": {
"$ref": "Date",
"description": "The date this block was added to Firebase Test Lab"
},
"block": {
"description": "An IP address block in CIDR notation eg: 34.68.194.64/29",
"type": "string"
},
"form": {
"description": "Whether this block is used by physical or virtual devices",
"enum": [
"DEVICE_FORM_UNSPECIFIED",
"VIRTUAL",
"PHYSICAL",
"EMULATOR"
],
"enumDescriptions": [
"Do not use. For proto versioning only.",
"Android virtual device using Compute Engine native virtualization. Firebase Test Lab only.",
"Actual hardware.",
"Android virtual device using emulator in nested virtualization. Equivalent to Android Studio."
],
"type": "string"
}
},
"type": "object"
},
"DeviceIpBlockCatalog": {
"description": "List of IP blocks used by the Firebase Test Lab",
"id": "DeviceIpBlockCatalog",
"properties": {
"ipBlocks": {
"description": "The device IP blocks used by Firebase Test Lab",
"items": {
"$ref": "DeviceIpBlock"
},
"type": "array"
}
},
"type": "object"
},
"DeviceSession": {
"description": "Protobuf message describing the device message, used from several RPCs.",
"id": "DeviceSession",
"properties": {
"activeStartTime": {
"description": "Output only. The timestamp that the session first became ACTIVE.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"androidDevice": {
"$ref": "AndroidDevice",
"description": "Required. The requested device"
},
"createTime": {
"description": "Output only. The time that the Session was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Output only. The title of the DeviceSession to be presented in the UI.",
"readOnly": true,
"type": "string"
},
"expireTime": {
"description": "Optional. If the device is still in use at this time, any connections will be ended and the SessionState will transition from ACTIVE to FINISHED.",
"format": "google-datetime",
"type": "string"
},
"inactivityTimeout": {
"description": "Output only. The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.",
"format": "google-duration",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Optional. Name of the DeviceSession, e.g. \"projects/{project_id}/deviceSessions/{session_id}\"",
"type": "string"
},
"state": {
"description": "Output only. Current state of the DeviceSession.",
"enum": [
"SESSION_STATE_UNSPECIFIED",
"REQUESTED",
"PENDING",
"ACTIVE",
"EXPIRED",
"FINISHED",
"UNAVAILABLE",
"ERROR"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Initial state of a session request. The session is being validated for correctness and a device is not yet requested.",
"The session has been validated and is in the queue for a device.",
"The session has been granted and the device is accepting connections.",
"The session duration exceeded the device\u2019s reservation time period and timed out automatically.",
"The user is finished with the session and it was canceled by the user while the request was still getting allocated or after allocation and during device usage period.",
"Unable to complete the session because the device was unavailable and it failed to allocate through the scheduler. For example, a device not in the catalog was requested or the request expired in the allocation queue.",
"Unable to complete the session for an internal reason, such as an infrastructure failure."
],
"readOnly": true,
"type": "string"
},
"stateHistories": {
"description": "Output only. The historical state transitions of the session_state message including the current session state.",
"items": {
"$ref": "SessionStateEvent"
},
"readOnly": true,
"type": "array"
},
"ttl": {
"description": "Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 15 minutes.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"DirectAccessVersionInfo": {
"description": "Denotes whether Direct Access is supported, and by which client versions. DirectAccessService is currently available as a preview to select developers. You can register today on behalf of you and your team at https://developer.android.com/studio/preview/android-device-streaming",
"id": "DirectAccessVersionInfo",
"properties": {
"directAccessSupported": {
"description": "Whether direct access is supported at all. Clients are expected to filter down the device list to only android models and versions which support Direct Access when that is the user intent.",
"type": "boolean"
},
"minimumAndroidStudioVersion": {
"description": "Output only. Indicates client-device compatibility, where a device is known to work only with certain workarounds implemented in the Android Studio client. Expected format \"major.minor.micro.patch\", e.g. \"5921.22.2211.8881706\".",
"type": "string"
}
},
"type": "object"
},
"Distribution": {
"description": "Data about the relative number of devices running a given configuration of the Android platform.",
"id": "Distribution",
"properties": {
"marketShare": {
"description": "Output only. The estimated fraction (0-1) of the total market with this configuration.",
"format": "double",
"type": "number"
},
"measurementTime": {
"description": "Output only. The time this distribution was measured.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"Environment": {
"description": "The environment in which the test is run.",
"id": "Environment",
"properties": {
"androidDevice": {
"$ref": "AndroidDevice",
"description": "An Android device which must be used with an Android test."
},
"iosDevice": {
"$ref": "IosDevice",
"description": "An iOS device which must be used with an iOS test."
}
},
"type": "object"
},
"EnvironmentMatrix": {
"description": "The matrix of environments in which the test is to be executed.",
"id": "EnvironmentMatrix",
"properties": {
"androidDeviceList": {
"$ref": "AndroidDeviceList",
"description": "A list of Android devices; the test will be run only on the specified devices."
},
"androidMatrix": {
"$ref": "AndroidMatrix",
"description": "A matrix of Android devices."
},
"iosDeviceList": {
"$ref": "IosDeviceList",
"description": "A list of iOS devices."
}
},
"type": "object"
},
"EnvironmentVariable": {
"description": "A key-value pair passed as an environment variable to the test.",
"id": "EnvironmentVariable",
"properties": {
"key": {
"description": "Key for the environment variable.",
"type": "string"
},
"value": {
"description": "Value for the environment variable.",
"type": "string"
}
},
"type": "object"
},
"FileReference": {
"description": "A reference to a file, used for user inputs.",
"id": "FileReference",
"properties": {
"gcsPath": {
"description": "A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding)",
"type": "string"
}
},
"type": "object"
},
"GetApkDetailsResponse": {
"description": "Response containing the details of the specified Android application.",
"id": "GetApkDetailsResponse",
"properties": {
"apkDetail": {
"$ref": "ApkDetail",
"description": "Details of the Android App."
}
},
"type": "object"
},
"GoogleAuto": {
"description": "Enables automatic Google account login. If set, the service automatically generates a Google test account and adds it to the device, before executing the test. Note that test accounts might be reused. Many applications show their full set of functionalities when an account is present on the device. Logging into the device with these generated accounts allows testing more functionalities.",
"id": "GoogleAuto",
"properties": {},
"type": "object"
},
"GoogleCloudStorage": {
"description": "A storage location within Google cloud storage (GCS).",
"id": "GoogleCloudStorage",
"properties": {
"gcsPath": {
"description": "Required. The path to a directory in GCS that will eventually contain the results for this test. The requesting user must have write access on the bucket in the supplied path.",
"type": "string"
}
},
"type": "object"
},
"IntentFilter": {
"description": "The section of an tag. https://developer.android.com/guide/topics/manifest/intent-filter-element.html",
"id": "IntentFilter",
"properties": {
"actionNames": {
"description": "The android:name value of the tag.",
"items": {
"type": "string"
},
"type": "array"
},
"categoryNames": {
"description": "The android:name value of the tag.",
"items": {
"type": "string"
},
"type": "array"
},
"mimeType": {
"description": "The android:mimeType value of the tag.",
"type": "string"
}
},
"type": "object"
},
"IosDevice": {
"description": "A single iOS device.",
"id": "IosDevice",
"properties": {
"iosModelId": {
"description": "Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options.",
"type": "string"
},
"iosVersionId": {
"description": "Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options.",
"type": "string"
},
"locale": {
"description": "Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.",
"type": "string"
},
"orientation": {
"description": "Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.",
"type": "string"
}
},
"type": "object"
},
"IosDeviceCatalog": {
"description": "The currently supported iOS devices.",
"id": "IosDeviceCatalog",
"properties": {
"models": {
"description": "The set of supported iOS device models.",
"items": {
"$ref": "IosModel"
},
"type": "array"
},
"runtimeConfiguration": {
"$ref": "IosRuntimeConfiguration",
"description": "The set of supported runtime configurations."
},
"versions": {
"description": "The set of supported iOS software versions.",
"items": {
"$ref": "IosVersion"
},
"type": "array"
},
"xcodeVersions": {
"description": "The set of supported Xcode versions.",
"items": {
"$ref": "XcodeVersion"
},
"type": "array"
}
},
"type": "object"
},
"IosDeviceFile": {
"description": "A file or directory to install on the device before the test starts.",
"id": "IosDeviceFile",
"properties": {
"bundleId": {
"description": "The bundle id of the app where this file lives. iOS apps sandbox their own filesystem, so app files must specify which app installed on the device.",
"type": "string"
},
"content": {
"$ref": "FileReference",
"description": "The source file"
},
"devicePath": {
"description": "Location of the file on the device, inside the app's sandboxed filesystem",
"type": "string"
}
},
"type": "object"
},
"IosDeviceList": {
"description": "A list of iOS device configurations in which the test is to be executed.",
"id": "IosDeviceList",
"properties": {
"iosDevices": {
"description": "Required. A list of iOS devices.",
"items": {
"$ref": "IosDevice"
},
"type": "array"
}
},
"type": "object"
},
"IosModel": {
"description": "A description of an iOS device tests may be run on.",
"id": "IosModel",
"properties": {
"deviceCapabilities": {
"description": "Device capabilities. Copied from https://developer.apple.com/library/archive/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/DeviceCompatibilityMatrix/DeviceCompatibilityMatrix.html",
"items": {
"type": "string"
},
"type": "array"
},
"formFactor": {
"description": "Whether this device is a phone, tablet, wearable, etc.",
"enum": [
"DEVICE_FORM_FACTOR_UNSPECIFIED",
"PHONE",
"TABLET",
"WEARABLE",
"TV",
"AUTOMOTIVE",
"DESKTOP",
"XR"
],
"enumDescriptions": [
"Do not use. For proto versioning only.",
"This device has the shape of a phone.",
"This device has the shape of a tablet.",
"This device has the shape of a watch or other wearable.",
"This device has a television form factor.",
"This device has an automotive form factor.",
"This device has a desktop form factor.",
"This device has an Extended Reality form factor."
],
"type": "string"
},
"id": {
"description": "The unique opaque id for this model. Use this for invoking the TestExecutionService.",
"type": "string"
},
"name": {
"description": "The human-readable name for this device model. Examples: \"iPhone 4s\", \"iPad Mini 2\".",
"type": "string"
},
"perVersionInfo": {
"description": "Version-specific information of an iOS model.",
"items": {
"$ref": "PerIosVersionInfo"
},
"type": "array"
},
"screenDensity": {
"description": "Screen density in DPI.",
"format": "int32",
"type": "integer"
},
"screenX": {
"description": "Screen size in the horizontal (X) dimension measured in pixels.",
"format": "int32",
"type": "integer"
},
"screenY": {
"description": "Screen size in the vertical (Y) dimension measured in pixels.",
"format": "int32",
"type": "integer"
},
"supportedVersionIds": {
"description": "The set of iOS major software versions this device supports.",
"items": {
"type": "string"
},
"type": "array"
},
"tags": {
"description": "Tags for this dimension. Examples: \"default\", \"preview\", \"deprecated\".",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"IosRoboTest": {
"description": "A test that explores an iOS application on an iOS device.",
"id": "IosRoboTest",
"properties": {
"appBundleId": {
"description": "The bundle ID for the app-under-test. This is determined by examining the application's \"Info.plist\" file.",
"type": "string"
},
"appIpa": {
"$ref": "FileReference",
"description": "Required. The ipa stored at this file should be used to run the test."
},
"roboScript": {
"$ref": "FileReference",
"description": "An optional Roboscript to customize the crawl. See https://firebase.google.com/docs/test-lab/android/robo-scripts-reference for more information about Roboscripts. The maximum allowed file size of the roboscript is 10MiB."
}
},
"type": "object"
},
"IosRuntimeConfiguration": {
"description": "iOS configuration that can be selected at the time a test is run.",
"id": "IosRuntimeConfiguration",
"properties": {
"locales": {
"description": "The set of available locales.",
"items": {
"$ref": "Locale"
},
"type": "array"
},
"orientations": {
"description": "The set of available orientations.",
"items": {
"$ref": "Orientation"
},
"type": "array"
}
},
"type": "object"
},
"IosTestLoop": {
"description": "A test of an iOS application that implements one or more game loop scenarios. This test type accepts an archived application (.ipa file) and a list of integer scenarios that will be executed on the app sequentially.",
"id": "IosTestLoop",
"properties": {
"appBundleId": {
"description": "Output only. The bundle id for the application under test.",
"type": "string"
},
"appIpa": {
"$ref": "FileReference",
"description": "Required. The .ipa of the application to test."
},
"scenarios": {
"description": "The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
}
},
"type": "object"
},
"IosTestSetup": {
"description": "A description of how to set up an iOS device prior to running the test.",
"id": "IosTestSetup",
"properties": {
"additionalIpas": {
"description": "iOS apps to install in addition to those being directly tested.",
"items": {
"$ref": "FileReference"
},
"type": "array"
},
"networkProfile": {
"description": "The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.",
"type": "string"
},
"pullDirectories": {
"description": "List of directories on the device to upload to Cloud Storage at the end of the test. Directories should either be in a shared directory (such as /private/var/mobile/Media) or within an accessible directory inside the app's filesystem (such as /Documents) by specifying the bundle ID.",
"items": {
"$ref": "IosDeviceFile"
},
"type": "array"
},
"pushFiles": {
"description": "List of files to push to the device before starting the test.",
"items": {
"$ref": "IosDeviceFile"
},
"type": "array"
}
},
"type": "object"
},
"IosVersion": {
"description": "An iOS version.",
"id": "IosVersion",
"properties": {
"id": {
"description": "An opaque id for this iOS version. Use this id to invoke the TestExecutionService.",
"type": "string"
},
"majorVersion": {
"description": "An integer representing the major iOS version. Examples: \"8\", \"9\".",
"format": "int32",
"type": "integer"
},
"minorVersion": {
"description": "An integer representing the minor iOS version. Examples: \"1\", \"2\".",
"format": "int32",
"type": "integer"
},
"supportedXcodeVersionIds": {
"description": "The available Xcode versions for this version.",
"items": {
"type": "string"
},
"type": "array"
},
"tags": {
"description": "Tags for this dimension. Examples: \"default\", \"preview\", \"deprecated\".",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"IosXcTest": {
"description": "A test of an iOS application that uses the XCTest framework. Xcode supports the option to \"build for testing\", which generates an .xctestrun file that contains a test specification (arguments, test methods, etc). This test type accepts a zip file containing the .xctestrun file and the corresponding contents of the Build/Products directory that contains all the binaries needed to run the tests.",
"id": "IosXcTest",
"properties": {
"appBundleId": {
"description": "Output only. The bundle id for the application under test.",
"type": "string"
},
"testSpecialEntitlements": {
"description": "The option to test special app entitlements. Setting this would re-sign the app having special entitlements with an explicit application-identifier. Currently supports testing aps-environment entitlement.",
"type": "boolean"
},
"testsZip": {
"$ref": "FileReference",
"description": "Required. The .zip containing the .xctestrun file and the contents of the DerivedData/Build/Products directory. The .xctestrun file in this zip is ignored if the xctestrun field is specified."
},
"xcodeVersion": {
"description": "The Xcode version that should be used for the test. Use the TestEnvironmentDiscoveryService to get supported options. Defaults to the latest Xcode version Firebase Test Lab supports.",
"type": "string"
},
"xctestrun": {
"$ref": "FileReference",
"description": "An .xctestrun file that will override the .xctestrun file in the tests zip. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for sharding tests. Default is taken from the tests zip."
}
},
"type": "object"
},
"LabInfo": {
"description": "Lab specific information for a device.",
"id": "LabInfo",
"properties": {
"name": {
"description": "Lab name where the device is hosted. If empty, the device is hosted in a Google owned lab.",
"type": "string"
},
"regionCode": {
"description": "The Unicode country/region code (CLDR) of the lab where the device is hosted. E.g. \"US\" for United States, \"CH\" for Switzerland.",
"type": "string"
}
},
"type": "object"
},
"LauncherActivityIntent": {
"description": "Specifies an intent that starts the main launcher activity.",
"id": "LauncherActivityIntent",
"properties": {},
"type": "object"
},
"ListDeviceSessionsResponse": {
"description": "A list of device sessions.",
"id": "ListDeviceSessionsResponse",
"properties": {
"deviceSessions": {
"description": "The sessions matching the specified filter in the given cloud project.",
"items": {
"$ref": "DeviceSession"
},
"type": "array"
},
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"Locale": {
"description": "A location/region designation for language.",
"id": "Locale",
"properties": {
"id": {
"description": "The id for this locale. Example: \"en_US\".",
"type": "string"
},
"name": {
"description": "A human-friendly name for this language/locale. Example: \"English\".",
"type": "string"
},
"region": {
"description": "A human-friendly string representing the region for this locale. Example: \"United States\". Not present for every locale.",
"type": "string"
},
"tags": {
"description": "Tags for this dimension. Example: \"default\".",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ManualSharding": {
"description": "Shards test cases into the specified groups of packages, classes, and/or methods. With manual sharding enabled, specifying test targets via environment_variables or in InstrumentationTest is invalid.",
"id": "ManualSharding",
"properties": {
"testTargetsForShard": {
"description": "Required. Group of packages, classes, and/or test methods to be run for each manually-created shard. You must specify at least one shard if this field is present. When you select one or more physical devices, the number of repeated test_targets_for_shard must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500.",
"items": {
"$ref": "TestTargetsForShard"
},
"type": "array"
}
},
"type": "object"
},
"MatrixErrorDetail": {
"description": "Describes a single error or issue with a matrix.",
"id": "MatrixErrorDetail",
"properties": {
"message": {
"description": "Output only. A human-readable message about how the error in the TestMatrix. Expands on the `reason` field with additional details and possible options to fix the issue.",
"readOnly": true,
"type": "string"
},
"reason": {
"description": "Output only. The reason for the error. This is a constant value in UPPER_SNAKE_CASE that identifies the cause of the error.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Metadata": {
"description": "A tag within a manifest. https://developer.android.com/guide/topics/manifest/meta-data-element.html",
"id": "Metadata",
"properties": {
"name": {
"description": "The android:name value",
"type": "string"
},
"value": {
"description": "The android:value value",
"type": "string"
}
},
"type": "object"
},
"NetworkConfiguration": {
"id": "NetworkConfiguration",
"properties": {
"downRule": {
"$ref": "TrafficRule",
"description": "The emulation rule applying to the download traffic."
},
"id": {
"description": "The unique opaque id for this network traffic configuration.",
"type": "string"
},
"upRule": {
"$ref": "TrafficRule",
"description": "The emulation rule applying to the upload traffic."
}
},
"type": "object"
},
"NetworkConfigurationCatalog": {
"id": "NetworkConfigurationCatalog",
"properties": {
"configurations": {
"items": {
"$ref": "NetworkConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"NoActivityIntent": {
"description": "Skips the starting activity",
"id": "NoActivityIntent",
"properties": {},
"type": "object"
},
"ObbFile": {
"description": "An opaque binary blob file to install on the device before the test starts.",
"id": "ObbFile",
"properties": {
"obb": {
"$ref": "FileReference",
"description": "Required. Opaque Binary Blob (OBB) file(s) to install on the device."
},
"obbFileName": {
"description": "Required. OBB file name which must conform to the format as specified by Android e.g. [main|patch].0300110.com.example.android.obb which will be installed into \\/Android/obb/\\/ on the device.",
"type": "string"
}
},
"type": "object"
},
"Orientation": {
"description": "Screen orientation of the device.",
"id": "Orientation",
"properties": {
"id": {
"description": "The id for this orientation. Example: \"portrait\".",
"type": "string"
},
"name": {
"description": "A human-friendly name for this orientation. Example: \"portrait\".",
"type": "string"
},
"tags": {
"description": "Tags for this dimension. Example: \"default\".",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"PerAndroidVersionInfo": {
"description": "A version-specific information of an Android model.",
"id": "PerAndroidVersionInfo",
"properties": {
"deviceCapacity": {
"description": "The number of online devices for an Android version.",
"enum": [
"DEVICE_CAPACITY_UNSPECIFIED",
"DEVICE_CAPACITY_HIGH",
"DEVICE_CAPACITY_MEDIUM",
"DEVICE_CAPACITY_LOW",
"DEVICE_CAPACITY_NONE"
],
"enumDescriptions": [
"The value of device capacity is unknown or unset.",
"Devices that are high in capacity (The lab has a large number of these devices). These devices are generally suggested for running a large number of simultaneous tests (e.g. more than 100 tests). Please note that high capacity devices do not guarantee short wait times due to several factors: 1. Traffic (how heavily they are used at any given moment) 2. High capacity devices are prioritized for certain usages, which may cause user tests to be slower than selecting other similar device types.",
"Devices that are medium in capacity (The lab has a decent number of these devices, though not as many as high capacity devices). These devices are suitable for fewer test runs (e.g. fewer than 100 tests) and only for low shard counts (e.g. less than 10 shards).",
"Devices that are low in capacity (The lab has a small number of these devices). These devices may be used if users need to test on this specific device model and version. Please note that due to low capacity, the tests may take much longer to finish, especially if a large number of tests are invoked at once. These devices are not suitable for test sharding.",
"Devices that are completely missing from the lab. These devices are unavailable either temporarily or permanently and should not be requested. If the device is also marked as deprecated, this state is very likely permanent."
],
"type": "string"
},
"directAccessVersionInfo": {
"$ref": "DirectAccessVersionInfo",
"description": "Output only. Identifies supported clients for DirectAccess for this Android version.",
"readOnly": true
},
"interactiveDeviceAvailabilityEstimate": {
"description": "Output only. The estimated wait time for a single interactive device session using Direct Access.",
"format": "google-duration",
"readOnly": true,
"type": "string"
},
"versionId": {
"description": "An Android version.",
"type": "string"
}
},
"type": "object"
},
"PerIosVersionInfo": {
"description": "A version-specific information of an iOS model.",
"id": "PerIosVersionInfo",
"properties": {
"deviceCapacity": {
"description": "The number of online devices for an iOS version.",
"enum": [
"DEVICE_CAPACITY_UNSPECIFIED",
"DEVICE_CAPACITY_HIGH",
"DEVICE_CAPACITY_MEDIUM",
"DEVICE_CAPACITY_LOW",
"DEVICE_CAPACITY_NONE"
],
"enumDescriptions": [
"The value of device capacity is unknown or unset.",
"Devices that are high in capacity (The lab has a large number of these devices). These devices are generally suggested for running a large number of simultaneous tests (e.g. more than 100 tests). Please note that high capacity devices do not guarantee short wait times due to several factors: 1. Traffic (how heavily they are used at any given moment) 2. High capacity devices are prioritized for certain usages, which may cause user tests to be slower than selecting other similar device types.",
"Devices that are medium in capacity (The lab has a decent number of these devices, though not as many as high capacity devices). These devices are suitable for fewer test runs (e.g. fewer than 100 tests) and only for low shard counts (e.g. less than 10 shards).",
"Devices that are low in capacity (The lab has a small number of these devices). These devices may be used if users need to test on this specific device model and version. Please note that due to low capacity, the tests may take much longer to finish, especially if a large number of tests are invoked at once. These devices are not suitable for test sharding.",
"Devices that are completely missing from the lab. These devices are unavailable either temporarily or permanently and should not be requested. If the device is also marked as deprecated, this state is very likely permanent."
],
"type": "string"
},
"versionId": {
"description": "An iOS version.",
"type": "string"
}
},
"type": "object"
},
"ProvidedSoftwareCatalog": {
"description": "The currently provided software environment on the devices under test.",
"id": "ProvidedSoftwareCatalog",
"properties": {
"androidxOrchestratorVersion": {
"description": "A string representing the current version of AndroidX Test Orchestrator that is used in the environment. The package is available at https://maven.google.com/web/index.html#androidx.test:orchestrator.",
"type": "string"
},
"orchestratorVersion": {
"deprecated": true,
"description": "Deprecated: Use AndroidX Test Orchestrator going forward. A string representing the current version of Android Test Orchestrator that is used in the environment. The package is available at https://maven.google.com/web/index.html#com.android.support.test:orchestrator.",
"type": "string"
}
},
"type": "object"
},
"RegularFile": {
"description": "A file or directory to install on the device before the test starts.",
"id": "RegularFile",
"properties": {
"content": {
"$ref": "FileReference",
"description": "Required. The source file."
},
"devicePath": {
"description": "Required. Where to put the content on the device. Must be an absolute, allowlisted path. If the file exists, it will be replaced. The following device-side directories and any of their subdirectories are allowlisted: ${EXTERNAL_STORAGE}, /sdcard ${ANDROID_DATA}/local/tmp, or /data/local/tmp Specifying a path outside of these directory trees is invalid. The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device and copy the file there. It is strongly advised to use the Environment API in app and test code to access files on the device in a portable way.",
"type": "string"
}
},
"type": "object"
},
"ResultStorage": {
"description": "Locations where the results of running the test are stored.",
"id": "ResultStorage",
"properties": {
"googleCloudStorage": {
"$ref": "GoogleCloudStorage",
"description": "Required."
},
"resultsUrl": {
"description": "Output only. URL to the results in the Firebase Web Console.",
"type": "string"
},
"toolResultsExecution": {
"$ref": "ToolResultsExecution",
"description": "Output only. The tool results execution that results are written to."
},
"toolResultsHistory": {
"$ref": "ToolResultsHistory",
"description": "The tool results history that contains the tool results execution that results are written to. If not provided, the service will choose an appropriate value."
}
},
"type": "object"
},
"RoboDirective": {
"description": "Directs Robo to interact with a specific UI element if it is encountered during the crawl. Currently, Robo can perform text entry or element click.",
"id": "RoboDirective",
"properties": {
"actionType": {
"description": "Required. The type of action that Robo should perform on the specified element.",
"enum": [
"ACTION_TYPE_UNSPECIFIED",
"SINGLE_CLICK",
"ENTER_TEXT",
"IGNORE"
],
"enumDescriptions": [
"DO NOT USE. For proto versioning only.",
"Direct Robo to click on the specified element. No-op if specified element is not clickable.",
"Direct Robo to enter text on the specified element. No-op if specified element is not enabled or does not allow text entry.",
"Direct Robo to ignore interactions with a specific element."
],
"type": "string"
},
"inputText": {
"description": "The text that Robo is directed to set. If left empty, the directive will be treated as a CLICK on the element matching the resource_name.",
"type": "string"
},
"resourceName": {
"description": "Required. The android resource name of the target UI element. For example, in Java: R.string.foo in xml: @string/foo Only the \"foo\" part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html",
"type": "string"
}
},
"type": "object"
},
"RoboStartingIntent": {
"description": "Message for specifying the start activities to crawl.",
"id": "RoboStartingIntent",
"properties": {
"launcherActivity": {
"$ref": "LauncherActivityIntent",
"description": "An intent that starts the main launcher activity."
},
"noActivity": {
"$ref": "NoActivityIntent",
"description": "Skips the starting activity"
},
"startActivity": {
"$ref": "StartActivityIntent",
"description": "An intent that starts an activity with specific details."
},
"timeout": {
"description": "Timeout in seconds for each intent.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"Service": {
"description": "The section of an tag. https://developer.android.com/guide/topics/manifest/service-element",
"id": "Service",
"properties": {
"intentFilter": {
"description": "Intent filters in the service",
"items": {
"$ref": "IntentFilter"
},
"type": "array"
},
"name": {
"description": "The android:name value",
"type": "string"
}
},
"type": "object"
},
"SessionStateEvent": {
"description": "A message encapsulating a series of Session states and the time that the DeviceSession first entered those states.",
"id": "SessionStateEvent",
"properties": {
"eventTime": {
"description": "Output only. The time that the session_state first encountered that state.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"sessionState": {
"description": "Output only. The session_state tracked by this event",
"enum": [
"SESSION_STATE_UNSPECIFIED",
"REQUESTED",
"PENDING",
"ACTIVE",
"EXPIRED",
"FINISHED",
"UNAVAILABLE",
"ERROR"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Initial state of a session request. The session is being validated for correctness and a device is not yet requested.",
"The session has been validated and is in the queue for a device.",
"The session has been granted and the device is accepting connections.",
"The session duration exceeded the device\u2019s reservation time period and timed out automatically.",
"The user is finished with the session and it was canceled by the user while the request was still getting allocated or after allocation and during device usage period.",
"Unable to complete the session because the device was unavailable and it failed to allocate through the scheduler. For example, a device not in the catalog was requested or the request expired in the allocation queue.",
"Unable to complete the session for an internal reason, such as an infrastructure failure."
],
"readOnly": true,
"type": "string"
},
"stateMessage": {
"description": "Output only. A human-readable message to explain the state.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Shard": {
"description": "Output only. Details about the shard.",
"id": "Shard",
"properties": {
"estimatedShardDuration": {
"description": "Output only. The estimated shard duration based on previous test case timing records, if available.",
"format": "google-duration",
"readOnly": true,
"type": "string"
},
"numShards": {
"description": "Output only. The total number of shards.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"shardIndex": {
"description": "Output only. The index of the shard among all the shards.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"testTargetsForShard": {
"$ref": "TestTargetsForShard",
"description": "Output only. Test targets for each shard. Only set for manual sharding.",
"readOnly": true
}
},
"type": "object"
},
"ShardingOption": {
"description": "Options for enabling sharding.",
"id": "ShardingOption",
"properties": {
"manualSharding": {
"$ref": "ManualSharding",
"description": "Shards test cases into the specified groups of packages, classes, and/or methods."
},
"smartSharding": {
"$ref": "SmartSharding",
"description": "Shards test based on previous test case timing records."
},
"uniformSharding": {
"$ref": "UniformSharding",
"description": "Uniformly shards test cases given a total number of shards."
}
},
"type": "object"
},
"SmartSharding": {
"description": "Shards test based on previous test case timing records.",
"id": "SmartSharding",
"properties": {
"targetedShardDuration": {
"description": "The amount of time tests within a shard should take. Default: 300 seconds (5 minutes). The minimum allowed: 120 seconds (2 minutes). The shard count is dynamically set based on time, up to the maximum shard limit (described below). To guarantee at least one test case for each shard, the number of shards will not exceed the number of test cases. Shard duration will be exceeded if: - The maximum shard limit is reached and there is more calculated test time remaining to allocate into shards. - Any individual test is estimated to be longer than the targeted shard duration. Shard duration is not guaranteed because smart sharding uses test case history and default durations which may not be accurate. The rules for finding the test case timing records are: - If the service has processed a test case in the last 30 days, the record of the latest successful test case will be used. - For new test cases, the average duration of other known test cases will be used. - If there are no previous test case timing records available, the default test case duration is 15 seconds. Because the actual shard duration can exceed the targeted shard duration, we recommend that you set the targeted value at least 5 minutes less than the maximum allowed test timeout (45 minutes for physical devices and 60 minutes for virtual), or that you use the custom test timeout value that you set. This approach avoids cancelling the shard before all tests can finish. Note that there is a limit for maximum number of shards. When you select one or more physical devices, the number of shards must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500. To guarantee at least one test case for per shard, the number of shards will not exceed the number of test cases. Each shard created counts toward daily test quota.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"StartActivityIntent": {
"description": "A starting intent specified by an action, uri, and categories.",
"id": "StartActivityIntent",
"properties": {
"action": {
"description": "Action name. Required for START_ACTIVITY.",
"type": "string"
},
"categories": {
"description": "Intent categories to set on the intent.",
"items": {
"type": "string"
},
"type": "array"
},
"uri": {
"description": "URI for the action.",
"type": "string"
}
},
"type": "object"
},
"SystraceSetup": {
"id": "SystraceSetup",
"properties": {
"durationSeconds": {
"deprecated": true,
"description": "Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"TestDetails": {
"description": "Additional details about the progress of the running test.",
"id": "TestDetails",
"properties": {
"errorMessage": {
"description": "Output only. If the TestState is ERROR, then this string will contain human-readable details about the error.",
"type": "string"
},
"progressMessages": {
"description": "Output only. Human-readable, detailed descriptions of the test's progress. For example: \"Provisioning a device\", \"Starting Test\". During the course of execution new data may be appended to the end of progress_messages.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TestEnvironmentCatalog": {
"description": "A description of a test environment.",
"id": "TestEnvironmentCatalog",
"properties": {
"androidDeviceCatalog": {
"$ref": "AndroidDeviceCatalog",
"description": "Supported Android devices."
},
"deviceIpBlockCatalog": {
"$ref": "DeviceIpBlockCatalog",
"description": "The IP blocks used by devices in the test environment."
},
"iosDeviceCatalog": {
"$ref": "IosDeviceCatalog",
"description": "Supported iOS devices."
},
"networkConfigurationCatalog": {
"$ref": "NetworkConfigurationCatalog",
"description": "Supported network configurations."
},
"softwareCatalog": {
"$ref": "ProvidedSoftwareCatalog",
"description": "The software test environment provided by TestExecutionService."
}
},
"type": "object"
},
"TestExecution": {
"description": "A single test executed in a single environment.",
"id": "TestExecution",
"properties": {
"environment": {
"$ref": "Environment",
"description": "Output only. How the host machine(s) are configured."
},
"id": {
"description": "Output only. Unique id set by the service.",
"type": "string"
},
"matrixId": {
"description": "Output only. Id of the containing TestMatrix.",
"type": "string"
},
"projectId": {
"description": "Output only. The cloud project that owns the test execution.",
"type": "string"
},
"shard": {
"$ref": "Shard",
"description": "Output only. Details about the shard."
},
"state": {
"description": "Output only. Indicates the current progress of the test execution (e.g., FINISHED).",
"enum": [
"TEST_STATE_UNSPECIFIED",
"VALIDATING",
"PENDING",
"RUNNING",
"FINISHED",
"ERROR",
"UNSUPPORTED_ENVIRONMENT",
"INCOMPATIBLE_ENVIRONMENT",
"INCOMPATIBLE_ARCHITECTURE",
"CANCELLED",
"INVALID"
],
"enumDescriptions": [
"Do not use. For proto versioning only.",
"The execution or matrix is being validated.",
"The execution or matrix is waiting for resources to become available.",
"The execution is currently being processed. Can only be set on an execution.",
"The execution or matrix has terminated normally. On a matrix this means that the matrix level processing completed normally, but individual executions may be in an ERROR state.",
"The execution or matrix has stopped because it encountered an infrastructure failure.",
"The execution was not run because it corresponds to a unsupported environment. Can only be set on an execution.",
"The execution was not run because the provided inputs are incompatible with the requested environment. Example: requested AndroidVersion is lower than APK's minSdkVersion Can only be set on an execution.",
"The execution was not run because the provided inputs are incompatible with the requested architecture. Example: requested device does not support running the native code in the supplied APK Can only be set on an execution.",
"The user cancelled the execution. Can only be set on an execution.",
"The execution or matrix was not run because the provided inputs are not valid. Examples: input file is not of the expected type, is malformed/corrupt, or was flagged as malware"
],
"type": "string"
},
"testDetails": {
"$ref": "TestDetails",
"description": "Output only. Additional details about the running test."
},
"testSpecification": {
"$ref": "TestSpecification",
"description": "Output only. How to run the test."
},
"timestamp": {
"description": "Output only. The time this test execution was initially created.",
"format": "google-datetime",
"type": "string"
},
"toolResultsStep": {
"$ref": "ToolResultsStep",
"description": "Output only. Where the results for this execution are written."
}
},
"type": "object"
},
"TestMatrix": {
"description": "TestMatrix captures all details about a test. It contains the environment configuration, test specification, test executions and overall state and outcome.",
"id": "TestMatrix",
"properties": {
"clientInfo": {
"$ref": "ClientInfo",
"description": "Information about the client which invoked the test."
},
"environmentMatrix": {
"$ref": "EnvironmentMatrix",
"description": "Required. The devices the tests are being executed on."
},
"extendedInvalidMatrixDetails": {
"description": "Output only. Details about why a matrix was deemed invalid. If multiple checks can be safely performed, they will be reported but no assumptions should be made about the length of this list.",
"items": {
"$ref": "MatrixErrorDetail"
},
"readOnly": true,
"type": "array"
},
"failFast": {
"description": "If true, only a single attempt at most will be made to run each execution/shard in the matrix. Flaky test attempts are not affected. Normally, 2 or more attempts are made if a potential infrastructure issue is detected. This feature is for latency sensitive workloads. The incidence of execution failures may be significantly greater for fail-fast matrices and support is more limited because of that expectation.",
"type": "boolean"
},
"flakyTestAttempts": {
"description": "The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns.",
"format": "int32",
"type": "integer"
},
"invalidMatrixDetails": {
"description": "Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state.",
"enum": [
"INVALID_MATRIX_DETAILS_UNSPECIFIED",
"DETAILS_UNAVAILABLE",
"MALFORMED_APK",
"MALFORMED_TEST_APK",
"NO_MANIFEST",
"NO_PACKAGE_NAME",
"INVALID_PACKAGE_NAME",
"TEST_SAME_AS_APP",
"NO_INSTRUMENTATION",
"NO_SIGNATURE",
"INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE",
"NO_TEST_RUNNER_CLASS",
"NO_LAUNCHER_ACTIVITY",
"FORBIDDEN_PERMISSIONS",
"INVALID_ROBO_DIRECTIVES",
"INVALID_RESOURCE_NAME",
"INVALID_DIRECTIVE_ACTION",
"TEST_LOOP_INTENT_FILTER_NOT_FOUND",
"SCENARIO_LABEL_NOT_DECLARED",
"SCENARIO_LABEL_MALFORMED",
"SCENARIO_NOT_DECLARED",
"DEVICE_ADMIN_RECEIVER",
"MALFORMED_XC_TEST_ZIP",
"BUILT_FOR_IOS_SIMULATOR",
"NO_TESTS_IN_XC_TEST_ZIP",
"USE_DESTINATION_ARTIFACTS",
"TEST_NOT_APP_HOSTED",
"PLIST_CANNOT_BE_PARSED",
"TEST_ONLY_APK",
"MALFORMED_IPA",
"MISSING_URL_SCHEME",
"MALFORMED_APP_BUNDLE",
"NO_CODE_APK",
"INVALID_INPUT_APK",
"INVALID_APK_PREVIEW_SDK",
"MATRIX_TOO_LARGE",
"TEST_QUOTA_EXCEEDED",
"SERVICE_NOT_ACTIVATED",
"UNKNOWN_PERMISSION_ERROR"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Do not use. For proto versioning only.",
"The matrix is INVALID, but there are no further details available.",
"The input app APK could not be parsed.",
"The input test APK could not be parsed.",
"The AndroidManifest.xml could not be found.",
"The APK manifest does not declare a package name.",
"The APK application ID (aka package name) is invalid. See also https://developer.android.com/studio/build/application-id",
"The test package and app package are the same.",
"The test apk does not declare an instrumentation.",
"The input app apk does not have a signature.",
"The test runner class specified by user or in the test APK's manifest file is not compatible with Android Test Orchestrator. Orchestrator is only compatible with AndroidJUnitRunner version 1.1 or higher. Orchestrator can be disabled by using DO_NOT_USE_ORCHESTRATOR OrchestratorOption.",
"The test APK does not contain the test runner class specified by the user or in the manifest file. This can be caused by one of the following reasons: - the user provided a runner class name that's incorrect, or - the test runner isn't built into the test APK (might be in the app APK instead).",
"A main launcher activity could not be found.",
"The app declares one or more permissions that are not allowed.",
"There is a conflict in the provided robo_directives.",
"There is at least one invalid resource name in the provided robo directives",
"Invalid definition of action in the robo directives (e.g. a click or ignore action includes an input text field)",
"There is no test loop intent filter, or the one that is given is not formatted correctly.",
"The request contains a scenario label that was not declared in the manifest.",
"There was an error when parsing a label's value.",
"The request contains a scenario number that was not declared in the manifest.",
"Device administrator applications are not allowed.",
"The zipped XCTest was malformed. The zip did not contain a single .xctestrun file and the contents of the DerivedData/Build/Products directory.",
"The zipped XCTest was built for the iOS simulator rather than for a physical device.",
"The .xctestrun file did not specify any test targets.",
"One or more of the test targets defined in the .xctestrun file specifies \"UseDestinationArtifacts\", which is disallowed.",
"XC tests which run on physical devices must have \"IsAppHostedTestBundle\" == \"true\" in the xctestrun file.",
"An Info.plist file in the XCTest zip could not be parsed.",
"The APK is marked as \"testOnly\". Deprecated and not currently used.",
"The input IPA could not be parsed.",
"The application doesn't register the game loop URL scheme.",
"The iOS application bundle (.app) couldn't be processed.",
"APK contains no code. See also https://developer.android.com/guide/topics/manifest/application-element.html#code",
"Either the provided input APK path was malformed, the APK file does not exist, or the user does not have permission to access the APK file.",
"APK is built for a preview SDK which is unsupported",
"The matrix expanded to contain too many executions.",
"Not enough test quota to run the executions in this matrix.",
"A required cloud service api is not activated. See: https://firebase.google.com/docs/test-lab/android/continuous#requirements",
"There was an unknown permission issue running this test."
],
"type": "string"
},
"outcomeSummary": {
"description": "Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED.",
"enum": [
"OUTCOME_SUMMARY_UNSPECIFIED",
"SUCCESS",
"FAILURE",
"INCONCLUSIVE",
"SKIPPED"
],
"enumDescriptions": [
"Do not use. For proto versioning only.",
"The test matrix run was successful, for instance: - All the test cases passed. - Robo did not detect a crash of the application under test.",
"A run failed, for instance: - One or more test cases failed. - A test timed out. - The application under test crashed.",
"Something unexpected happened. The run should still be considered unsuccessful but this is likely a transient problem and re-running the test might be successful.",
"All tests were skipped, for instance: - All device configurations were incompatible."
],
"type": "string"
},
"projectId": {
"description": "The cloud project that owns the test matrix.",
"type": "string"
},
"resultStorage": {
"$ref": "ResultStorage",
"description": "Required. Where the results for the matrix are written."
},
"state": {
"description": "Output only. Indicates the current progress of the test matrix.",
"enum": [
"TEST_STATE_UNSPECIFIED",
"VALIDATING",
"PENDING",
"RUNNING",
"FINISHED",
"ERROR",
"UNSUPPORTED_ENVIRONMENT",
"INCOMPATIBLE_ENVIRONMENT",
"INCOMPATIBLE_ARCHITECTURE",
"CANCELLED",
"INVALID"
],
"enumDescriptions": [
"Do not use. For proto versioning only.",
"The execution or matrix is being validated.",
"The execution or matrix is waiting for resources to become available.",
"The execution is currently being processed. Can only be set on an execution.",
"The execution or matrix has terminated normally. On a matrix this means that the matrix level processing completed normally, but individual executions may be in an ERROR state.",
"The execution or matrix has stopped because it encountered an infrastructure failure.",
"The execution was not run because it corresponds to a unsupported environment. Can only be set on an execution.",
"The execution was not run because the provided inputs are incompatible with the requested environment. Example: requested AndroidVersion is lower than APK's minSdkVersion Can only be set on an execution.",
"The execution was not run because the provided inputs are incompatible with the requested architecture. Example: requested device does not support running the native code in the supplied APK Can only be set on an execution.",
"The user cancelled the execution. Can only be set on an execution.",
"The execution or matrix was not run because the provided inputs are not valid. Examples: input file is not of the expected type, is malformed/corrupt, or was flagged as malware"
],
"type": "string"
},
"testExecutions": {
"description": "Output only. The list of test executions that the service creates for this matrix.",
"items": {
"$ref": "TestExecution"
},
"type": "array"
},
"testMatrixId": {
"description": "Output only. Unique id set by the service.",
"type": "string"
},
"testSpecification": {
"$ref": "TestSpecification",
"description": "Required. How to run the test."
},
"timestamp": {
"description": "Output only. The time this test matrix was initially created.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"TestSetup": {
"description": "A description of how to set up the Android device prior to running the test.",
"id": "TestSetup",
"properties": {
"account": {
"$ref": "Account",
"description": "The device will be logged in on this account for the duration of the test."
},
"additionalApks": {
"description": "APKs to install in addition to those being directly tested. These will be installed after the app under test. Limited to a combined total of 100 initial setup and additional files.",
"items": {
"$ref": "Apk"
},
"type": "array"
},
"directoriesToPull": {
"description": "List of directories on the device to upload to GCS at the end of the test; they must be absolute paths under /sdcard, /storage or /data/local/tmp. Path names are restricted to characters a-z A-Z 0-9 _ - . + and / Note: The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device.",
"items": {
"type": "string"
},
"type": "array"
},
"dontAutograntPermissions": {
"description": "Whether to prevent all runtime permissions to be granted at app install",
"type": "boolean"
},
"environmentVariables": {
"description": "Environment variables to set for the test (only applicable for instrumentation tests).",
"items": {
"$ref": "EnvironmentVariable"
},
"type": "array"
},
"filesToPush": {
"description": "List of files to push to the device before starting the test.",
"items": {
"$ref": "DeviceFile"
},
"type": "array"
},
"initialSetupApks": {
"description": "Optional. Initial setup APKs to install before the app under test is installed. Limited to a combined total of 100 initial setup and additional files.",
"items": {
"$ref": "Apk"
},
"type": "array"
},
"networkProfile": {
"description": "The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.",
"type": "string"
},
"systrace": {
"$ref": "SystraceSetup",
"deprecated": true,
"description": "Systrace configuration for the run. Deprecated: Systrace used Python 2 which was sunsetted on 2020-01-01. Systrace is no longer supported in the Cloud Testing API, and no Systrace file will be provided in the results."
}
},
"type": "object"
},
"TestSpecification": {
"description": "A description of how to run the test.",
"id": "TestSpecification",
"properties": {
"androidInstrumentationTest": {
"$ref": "AndroidInstrumentationTest",
"description": "An Android instrumentation test."
},
"androidRoboTest": {
"$ref": "AndroidRoboTest",
"description": "An Android robo test."
},
"androidTestLoop": {
"$ref": "AndroidTestLoop",
"description": "An Android Application with a Test Loop."
},
"disablePerformanceMetrics": {
"description": "Disables performance metrics recording. May reduce test latency.",
"type": "boolean"
},
"disableVideoRecording": {
"description": "Disables video recording. May reduce test latency.",
"type": "boolean"
},
"iosRoboTest": {
"$ref": "IosRoboTest",
"description": "An iOS Robo test."
},
"iosTestLoop": {
"$ref": "IosTestLoop",
"description": "An iOS application with a test loop."
},
"iosTestSetup": {
"$ref": "IosTestSetup",
"description": "Test setup requirements for iOS."
},
"iosXcTest": {
"$ref": "IosXcTest",
"description": "An iOS XCTest, via an .xctestrun file."
},
"testSetup": {
"$ref": "TestSetup",
"description": "Test setup requirements for Android e.g. files to install, bootstrap scripts."
},
"testTimeout": {
"description": "Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"TestTargetsForShard": {
"description": "Test targets for a shard.",
"id": "TestTargetsForShard",
"properties": {
"testTargets": {
"description": "Group of packages, classes, and/or test methods to be run for each shard. The targets need to be specified in AndroidJUnitRunner argument format. For example, \"package com.my.packages\" \"class com.my.package.MyClass\". The number of test_targets must be greater than 0.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ToolResultsExecution": {
"description": "Represents a tool results execution resource. This has the results of a TestMatrix.",
"id": "ToolResultsExecution",
"properties": {
"executionId": {
"description": "Output only. A tool results execution ID.",
"type": "string"
},
"historyId": {
"description": "Output only. A tool results history ID.",
"type": "string"
},
"projectId": {
"description": "Output only. The cloud project that owns the tool results execution.",
"type": "string"
}
},
"type": "object"
},
"ToolResultsHistory": {
"description": "Represents a tool results history resource.",
"id": "ToolResultsHistory",
"properties": {
"historyId": {
"description": "Required. A tool results history ID.",
"type": "string"
},
"projectId": {
"description": "Required. The cloud project that owns the tool results history.",
"type": "string"
}
},
"type": "object"
},
"ToolResultsStep": {
"description": "Represents a tool results step resource. This has the results of a TestExecution.",
"id": "ToolResultsStep",
"properties": {
"executionId": {
"description": "Output only. A tool results execution ID.",
"type": "string"
},
"historyId": {
"description": "Output only. A tool results history ID.",
"type": "string"
},
"projectId": {
"description": "Output only. The cloud project that owns the tool results step.",
"type": "string"
},
"stepId": {
"description": "Output only. A tool results step ID.",
"type": "string"
}
},
"type": "object"
},
"TrafficRule": {
"description": "Network emulation parameters.",
"id": "TrafficRule",
"properties": {
"bandwidth": {
"description": "Bandwidth in kbits/second.",
"format": "float",
"type": "number"
},
"burst": {
"description": "Burst size in kbits.",
"format": "float",
"type": "number"
},
"delay": {
"description": "Packet delay, must be >= 0.",
"format": "google-duration",
"type": "string"
},
"packetDuplicationRatio": {
"description": "Packet duplication ratio (0.0 - 1.0).",
"format": "float",
"type": "number"
},
"packetLossRatio": {
"description": "Packet loss ratio (0.0 - 1.0).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"UniformSharding": {
"description": "Uniformly shards test cases given a total number of shards. For instrumentation tests, it will be translated to \"-e numShard\" and \"-e shardIndex\" AndroidJUnitRunner arguments. With uniform sharding enabled, specifying either of these sharding arguments via `environment_variables` is invalid. Based on the sharding mechanism AndroidJUnitRunner uses, there is no guarantee that test cases will be distributed uniformly across all shards.",
"id": "UniformSharding",
"properties": {
"numShards": {
"description": "Required. The total number of shards to create. This must always be a positive number that is no greater than the total number of test cases. When you select one or more physical devices, the number of shards must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"UsesFeature": {
"description": "A tag within a manifest. https://developer.android.com/guide/topics/manifest/uses-feature-element.html",
"id": "UsesFeature",
"properties": {
"isRequired": {
"description": "The android:required value",
"type": "boolean"
},
"name": {
"description": "The android:name value",
"type": "string"
}
},
"type": "object"
},
"UsesPermissionTag": {
"description": "The tag within a manifest. https://developer.android.com/guide/topics/manifest/uses-permission-element.html",
"id": "UsesPermissionTag",
"properties": {
"maxSdkVersion": {
"description": "The android:name value",
"format": "int32",
"type": "integer"
},
"name": {
"description": "The android:name value",
"type": "string"
}
},
"type": "object"
},
"XcodeVersion": {
"description": "An Xcode version that an iOS version is compatible with.",
"id": "XcodeVersion",
"properties": {
"tags": {
"description": "Tags for this Xcode version. Example: \"default\".",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The id for this version. Example: \"9.2\".",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud Testing API",
"version": "v1"
}