"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"
},
"bearer_token":{
"description":"OAuth bearer token.",
"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"
},
"pp":{
"default":"true",
"description":"Pretty-print response.",
"location":"query",
"type":"boolean"
},
"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\").",
"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",
"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",
"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.",
"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",
"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":"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.",
"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.",
"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":"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":"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.",
"description":"Screen size in the horizontal (X) dimension measured in pixels.\n@OutputOnly",
"format":"int32",
"type":"integer"
},
"screenY":{
"description":"Screen size in the vertical (Y) dimension measured in pixels.\n@OutputOnly",
"format":"int32",
"type":"integer"
},
"supportedAbis":{
"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":"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 APK for the application under test.\nRequired"
},
"appInitialActivity":{
"description":"The initial activity that should be used to start the app.\nOptional",
"type":"string"
},
"appPackageId":{
"description":"The java package for the application under test.\nOptional, default is determined by examining the application's manifest.",
"type":"string"
},
"maxDepth":{
"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",
"format":"int32",
"type":"integer"
},
"maxSteps":{
"description":"The max number of steps Robo can execute.\nDefault is no limit.\nOptional",
"format":"int32",
"type":"integer"
},
"roboDirectives":{
"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 JSON file with a sequence of actions Robo should perform as a prologue\nfor the crawl.\nOptional"
},
"startingIntents":{
"description":"The intents used to launch the app for the crawl.\nIf none are provided, then the main launcher activity is launched.\nIf some are provided, then only those provided are launched (the main\nlauncher activity must be provided explicitly).",
"description":"The set of available orientations.\n@OutputOnly",
"items":{
"$ref":"Orientation"
},
"type":"array"
}
},
"type":"object"
},
"AndroidTestLoop":{
"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.",
"id":"AndroidTestLoop",
"properties":{
"appApk":{
"$ref":"FileReference",
"description":"The APK for the application under test.\nRequired"
},
"appPackageId":{
"description":"The java package for the application under test.\nOptional, default is determined by examining the application's manifest.",
"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.",
"description":"The list of scenarios that should be run during the test.\nOptional, default is all test loops, derived from the application's\nmanifest.",
"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":"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":"Client name, such as gcloud.\nRequired",
"type":"string"
}
},
"type":"object"
},
"ClientInfoDetail":{
"description":"Key-value pair of detailed information about the client which invoked the\ntest. For example {'Version', '1.0'}, {'Release Track', 'BETA'}",
"id":"ClientInfoDetail",
"properties":{
"key":{
"description":"The key of detailed client information.\nRequired",
"type":"string"
},
"value":{
"description":"The value of detailed client information.\nRequired",
"type":"string"
}
},
"type":"object"
},
"Date":{
"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`.",
"id":"Date",
"properties":{
"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.",
"format":"int32",
"type":"integer"
},
"year":{
"description":"Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na 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"
},
"Distribution":{
"description":"Data about the relative number of devices running a\ngiven configuration of the Android platform.",
"id":"Distribution",
"properties":{
"marketShare":{
"description":"The estimated fraction (0-1) of the total market with this configuration.\n@OutputOnly",
"format":"double",
"type":"number"
},
"measurementTime":{
"description":"The time this distribution was measured.\n@OutputOnly",
"format":"google-datetime",
"type":"string"
}
},
"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."
"description":"Response containing the details of the specified Android application APK.",
"id":"GetApkDetailsResponse",
"properties":{
"apkDetail":{
"$ref":"ApkDetail",
"description":"Details of the Android APK."
}
},
"type":"object"
},
"GoogleAuto":{
"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.",
"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",
"description":"The \u003cintent-filter\u003e section of an \u003cactivity\u003e tag.\nhttps://developer.android.com/guide/topics/manifest/intent-filter-element.html",
"id":"IntentFilter",
"properties":{
"actionNames":{
"description":"The android:name value of the \u003caction\u003e tag",
"description":"A human-friendly string representing the region for this locale.\nExample: \"United States\"\nNot present for every locale.\n@OutputOnly",
"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":"Where to put the content on the device. Must be an absolute, whitelisted\npath. If the file exists, it will be replaced.\nThe following device-side directories and any of their subdirectories are\nwhitelisted:\n\u003cp\u003e${EXTERNAL_STORAGE}, or /sdcard\u003c/p\u003e\n\u003cp\u003e${ANDROID_DATA}/local/tmp, or /data/local/tmp\u003c/p\u003e\n\u003cp\u003eSpecifying a path outside of these directory trees is invalid.\n\n\u003cp\u003e 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 and copy the file there.\n\n\u003cp\u003e It is strongly advised to use the \u003ca href=\n\"http://developer.android.com/reference/android/os/Environment.html\"\u003e\nEnvironment API\u003c/a\u003e in app and test code to access files on the device in a\nportable way.\nRequired",
"description":"The tool results execution that results are written to.\n@OutputOnly"
},
"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."
"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.",
"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",
"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",
"description":"If the TestState is ERROR, then this string will contain human-readable\ndetails about the error.\n@OutputOnly",
"type":"string"
},
"progressMessages":{
"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":"Indicates that video will not be recorded for this execution either because\nthe user chose to disable it or the device does not support it.\nSee AndroidModel.video_recording_not_supported\n@OutputOnly",
"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":"Additional details about the running test.\n@OutputOnly"
},
"testSpecification":{
"$ref":"TestSpecification",
"description":"How to run the test.\n@OutputOnly"
},
"timestamp":{
"description":"The time this test execution was initially created.\n@OutputOnly",
"format":"google-datetime",
"type":"string"
},
"toolResultsStep":{
"$ref":"ToolResultsStep",
"description":"Where the results for this execution are written.\n@OutputOnly"
}
},
"type":"object"
},
"TestMatrix":{
"description":"A group of one or more TestExecutions, built by taking a\nproduct of values over a pre-defined set of axes.",
"id":"TestMatrix",
"properties":{
"clientInfo":{
"$ref":"ClientInfo",
"description":"Information about the client which invoked the test.\nOptional"
},
"environmentMatrix":{
"$ref":"EnvironmentMatrix",
"description":"How the host machine(s) are configured.\nRequired"
},
"invalidMatrixDetails":{
"description":"Describes why the matrix is considered invalid.\nOnly useful for matrices in the INVALID state.\n@OutputOnly",
"enum":[
"INVALID_MATRIX_DETAILS_UNSPECIFIED",
"DETAILS_UNAVAILABLE",
"MALFORMED_APK",
"MALFORMED_TEST_APK",
"NO_MANIFEST",
"NO_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",
"TEST_LOOP_INTENT_FILTER_NOT_FOUND",
"SCENARIO_LABEL_NOT_DECLARED",
"SCENARIO_LABEL_MALFORMED",
"SCENARIO_NOT_DECLARED",
"DEVICE_ADMIN_RECEIVER",
"TEST_ONLY_APK",
"NO_CODE_APK"
],
"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 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 APK is marked as \"testOnly\".\nNOT USED",
"APK contains no code.\nSee also\nhttps://developer.android.com/guide/topics/manifest/application-element.html#code"
],
"type":"string"
},
"projectId":{
"description":"The cloud project that owns the test matrix.\n@OutputOnly",
"type":"string"
},
"resultStorage":{
"$ref":"ResultStorage",
"description":"Where the results for the matrix are written.\nRequired"
},
"state":{
"description":"Indicates the current progress of the test matrix (e.g., FINISHED)\n@OutputOnly",
"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":"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",
"description":"An Android Application with a Test Loop"
},
"autoGoogleLogin":{
"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",
"type":"boolean"
},
"disablePerformanceMetrics":{
"description":"Disables performance metrics recording; may reduce test latency.",
"type":"boolean"
},
"disableVideoRecording":{
"description":"Disables video recording; may reduce test latency.",
"type":"boolean"
},
"testSetup":{
"$ref":"TestSetup",
"description":"Test setup requirements for Android e.g. files to install, bootstrap\nscripts.\nOptional"
},
"testTimeout":{
"description":"Max time a test execution is allowed to run before it is\nautomatically cancelled.\nOptional, default is 5 min.",
