"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.",
"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.",
"description":"The value of detailed client information.\nRequired",
"type":"string"
}
},
"id":"ClientInfoDetail",
"description":"Key-value pair of detailed information about the client which invoked the\ntest. For example {'Version', '1.0'}, {'Release Track', 'BETA'}"
},
"EnvironmentVariable":{
"description":"A key-value pair passed as an environment variable to the test",
"The execution or matrix is waiting for resources to become available.",
"The execution is currently being processed.\n\nCan only be set on an execution.",
"The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
"The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
"The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
"The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
"The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
"The user cancelled the execution.\n\nCan only be set on an execution.",
"The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
],
"enum":[
"TEST_STATE_UNSPECIFIED",
"VALIDATING",
"PENDING",
"RUNNING",
"FINISHED",
"ERROR",
"UNSUPPORTED_ENVIRONMENT",
"INCOMPATIBLE_ENVIRONMENT",
"INCOMPATIBLE_ARCHITECTURE",
"CANCELLED",
"INVALID"
],
"description":"Indicates the current progress of the test execution (e.g., FINISHED).\n@OutputOnly"
},
"toolResultsStep":{
"$ref":"ToolResultsStep",
"description":"Where the results for this execution are written.\n@OutputOnly"
},
"testSpecification":{
"description":"How to run the test.\n@OutputOnly",
"$ref":"TestSpecification"
},
"projectId":{
"description":"The cloud project that owns the test execution.\n@OutputOnly",
"type":"string"
},
"id":{
"description":"Unique id set by the backend.\n@OutputOnly",
"type":"string"
},
"timestamp":{
"type":"string",
"description":"The time this test execution was initially created.\n@OutputOnly",
"format":"google-datetime"
}
},
"id":"TestExecution"
},
"GoogleCloudStorage":{
"description":"A storage location within Google cloud storage (GCS).",
"type":"object",
"properties":{
"gcsPath":{
"description":"The path to a directory in GCS that will\neventually contain the results for this test.\nThe requesting user must have write access on the bucket in the supplied\npath.\nRequired",
"type":"string"
}
},
"id":"GoogleCloudStorage"
},
"RoboDirective":{
"properties":{
"resourceName":{
"description":"The android resource name of the target UI element\nFor example,\n in Java: R.string.foo\n in xml: @string/foo\nOnly the “foo” part is needed.\nReference doc:\nhttps://developer.android.com/guide/topics/resources/accessing-resources.html\nRequired",
"type":"string"
},
"inputText":{
"type":"string",
"description":"The text that Robo is directed to set. If left empty, the directive will be\ntreated as a CLICK on the element matching the resource_name.\nOptional"
},
"actionType":{
"description":"The type of action that Robo should perform on the specified element.\nRequired.",
"type":"string",
"enumDescriptions":[
"DO NOT USE. For proto versioning only.",
"Direct Robo to click on the specified element. No-op if specified element\nis not clickable.",
"Direct Robo to enter text on the specified element. No-op if specified\nelement is not enabled or does not allow text entry."
],
"enum":[
"ACTION_TYPE_UNSPECIFIED",
"SINGLE_CLICK",
"ENTER_TEXT"
]
}
},
"id":"RoboDirective",
"description":"Directs Robo to interact with a specific UI element if it is encountered\nduring the crawl. Currently, Robo can perform text entry or element click.",
"type":"object"
},
"AndroidMatrix":{
"description":"A set of Android device configuration permutations is defined by the\nthe cross-product of the given axes. Internally, the given AndroidMatrix\nwill be expanded into a set of AndroidDevices.\n\nOnly supported permutations will be instantiated. Invalid permutations\n(e.g., incompatible models/versions) are ignored.",
"type":"object",
"properties":{
"androidModelIds":{
"description":"The ids of the set of Android device to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
"type":"array",
"items":{
"type":"string"
}
},
"orientations":{
"description":"The set of orientations to test with.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
"type":"array",
"items":{
"type":"string"
}
},
"androidVersionIds":{
"description":"The ids of the set of Android OS version to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
"type":"array",
"items":{
"type":"string"
}
},
"locales":{
"description":"The set of locales the test device will enable for testing.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
"type":"array",
"items":{
"type":"string"
}
}
},
"id":"AndroidMatrix"
},
"AndroidModel":{
"description":"A description of an Android device tests may be run on.",
"type":"object",
"properties":{
"id":{
"description":"The unique opaque id for this model.\nUse this for invoking the TestExecutionService.\n@OutputOnly",
"type":"string"
},
"tags":{
"description":"Tags for this dimension.\nExamples: \"default\", \"preview\", \"deprecated\"",
"type":"array",
"items":{
"type":"string"
}
},
"manufacturer":{
"type":"string",
"description":"The manufacturer of this device.\n@OutputOnly"
},
"brand":{
"description":"The company that this device is branded with.\nExample: \"Google\", \"Samsung\"\n@OutputOnly",
"type":"string"
},
"screenX":{
"description":"Screen size in the horizontal (X) dimension measured in pixels.\n@OutputOnly",
"format":"int32",
"type":"integer"
},
"codename":{
"description":"The name of the industrial design.\nThis corresponds to android.os.Build.DEVICE\n@OutputOnly",
"type":"string"
},
"screenY":{
"description":"Screen size in the vertical (Y) dimension measured in pixels.\n@OutputOnly",
"description":"The list of supported ABIs for this device.\nThis corresponds to either android.os.Build.SUPPORTED_ABIS (for API level\n21 and above) or android.os.Build.CPU_ABI/CPU_ABI2.\nThe most preferred ABI is the first element in the list.\n\nElements are optionally prefixed by \"version_id:\" (where version_id is\nthe id of an AndroidVersion), denoting an ABI that is supported only on\na particular version.\n@OutputOnly",
"description":"The device will be logged in on this account for the duration of the test.\nOptional"
},
"directoriesToPull":{
"description":"List of directories on the device to upload to GCS at the end of the test;\nthey must be absolute paths under /sdcard or /data/local/tmp.\nPath names are restricted to characters a-z A-Z 0-9 _ - . + and /\n\nNote: The paths /sdcard and /data will be made available and treated as\nimplicit path substitutions. E.g. if /sdcard on a particular device does\nnot map to external storage, the system will replace it with the external\nstorage path prefix for that device.\n\nOptional",
"type":"array",
"items":{
"type":"string"
}
},
"filesToPush":{
"description":"List of files to push to the device before starting the test.\n\nOptional",
"description":"Enables automatic Google account login.\nIf set, the service will automatically generate a Google test account and\nadd it to the device, before executing the test. Note that test accounts\nmight be reused.\nMany applications show their full set of functionalities when an account is\npresent on the device. Logging into the device with these generated\naccounts allows testing more functionalities.\nDefault is false.\nOptional",
"description":"An Android Application with a Test Loop",
"$ref":"AndroidTestLoop"
}
},
"id":"TestSpecification"
},
"ResultStorage":{
"description":"Locations where the results of running the test are stored.",
"type":"object",
"properties":{
"toolResultsHistory":{
"$ref":"ToolResultsHistory",
"description":"The tool results history that contains the tool results execution that\nresults are written to.\n\nOptional, if not provided the service will choose an appropriate value."
"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 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\nis not compatible with Android Test Orchestrator.\nOrchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher.\nOrchestrator can be disabled by using DO_NOT_USE_ORCHESTRATOR\nOrchestratorOption.",
"The test APK does not contain the test runner class specified by user or in\nthe manifest file.\nThis can be caused by either of the following reasons:\n- the user provided a runner class name that's incorrect, or\n- the test runner isn't built into the test APK (might be in the app APK\ninstead).",
"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 there is no test loop intent filter, or the one that is given is\nnot formatted correctly.",
"The request contains a scenario label that was not declared in the\nmanifest.",
"There was an error when parsing a label's value.",
"The request contains a scenario number that was not declared in the\nmanifest.",
"Device administrator applications are not allowed.",
"The execution or matrix is waiting for resources to become available.",
"The execution is currently being processed.\n\nCan only be set on an execution.",
"The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
"The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
"The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
"The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
"The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
"The user cancelled the execution.\n\nCan only be set on an execution.",
"The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
"description":"Human-readable, detailed descriptions of the test's progress.\nFor example: \"Provisioning a device\", \"Starting Test\".\n\nDuring the course of execution new data may be appended\nto the end of progress_messages.\n@OutputOnly",
"description":"A test of an android application that explores the application on a virtual\nor physical Android Device, finding culprits and crashes as it goes.",
"description":"The max depth of the traversal stack Robo can explore. Needs to be at least\n2 to make Robo explore the app beyond the first activity.\nDefault is 50.\nOptional",
"description":"A set of directives Robo should apply during the crawl.\nThis allows users to customize the crawl. For example, the username and\npassword for a test account can be provided.\nOptional",
"description":"A test of an Android Application with a Test Loop.\nThe intent \u003cintent-name\u003e will be implicitly added, since Games is the only\nuser of this api, for the time being.",
"type":"object",
"properties":{
"scenarios":{
"description":"The list of scenarios that should be run during the test.\nOptional, default is all test loops, derived from the application's\nmanifest.",
"description":"The list of scenario labels that should be run during the test.\nThe scenario labels should map to labels defined in the application's\nmanifest. For example, player_experience and\ncom.google.test.loops.player_experience add all of the loops labeled in the\nmanifest with the com.google.test.loops.player_experience name to the\nexecution.\nOptional. Scenarios can also be specified in the scenarios field.",
"type":"array",
"items":{
"type":"string"
}
},
"appApk":{
"$ref":"FileReference",
"description":"The APK for the application under test.\nRequired"
"description":"Enables automatic Google account login.\nIf set, the service will automatically generate a Google test account and add\nit to the device, before executing the test. Note that test accounts might be\nreused.\nMany applications show their full set of functionalities when an account is\npresent on the device. Logging into the device with these generated accounts\nallows testing more functionalities.",
"type":"object",
"properties":{},
"id":"GoogleAuto"
},
"AndroidDeviceCatalog":{
"description":"The currently supported Android devices.",
"description":"Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
"type":"object",
"properties":{
"year":{
"description":"Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format":"int32",
"type":"integer"
},
"day":{
"description":"Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
"format":"int32",
"type":"integer"
},
"month":{
"description":"Month of year. Must be from 1 to 12.",
"The execution or matrix is waiting for resources to become available.",
"The execution is currently being processed.\n\nCan only be set on an execution.",
"The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
"The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
"The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
"The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
"The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
"The user cancelled the execution.\n\nCan only be set on an execution.",
"The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
"description":"A human-friendy string representing the region for this locale.\nExample: \"United States\"\nNot present for every locale.\n@OutputOnly",
"description":"Opaque Binary Blob (OBB) file(s) to install on the device\nRequired"
},
"obbFileName":{
"description":"OBB file name which must conform to the format as specified by\nAndroid\ne.g. [main|patch].0300110.com.example.android.obb\nwhich will be installed into\n \u003cshared-storage\u003e/Android/obb/\u003cpackage-name\u003e/\non the device\nRequired",
"description":"A test of an Android application that can control an Android component\nindependently of its normal lifecycle.\nAndroid instrumentation tests run an application APK and test APK inside the\nsame process on a virtual or physical AndroidDevice. They also specify\na test runner class, such as com.google.GoogleTestRunner, which can vary\non the specific instrumentation framework chosen.\n\nSee \u003chttp://developer.android.com/tools/testing/testing_android.html\u003e for\nmore information on types of Android tests.",
"This means that the server should choose the mode. And test will be run\nwithout orchestrator.\nUsing orchestrator is highly encouraged because of all the benefits it\noffers. And in the future, all instrumentation tests will be run with\norchestrator by default if preference unspecified.",
"Run test using orchestrator.\n** Only compatible with AndroidJUnitRunner version 1.0 or higher! **\nRecommended.",
"description":"The option of whether running each test within its own invocation of\ninstrumentation with Android Test Orchestrator or not.\n** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher! **\nOrchestrator offers the following benefits:\n - No shared state\n - Crashes are isolated\n - Logs are scoped per test\n\nSee\n\u003chttps://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator\u003e\nfor more information about Android Test Orchestrator.\n\nOptional, if empty, test will be run without orchestrator.",
"description":"Each target must be fully qualified with the package name or class name,\nin one of these formats:\n - \"package package_name\"\n - \"class package_name.class_name\"\n - \"class package_name.class_name#method_name\"\n\nOptional, if empty, all targets in the module will be run.",
"description":"Get the catalog of supported test environments.\n\nMay return any of the following canonical error codes:\n\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the environment type does not exist\n- INTERNAL - if an internal error occurred",
"description":"Check the status of a test matrix.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist",
"response":{
"$ref":"TestMatrix"
},
"parameterOrder":[
"projectId",
"testMatrixId"
],
"httpMethod":"GET",
"parameters":{
"projectId":{
"location":"path",
"description":"Cloud project that owns the test matrix.",
"required":true,
"type":"string"
},
"testMatrixId":{
"required":true,
"type":"string",
"location":"path",
"description":"Unique test matrix id which was assigned by the service."
"description":"Request to run a matrix of tests according to the given specifications.\nUnsupported environments will be returned in the state UNSUPPORTED.\nMatrices are limited to at most 200 supported executions.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project\n- INVALID_ARGUMENT - if the request is malformed or if the matrix expands\n to more than 200 supported executions",
"response":{
"$ref":"TestMatrix"
},
"parameterOrder":[
"projectId"
],
"httpMethod":"POST",
"parameters":{
"projectId":{
"location":"path",
"description":"The GCE project under which this job will run.",
"required":true,
"type":"string"
},
"requestId":{
"location":"query",
"description":"A string id used to detect duplicated requests.\nIds are automatically scoped to a project, so\nusers should ensure the ID is unique per-project.\nA UUID is recommended.\n\nOptional, but strongly recommended.",
"type":"string"
}
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath":"v1/projects/{projectId}/testMatrices"
},
"cancel":{
"response":{
"$ref":"CancelTestMatrixResponse"
},
"parameterOrder":[
"projectId",
"testMatrixId"
],
"httpMethod":"POST",
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters":{
"projectId":{
"description":"Cloud project that owns the test.",
"required":true,
"type":"string",
"location":"path"
},
"testMatrixId":{
"location":"path",
"description":"Test matrix that will be canceled.",
"description":"Cancels unfinished test executions in a test matrix.\nThis call returns immediately and cancellation proceeds asychronously.\nIf the matrix is already final, this operation will have no effect.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist"
