Class ContactsApp

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

新しい連絡先を作成します。

// The code below creates a new contact with the name "John Doe" and the email address
// "john.doe@example.com".
var contact = ContactsApp.createContact('John', 'Doe', 'john.doe@example.com');

パラメータ

リターン

Contact - 新しく作成された Contact オブジェクト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• deleteContact(contact)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

指定した名前で連絡先グループを作成します。

// The code below creates a new contact group named "Work Friends"
var group = ContactsApp.createContactGroup("Work Friends");

パラメータ

リターン

ContactGroup - 新しく作成された連絡先グループ

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• deleteContactGroup(group)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

連絡先を削除します。

// The code below retrieves a contact with the email address "john.doe@example.com"
// and then deletes that contact.
var contact = ContactsApp.getContact('john.doe@example.com');
ContactsApp.deleteContact(contact);

パラメータ

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• createContact(givenName, familyName, email)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

連絡先グループを削除します

// The code below creates deletes the contact group named "Work Friends"
var group = ContactsApp.getContactGroup("Work Friends");
ContactsApp.deleteContactGroup(group);

パラメータ

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• createContactGroup(name)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

指定されたメールアドレスの連絡先を検索します。

パラメータ

リターン

Contact - そのメールアドレスを含む連絡先

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

指定された名前の連絡先グループを検索します。

パラメータ

リターン

ContactGroup - 指定した名前に一致する連絡先グループ

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

このユーザーに属するすべての連絡先を取得します。

リターン

Contact[] - このユーザーのすべての連絡先

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

メールアドレスで連絡先を取得します。

複数の連絡先が同じメールアドレスを共有している場合、このメソッドは、メールアドレスをメインとしてマークしている連絡先を優先します。メールアドレスがメインとしてマークされている連絡先がいない場合、または複数の連絡先のメールアドレスがメインとしてマークされている場合は、連絡先の並べ替え順で最初の結果を返します。

// The code below retrieves a contact with the email address "john.doe@example.com".
var contact = ContactsApp.getContact('john.doe@example.com');

パラメータ

リターン

Contact - そのメールアドレスを含む連絡先

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContacts()
• getContactById(id)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

この ID の連絡先を取得します。

// The code below retrieves the contact with the id
// "http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34ca5"
var id = 'http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34c';
var contact = ContactApp.getContactById(id);

パラメータ

リターン

Contact - 一致する連絡先または null

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

指定された名前の連絡先グループを取得します。一致する連絡先グループが見つからない場合は、null を返します。

// The code below returns the contact group with the name "Work Friends"
var group  = ContactsApp.getContactGroup('Work Friends');

パラメータ

リターン

ContactGroup - 一致する連絡先グループ。一致する連絡先グループが見つからない場合は null

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContactGroups()

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

指定された ID の連絡先グループを取得します。一致する連絡先グループが見つからない場合は、null を返します。

// The code below returns the contact group with the id
// "http://www.google.com/m8/feeds/groups/john.doe%40example.com/base/54eefbb093fdecb"
var id = "http://www.google.com/m8/feeds/groups/john.doe%40example.com/base/54eefbb093fdecb";
var group  = ContactsApp.getContactGroupById(id);

パラメータ

リターン

ContactGroup - 一致する連絡先グループ。一致する連絡先グループが見つからない場合は null

関連ドキュメント

• getContactGroups()

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

ユーザーの連絡先グループの一覧を取得します。

ユーザーは連絡先のリストを使用できるほか、場合によっては連絡先グループのリストも作成できます。各連絡先グループに連絡先を含めることができます。このメソッドは、すべての連絡先グループのリストを返します。

// The retrieves all the contract groups for the user and then logs the group name of each
// contact group.
var groups  = ContactsApp.getContactGroups();
for (var i = 0; i < groups.length; i++) {
  Logger.log(groups[i].getName());
}

リターン

ContactGroup[] - ユーザーの連絡先グループの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContactGroup(name)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

ユーザーのすべての連絡先を取得します。

