Class ContactsApp

連絡先アプリ

非推奨。代わりに、People API アドバンスト サービスを使用してください。

このクラスを使用すると、ユーザーは自分の Google コンタクトにアクセスし、そこに表示されている連絡先を作成、削除、更新できます。

サポートが終了したプロパティ

プロパティ	タイプ	説明
ExtendedField	ExtendedField
Field	Field
Gender	Gender
Month	Month
Priority	Priority
Sensitivity	Sensitivity

サポート終了のメソッド

メソッド	戻り値の型	概要
createContact(givenName, familyName, email)	Contact	新しい連絡先を作成します。
createContactGroup(name)	ContactGroup	指定された名前の連絡先グループを作成します。 // The code below creates a new contact group named "Work Friends" const group = ContactsApp.createContactGroup('Work Friends');
deleteContact(contact)	void	連絡先を削除します。
deleteContactGroup(group)	void	連絡先グループを削除します // The code below creates deletes the contact group named "Work Friends" const group = ContactsApp.getContactGroup('Work Friends'); ContactsApp.deleteContactGroup(group);
findByEmailAddress(email)	Contact	指定したメールアドレスの連絡先を検索します。
findContactGroup(name)	ContactGroup	指定した名前の連絡先グループを検索します。
getAllContacts()	Contact[]	このユーザーに属するすべての連絡先を取得します。
getContact(emailAddress)	Contact	メールアドレスで連絡先を取得します。
getContactById(id)	Contact	この ID の連絡先を取得します。
getContactGroup(name)	ContactGroup	指定された名前の連絡先グループを取得します。そのような連絡先グループが見つからない場合、null を返します。
getContactGroupById(id)	ContactGroup	指定された ID の連絡先グループを取得します。そのような連絡先グループが見つからない場合、null を返します。
getContactGroups()	ContactGroup[]	ユーザーの連絡先グループの完全なリストを取得します。
getContacts()	Contact[]	ユーザーの連絡先をすべて取得します。
getContactsByAddress(query)	Contact[]	住所に一致する連絡先を取得します。
getContactsByAddress(query, label)	Contact[]	住所と一致する連絡先を特定のフィールドに限定して取得します。
getContactsByAddress(query, label)	Contact[]	指定されたカスタム住所ラベルに限定して、住所に一致する連絡先を取得します。
getContactsByCompany(query)	Contact[]	会社フィールドに一致する連絡先を取得します。
getContactsByCustomField(query, label)	Contact[]	カスタム フィールドの特定の値に一致する連絡先を取得します。
getContactsByDate(month, day, label)	Contact[]	特定の標準フィールドの特定の月と日に一致する連絡先を取得します。
getContactsByDate(month, day, year, label)	Contact[]	特定の標準フィールドの指定された月、日、年と一致する連絡先を取得します。
getContactsByDate(month, day, year, label)	Contact[]	特定のカスタム フィールドの指定した月、日、年と一致する連絡先を取得します。
getContactsByDate(month, day, label)	Contact[]	特定のカスタム フィールドの特定の月と日に一致する連絡先を取得します。
getContactsByEmailAddress(query)	Contact[]	メールアドレスに一致する連絡先を取得します。
getContactsByEmailAddress(query, label)	Contact[]	メールアドレスに一致する連絡先を取得し、特定のフィールドに限定します。
getContactsByEmailAddress(query, label)	Contact[]	指定されたカスタム メールアドレスラベルに限定して、メールアドレスに一致する連絡先を取得します。
getContactsByGroup(group)	Contact[]	指定した ContactGroup 内の連絡先を取得します。
getContactsByIM(query)	Contact[]	インスタント メッセージ アドレスに一致する連絡先を取得します。
getContactsByIM(query, label)	Contact[]	特定のフィールドに限定して、インスタント メッセージ アドレスに一致する連絡先を取得します。
getContactsByIM(query, label)	Contact[]	インスタント メッセージ アドレスに一致する連絡先を取得します。取得する連絡先は、指定されたカスタム インスタント メッセージのラベルに限定されます。
getContactsByJobTitle(query)	Contact[]	役職フィールドに一致する連絡先を取得します。
getContactsByName(query)	Contact[]	名前に一致する連絡先を取得します。
getContactsByName(query, label)	Contact[]	名前に一致する連絡先を取得し、特定のフィールドに限定します。
getContactsByNotes(query)	Contact[]	メモ フィールドに一致する連絡先を取得します。
getContactsByPhone(query)	Contact[]	電話番号に一致する連絡先を取得します。
getContactsByPhone(query, label)	Contact[]	電話番号に一致する連絡先を取得します。特定のフィールドに限定できます。
getContactsByPhone(query, label)	Contact[]	指定されたカスタム電話番号ラベルに限定して、電話番号に一致する連絡先を取得します。
getContactsByUrl(query)	Contact[]	URL に一致する連絡先を取得します。
getContactsByUrl(query, label)	Contact[]	URL に一致する連絡先を特定のフィールドに限定して取得します。
getContactsByUrl(query, label)	Contact[]	指定されたカスタム URL ラベルに限定して、URL に一致する連絡先を取得します。

