blob: ed68f75e689734e6fa2212b81fbad690e762e2fa [file] [log] [blame] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="firebaseappdistribution_v1alpha.html">Firebase App Distribution API</a> . <a href="firebaseappdistribution_v1alpha.projects.html">projects</a> . <a href="firebaseappdistribution_v1alpha.projects.apps.html">apps</a> . <a href="firebaseappdistribution_v1alpha.projects.apps.releases.html">releases</a> . <a href="firebaseappdistribution_v1alpha.projects.apps.releases.tests.html">tests</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#cancel">cancel(name, x__xgafv=None)</a></code></p>
<p class="firstline">Abort automated test run on release.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, releaseTestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Run automated test(s) on release.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get results for automated test run on release.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">List results for automated tests run on release.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="cancel">cancel(name, x__xgafv=None)</code>
<pre>Abort automated test run on release.
Args:
name: string, Required. The name of the release test resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}/tests/{test_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The (empty) response message for `CancelReleaseTest`.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, releaseTestId=None, x__xgafv=None)</code>
<pre>Run automated test(s) on release.
Args:
parent: string, Required. The name of the release resource, which is the parent of the test Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}` (required)
body: object, The request body.
The object takes the form of:
{ # The results of running an automated test on a release.
&quot;aiInstructions&quot;: { # Optional. Instructions for AI driven test.
&quot;steps&quot;: [ # Required. Steps to be accomplished by the AI
{ # A step to be accomplished by the AI
&quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
&quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
&quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
&quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
},
],
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the test was run.
&quot;deviceExecutions&quot;: [ # Required. The results of the test on each device.
{ # The results of running an automated test on a particular device.
&quot;aiStepResults&quot;: [ # Output only. Results of the AI steps if passed in
{ # Captures the results of an AiStep
&quot;assertionDetails&quot;: { # Details for an assertion step. # Output only. Details for an assertion step.
&quot;explanation&quot;: &quot;A String&quot;, # Output only. An explanation justifying the assertion result.
&quot;result&quot;: True or False, # Output only. The result of the assertion.
&quot;screenshot&quot;: { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this assertion.
&quot;height&quot;: 42, # Output only. The height of the screenshot, in pixels.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The URI of the screenshot.
&quot;width&quot;: 42, # Output only. The width of the screenshot, in pixels.
},
},
&quot;goalDetails&quot;: { # Details for a goal step. # Output only. Details for a goal step.
&quot;goalActions&quot;: [ # Output only. The actions taken by the AI while attempting to accomplish the goal.
{ # An action taken by the AI agent while attempting to accomplish a goal.
&quot;debugInfo&quot;: { # Information to help the customer understand why the agent took this action # Output only. Debug information explaining why the agent to the specific action
&quot;annotatedScreenshotUri&quot;: &quot;A String&quot;, # Output only. URI of the screenshot with elements labeled which was used by the agent
&quot;jsonUri&quot;: &quot;A String&quot;, # Output only. Structured data explaining the agent&#x27;s choice
},
&quot;deviceAction&quot;: { # A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc. # Output only. A high level action taken by the AI on the device.
&quot;description&quot;: &quot;A String&quot;, # Output only. A short description of the high level action taken by the AI agent.
&quot;deviceInteractions&quot;: [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc.
{ # An interaction with the device, such as a tap, text entry, wait, etc.
&quot;enterText&quot;: { # A text entry action, that enters text into a particular text field, clearing any existing text in the field. # Output only. A text entry action, that enters text into a particular text field, clearing any existing text in the field. Unlike `text_input` this action does not require any other actions such as a tap to be performed before it can enter the text.
&quot;elementBounds&quot;: { # Rectangle for describing bounding boxes # Output only. The visible bounds of the element to enter text into.
&quot;bottom&quot;: 42,
&quot;left&quot;: 42,
&quot;right&quot;: 42,
&quot;top&quot;: 42,
},
&quot;text&quot;: &quot;A String&quot;, # Output only. The text to enter.
},
&quot;keyCode&quot;: &quot;A String&quot;, # Output only. Key code for a key event action.
&quot;screenshot&quot;: { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken.
&quot;height&quot;: 42, # Output only. The height of the screenshot, in pixels.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The URI of the screenshot.
&quot;width&quot;: 42, # Output only. The width of the screenshot, in pixels.
},
&quot;swipe&quot;: { # A swipe action. # Output only. A swipe action.
&quot;end&quot;: { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The end point of the swipe.
&quot;xCoordinate&quot;: 42,
&quot;yCoordinate&quot;: 42,
},
&quot;start&quot;: { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The start point of the swipe.
&quot;xCoordinate&quot;: 42,
&quot;yCoordinate&quot;: 42,
},
},
&quot;tap&quot;: { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. A tap action.
&quot;xCoordinate&quot;: 42,
&quot;yCoordinate&quot;: 42,
},
&quot;textInput&quot;: &quot;A String&quot;, # Output only. A text input action, that types some text into whatever field is currently focused, if any. Unlike `enter_text` this action requires that the field be brought into focus first, for example by emitting a tap action before this one.
&quot;wait&quot;: { # A wait action. # Output only. A wait action.
&quot;duration&quot;: &quot;A String&quot;, # Output only. The duration of the wait.
},
},
],
},
&quot;explanation&quot;: &quot;A String&quot;, # Output only. An explanation justifying why the action was taken.
&quot;terminalAction&quot;: { # An action taken by the AI to end the goal. # Output only. An action taken by the AI to end the goal.
&quot;reason&quot;: &quot;A String&quot;, # Output only. The reason why this goal was ended.
&quot;screenshot&quot;: { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this terminal action.
&quot;height&quot;: 42, # Output only. The height of the screenshot, in pixels.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The URI of the screenshot.
&quot;width&quot;: 42, # Output only. The width of the screenshot, in pixels.
},
},
},
],
},
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the step
&quot;step&quot;: { # A step to be accomplished by the AI # Required. The step performed by the AI
&quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
&quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
&quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
&quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
},
},
],
&quot;appCrash&quot;: { # An app crash that occurred during an automated test. # Output only. An app crash, if any occurred during the test.
&quot;message&quot;: &quot;A String&quot;, # Output only. The message associated with the crash.
&quot;stackTrace&quot;: &quot;A String&quot;, # Output only. The raw stack trace.
},
&quot;crawlGraphUri&quot;: &quot;A String&quot;, # Output only. A URI to an image of the Robo crawl graph.
&quot;device&quot;: { # A device on which automated tests can be run. # Required. The device that the test was run on.
&quot;locale&quot;: &quot;A String&quot;, # Optional. The locale of the device (e.g. &quot;en_US&quot; for US English) during the test.
&quot;model&quot;: &quot;A String&quot;, # Required. The device model.
&quot;orientation&quot;: &quot;A String&quot;, # Optional. The orientation of the device during the test.
&quot;version&quot;: &quot;A String&quot;, # Required. The version of the device (API level on Android).
},
&quot;failedReason&quot;: &quot;A String&quot;, # Output only. The reason why the test failed.
&quot;inconclusiveReason&quot;: &quot;A String&quot;, # Output only. The reason why the test was inconclusive.
&quot;resultsStoragePath&quot;: &quot;A String&quot;, # Output only. The path to a directory in Cloud Storage that will eventually contain the results for this execution. For example, gs://bucket/Nexus5-18-en-portrait.
&quot;roboStats&quot;: { # Statistics collected during a Robo test. # Output only. The statistics collected during the Robo test.
&quot;actionsPerformed&quot;: 42, # Output only. Number of actions that crawler performed.
&quot;crawlDuration&quot;: &quot;A String&quot;, # Output only. Duration of crawl.
&quot;distinctVisitedScreens&quot;: 42, # Output only. Number of distinct screens visited.
&quot;mainActivityCrawlTimedOut&quot;: True or False, # Output only. Whether the main activity crawl timed out.
},
&quot;screenshotUris&quot;: [ # Output only. A list of screenshot image URIs taken from the Robo crawl. The file names are numbered by the order in which they were taken.
&quot;A String&quot;,
],
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the test.
&quot;videoUri&quot;: &quot;A String&quot;, # Output only. A URI to a video of the test run.
},
],
&quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the release test. Required if the release test is created with multiple goals.
&quot;loginCredential&quot;: { # Login credential for automated tests # Optional. Input only. Login credentials for the test. Input only.
&quot;fieldHints&quot;: { # Hints to the crawler for identifying input fields # Optional. Hints to the crawler for identifying input fields
&quot;passwordResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the password UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
&quot;usernameResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the username UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
},
&quot;google&quot;: True or False, # Optional. Are these credentials for Google?
&quot;password&quot;: &quot;A String&quot;, # Optional. Password for automated tests
&quot;username&quot;: &quot;A String&quot;, # Optional. Username for automated tests
},
&quot;name&quot;: &quot;A String&quot;, # The name of the release test resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}/tests/{test_id}`
&quot;testCase&quot;: &quot;A String&quot;, # Optional. The test case that was used to generate this release test. Note: The test case may have changed or been deleted since the release test was created. Format: `projects/{project_number}/apps/{app}/testCases/{test_case}`
&quot;testState&quot;: &quot;A String&quot;, # Output only. The state of the release test.
}
releaseTestId: string, Optional. The ID to use for the test, which will become the final component of the test&#x27;s resource name. This value should be 4-63 characters, and valid characters are /a-z-/. If it is not provided one will be automatically generated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The results of running an automated test on a release.
&quot;aiInstructions&quot;: { # Optional. Instructions for AI driven test.
&quot;steps&quot;: [ # Required. Steps to be accomplished by the AI
{ # A step to be accomplished by the AI
&quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
&quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
&quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
&quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
},
],
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the test was run.
&quot;deviceExecutions&quot;: [ # Required. The results of the test on each device.
{ # The results of running an automated test on a particular device.
&quot;aiStepResults&quot;: [ # Output only. Results of the AI steps if passed in
{ # Captures the results of an AiStep
&quot;assertionDetails&quot;: { # Details for an assertion step. # Output only. Details for an assertion step.
&quot;explanation&quot;: &quot;A String&quot;, # Output only. An explanation justifying the assertion result.
&quot;result&quot;: True or False, # Output only. The result of the assertion.
&quot;screenshot&quot;: { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this assertion.
&quot;height&quot;: 42, # Output only. The height of the screenshot, in pixels.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The URI of the screenshot.
&quot;width&quot;: 42, # Output only. The width of the screenshot, in pixels.
},
},
&quot;goalDetails&quot;: { # Details for a goal step. # Output only. Details for a goal step.
&quot;goalActions&quot;: [ # Output only. The actions taken by the AI while attempting to accomplish the goal.
{ # An action taken by the AI agent while attempting to accomplish a goal.
&quot;debugInfo&quot;: { # Information to help the customer understand why the agent took this action # Output only. Debug information explaining why the agent to the specific action
&quot;annotatedScreenshotUri&quot;: &quot;A String&quot;, # Output only. URI of the screenshot with elements labeled which was used by the agent
&quot;jsonUri&quot;: &quot;A String&quot;, # Output only. Structured data explaining the agent&#x27;s choice
},
&quot;deviceAction&quot;: { # A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc. # Output only. A high level action taken by the AI on the device.
&quot;description&quot;: &quot;A String&quot;, # Output only. A short description of the high level action taken by the AI agent.
&quot;deviceInteractions&quot;: [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc.
{ # An interaction with the device, such as a tap, text entry, wait, etc.
&quot;enterText&quot;: { # A text entry action, that enters text into a particular text field, clearing any existing text in the field. # Output only. A text entry action, that enters text into a particular text field, clearing any existing text in the field. Unlike `text_input` this action does not require any other actions such as a tap to be performed before it can enter the text.
&quot;elementBounds&quot;: { # Rectangle for describing bounding boxes # Output only. The visible bounds of the element to enter text into.
&quot;bottom&quot;: 42,
&quot;left&quot;: 42,
&quot;right&quot;: 42,
&quot;top&quot;: 42,
},
&quot;text&quot;: &quot;A String&quot;, # Output only. The text to enter.
},
&quot;keyCode&quot;: &quot;A String&quot;, # Output only. Key code for a key event action.
&quot;screenshot&quot;: { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken.
&quot;height&quot;: 42, # Output only. The height of the screenshot, in pixels.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The URI of the screenshot.
&quot;width&quot;: 42, # Output only. The width of the screenshot, in pixels.
},
&quot;swipe&quot;: { # A swipe action. # Output only. A swipe action.
&quot;end&quot;: { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The end point of the swipe.
&quot;xCoordinate&quot;: 42,
&quot;yCoordinate&quot;: 42,
},
&quot;start&quot;: { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The start point of the swipe.
&quot;xCoordinate&quot;: 42,
&quot;yCoordinate&quot;: 42,
},
},
&quot;tap&quot;: { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. A tap action.
&quot;xCoordinate&quot;: 42,
&quot;yCoordinate&quot;: 42,
},
&quot;textInput&quot;: &quot;A String&quot;, # Output only. A text input action, that types some text into whatever field is currently focused, if any. Unlike `enter_text` this action requires that the field be brought into focus first, for example by emitting a tap action before this one.
&quot;wait&quot;: { # A wait action. # Output only. A wait action.
&quot;duration&quot;: &quot;A String&quot;, # Output only. The duration of the wait.
},
},
],
},
&quot;explanation&quot;: &quot;A String&quot;, # Output only. An explanation justifying why the action was taken.
&quot;terminalAction&quot;: { # An action taken by the AI to end the goal. # Output only. An action taken by the AI to end the goal.
&quot;reason&quot;: &quot;A String&quot;, # Output only. The reason why this goal was ended.
&quot;screenshot&quot;: { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this terminal action.
&quot;height&quot;: 42, # Output only. The height of the screenshot, in pixels.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The URI of the screenshot.
&quot;width&quot;: 42, # Output only. The width of the screenshot, in pixels.
},
},
},
],
},
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the step
&quot;step&quot;: { # A step to be accomplished by the AI # Required. The step performed by the AI
&quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
&quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
&quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
&quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
},
},
],
&quot;appCrash&quot;: { # An app crash that occurred during an automated test. # Output only. An app crash, if any occurred during the test.
&quot;message&quot;: &quot;A String&quot;, # Output only. The message associated with the crash.
&quot;stackTrace&quot;: &quot;A String&quot;, # Output only. The raw stack trace.
},
&quot;crawlGraphUri&quot;: &quot;A String&quot;, # Output only. A URI to an image of the Robo crawl graph.
&quot;device&quot;: { # A device on which automated tests can be run. # Required. The device that the test was run on.
&quot;locale&quot;: &quot;A String&quot;, # Optional. The locale of the device (e.g. &quot;en_US&quot; for US English) during the test.
&quot;model&quot;: &quot;A String&quot;, # Required. The device model.
&quot;orientation&quot;: &quot;A String&quot;, # Optional. The orientation of the device during the test.
&quot;version&quot;: &quot;A String&quot;, # Required. The version of the device (API level on Android).
},
&quot;failedReason&quot;: &quot;A String&quot;, # Output only. The reason why the test failed.
&quot;inconclusiveReason&quot;: &quot;A String&quot;, # Output only. The reason why the test was inconclusive.
&quot;resultsStoragePath&quot;: &quot;A String&quot;, # Output only. The path to a directory in Cloud Storage that will eventually contain the results for this execution. For example, gs://bucket/Nexus5-18-en-portrait.
&quot;roboStats&quot;: { # Statistics collected during a Robo test. # Output only. The statistics collected during the Robo test.
&quot;actionsPerformed&quot;: 42, # Output only. Number of actions that crawler performed.
&quot;crawlDuration&quot;: &quot;A String&quot;, # Output only. Duration of crawl.
&quot;distinctVisitedScreens&quot;: 42, # Output only. Number of distinct screens visited.
&quot;mainActivityCrawlTimedOut&quot;: True or False, # Output only. Whether the main activity crawl timed out.
},
&quot;screenshotUris&quot;: [ # Output only. A list of screenshot image URIs taken from the Robo crawl. The file names are numbered by the order in which they were taken.
&quot;A String&quot;,
],
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the test.
&quot;videoUri&quot;: &quot;A String&quot;, # Output only. A URI to a video of the test run.
},
],
&quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the release test. Required if the release test is created with multiple goals.
&quot;loginCredential&quot;: { # Login credential for automated tests # Optional. Input only. Login credentials for the test. Input only.
&quot;fieldHints&quot;: { # Hints to the crawler for identifying input fields # Optional. Hints to the crawler for identifying input fields
&quot;passwordResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the password UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
&quot;usernameResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the username UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
},
&quot;google&quot;: True or False, # Optional. Are these credentials for Google?
&quot;password&quot;: &quot;A String&quot;, # Optional. Password for automated tests
&quot;username&quot;: &quot;A String&quot;, # Optional. Username for automated tests
},
&quot;name&quot;: &quot;A String&quot;, # The name of the release test resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}/tests/{test_id}`
&quot;testCase&quot;: &quot;A String&quot;, # Optional. The test case that was used to generate this release test. Note: The test case may have changed or been deleted since the release test was created. Format: `projects/{project_number}/apps/{app}/testCases/{test_case}`
&quot;testState&quot;: &quot;A String&quot;, # Output only. The state of the release test.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get results for automated test run on release.
Args:
name: string, Required. The name of the release test resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}/tests/{test_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The results of running an automated test on a release.
&quot;aiInstructions&quot;: { # Optional. Instructions for AI driven test.
&quot;steps&quot;: [ # Required. Steps to be accomplished by the AI
{ # A step to be accomplished by the AI
&quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
&quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
&quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
&quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
},
],
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the test was run.
&quot;deviceExecutions&quot;: [ # Required. The results of the test on each device.
{ # The results of running an automated test on a particular device.
&quot;aiStepResults&quot;: [ # Output only. Results of the AI steps if passed in
{ # Captures the results of an AiStep
&quot;assertionDetails&quot;: { # Details for an assertion step. # Output only. Details for an assertion step.
&quot;explanation&quot;: &quot;A String&quot;, # Output only. An explanation justifying the assertion result.
&quot;result&quot;: True or False, # Output only. The result of the assertion.
&quot;screenshot&quot;: { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this assertion.
&quot;height&quot;: 42, # Output only. The height of the screenshot, in pixels.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The URI of the screenshot.
&quot;width&quot;: 42, # Output only. The width of the screenshot, in pixels.
},
},
&quot;goalDetails&quot;: { # Details for a goal step. # Output only. Details for a goal step.
&quot;goalActions&quot;: [ # Output only. The actions taken by the AI while attempting to accomplish the goal.
{ # An action taken by the AI agent while attempting to accomplish a goal.
&quot;debugInfo&quot;: { # Information to help the customer understand why the agent took this action # Output only. Debug information explaining why the agent to the specific action
&quot;annotatedScreenshotUri&quot;: &quot;A String&quot;, # Output only. URI of the screenshot with elements labeled which was used by the agent
&quot;jsonUri&quot;: &quot;A String&quot;, # Output only. Structured data explaining the agent&#x27;s choice
},
&quot;deviceAction&quot;: { # A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc. # Output only. A high level action taken by the AI on the device.
&quot;description&quot;: &quot;A String&quot;, # Output only. A short description of the high level action taken by the AI agent.
&quot;deviceInteractions&quot;: [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc.
{ # An interaction with the device, such as a tap, text entry, wait, etc.
&quot;enterText&quot;: { # A text entry action, that enters text into a particular text field, clearing any existing text in the field. # Output only. A text entry action, that enters text into a particular text field, clearing any existing text in the field. Unlike `text_input` this action does not require any other actions such as a tap to be performed before it can enter the text.
&quot;elementBounds&quot;: { # Rectangle for describing bounding boxes # Output only. The visible bounds of the element to enter text into.
&quot;bottom&quot;: 42,
&quot;left&quot;: 42,
&quot;right&quot;: 42,
&quot;top&quot;: 42,
},
&quot;text&quot;: &quot;A String&quot;, # Output only. The text to enter.
},
&quot;keyCode&quot;: &quot;A String&quot;, # Output only. Key code for a key event action.
&quot;screenshot&quot;: { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken.
&quot;height&quot;: 42, # Output only. The height of the screenshot, in pixels.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The URI of the screenshot.
&quot;width&quot;: 42, # Output only. The width of the screenshot, in pixels.
},
&quot;swipe&quot;: { # A swipe action. # Output only. A swipe action.
&quot;end&quot;: { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The end point of the swipe.
&quot;xCoordinate&quot;: 42,
&quot;yCoordinate&quot;: 42,
},
&quot;start&quot;: { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The start point of the swipe.
&quot;xCoordinate&quot;: 42,
&quot;yCoordinate&quot;: 42,
},
},
&quot;tap&quot;: { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. A tap action.
&quot;xCoordinate&quot;: 42,
&quot;yCoordinate&quot;: 42,
},
&quot;textInput&quot;: &quot;A String&quot;, # Output only. A text input action, that types some text into whatever field is currently focused, if any. Unlike `enter_text` this action requires that the field be brought into focus first, for example by emitting a tap action before this one.
&quot;wait&quot;: { # A wait action. # Output only. A wait action.
&quot;duration&quot;: &quot;A String&quot;, # Output only. The duration of the wait.
},
},
],
},
&quot;explanation&quot;: &quot;A String&quot;, # Output only. An explanation justifying why the action was taken.
&quot;terminalAction&quot;: { # An action taken by the AI to end the goal. # Output only. An action taken by the AI to end the goal.
&quot;reason&quot;: &quot;A String&quot;, # Output only. The reason why this goal was ended.
&quot;screenshot&quot;: { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this terminal action.
&quot;height&quot;: 42, # Output only. The height of the screenshot, in pixels.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The URI of the screenshot.
&quot;width&quot;: 42, # Output only. The width of the screenshot, in pixels.
},
},
},
],
},
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the step
&quot;step&quot;: { # A step to be accomplished by the AI # Required. The step performed by the AI
&quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
&quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
&quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
&quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
},
},
],
&quot;appCrash&quot;: { # An app crash that occurred during an automated test. # Output only. An app crash, if any occurred during the test.
&quot;message&quot;: &quot;A String&quot;, # Output only. The message associated with the crash.
&quot;stackTrace&quot;: &quot;A String&quot;, # Output only. The raw stack trace.
},
&quot;crawlGraphUri&quot;: &quot;A String&quot;, # Output only. A URI to an image of the Robo crawl graph.
&quot;device&quot;: { # A device on which automated tests can be run. # Required. The device that the test was run on.
&quot;locale&quot;: &quot;A String&quot;, # Optional. The locale of the device (e.g. &quot;en_US&quot; for US English) during the test.
&quot;model&quot;: &quot;A String&quot;, # Required. The device model.
&quot;orientation&quot;: &quot;A String&quot;, # Optional. The orientation of the device during the test.
&quot;version&quot;: &quot;A String&quot;, # Required. The version of the device (API level on Android).
},
&quot;failedReason&quot;: &quot;A String&quot;, # Output only. The reason why the test failed.
&quot;inconclusiveReason&quot;: &quot;A String&quot;, # Output only. The reason why the test was inconclusive.
&quot;resultsStoragePath&quot;: &quot;A String&quot;, # Output only. The path to a directory in Cloud Storage that will eventually contain the results for this execution. For example, gs://bucket/Nexus5-18-en-portrait.
&quot;roboStats&quot;: { # Statistics collected during a Robo test. # Output only. The statistics collected during the Robo test.
&quot;actionsPerformed&quot;: 42, # Output only. Number of actions that crawler performed.
&quot;crawlDuration&quot;: &quot;A String&quot;, # Output only. Duration of crawl.
&quot;distinctVisitedScreens&quot;: 42, # Output only. Number of distinct screens visited.
&quot;mainActivityCrawlTimedOut&quot;: True or False, # Output only. Whether the main activity crawl timed out.
},
&quot;screenshotUris&quot;: [ # Output only. A list of screenshot image URIs taken from the Robo crawl. The file names are numbered by the order in which they were taken.
&quot;A String&quot;,
],
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the test.
&quot;videoUri&quot;: &quot;A String&quot;, # Output only. A URI to a video of the test run.
},
],
&quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the release test. Required if the release test is created with multiple goals.
&quot;loginCredential&quot;: { # Login credential for automated tests # Optional. Input only. Login credentials for the test. Input only.
&quot;fieldHints&quot;: { # Hints to the crawler for identifying input fields # Optional. Hints to the crawler for identifying input fields
&quot;passwordResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the password UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
&quot;usernameResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the username UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
},
&quot;google&quot;: True or False, # Optional. Are these credentials for Google?
&quot;password&quot;: &quot;A String&quot;, # Optional. Password for automated tests
&quot;username&quot;: &quot;A String&quot;, # Optional. Username for automated tests
},
&quot;name&quot;: &quot;A String&quot;, # The name of the release test resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}/tests/{test_id}`
&quot;testCase&quot;: &quot;A String&quot;, # Optional. The test case that was used to generate this release test. Note: The test case may have changed or been deleted since the release test was created. Format: `projects/{project_number}/apps/{app}/testCases/{test_case}`
&quot;testState&quot;: &quot;A String&quot;, # Output only. The state of the release test.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>List results for automated tests run on release.
Args:
parent: string, Required. The name of the release resource, which is the parent of the tests Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}` (required)
pageSize: integer, Optional. The maximum number of tests to return. The service may return fewer than this value.
pageToken: string, Optional. A page token, received from a previous `ListReleaseTests` call. Provide this to retrieve the subsequent page.
view: string, Optional. The requested view on the returned ReleaseTests. Defaults to the basic view.
Allowed values
RELEASE_TEST_VIEW_UNSPECIFIED - The default / unset value. The default view depends on the RPC.
RELEASE_TEST_VIEW_BASIC - Include basic metadata about the release test and its status, but not the full result details. This is the default value for ListReleaseTests.
RELEASE_TEST_VIEW_FULL - Include everything.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for `ListReleaseTests`.
&quot;nextPageToken&quot;: &quot;A String&quot;, # A short-lived token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.
&quot;releaseTests&quot;: [ # The tests listed.
{ # The results of running an automated test on a release.
&quot;aiInstructions&quot;: { # Optional. Instructions for AI driven test.
&quot;steps&quot;: [ # Required. Steps to be accomplished by the AI
{ # A step to be accomplished by the AI
&quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
&quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
&quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
&quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
},
],
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the test was run.
&quot;deviceExecutions&quot;: [ # Required. The results of the test on each device.
{ # The results of running an automated test on a particular device.
&quot;aiStepResults&quot;: [ # Output only. Results of the AI steps if passed in
{ # Captures the results of an AiStep
&quot;assertionDetails&quot;: { # Details for an assertion step. # Output only. Details for an assertion step.
&quot;explanation&quot;: &quot;A String&quot;, # Output only. An explanation justifying the assertion result.
&quot;result&quot;: True or False, # Output only. The result of the assertion.
&quot;screenshot&quot;: { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this assertion.
&quot;height&quot;: 42, # Output only. The height of the screenshot, in pixels.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The URI of the screenshot.
&quot;width&quot;: 42, # Output only. The width of the screenshot, in pixels.
},
},
&quot;goalDetails&quot;: { # Details for a goal step. # Output only. Details for a goal step.
&quot;goalActions&quot;: [ # Output only. The actions taken by the AI while attempting to accomplish the goal.
{ # An action taken by the AI agent while attempting to accomplish a goal.
&quot;debugInfo&quot;: { # Information to help the customer understand why the agent took this action # Output only. Debug information explaining why the agent to the specific action
&quot;annotatedScreenshotUri&quot;: &quot;A String&quot;, # Output only. URI of the screenshot with elements labeled which was used by the agent
&quot;jsonUri&quot;: &quot;A String&quot;, # Output only. Structured data explaining the agent&#x27;s choice
},
&quot;deviceAction&quot;: { # A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc. # Output only. A high level action taken by the AI on the device.
&quot;description&quot;: &quot;A String&quot;, # Output only. A short description of the high level action taken by the AI agent.
&quot;deviceInteractions&quot;: [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc.
{ # An interaction with the device, such as a tap, text entry, wait, etc.
&quot;enterText&quot;: { # A text entry action, that enters text into a particular text field, clearing any existing text in the field. # Output only. A text entry action, that enters text into a particular text field, clearing any existing text in the field. Unlike `text_input` this action does not require any other actions such as a tap to be performed before it can enter the text.
&quot;elementBounds&quot;: { # Rectangle for describing bounding boxes # Output only. The visible bounds of the element to enter text into.
&quot;bottom&quot;: 42,
&quot;left&quot;: 42,
&quot;right&quot;: 42,
&quot;top&quot;: 42,
},
&quot;text&quot;: &quot;A String&quot;, # Output only. The text to enter.
},
&quot;keyCode&quot;: &quot;A String&quot;, # Output only. Key code for a key event action.
&quot;screenshot&quot;: { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken.
&quot;height&quot;: 42, # Output only. The height of the screenshot, in pixels.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The URI of the screenshot.
&quot;width&quot;: 42, # Output only. The width of the screenshot, in pixels.
},
&quot;swipe&quot;: { # A swipe action. # Output only. A swipe action.
&quot;end&quot;: { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The end point of the swipe.
&quot;xCoordinate&quot;: 42,
&quot;yCoordinate&quot;: 42,
},
&quot;start&quot;: { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The start point of the swipe.
&quot;xCoordinate&quot;: 42,
&quot;yCoordinate&quot;: 42,
},
},
&quot;tap&quot;: { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. A tap action.
&quot;xCoordinate&quot;: 42,
&quot;yCoordinate&quot;: 42,
},
&quot;textInput&quot;: &quot;A String&quot;, # Output only. A text input action, that types some text into whatever field is currently focused, if any. Unlike `enter_text` this action requires that the field be brought into focus first, for example by emitting a tap action before this one.
&quot;wait&quot;: { # A wait action. # Output only. A wait action.
&quot;duration&quot;: &quot;A String&quot;, # Output only. The duration of the wait.
},
},
],
},
&quot;explanation&quot;: &quot;A String&quot;, # Output only. An explanation justifying why the action was taken.
&quot;terminalAction&quot;: { # An action taken by the AI to end the goal. # Output only. An action taken by the AI to end the goal.
&quot;reason&quot;: &quot;A String&quot;, # Output only. The reason why this goal was ended.
&quot;screenshot&quot;: { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this terminal action.
&quot;height&quot;: 42, # Output only. The height of the screenshot, in pixels.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The URI of the screenshot.
&quot;width&quot;: 42, # Output only. The width of the screenshot, in pixels.
},
},
},
],
},
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the step
&quot;step&quot;: { # A step to be accomplished by the AI # Required. The step performed by the AI
&quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
&quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
&quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
&quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
},
},
],
&quot;appCrash&quot;: { # An app crash that occurred during an automated test. # Output only. An app crash, if any occurred during the test.
&quot;message&quot;: &quot;A String&quot;, # Output only. The message associated with the crash.
&quot;stackTrace&quot;: &quot;A String&quot;, # Output only. The raw stack trace.
},
&quot;crawlGraphUri&quot;: &quot;A String&quot;, # Output only. A URI to an image of the Robo crawl graph.
&quot;device&quot;: { # A device on which automated tests can be run. # Required. The device that the test was run on.
&quot;locale&quot;: &quot;A String&quot;, # Optional. The locale of the device (e.g. &quot;en_US&quot; for US English) during the test.
&quot;model&quot;: &quot;A String&quot;, # Required. The device model.
&quot;orientation&quot;: &quot;A String&quot;, # Optional. The orientation of the device during the test.
&quot;version&quot;: &quot;A String&quot;, # Required. The version of the device (API level on Android).
},
&quot;failedReason&quot;: &quot;A String&quot;, # Output only. The reason why the test failed.
&quot;inconclusiveReason&quot;: &quot;A String&quot;, # Output only. The reason why the test was inconclusive.
&quot;resultsStoragePath&quot;: &quot;A String&quot;, # Output only. The path to a directory in Cloud Storage that will eventually contain the results for this execution. For example, gs://bucket/Nexus5-18-en-portrait.
&quot;roboStats&quot;: { # Statistics collected during a Robo test. # Output only. The statistics collected during the Robo test.
&quot;actionsPerformed&quot;: 42, # Output only. Number of actions that crawler performed.
&quot;crawlDuration&quot;: &quot;A String&quot;, # Output only. Duration of crawl.
&quot;distinctVisitedScreens&quot;: 42, # Output only. Number of distinct screens visited.
&quot;mainActivityCrawlTimedOut&quot;: True or False, # Output only. Whether the main activity crawl timed out.
},
&quot;screenshotUris&quot;: [ # Output only. A list of screenshot image URIs taken from the Robo crawl. The file names are numbered by the order in which they were taken.
&quot;A String&quot;,
],
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the test.
&quot;videoUri&quot;: &quot;A String&quot;, # Output only. A URI to a video of the test run.
},
],
&quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the release test. Required if the release test is created with multiple goals.
&quot;loginCredential&quot;: { # Login credential for automated tests # Optional. Input only. Login credentials for the test. Input only.
&quot;fieldHints&quot;: { # Hints to the crawler for identifying input fields # Optional. Hints to the crawler for identifying input fields
&quot;passwordResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the password UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
&quot;usernameResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the username UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
},
&quot;google&quot;: True or False, # Optional. Are these credentials for Google?
&quot;password&quot;: &quot;A String&quot;, # Optional. Password for automated tests
&quot;username&quot;: &quot;A String&quot;, # Optional. Username for automated tests
},
&quot;name&quot;: &quot;A String&quot;, # The name of the release test resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}/tests/{test_id}`
&quot;testCase&quot;: &quot;A String&quot;, # Optional. The test case that was used to generate this release test. Note: The test case may have changed or been deleted since the release test was created. Format: `projects/{project_number}/apps/{app}/testCases/{test_case}`
&quot;testState&quot;: &quot;A String&quot;, # Output only. The state of the release test.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>