// The code below will retrieve all the user's contacts
var contacts = ContactsApp.getContacts();

リターン

Contact[] - ユーザーのすべての連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

住所に一致する連絡先を取得します。

// The code below returns an array of contacts where the contact's address contains
// "San Francisco'.
var contacts = ContactsApp.getContactsByAddress('San Francisco');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

住所に一致する連絡先を、特定のフィールドに限定して取得します。

// The code below returns an array of contacts where the contact's address contains
// "San Francisco" in the Home address field.
var contacts = ContactsApp.getContactsByAddress('San Francisco',
                                                ContactsApp.Field.HOME_ADDRESS);

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

住所に一致する連絡先を、指定したカスタムの住所ラベルに限定して取得します。

// The code below returns an array of contacts where the contact's address contains
// "San Francisco" in a custom address label (created by the user) called
// "vacation".
var contacts = ContactsApp.getContactsByAddress('San Francisco', 'vacation');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

会社フィールドに一致する連絡先を取得します。

// The code below returns an array of contacts where the contact's company field
// contains "Google".
var contacts = ContactsApp.getContactsByCompany('Google');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

カスタム フィールドの指定値に一致する連絡先を取得します。

カスタム フィールドは、文字列または ContactsApp.ExtendedField の値のいずれかで指定できます。

// The code below returns an array of contacts where the contact's custom field
// named "Favorite Sport" contains "tennis".
var contacts = ContactsApp.getContactsByCustomField('tennis', 'Favorite Sport');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

特定の標準フィールドについて、指定した月と日に一致する連絡先を取得します。

// The code below returns an array of contacts where the contact's "Birthday" field
// contains April for the month and 19 for the day.
var contacts = ContactsApp.getContactsByDate(ContactsApp.Month.APRIL, 19,
                                              ContactsApp.Field.BIRTHDAY);

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

特定の標準フィールドについて、指定した年、月、日に一致する連絡先を取得します。

// The code below returns an array of contacts where the contact's "Birthday" field
// contains April for the month, 19 for the day, and 1950 for the year.
var contacts = ContactsApp.getContactsByDate(ContactsApp.Month.APRIL, 19, 1950,
                                             ContactsApp.Field.BIRTHDAY);

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

特定のカスタム フィールドについて指定した月、日、年と一致する連絡先を取得します。

// The code below returns an array of contacts where the contact's custom "Start Date" field
// contains April for the month, 19 for the day, and 2011 for the year.
var contacts = ContactsApp.getContactsByDate(ContactsApp.Month.APRIL, 19, 2011, 'Start Date');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

特定のカスタム フィールドについて指定した月と日に一致する連絡先を取得します。

// The code below returns an array of contacts where the contact's custom "Start Date" field
// contains April for the month and 19 for the day.
var contacts = ContactsApp.getContactsByDate(ContactsApp.Month.APRIL, 19, 'Start Date');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

メールアドレスが一致する連絡先を取得します。

// The code below returns an array of contacts where the contact's email address contains
// "john.doe@example.com'.
var contacts = ContactsApp.getContactsByEmailAddress('john.doe@example.com');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

メールアドレスに一致する連絡先を、特定のフィールドに限定して取得します。

// The code below returns an array of contacts where the contact's email address contains
// "john.doe@example.com" in the Home email field.
var contacts = ContactsApp.getContactsByEmailAddress('john.doe@example.com',
                                                     ContactsApp.Field.HOME_EMAIL);

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

メールアドレスに一致する連絡先を、指定したカスタム メールアドレスラベルに限定して取得します。

// The code below returns an array of contacts where the contact's email address contains
// "john.doe@example.com" in a custom email address label (created by the user) called
// "alternate".
var contacts = ContactsApp.getContactsByEmailAddress('john.doe@example.com', 'alternate');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

指定した ContactGroup の連絡先を取得します。

// The code below returns an array of contacts in the ContactGroup with the name
// "Work Friends".
var group  = ContactsApp.getContactGroup('Work Friends');
var contacts = ContactsApp.getContactsByGroup(group);