サポート終了のメソッド

createContact(givenName, familyName, email)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

// The code below creates a new contact with the name "John Doe" and the email
// address "[e-mail]".
const contact = ContactsApp.createContact(
    'John',
    'Doe',
    '[e-mail]',
);

パラメータ

名前	型	説明
givenName	String	連絡先の名前（名）
familyName	String	連絡先の姓
email	String	連絡先のメールアドレス

戻る

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

承認

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

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

関連情報

• deleteContact(contact)

---

createContactGroup(name)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
name	String	新しい連絡先グループの名前

戻る

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

承認

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

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

関連情報

• deleteContactGroup(group)

---

deleteContact(contact)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

連絡先を削除します。

// The code below retrieves a contact with the email address
// "[e-mail]" and then deletes that contact.
const contact = ContactsApp.getContact('[e-mail]');
ContactsApp.deleteContact(contact);

パラメータ

名前	型	説明
contact	Contact	削除する連絡先

承認

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

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

関連情報

• createContact(givenName, familyName, email)

---

deleteContactGroup(group)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
group	ContactGroup	削除する連絡先グループ

承認

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

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

関連情報

• createContactGroup(name)

---

findByEmailAddress(email)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

パラメータ

名前	型	説明
email	String	検索する連絡先のメールアドレス

戻る

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

承認

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

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

---

findContactGroup(name)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

パラメータ

名前	型	説明
name	String	検索する連絡先グループの名前

戻る

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

承認

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

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

---

getAllContacts()

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

戻る

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

承認

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

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

---

getContact(emailAddress)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

// The code below retrieves a contact with the email address
// "[e-mail]".
const contact = ContactsApp.getContact('[e-mail]');

パラメータ

名前	型	説明
emailAddress	String	連絡先のメールアドレス

戻る

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

承認

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

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

関連情報

• getContacts()
• getContactById(id)

---

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"
const id =
    'http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34c';
const contact = ContactsApp.getContactById(id);

パラメータ

名前	型	説明
id	String	取得する連絡先の ID

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactGroup(name)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
name	String	一致する連絡先グループの名前

戻る

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

承認

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

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

関連情報

• getContactGroups()

---

getContactGroupById(id)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

指定された 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"
const id =
    'http://www.google.com/m8/feeds/groups/john.doe%40example.com/base/54eefbb093fdecb';
const group = ContactsApp.getContactGroupById(id);

パラメータ

名前	型	説明
id	String	照合する連絡先グループの ID

戻る

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

関連情報

• getContactGroups()

---

getContactGroups()

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

ユーザーの連絡先グループの完全なリストを取得します。

ユーザーは連絡先のリストだけでなく、連絡先グループのリストも持つことができます。各連絡先グループには連絡先を含めることができます。このメソッドは、すべての連絡先グループのリストを返します。

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

戻る

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

承認

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

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

関連情報

• getContactGroup(name)

---

