重要提示:Apps 脚本将于 2023 年 3 月关闭通讯录服务,在此之前,请将脚本从“通讯录”服务迁移到 People API 高级服务。
Apps 脚本已于 2022 年 12 月 16 日弃用通讯录服务。请改用 People API 高级服务。People API 使用较新的 JSON 协议并提供高级功能,例如将联系人与个人资料合并。
通过本指南,您可以了解哪些通讯录服务方法在 People API 高级服务中没有对应项,了解您可以改用哪些方法,并查找用于迁移常见任务的代码示例。如需了解详情,请参阅 Contacts API 迁移指南。
没有 People API 等效项的方法
下面列出了通讯录服务中与在 People API 高级服务中搜索联系人不具有相同方法的 getContacts
方法。借助 People API 高级服务,您可以按联系人的 names
、nickNames
、emailAddresses
、phoneNumbers
和 organizations
字段(来自 CONTACT
来源)进行搜索。
没有等效项的方法 |
---|
|
下面列出了通讯录服务中使用额外的 label
参数的 getContacts
方法。您可以使用 People API 高级服务中的 searchContacts
按等效字段获取联系人,但无法将搜索范围限制为特定标签。
具有部分等效项的方法 |
---|
|
People API 提供的其他功能
迁移到 People API 高级服务时,您可以访问通讯录服务中不可用的以下 People API 功能:
- 指定数据源 - 搜索某人的信息时,可以指定搜索位置,例如 Google 联系人或 Google 个人资料。
- 按查询字符串搜索人员 - 您可以获取与特定字符串匹配的个人资料和联系人列表。
- 批量请求 - 您可以批量处理 People API 调用,以帮助缩短脚本执行时间。
常见任务的代码示例
本部分列出了通讯录服务中的常见任务。这些代码示例展示了如何使用 People API 高级服务构建任务。
按名称获取联系人群组
以下代码示例演示了如何按名称获取联系人组,这相当于通讯录服务中的 getContactGroup(name)
。
通过电子邮件地址获取联系人
以下代码示例演示了如何通过电子邮件地址获取联系人,这相当于通讯录服务中的 getContact(emailAddress)
。
获取所有联系人
以下代码示例展示了如何获取用户的所有联系人,这相当于通讯录服务中的 getContacts()
。
获取联系人的全名
以下代码示例展示了如何获取联系人的全名,这相当于通讯录服务中的 getFullName()
。
获取联系人的所有电话号码
以下代码示例展示了如何获取联系人的所有电话号码,这相当于通讯录服务中的 getPhones()
。
获取联系人的特定电话号码
以下代码示例展示了如何获取联系人的特定电话号码,这相当于通讯录服务中的 getPhoneNumber()
。