Method: schemas.get
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
HTTP 要求
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 |
customerId |
string
客戶 Google Workspace 帳戶的專屬 ID。如果是多網域帳戶,請使用這個欄位,而非 domain ,為客戶擷取所有群組。您也可以使用 my_customer 別名來代表帳戶的 customerId 。系統也會在 Users 資源中傳回 customerId 。您必須提供 customer 或 domain 參數。
|
schemaKey |
string
結構定義的名稱或固定 ID。
|
回應主體
如果成功,回應主體會包含 Schema
的執行例項。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/admin.directory.userschema
https://www.googleapis.com/auth/admin.directory.userschema.readonly
詳情請參閱授權指南。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間:2025-07-25 (世界標準時間)。"],[],[],null,["# Method: schemas.get\n\nRetrieves a schema.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/schemas/{schemaKey}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerId` | `string` The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. |\n| `schemaKey` | `string` Name or immutable ID of the schema. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Schema](/workspace/admin/directory/reference/rest/v1/schemas#Schema).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.userschema`\n- `\n https://www.googleapis.com/auth/admin.directory.userschema.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]