Google コンタクト API は 2022 年 1 月 19 日に提供が終了しました。このガイドでは、People API への移行によるフィールド、エンドポイント、認証スコープの変更について説明します。
概要
People API のすべての機能は、以前の Contacts API と同じですが、その他の連絡先を除き、次の例外があります。
管理者は、新しいスコープで「その他の連絡先」に対する読み取り専用権限を持ちます。他の連絡先への変換/書き込みシグナルの返送はサポートされていないため、ユーザーがデータ フィールドを更新するには、その他の連絡先をマイ連絡先として追加する必要があります。
API を介して読み取ることができるのは、「その他の連絡先」の基本的な連絡先情報のみです。(氏名、メールアドレス、電話番号など)。
また、個人の連絡先とディレクトリ情報の両方へのアクセスを提供する以前の連絡先スコープ(https://www.google.com/m8/feeds
)は、次のスコープに置き換えられました。
- 個人の連絡先にアクセスするには:
https://www.googleapis.com/auth/contacts
- ディレクトリ情報にアクセスするには、次のようにします。
https://www.googleapis.com/auth/directory.readonly
連絡先
フィールド マッピング
連絡先フィールド | 担当者フィールド |
---|---|
atom:content | 伝記 |
atom:link rel='http://schemas.google.com/contacts/2008/rel#photo' | 写真 |
atom:title | 名前 |
gContact:billingInformation(連絡先: 請求情報) | その他のキーワード(type=OUTLOOK_BILLING_INFORMATION) |
gContact:誕生日 | 誕生日 |
gContact:calendarLink | calendarUrls |
gContact:ディレクトリ サーバー | その他のキーワード(type=OUTLOOK_DIRECTORY_SERVER) |
gContact:event | イベント |
gContact:extendedProperty | clientData |
gContact:externalId | externalIds |
gContact:fileAs | fileAses |
gContact:gender | 性別 |
gContact:groupMembershipInfo | memberships.contactGroupMembership |
gContact:趣味 | 関心 |
gContact:イニシャル | 非推奨のニックネーム(type=INITIALS) |
gContact:jot type='home' | その他のキーワード(type=HOME) |
gContact:jot type='keywords' | その他のキーワード(type=OUTLOOK_KEYWORD) |
gContact:jot type='other' | その他のキーワード(type=OTHER) |
gContact:jot type='user' | その他のキーワード(type=OUTLOOK_USER) |
gContact:jot type='work' | その他のキーワード(type=WORK) |
gContact:言語 | 言語 |
gContact:maidenName | 非推奨のニックネーム(type=MAIDEN_NAME) |
gContact:マイル | その他のキーワード(type=OUTLOOK_MILEAGE) |
gContact:ニックネーム | ニックネーム(type=DEFAULT) |
gContact:occupation(gContact:職業) | 職業 |
gContact:priority | その他のキーワード(type=OUTLOOK_PRIORITY) |
gContact:relationship | リレーション |
gContact:感度 | その他のキーワード(type=OUTLOOK_SENSITIVITY) |
gContact:shortName | 非推奨のニックネーム(type=SHORT_NAME) |
gContact:subject | その他のキーワード(type=OUTLOOK_SUBJECT) |
gContact:[ユーザー定義フィールド] | userDefined |
gContact:ウェブサイト | urls |
gContact:yomiName | names.phonetic_full_name |
gd:削除済み | metadata.Deleted |
gd:email | emailAddress(メールアドレス) |
gd:im | imClients |
gd:organization | 組織 |
gd:phoneNumber | 電話番号 |
gd:postalAddress(gd:住所) | addresses.formattedValue |
gd:where | 居住地 |
gd:structuredPostAddress | addresses |
個人の連絡先エンドポイント
読む
https://www.googleapis.com/auth/contacts
または https://www.googleapis.com/auth/contacts.readonly
スコープが必要です。
- 特定の連絡先を参照する
people.get
- 特定の連絡先を読み取る
people.getBatchGet
people.connections.list
を使用して連絡先を読み取る
Mutate
https://www.googleapis.com/auth/contacts
スコープが必要です。写真を除くすべての連絡先フィールドを変更します。
people.createContact
を使用して連絡先を作成するpeople.updateContact
を使用して既存の連絡先を更新するpeople.deleteContact
を使用して連絡先を削除します。
写真の変更
https://www.googleapis.com/auth/contacts
スコープが必要です。
people.updateContactPhoto
を使用して連絡先の写真を更新します。people.deleteContactPhoto
を使用して連絡先の写真を削除します。
その他の連絡先エンドポイント
読む
その他の連絡先は読み取り専用で、names
、emailAddresses
、phoneNumbers
フィールドのみが返されます。
https://www.googleapis.com/auth/contacts.other.readonly
スコープが必要です。
otherContacts.list
を使用してその他の連絡先を読み取る。
コピー
https://www.googleapis.com/auth/contacts.other.readonly
スコープと https://www.googleapis.com/auth/contacts
スコープが必要です。
otherContacts.copyOtherContactToMyContactsGroup
を使用して他の連絡先をコピーします。
グローバル アドレス一覧エンドポイント
https://www.googleapis.com/auth/directory.readonly
スコープが必要です。
- すべてのディレクトリの連絡先とプロファイル
people.listDirectoryPeople
を一覧表示します。 - ディレクトリの連絡先とプロフィールを検索
people.searchDirectoryPeople
連絡先グループ
フィールド マッピング
Contacts API の [Contact Group] フィールド | People API 連絡先グループのフィールド |
---|---|
atom:updated | metadata.updateTime |
atom:title | name |
atom:content | name |
gd:削除済み | metadata.Deleted |
systemGroup | groupType=SYSTEM_CONTACT_GROUP |
エンドポイント
読む
https://www.googleapis.com/auth/contacts
または https://www.googleapis.com/auth/contacts.readonly
スコープが必要です。
people.contactGroups.get
を使用して特定の連絡先グループを取得するpeople.contactGroups.list
を使用して連絡先グループを一覧表示する
Mutate
https://www.googleapis.com/auth/contacts
スコープが必要です。
people.contactGroups.create
を使用して連絡先グループを作成するpeople.contactGroups.update
を使用して連絡先グループを更新するpeople.contactGroups.delete
を使用して連絡先グループを削除するpeople.contactGroups.members.modify
を使って連絡先グループに対して連絡先を追加または削除する
認証スコープ
レガシー スコープ https://www.google.com/m8/feeds
は、https://www.googleapis.com/auth/contacts
スコープのエイリアスです。つまり、従来のスコープを使用した既存の OAuth 権限付与は、https://www.googleapis.com/auth/contacts
スコープを必要とする People API のすべてのエンドポイントで機能します。連絡先と連絡先グループの読み取り / 書き込みは、従来のスコープで機能します。
People API で「その他の連絡先」やディレクトリのデータにアクセスするには、新しいスコープが必要です。必要なスコープについては、上記をご覧ください。
詳しくは、リクエストを承認するをご覧ください。
クライアント ライブラリ
- Apps Script については、高度なユーザーサービスをご覧ください。
- サポートされているその他の言語については、クライアント ライブラリのインストールをご覧ください。