重要: 2023 年 3 月に Apps Script によって連絡先サービスが廃止される前に、スクリプトを連絡先サービスから People API Advanced サービスに移行してください。
Apps Script では、2022 年 12 月 16 日に連絡先サービスのサポートを終了しました。代わりに、People API 拡張サービスを使用してください。People API は新しい JSON プロトコルを使用し、連絡先とプロフィールの統合などの高度な機能を備えています。
このガイドでは、People API 拡張サービスに同等のものがない連絡先サービスのメソッドと、その代わりに使用できるもの、一般的なタスクを移行するためのコードサンプルについて説明します。詳しくは、Contacts API 移行ガイドをご覧ください。
People API に相当するものがないメソッド
以下に、連絡帳サービスの getContacts
メソッドを示します。ただし、People API 拡張サービスで同等の方法で連絡先を検索することはできません。People API Advanced サービスでは、CONTACT
ソースにある連絡先の names
、nickNames
、emailAddresses
、phoneNumbers
、organizations
の各フィールドで検索できます。
同等のものがないメソッド |
---|
|
以下に、追加の label
パラメータを使用する連絡先サービスの getContacts
メソッドを示します。People API 拡張サービスの searchContacts
を使用すると、同等のフィールドで連絡先を取得できますが、検索対象を特定のラベルに限定することはできません。
一部同等なメソッド |
---|
|
People API で使用できる追加機能
People API Advanced サービスに移行すると、Contacts サービスでは利用できない People API の次の機能を利用できるようになります。
- データソースを指定する - ユーザーに関する情報を検索するときに、Google の連絡先や Google プロフィールなどの検索場所を指定できます。
- クエリ文字列でユーザーを検索する - 指定した文字列に一致するプロフィールと連絡先のリストを取得できます。
- バッチ リクエスト - People API 呼び出しをバッチ処理することで、スクリプトの実行時間を短縮できます。
一般的なタスクのコードサンプル
このセクションでは、連絡先サービスの一般的なタスクについて説明します。コードサンプルは、People API 高度なサービスを使用してタスクを作成する方法を示しています。
名前で連絡先グループを取得する
次のコードサンプルは、名前で連絡先グループを取得する方法を示しています。これは、連絡先サービスの getContactGroup(name)
に相当します。
メールアドレスで連絡先を取得する
次のコードサンプルは、メールアドレスで連絡先を取得する方法を示しています。これは、連絡先サービスの getContact(emailAddress)
に相当します。
すべての連絡先を取得する
次のコードサンプルは、ユーザーのすべての連絡先を取得する方法を示しています。これは、連絡先サービスの getContacts()
に相当します。
連絡先のフルネームを取得する
次のコードサンプルは、連絡先のフルネームを取得する方法を示しています。これは、連絡先サービスの getFullName()
に相当します。
連絡先のすべての電話番号を取得する
次のコードサンプルは、連絡先のすべての電話番号を取得する方法を示しています。これは、連絡先サービスの getPhones()
に相当します。
連絡先の特定の電話番号を取得する
次のコードサンプルは、連絡先の特定の電話番号を取得する方法を示しています。これは、連絡先サービスの getPhoneNumber()
に相当します。