gws-people

people (v1)

必要條件： 請先閱讀 ../gws-shared/SKILL.md 了解驗證、全域旗標與安全規則。若缺少該檔案，請執行 gws generate-skills 建立。

gws people <resource> <method> [flags]

API 資源

contactGroups

• batchGet — 透過指定聯絡人群組資源名稱清單，取得已驗證使用者擁有的聯絡人群組清單。
• create — 為已驗證使用者建立新的聯絡人群組。建立的聯絡人群組名稱在使用者的聯絡人群組中必須是唯一的。嘗試使用重複名稱建立群組將回傳 HTTP 409 錯誤。對同一使用者的變更請求應依序發送，以避免延遲增加與失敗。
• delete — 透過指定聯絡人群組資源名稱，刪除已驗證使用者擁有的現有聯絡人群組。對同一使用者的變更請求應依序發送，以避免延遲增加與失敗。
• get — 透過指定聯絡人群組資源名稱，取得已驗證使用者擁有的特定聯絡人群組。
• list — 列出已驗證使用者擁有的所有聯絡人群組。聯絡人群組的成員不會被填入。
• update — 更新已驗證使用者擁有的現有聯絡人群組名稱。更新後的聯絡人群組名稱在使用者的聯絡人群組中必須是唯一的。嘗試使用重複名稱更新群組將回傳 HTTP 409 錯誤。對同一使用者的變更請求應依序發送，以避免延遲增加與失敗。
• members — 對 'members' 資源的操作

otherContacts

• copyOtherContactToMyContactsGroup — 將「其他聯絡人」複製到使用者「myContacts」群組中的新聯絡人。對同一使用者的變更請求應依序發送，以避免延遲增加與失敗。
• list — 列出所有「其他聯絡人」，即不在聯絡人群組中的聯絡人。「其他聯絡人」通常是從互動中自動建立的聯絡人。同步權杖在完整同步後 7 天過期。使用過期同步權杖的請求將收到一個帶有原因 "EXPIRED_SYNC_TOKEN" 的 google.rpc.ErrorInfo 錯誤。遇到此類錯誤時，用戶端應在不帶 sync_token 的情況下進行完整同步請求。
• search — 提供符合搜尋查詢的已驗證使用者其他聯絡人清單。查詢比對來自 OTHER_CONTACT 來源的聯絡人 names、emailAddresses 和 phoneNumbers 欄位。重要提示：搜尋前，用戶端應發送一個空查詢的暖機請求以更新快取。請參閱 https://developers.google.com/people/v1/other-contacts#search_the_users_other_contacts

people

• batchCreateContacts — 批次建立新聯絡人，並回傳新建立聯絡人的 PersonResponses。對同一使用者的變更請求應依序發送，以避免延遲增加與失敗。
• batchUpdateContacts — 批次更新聯絡人，並回傳資源名稱到已更新聯絡人 PersonResponses 的對應。對同一使用者的變更請求應依序發送，以避免延遲增加與失敗。
• createContact — 建立新聯絡人，並回傳該聯絡人的 person 資源。如果對聯絡人來源中為單一值的欄位指定了多個欄位，請求將回傳 400 錯誤：* biographies * birthdays * genders * names。對同一使用者的變更請求應依序發送，以避免延遲增加與失敗。
• deleteContactPhoto — 刪除聯絡人的照片。對同一使用者的變更請求應依序執行，以避免鎖定競爭。
• get — 透過指定資源名稱提供個人資訊。使用 people/me 表示已驗證使用者。如果未指定 'personFields'，請求將回傳 400 錯誤。
• getBatchGet — 透過指定請求的資源名稱清單，提供特定人員清單的資訊。使用 people/me 表示已驗證使用者。如果未指定 'personFields'，請求將回傳 400 錯誤。
• listDirectoryPeople — 提供已驗證使用者網域目錄中的網域個人資料與網域聯絡人清單。當指定 sync_token 時，自上次同步以來已刪除的資源將以 PersonMetadata.deleted 設為 true 的 person 回傳。當指定 page_token 或 sync_token 時，所有其他請求參數必須與第一次呼叫相符。寫入操作可能會有數分鐘的傳播延遲。增量同步不適用於讀取後寫入的使用情境。
• searchContacts — 提供符合搜尋查詢的已驗證使用者分組聯絡人清單。查詢比對來自 CONTACT 來源的聯絡人 names、nickNames、emailAddresses、phoneNumbers 和 organizations 欄位。重要提示：搜尋前，用戶端應發送一個空查詢的暖機請求以更新快取。請參閱 https://developers.google.com/people/v1/contacts#search_the_users_contacts
• searchDirectoryPeople — 提供已驗證使用者網域目錄中符合搜尋查詢的網域個人資料與網域聯絡人清單。
• updateContact — 更新現有聯絡人的聯絡人資料。任何非聯絡人資料將不會被修改。要更新的 person 中的任何非聯絡人資料將被忽略。update_mask 中指定的所有欄位將被取代。如果未為要更新的聯絡人指定 person.metadata.sources，或沒有聯絡人來源，伺服器將回傳 400 錯誤。
• updateContactPhoto — 更新聯絡人的照片。對同一使用者的變更請求應依序發送，以避免延遲增加與失敗。
• connections — 對 'connections' 資源的操作

探索指令

在呼叫任何 API 方法之前，請先檢查它：

# 瀏覽資源與方法
gws people --help

# 檢查方法的必要參數、型別與預設值
gws schema people.<resource>.<method>

使用 gws schema 的輸出建構你的 --params 與 --json 旗標。