Method: people.get
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
透過指定資源名稱來提供人員相關資訊。使用 people/me
表示已驗證的使用者。
如未指定「personFields」,要求會傳回 400 錯誤。
HTTP 要求
GET https://people.googleapis.com/v1/{resourceName=people/*}
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 |
resourceName |
string
必要欄位。要提供相關資訊的人員資源名稱。
- 如要取得已驗證使用者的資訊,請指定
people/me 。
- 如要取得 Google 帳戶的相關資訊,請指定
people/{account_id} 。
- 如要取得聯絡人的相關資訊,請指定能識別
people.connections.list 傳回聯絡人的資源名稱。
|
查詢參數
參數 |
requestMask (deprecated) |
object (RequestMask )
已淘汰 (請改用 personFields ) 可將結果限制為部分個人欄位的遮罩。
|
personFields |
string (FieldMask format)
必要欄位。欄位遮罩,用於限制傳回使用者上的欄位。如要指定多個欄位,請用半形逗號分隔。以下為有效值:
- addresses
- ageRanges
- 傳記
- 生日
- calendarUrls
- clientData
- coverPhotos
- emailAddresses
- 活動
- externalIds
- 性別
- imClients
- 興趣
- locales
- 地點
- 會籍
- 中繼資料
- miscKeywords
- names
- 暱稱
- 職業
- organizations
- phoneNumbers
- 相片
- 關係
- sipAddresses
- skills
- urls
- userDefined
|
sources[] |
enum (ReadSourceType )
選用設定。要傳回哪些來源類型的遮罩。如未設定,預設值為 READ_SOURCE_TYPE_PROFILE 和 READ_SOURCE_TYPE_CONTACT 。
|
回應主體
如果成功,回應主體會包含 Person
的執行例項。
授權範圍
不需授權即可存取公開資料。如果是私人資料,必須提供下列其中一個 OAuth 範圍:
https://www.googleapis.com/auth/contacts
https://www.googleapis.com/auth/contacts.readonly
https://www.googleapis.com/auth/contacts.other.readonly
https://www.googleapis.com/auth/directory.readonly
https://www.googleapis.com/auth/profile.agerange.read
https://www.googleapis.com/auth/profile.emails.read
https://www.googleapis.com/auth/profile.language.read
https://www.googleapis.com/auth/user.addresses.read
https://www.googleapis.com/auth/user.birthday.read
https://www.googleapis.com/auth/user.emails.read
https://www.googleapis.com/auth/user.gender.read
https://www.googleapis.com/auth/user.organization.read
https://www.googleapis.com/auth/user.phonenumbers.read
https://www.googleapis.com/auth/userinfo.email
https://www.googleapis.com/auth/userinfo.profile
https://www.googleapis.com/auth/profile.language.read
詳情請參閱授權指南。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2024-08-06 (世界標準時間)。
[[["容易理解","easyToUnderstand","thumb-up"],["確實解決了我的問題","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["缺少我需要的資訊","missingTheInformationINeed","thumb-down"],["過於複雜/步驟過多","tooComplicatedTooManySteps","thumb-down"],["過時","outOfDate","thumb-down"],["翻譯問題","translationIssue","thumb-down"],["示例/程式碼問題","samplesCodeIssue","thumb-down"],["其他","otherDown","thumb-down"]],["上次更新時間:2024-08-06 (世界標準時間)。"],[[["Retrieves information about a person, including the authenticated user using `people/me` or by specifying a resource name."],["Requires the `personFields` query parameter to specify which fields to include in the response, otherwise, it returns a 400 error."],["Allows filtering the source of the data using the `sources[]` parameter and supports various authorization scopes for accessing private data."],["Uses a `GET` request to the `https://people.googleapis.com/v1/{resourceName=people/*}` endpoint with optional query parameters."],["Response includes a [Person](/people/api/rest/v1/people#Person) object containing the requested information if successful."]]],[]]