getContacts()

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByAddress(query)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
query	String	連絡先の住所で検索する文字列

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByAddress(query, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
query	String	連絡先の住所で検索する文字列
label	Field	検索するフィールド

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByAddress(query, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

// 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".
const contacts = ContactsApp.getContactsByAddress('San Francisco', 'vacation');

パラメータ

名前	型	説明
query	String	指定されたカスタム住所ラベルを使用して連絡先の住所で検索する文字列
label	String	検索するカスタム住所ラベル

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByCompany(query)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
query	String	連絡先の会社フィールドで検索する文字列

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByCustomField(query, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

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

パラメータ

名前	型	説明
query	Object	連絡先のカスタム フィールドで検索する文字列
label	ExtendedField	検索するカスタム フィールド

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByDate(month, day, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
month	Month	一致させる月（ContactsApp.Month の値のいずれか）
day	Integer	一致する日
label	Field	検索するフィールド（ContactsApp.Field から取得）

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByDate(month, day, year, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

// 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.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    1950,
    ContactsApp.Field.BIRTHDAY,
);

パラメータ

名前	型	説明
month	Month	一致させる月（ContactsApp.Month の値のいずれか）
day	Integer	一致する日
year	Integer	一致させる年（null にできます）
label	Field	検索するフィールド（ContactsApp.Field から取得）

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByDate(month, day, year, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

// 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.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    2011,
    'Start Date',
);

パラメータ

名前	型	説明
month	Month	一致させる月（ContactsApp.Month の値のいずれか）
day	Integer	一致する日
year	Integer	一致させる年（null にできます）
label	String	検索するカスタム フィールド

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByDate(month, day, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

// 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.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    'Start Date',
);

パラメータ

名前	型	説明
month	Month	一致させる月（ContactsApp.Month の値のいずれか）
day	Integer	一致する日
label	String	検索するカスタム フィールド

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByEmailAddress(query)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

// The code below returns an array of contacts where the contact's email address
// contains "[e-mail]'.
const contacts = ContactsApp.getContactsByEmailAddress('[e-mail]');

パラメータ

名前	型	説明
query	String	連絡先のメールアドレスで検索する文字列

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByEmailAddress(query, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

// The code below returns an array of contacts where the contact's email address
// contains "[e-mail]" in the Home email field.
const contacts = ContactsApp.getContactsByEmailAddress(
    '[e-mail]',
    ContactsApp.Field.HOME_EMAIL,
);

パラメータ

名前	型	説明
query	String	連絡先のメールアドレスで検索する文字列
label	Field	検索するフィールド

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByEmailAddress(query, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

// The code below returns an array of contacts where the contact's email address
// contains "[e-mail]" in a custom email address label (created by
// the user) called "alternate".
const contacts = ContactsApp.getContactsByEmailAddress(
    '[e-mail]',
    'alternate',
);

パラメータ

名前	型	説明
query	String	指定されたカスタム メールアドレスラベルを持つ連絡先のメールアドレスで検索する文字列
label	String	検索対象のカスタム メールアドレスのラベル

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByGroup(group)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
group	ContactGroup	連絡先のグループ

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByIM(query)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
query	String	連絡先のインスタント メッセージ アドレスで検索する文字列

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByIM(query, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
query	String	連絡先のインスタント メッセージ アドレスで検索する文字列
label	Field	検索するフィールド

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByIM(query, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

// 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".
const contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe', 'eBuddy');

パラメータ

名前	型	説明
query	String	指定したカスタム インスタント メッセージ ラベルを使用して、連絡先のインスタント メッセージ アドレスで検索する文字列
label	String	検索対象のカスタム インスタント メッセージ ラベル

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByJobTitle(query)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
query	String	連絡先の役職フィールドで検索する文字列

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByName(query)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
query	String	連絡先名で検索する文字列

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByName(query, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
query	String	連絡先名で検索する文字列
label	Field	検索するフィールド

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByNotes(query)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
query	String	連絡先のメモ欄で検索する文字列

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByPhone(query)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

この方法では、文字で表された電話番号が展開されます。たとえば、「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.
const contacts = ContactsApp.getContactsByPhone('212-555-1234');

パラメータ

名前	型	説明
query	String	連絡先の電話番号で検索する文字列

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByPhone(query, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

この方法では、文字で表された電話番号が展開されます。たとえば、「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.
const contacts = ContactsApp.getContactsByPhone(
    '212-555-1234',
    ContactsApp.Field.HOME_PHONE,
);

パラメータ

名前	型	説明
query	String	連絡先の電話番号で検索する文字列
label	Field	検索するフィールド

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByPhone(query, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

この方法では、文字で表された電話番号が展開されます。たとえば、「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".
const contacts = ContactsApp.getContactsByPhone('212-555-1234', 'alternate');

パラメータ

名前	型	説明
query	String	指定されたカスタム電話番号ラベルを使用して、連絡先の電話番号で検索する文字列
label	String	検索するカスタム電話番号ラベル

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByUrl(query)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
query	String	連絡先の URL で検索する文字列

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByUrl(query, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

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

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

パラメータ

名前	型	説明
query	String	連絡先の URL で検索する文字列
label	Field	検索するフィールド

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)

---

getContactsByUrl(query, label)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

指定されたカスタム 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".
const contacts = ContactsApp.getContactsByUrl(
    'www.example.com',
    'alternate work',
);

パラメータ

名前	型	説明
query	String	指定したカスタム URL ラベルを持つ連絡先の URL で検索する文字列
label	String	検索するカスタム URL ラベル

戻る

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

承認

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

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

関連情報

• getContact(emailAddress)