連絡先サービスから People API 高度なサービスに移行する

重要: 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 ソースにある連絡先の namesnickNamesemailAddressesphoneNumbersorganizations の各フィールドで検索できます。

同等のものがないメソッド
  • getContactsByAddress(query)
  • getContactsByAddress(query, label)
  • getContactsByAddress(query, label)
  • getContactsByCustomField(query, label)
  • getContactsByDate(month, day, label)
  • getContactsByDate(month, day, year, label)
  • getContactsByDate(month, day, year, label)
  • getContactsByIM(query)
  • getContactsByIM(query, label)
  • getContactsByJobTitle(query)
  • getContactsByNotes(query)
  • getContactsByUrl(query)
  • getContactsByUrl(query, label)
  • getContactsByGroup(group)

以下に、追加の label パラメータを使用する連絡先サービスの getContacts メソッドを示します。People API 拡張サービスの searchContacts を使用すると、同等のフィールドで連絡先を取得できますが、検索対象を特定のラベルに限定することはできません。

一部同等なメソッド
  • getContactsByEmailAddress(query, label)
  • getContactsByName(query, label)
  • getContactsByPhone(query, label)

People API で使用できる追加機能

People API Advanced サービスに移行すると、Contacts サービスでは利用できない People API の次の機能を利用できるようになります。

一般的なタスクのコードサンプル

このセクションでは、連絡先サービスの一般的なタスクについて説明します。コードサンプルは、People API 高度なサービスを使用してタスクを作成する方法を示しています。

名前で連絡先グループを取得する

次のコードサンプルは、名前で連絡先グループを取得する方法を示しています。これは、連絡先サービスの getContactGroup(name) に相当します。

Advanced/people.gs
/**
 * Gets a contact group with the given name
 * @param {string} name The group name.
 * @see https://developers.google.com/people/api/rest/v1/contactGroups/list
 */
function getContactGroup(name) {
  try {
    const people = People.ContactGroups.list();
    // Finds the contact group for the person where the name matches.
    const group = people['contactGroups'].find((group) => group['name'] === name);
    // Prints the contact group
    console.log('Group: %s', JSON.stringify(group, null, 2));
  } catch (err) {
    // TODO (developers) - Handle exception
    console.log('Failed to get the contact group with an error %s', err.message);
  }
}

メールアドレスで連絡先を取得する

次のコードサンプルは、メールアドレスで連絡先を取得する方法を示しています。これは、連絡先サービスの getContact(emailAddress) に相当します。

Advanced/people.gs
/**
 * Gets a contact by the email address.
 * @param {string} email The email address.
 * @see https://developers.google.com/people/api/rest/v1/people.connections/list
 */
function getContactByEmail(email) {
  try {
    // Gets the person with that email address by iterating over all contacts.
    const people = People.People.Connections.list('people/me', {
      personFields: 'names,emailAddresses'
    });
    const contact = people['connections'].find((connection) => {
      return connection['emailAddresses'].some((emailAddress) => emailAddress['value'] === email);
    });
    // Prints the contact.
    console.log('Contact: %s', JSON.stringify(contact, null, 2));
  } catch (err) {
    // TODO (developers) - Handle exception
    console.log('Failed to get the connection with an error %s', err.message);
  }
}

すべての連絡先を取得する

次のコードサンプルは、ユーザーのすべての連絡先を取得する方法を示しています。これは、連絡先サービスの getContacts() に相当します。

Advanced/people.gs
/**
 * Gets a list of people in the user's contacts.
 * @see https://developers.google.com/people/api/rest/v1/people.connections/list
 */
function getConnections() {
  try {
    // Get the list of connections/contacts of user's profile
    const people = People.People.Connections.list('people/me', {
      personFields: 'names,emailAddresses'
    });
    // Print the connections/contacts
    console.log('Connections: %s', JSON.stringify(people, null, 2));
  } catch (err) {
    // TODO (developers) - Handle exception here
    console.log('Failed to get the connection with an error %s', err.message);
  }
}

連絡先のフルネームを取得する

次のコードサンプルは、連絡先のフルネームを取得する方法を示しています。これは、連絡先サービスの getFullName() に相当します。

Advanced/people.gs
/**
 * Gets the full name (given name and last name) of the contact as a string.
 * @see https://developers.google.com/people/api/rest/v1/people/get
 */
function getFullName() {
  try {
    // Gets the person by specifying resource name/account ID
    // in the first parameter of People.People.get.
    // This example gets the person for the user running the script.
    const people = People.People.get('people/me', {personFields: 'names'});
    // Prints the full name (given name + family name)
    console.log(`${people['names'][0]['givenName']} ${people['names'][0]['familyName']}`);
  } catch (err) {
    // TODO (developers) - Handle exception
    console.log('Failed to get the connection with an error %s', err.message);
  }
}

連絡先のすべての電話番号を取得する

次のコードサンプルは、連絡先のすべての電話番号を取得する方法を示しています。これは、連絡先サービスの getPhones() に相当します。

Advanced/people.gs
/**
 * Gets all the phone numbers for this contact.
 * @see https://developers.google.com/people/api/rest/v1/people/get
 */
function getPhoneNumbers() {
  try {
    // Gets the person by specifying resource name/account ID
    // in the first parameter of People.People.get.
    // This example gets the person for the user running the script.
    const people = People.People.get('people/me', {personFields: 'phoneNumbers'});
    // Prints the phone numbers.
    console.log(people['phoneNumbers']);
  } catch (err) {
    // TODO (developers) - Handle exception
    console.log('Failed to get the connection with an error %s', err.message);
  }
}

連絡先の特定の電話番号を取得する

次のコードサンプルは、連絡先の特定の電話番号を取得する方法を示しています。これは、連絡先サービスの getPhoneNumber() に相当します。

Advanced/people.gs
/**
 * Gets a phone number by type, such as work or home.
 * @see https://developers.google.com/people/api/rest/v1/people/get
 */
function getPhone() {
  try {
    // Gets the person by specifying resource name/account ID
    // in the first parameter of People.People.get.
    // This example gets the person for the user running the script.
    const people = People.People.get('people/me', {personFields: 'phoneNumbers'});
    // Gets phone number by type, such as home or work.
    const phoneNumber = people['phoneNumbers'].find((phone) => phone['type'] === 'home')['value'];
    // Prints the phone numbers.
    console.log(phoneNumber);
  } catch (err) {
    // TODO (developers) - Handle exception
    console.log('Failed to get the connection with an error %s', err.message);
  }
}