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 天过期。使用过期同步令牌的请求将收到一个错误，其中包含 google.rpc.ErrorInfo，原因为 "EXPIRED_SYNC_TOKEN"。在这种情况下，客户端应进行完全同步请求，不带 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 的人员返回。当指定 page_token 或 sync_token 时，所有其他请求参数必须与第一次调用匹配。写入操作可能有几分钟的传播延迟用于同步请求。增量同步不适用于读后写用例。
• searchContacts — 提供与搜索查询匹配的认证用户分组联系人中的联系人列表。查询匹配来自 CONTACT 来源的联系人的 names、nickNames、emailAddresses、phoneNumbers 和 organizations 字段。重要提示： 搜索前，客户端应发送一个空查询的预热请求以更新缓存。请参阅 https://developers.google.com/people/v1/contacts#search_the_users_contacts
• searchDirectoryPeople — 提供与搜索查询匹配的认证用户域目录中的域配置文件和域联系人列表。
• updateContact — 更新现有联系人的联系人数据。任何非联系人数据将不会被修改。要更新的人员中的任何非联系人数据将被忽略。update_mask 中指定的所有字段将被替换。如果未为要更新的联系人指定 person.metadata.sources 或没有联系人来源，则服务器返回 400 错误。
• updateContactPhoto — 更新联系人的照片。同一用户的变更请求应顺序发送，以避免增加延迟和失败。
• connections — 对 'connections' 资源的操作

发现命令

在调用任何 API 方法之前，请检查它：

# 浏览资源和方法
gws people --help

# 检查方法的必需参数、类型和默认值
gws schema people.<resource>.<method>

使用 gws schema 输出来构建你的 --params 和 --json 标志。