Contacts API 移行ガイド

Contacts API は 2022 年 1 月 19 日をもってサポートを終了しました。このガイドでは、People API に移行する際のフィールド、エンドポイント、認可スコープの変更について説明します。

概要

People API は、その他の連絡先を除き、すべての機能で従来の Contacts API と同じ機能を利用できます。

  • 管理者には、新しいスコープで「その他の連絡先」に対する読み取り専用権限が付与されます。「その他の連絡先」への変更/書き込みシグナルの送信はサポートされていないため、ユーザーがデータ フィールドを更新する場合は、そのその他の連絡先を「My Contact」として追加する必要があります。

  • API で読み取ることができるのは [その他の連絡先] の基本的な連絡先情報のみです。（氏名、メールアドレス、電話番号など）。

また、個人の連絡先とディレクトリ情報の両方へのアクセスを提供していた古い連絡先スコープ（https://www.google.com/m8/feeds）は、次のスコープに置き換えられます。

  • 個人の連絡先にアクセスするには: https://www.googleapis.com/auth/contacts
  • ディレクトリ情報にアクセスする場合: https://www.googleapis.com/auth/directory.readonly

連絡先

フィールドのマッピング

連絡先フィールド Person フィールド
atom:content 伝記
Atom:link rel='http://schemas.google.com/contacts/2008/rel#photo' 写真
atom:title names
gContact:billingInformation その他のキーワード（type=OUTLOOK_BILLING_INFORMATION）
gContact:誕生日 誕生日
Google コンタクト:カレンダー リンク calendarUrls
gContact:directoryServer その他のキーワード（type=OUTLOOK_DIRECTORY_SERVER）
gContact:イベント イベント
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='keyword' その他のキーワード（type=OUTLOOK_KEYWORD）
gContact:jot type='other' その他のキーワード（type=OTHER）
gContact:jot type='user' その他のキーワード（type=OUTLOOK_USER）
gContact:jot type='work' その他のキーワード（type=WORK）
gContact:言語 言語
gContact:旧姓 非推奨 nicknames (type=MAIDEN_NAME)
gContact:マイレージ その他のキーワード（type=OUTLOOK_MILEAGE）
gContact:ニックネーム nicknames（type=DEFAULT）
gContact:occupation 職業
gContact:優先順位 その他のキーワード（type=OUTLOOK_PRIORITY）
gContact:関係 関係
gContact:感度 その他のキーワード（type=OUTLOOK_SENSITIVITY）
gContact:shortName 非推奨 nicknames (type=SHORT_NAME)
gContact:subject その他のキーワード（type=OUTLOOK_SUBJECT）
gContact:userDefinedField userDefined
gContact:ウェブサイト urls
gContact:yomiName names.phonetic_full_name
gd:deleted metadata.deleted
gd:email emailAddresses
gd:im imClients
gd:組織 organizations
gd:phoneNumber phoneNumbers
gd:postalAddress addresses.formattedValue
gd:where 住宅
gd:structuredPostalAddress addresses

個人用連絡先エンドポイント

読み取り

https://www.googleapis.com/auth/contacts または https://www.googleapis.com/auth/contacts.readonly のスコープが必要です。

アクション

https://www.googleapis.com/auth/contacts スコープが必要です。写真を除くすべての連絡先フィールドを変更します。

写真の変更

https://www.googleapis.com/auth/contacts スコープが必要です。

その他の連絡先エンドポイント

読み取り

その他の連絡先は読み取り専用で、names、emailAddresses、phoneNumbers のフィールドのみが返されます。

https://www.googleapis.com/auth/contacts.other.readonly スコープが必要です。

コピー

https://www.googleapis.com/auth/contacts.other.readonly と https://www.googleapis.com/auth/contacts のスコープが必要です。

グローバル アドレスリストのエンドポイント

https://www.googleapis.com/auth/directory.readonly スコープが必要です。

連絡先グループ

フィールドのマッピング

Contacts API の連絡先グループ フィールド People API の連絡先グループ フィールド
atom:updated metadata.updateTime
atom:title name
atom:content name
gd:deleted metadata.deleted
systemGroup groupType=SYSTEM_CONTACT_GROUP

エンドポイント

読み取り

https://www.googleapis.com/auth/contacts または https://www.googleapis.com/auth/contacts.readonly のスコープが必要です。

アクション

https://www.googleapis.com/auth/contacts スコープが必要です。

認可スコープ

以前のスコープ https://www.google.com/m8/feeds は、https://www.googleapis.com/auth/contacts スコープのエイリアスです。つまり、以前のスコープを使用した既存の OAuth 権限は、https://www.googleapis.com/auth/contacts スコープを必要とする People API のエンドポイントで機能します。連絡先と連絡先グループの読み取りと書き込みは、以前のスコープで機能します。

People API で「その他の連絡先」またはディレクトリのデータにアクセスするには、新しいスコープが必要です。必要なスコープについては、上記をご覧ください。

詳しくは、リクエストを承認するをご覧ください。

クライアント ライブラリ