Device Run API (devicerun:v1alpha)

2026-09-24

15 new methods | New API

Additions

    Methods
  • ▼ ▲ devicerun.projects.locations.list

      HTTP Method : GET

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : name

      Parameters :

        pageSize

          Format : int32

          Location : query

          Type : integer

          Description : The maximum number of results to return. If not set, the service selects a default.

        extraLocationTypes

          Description : Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.

          Location : query

          Repeated : Yes

          Type : string

        pageToken

          Location : query

          Type : string

          Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

        filter

          Type : string

          Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

          Location : query

        name

          Type : string

          Pattern : ^projects/[^/]+$

          Location : path

          Description : The resource that owns the locations collection, if applicable.

          Required : Yes

      Flat Path : v1alpha/projects/{projectsId}/locations

      Path : v1alpha/{+name}/locations

      Description : Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

  • ▼ ▲ devicerun.projects.locations.get

      Description : Gets information about a location.

      Parameter Order : name

      HTTP Method : GET

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}

      Parameters :

        name

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Required : Yes

          Type : string

          Description : Resource name for the location.

      Path : v1alpha/{+name}

  • ▼ ▲ devicerun.projects.locations.devices.get

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : name

      HTTP Method : GET

      Path : v1alpha/{+name}

      Description : Returns information about a specific device.

      Parameters :

        name

          Location : path

          Required : Yes

          Type : string

          Description : Required. The name of the device. Format: `projects/{project}/locations/global/devices/{device}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/devices/[^/]+$

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/devices/{devicesId}

  • ▼ ▲ devicerun.projects.locations.devices.list

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/devices

      Parameter Order : parent

      Description : Lists all devices.

      HTTP Method : GET

      Parameters :

        pageToken

          Location : query

          Description : Optional. A page token, received from a previous `ListDevices` call. Provide this to receive the subsequent page. When paginating, all other parameters provided to `ListDevices` must match the call that provided the page token.

          Type : string

        parent

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Type : string

          Description : Required. The parent of the collection of devices. Format: `projects/{project}/locations/global`.

          Location : path

          Required : Yes

        filter

          Description : Optional. An AIP-160 (https://google.aip.dev/160) filter expression restricting which devices are returned. An empty filter returns all devices. Filtering is supported over the `Device` fields, including nested fields via dot-path. Enum and string values must be double-quoted. Examples: * `platform = "ANDROID"` * `platform = "ANDROID" AND os_version = "34"` * `hardware_type = "PHYSICAL" AND form_factor = "PHONE"` * `android_details.build_type = "userdebug"` * `availability.capacity = "HIGH"`

          Location : query

          Type : string

        pageSize

          Location : query

          Description : Optional. The maximum number of devices to return. The server may return fewer items than this value.

          Format : int32

          Type : integer

      Path : v1alpha/{+parent}/devices

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • ▼ ▲ devicerun.projects.locations.softwareVersions.get

      Parameter Order : name

      Parameters :

        name

          Location : path

          Required : Yes

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/softwareVersions/[^/]+$

          Description : Required. The name of the software version. Format: `projects/{project}/locations/global/softwareVersions/{software_version}`.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Returns information about a specific software version.

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/softwareVersions/{softwareVersionsId}

      HTTP Method : GET

  • ▼ ▲ devicerun.projects.locations.softwareVersions.list

      Parameters :

        pageSize

          Description : Optional. The maximum number of software versions to return. The server may return fewer items than this value.

          Format : int32

          Location : query

          Type : integer

        pageToken

          Type : string

          Location : query

          Description : Optional. A page token, received from a previous `ListSoftwareVersions` call. Provide this to receive the subsequent page. When paginating, all other parameters provided to `ListSoftwareVersions` must match the call that provided the page token.

        filter

          Type : string

          Description : Optional. An AIP-160 (https://google.aip.dev/160) filter expression restricting which software versions are returned. An empty filter returns all software versions. Filtering is supported over the `SoftwareVersion` fields, including nested fields via dot-path. Enum and string values must be double-quoted. Examples: * `software_type = "ANDROIDX_TEST_ORCHESTRATOR"` * `software_type = "ANDROIDX_TEST_ORCHESTRATOR" AND is_default = true` * `lifecycle.state = "ACTIVE"` * `version = "1.4.1"`

          Location : query

        parent

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Required : Yes

          Type : string

          Location : path

          Description : Required. The parent of the collection of software versions. Format: `projects/{project}/locations/global`.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Lists all software versions.

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/softwareVersions

      Parameter Order : parent

      HTTP Method : GET

      Path : v1alpha/{+parent}/softwareVersions

  • ▼ ▲ devicerun.projects.locations.sessions.delete

      Parameters :

        name

          Type : string

          Description : Required. The name of the session. Format: `projects/{project}/locations/{location}/sessions/{session}`.

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/sessions/[^/]+$

          Location : path

        requestId

          Type : string

          Location : query

          Description : Optional. A unique identifier for this request. This request is only idempotent if a `request_id` is provided, i.e. if a request with the same `request_id` is received, then the previous result will be returned. The server will guarantee that for at least 60 minutes after the first request. The value must be a UUID (e.g., 123e4567-e89b-12d3-a456-426655440000). See github.com/google/uuid for more details.

      Description : Deletes a session. This RPC returns immediately and deletion proceeds asynchronously. It will cancel the session at first if it is still running.

      Parameter Order : name

      HTTP Method : DELETE

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}

  • ▼ ▲ devicerun.projects.locations.sessions.create

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sessions

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Starts an automation session with the specified configuration. This method returns a long-running `Operation`, awaiting the completion of all jobs in the session.

      Parameters :

        parent

          Type : string

          Location : path

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Description : Required. The parent resource where this session will be created. Format: `projects/{project}/locations/{location}`.

        sessionId

          Type : string

          Description : Optional. The ID to use for the session, which will become the final component of the resource name. If not provided, the server will generate a value for this field. When provided, this value must be between 4 and 63 characters, and match the following regex: ^a-z{2,61}[a-z0-9]$.

          Location : query

        requestId

          Location : query

          Type : string

          Description : Optional. A unique identifier for this request. This request is only idempotent if a `request_id` is provided, i.e. if a request with the same `request_id` is received, then the previous result will be returned. The server will guarantee that for at least 60 minutes after the first request. The value must be a UUID (e.g., 123e4567-e89b-12d3-a456-426655440000). See github.com/google/uuid for more details.

      Path : v1alpha/{+parent}/sessions

      Parameter Order : parent

      HTTP Method : POST

  • ▼ ▲ devicerun.projects.locations.sessions.cancel

      Parameters :

        name

          Description : Required. The name of the session. Format: "projects/{project}/locations/{location}/sessions/{session}"

          Location : path

          Required : Yes

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/sessions/[^/]+$

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}:cancel

      HTTP Method : POST

      Description : Cancels an in-progress automation session. This RPC returns immediately and cancellation proceeds asynchronously. If the session is already finished, this RPC will have no effect.

      Path : v1alpha/{+name}:cancel

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : name

  • ▼ ▲ devicerun.projects.locations.sessions.list

      Path : v1alpha/{+parent}/sessions

      Description : Lists previously created automation sessions. Sessions may still be in-progress, or may have finished successfully, or unsuccessfully.

      HTTP Method : GET

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sessions

      Parameter Order : parent

      Parameters :

        view

          Description : Optional. The view of the sessions to return. If not set, the `BASIC` view will be returned.

          Location : query

          Enum :

        • SESSION_VIEW_UNSPECIFIED
        • SESSION_VIEW_BASIC
        • SESSION_VIEW_FULL
        • Enum Descriptions :

        • The default / unset value. The API will default to the BASIC view.
        • Include basic view of the session but not the full contents. Only the uid/display_name/status/result of the session and its jobs/executions will be included. This is the default value (for GetSession).
        • Include everything.
        • Type : string

        orderBy

          Type : string

          Location : query

          Description : Optional. The order to sort results by. Supported values: `name`, `name desc`, `create_time`, `create_time desc`. Values must use the snake_case field name; `createTime` is not accepted. Ordering by `create_time` is not supported when listing across all locations (`locations/-`). If unspecified, results are returned in an unspecified order.

        pageToken

          Type : string

          Location : query

          Description : Optional. A page token, received from a previous `ListSessions` call. Provide this to receive the subsequent page. When paginating, all other parameters provided to `ListSessions` must match the call that provided the page token.

        filter

          Description : Optional. The raw filter text to constrain the results.

          Type : string

          Location : query

        pageSize

          Type : integer

          Format : int32

          Description : Optional. The maximum number of sessions to return. The server may return fewer items than this value. If unspecified, at most 500 sessions will be returned. The maximum value is 1000, values above will be coerced to 1000.

          Location : query

        parent

          Location : path

          Type : string

          Required : Yes

          Description : Required. Parent value for ListSessionsRequest The parent of the collection of sessions. Format: `projects/{project}/locations/{location}`.

          Pattern : ^projects/[^/]+/locations/[^/]+$

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • ▼ ▲ devicerun.projects.locations.sessions.get

      Parameters :

        name

          Location : path

          Description : Required. The name of the session. Format: `projects/{project}/locations/{location}/sessions/{session}`.

          Required : Yes

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/sessions/[^/]+$

        view

          Location : query

          Enum Descriptions :

        • The default / unset value. The API will default to the BASIC view.
        • Include basic view of the session but not the full contents. Only the uid/display_name/status/result of the session and its jobs/executions will be included. This is the default value (for GetSession).
        • Include everything.
        • Type : string

          Enum :

        • SESSION_VIEW_UNSPECIFIED
        • SESSION_VIEW_BASIC
        • SESSION_VIEW_FULL
        • Description : Optional. The view of the session to return. If not set, the default BASIC view will be returned.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}

      Description : Returns information about a previously created automation session.

      HTTP Method : GET

      Parameter Order : name

      Path : v1alpha/{+name}

  • ▼ ▲ devicerun.projects.locations.operations.list

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations

      Path : v1alpha/{+name}/operations

      HTTP Method : GET

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        filter

          Type : string

          Location : query

          Description : The standard list filter.

        name

          Location : path

          Required : Yes

          Description : The name of the operation's parent resource.

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Type : string

        returnPartialSuccess

          Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

          Type : boolean

          Location : query

        pageToken

          Type : string

          Description : The standard list page token.

          Location : query

        pageSize

          Location : query

          Type : integer

          Description : The standard list page size.

          Format : int32

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • ▼ ▲ devicerun.projects.locations.operations.get

      Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

      Path : v1alpha/{+name}

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : GET

      Parameter Order : name

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Parameters :

        name

          Required : Yes

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Type : string

          Description : The name of the operation resource.

  • ▼ ▲ devicerun.projects.locations.operations.delete

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : DELETE

      Parameters :

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Type : string

          Required : Yes

          Location : path

          Description : The name of the operation resource to be deleted.

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Parameter Order : name

      Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

      Path : v1alpha/{+name}

  • ▼ ▲ devicerun.projects.locations.operations.cancel

      Path : v1alpha/{+name}:cancel

      HTTP Method : POST

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

      Parameter Order : name

      Parameters :

        name

          Required : Yes

          Location : path

          Description : The name of the operation resource to be cancelled.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Type : string

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.