Method: deployments.groups.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists groups of a deployment. Returns NOT_FOUND if the matching path does not exist.
HTTP request
GET https://androidovertheair.googleapis.com/v1/{name=deployments/*}/groups
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Relative resource name. For example: "deployments/deployment_x"
|
Query parameters
| Parameters |
view |
enum (View)
Optional. Specify whether basic or detailed information of each group should be returned.
|
Request body
The request body must be empty.
Response body
Response message for OverTheAirService.ListGroups.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"groups": [
{
object (Group)
}
]
} |
| Fields |
groups[] |
object (Group)
The list of groups. Note that GroupDetails will not contain members due to size issues. If you require members, we recommend that you load them on-demand, per Group.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/android_partner_over_the_air
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003eLists groups of a deployment and returns basic or detailed group information.\u003c/p\u003e\n"],["\u003cp\u003eRequires an HTTP GET request to the specified URL with deployment name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eOptionally, specify the level of group information detail using the \u003ccode\u003eview\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, and the response includes an array of groups with their details, excluding members for performance reasons.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/android_partner_over_the_air\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document outlines the process for listing groups within a deployment using an HTTP GET request. The endpoint is `https://androidovertheair.googleapis.com/v1/{name=deployments/*}/groups`, with `name` as a required path parameter specifying the deployment. An optional `view` query parameter determines the level of detail for each group. The request body must be empty. The successful response includes a JSON object containing an array of `groups`. OAuth scope `https://www.googleapis.com/auth/android_partner_over_the_air` is needed for authorization.\n"],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListGroupsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists [groups](/android/over-the-air/reference/rest/v1/deployments.groups#Group) of a deployment. Returns `NOT_FOUND` if the matching path does not exist.\n\nHTTP request\n\n`GET https://androidovertheair.googleapis.com/v1/{name=deployments/*}/groups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------|\n| `name` | `string` Relative resource name. For example: \"deployments/deployment_x\" |\n\nQuery parameters\n\n| Parameters ||\n|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `view` | `enum (`[View](/android/over-the-air/reference/rest/v1/View)`)` Optional. Specify whether basic or detailed information of each group should be returned. |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body Response message for OverTheAirService.ListGroups.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------|\n| ``` { \"groups\": [ { object (/android/over-the-air/reference/rest/v1/deployments.groups#Group) } ] } ``` |\n\n| Fields ||\n|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `groups[]` | `object (`[Group](/android/over-the-air/reference/rest/v1/deployments.groups#Group)`)` The list of groups. Note that `GroupDetails` will not contain `members` due to size issues. If you require `members`, we recommend that you load them on-demand, per `Group`. |\n\nAuthorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/android_partner_over_the_air`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]