Class EmailField

EmailField

非推奨。代わりに、People API Advanced の サービス

連絡先のメール フィールド。

メソッド

メソッド	戻り値の型	概要
getAddress()	String	このフィールドのアドレスを取得します。
getLabel()	Object	このフィールドのラベルを取得します。
isPrimary()	Boolean	これがプライマリ フィールド値かどうかを取得します。
setAddress(address)	EmailField	このフィールドのアドレスを設定します。
setAsPrimary()	EmailField	このフィールドをプライマリに設定します。
setLabel(field)	EmailField	このフィールドのラベルを設定します。
setLabel(label)	EmailField	このフィールドのラベルを設定します。

サポート終了のメソッド

メソッド	戻り値の型	概要
deleteEmailField()	void	このメールアドレスを連絡先から削除します。
getDisplayName()	String	このメールアドレスの表示名を返します。
setDisplayName(name)	EmailField	このメールアドレスの表示名を設定します。

詳細なドキュメント

getAddress()

このフィールドのアドレスを取得します。

// Logs the address for the 'Home Address' field for contact 'John Doe'.
// Can be used similarly for other fields that contain addresses.
var contacts = ContactsApp.getContactsByName('John Doe');
var homeAddress = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);
Logger.log(homeAddress[0].getAddress());

戻る

String - 文字列でのアドレス

承認

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

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

---

getLabel()

このフィールドのラベルを取得します。Field、ExtendedField、または String になります。

// Logs the label for all the address fields associated with contact
// 'John Doe'. This method can be similarly called for any field that has
// a label.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
for (var i = 0; i < addressFields.length; i++) {
  Logger.log(addressFields[i].getLabel());
}

戻る

Object - このフィールドのラベル

承認

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

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

---

isPrimary()

これがプライマリ フィールド値かどうかを取得します。

// Logs whether or not the first address field associated with contact
// 'John Doe' is labeled as primary. This method can be similarly called
// for any field.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
Logger.log(addressFields[0].isPrimary());

戻る

Boolean - プライマリかどうか

承認

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

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

---

setAddress(address)

このフィールドのアドレスを設定します。

// Sets the address for the 'Home Address' field for contact 'John Doe'.
// Can be used similarly for other fields that contain addresses.
var contacts = ContactsApp.getContactsByName('John Doe');
var homeAddress = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);
homeAddress[0].setAddress('123 Main St, Raleigh, NC, 27601');

パラメータ

名前	型	説明
address	String	新しい住所

戻る

EmailField - このフィールド、チェーン接続に有用

承認

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

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

---

setAsPrimary()

このフィールドをプライマリに設定します。

// Sets the the first address field associated with contact 'John Doe'
// as primary. This method can be similarly called for any field.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
addressFields[0].setAsPrimary();

戻る

EmailField - この FieldValue（チェーン用）

承認

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

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

---

setLabel(field)

このフィールドのラベルを設定します。

// Sets the label to 'Work' for the first address field associated
// with contact 'John Doe'. This method can be similarly called for any
// field that has a label.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
addressFields[0].setLabel(ContactsApp.Field.WORK_ADDRESS);

パラメータ

名前	型	説明
field	Field	新しい標準ラベルは

戻る

EmailField - この FieldValue（チェーン用）

承認

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

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

---

setLabel(label)

このフィールドのラベルを設定します。

// Sets the label to 'Apartment' for the first address field associated
// with contact 'John Doe'. This method can be similarly called for any
// field that has a label.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
addressFields[0].setLabel('Apartment');

パラメータ

名前	型	説明
label	String	このフィールドの新しいラベルです。

戻る

EmailField - このフィールド、チェーン接続に有用

承認

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

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

サポート終了のメソッド

deleteEmailField()

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

このメールアドレスを連絡先から削除します。

// Retrieves and deletes the work email address for contact 'John Doe'
var contacts = ContactsApp.getContactsByName('John Doe');
var workEmail = contacts[0].getEmails(ContactsApp.Field.WORK_EMAIL);
workEmail[0].deleteEmailField();

承認

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

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

---

getDisplayName()

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

このメールアドレスの表示名を返します。

// Logs the display name for the the work email address for contact 'John Doe'
var contacts = ContactsApp.getContactsByName('John Doe');
var workEmail = contacts[0].getEmails(ContactsApp.Field.WORK_EMAIL);
Logger.log(workEmail[0].getDisplayName());

戻る

String - このメールの表示名

承認

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

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

---

setDisplayName(name)

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

このメールアドレスの表示名を設定します。

// Sets the display name to 'Doe, John' for the the work email address for contact 'John Doe'
var contacts = ContactsApp.getContactsByName('John Doe');
var workEmail = contacts[0].getEmails(ContactsApp.Field.WORK_EMAIL);
workEmail[0].setDisplayName('Doe, John');

パラメータ

名前	型	説明
name	String	このメールアドレスの新しい表示名

戻る

EmailField - このメール フィールド。チェーンに便利です。

承認

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

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