パラメータ

リターン

Contact[] - 指定されたグループ内の連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

インスタント メッセージのアドレスに一致する連絡先を取得します。

// The code below returns an array of contacts where the contact's instant messaging address
// contains "ChatWithJohnDoe" in any instant messaging field.
var contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

インスタント メッセージのアドレスに一致する連絡先を、特定のフィールドに限定して取得します。

// The code below returns an array of contacts where the contact's instant messaging address
// contains "ChatWithJohnDoe" in the AIM instant messaging field.
var contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe',
                                            ContactsApp.Field.AIM);

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

インスタント メッセージのアドレスに一致する連絡先を、指定したカスタム インスタント メッセージ ラベルに限定して取得します。

// The code below returns an array of contacts where the contact's instant messaging address
// contains "ChatWithJohnDoe" in a custom instant messaging label (created by the user) called
// "eBuddy".
var contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe', 'eBuddy');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

役職欄に一致する連絡先を取得します。

// The code below returns an array of contacts where the contact's job title field
// contains "Product Manager".
var contacts = ContactsApp.getContactsByJobTitle('Product Manager');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

名前に一致する連絡先を取得します。

// The code below returns an array of contacts where the contact name contains "John"
var contacts = ContactsApp.getContactsByName('John');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

名前に一致する特定のフィールドに限定された連絡先を取得します。

// The code below returns an array of contacts where the contact name contains "John"
// in the Given Name field.
var contacts = ContactsApp.getContactsByName('John', ContactsApp.Field.GIVEN_NAME);

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

メモ フィールドと一致する連絡先を取得します。

// The code below returns an array of contacts where the contact's notes field
// contains "sent birthday card".
var contacts = ContactsApp.getContactsByNotes('sent birthday card');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

電話番号と一致する連絡先を取得します。

この方法では、文字で始まる電話番号が展開されます。「212-555-CODE」を検索すると、連絡先に「212-555-2633」が含まれる場合、またはその逆の場合は、適切な連絡先が見つかります。

// The code below returns an array of contacts where the contact's phone number contains
// "212-555-1234' in any phone number field.
var contacts = ContactsApp.getContactsByPhone('212-555-1234');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

電話番号に一致する連絡先を、特定のフィールドに限定して取得します。

この方法では、文字で始まる電話番号が展開されます。「212-555-CODE」を検索すると、連絡先に「212-555-2633」が含まれる場合、またはその逆の場合は、適切な連絡先が見つかります。

// The code below returns an array of contacts where the contact's phone number contains
// "212-555-1234" in the Home phone number field.
var contacts = ContactsApp.getContactsByPhone('212-555-1234',
                                              ContactsApp.Field.HOME_PHONE);

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

電話番号に一致する連絡先を、指定したカスタムの電話番号ラベルに限定して取得します。

この方法では、文字で始まる電話番号が展開されます。「212-555-CODE」を検索すると、連絡先に「212-555-2633」が含まれる場合、またはその逆の場合は、適切な連絡先が見つかります。

// The code below returns an array of contacts where the contact's phone number contains
// "212-555-1234" in a custom phone number label (created by the user) called
// "alternate".
var contacts = ContactsApp.getContactsByPhone('212-555-1234', 'alternate');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

URL に一致する連絡先を取得します。

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com' in any URL field.
var contacts = ContactsApp.getContactsByUrl('www.example.com');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

URL に一致する連絡先を、特定のフィールドに限定して取得します。

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com" in the Work URL field.
var contacts = ContactsApp.getContactsByUrl('www.example.com',
                                            ContactsApp.Field.WORK_WEBSITE);

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

URL に一致する連絡先を、指定したカスタム URL ラベルに限定して取得します。

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com" in a custom URL label (created by the user) called
// "alternate work".
var contacts = ContactsApp.getContactsByUrl('www.example.com', 'alternate work');

パラメータ

リターン

Contact[] - 一致する連絡先の配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

• https://www.google.com/m8/feeds

関連ドキュメント

• getContact(emailAddress)