本頁面由 Cloud Translation API 翻譯而成。

Class ContactGroup

ContactGroup 是聯絡人群組。

已淘汰的方法

方法	傳回類型	簡短說明
`addContact(contact)`	`ContactGroup`	將指定的聯絡人新增至這個群組
`deleteGroup()`	`void`	刪除這個聯絡人群組。
`getContacts()`	`Contact[]`	取得這個聯絡人群組中的所有聯絡人。
`getGroupName()`	`String`	傳回這個群組的名稱。
`getId()`	`String`	取得這個聯絡人群組的 ID。
`getName()`	`String`	取得這個聯絡人群組的名稱。
`isSystemGroup()`	`Boolean`	取得布林值，以判斷這個聯絡人群組是否為系統群組 (可取消)。
`removeContact(contact)`	`ContactGroup`	將指定聯絡人從這個群組中移除
`setGroupName(name)`	`void`	設定這個群組的名稱。
`setName(name)`	`ContactGroup`	設定這個聯絡人群組的名稱。

已淘汰的方法

`addContact(contact)`

已淘汰。此函式已淘汰，不應在新的指令碼中使用。

將指定的聯絡人新增至這個群組

// The code below creates a new contact and adds it to the "Work Friends" contact group
var contact = ContactsApp.createContact('John', 'Doe', 'john.doe@example.com');
var group = ContactsApp.getContactGroup('Work Friends');
group.addContact(contact);

參數

名稱	類型	說明
`contact`	`Contact`	要加入群組的聯絡人

回攻員

ContactGroup：這個聯絡人群組

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

另請參閱

removeContact(contact)

`deleteGroup()`

已淘汰。此函式已淘汰，不應在新的指令碼中使用。

刪除這個聯絡人群組。

僅刪除非系統群組，且無法刪除系統群組。

// The code below retrieves a contact group named "Work Friends" and deletes it
var group = ContactsApp.getContactGroup('Work Friends');
group.deleteGroup();

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

另請參閱

isSystemGroup()

`getContacts()`

已淘汰。此函式已淘汰，不應在新的指令碼中使用。

取得這個聯絡人群組中的所有聯絡人。

// The code below retrieves all the contacts in the group named "Work Friends"
var group = ContactsApp.getContactGroup('Work Friends');
var contacts = group.getContacts();

回攻員

Contact[]：這個群組中的聯絡人

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

`getGroupName()`

已淘汰。此函式已淘汰，不應在新的指令碼中使用。

傳回這個群組的名稱。

回攻員

String：這個群組的名稱

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

`getId()`

已淘汰。此函式已淘汰，不應在新的指令碼中使用。

取得這個聯絡人群組的 ID。

// The code below retrieves a contact group named "Work Friends" and gets its id
var group = ContactsApp.getContactGroup('Work Friends');
var id = group.getId();

回攻員

String：這個群組的 ID

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

`getName()`

已淘汰。此函式已淘汰，不應在新的指令碼中使用。

取得這個聯絡人群組的名稱。

// The code below creates a new contact group and then retrieves its name
var group = ContactsApp.createContactGroup('Work Friends');
var name = group.getName();

回攻員

String：這個聯絡人群組的名稱

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

另請參閱

setName(name)

`isSystemGroup()`

已淘汰。此函式已淘汰，不應在新的指令碼中使用。

取得布林值，以判斷這個聯絡人群組是否為系統群組 (可取消)。

系統群組是 Google 聯絡人預先定義的一組群組，例如「我的聯絡人」、「家人」、「同事」等。系統群組名稱通常包含「系統群組」一詞。

// The code below retrieves two contact groups, then logs whether or not
// each is a system group.
var myGroup = ContactsApp.getContactGroup('Work Friends');
var systemGroup = ContactsApp.getContactGroup('System Group: Coworkers');
Logger.log(myGroup.isSystemGroup()); // Returns false, if the group exists.
Logger.log(systemGroup.isSystemGroup()); // Returns true.

回攻員

Boolean：是否這個聯絡人群組是否為系統群組

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

`removeContact(contact)`

已淘汰。此函式已淘汰，不應在新的指令碼中使用。

將指定聯絡人從這個群組中移除

// The code below retrieves all the contacts named "John Doe' and removes them from the
// "Work Friends" contact group
var contacts = ContactsApp.getContactsByName('John Doe');
var group = ContactsApp.getContactGroup('Work Friends');
for (var i in contacts) {
  group.removeContact(contacts[i]);
}

參數

名稱	類型	說明
`contact`	`Contact`	要從群組中移除的聯絡人

回攻員

ContactGroup：這個聯絡人群組

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

另請參閱

addContact(contact)

`setGroupName(name)`

已淘汰。此函式已淘汰，不應在新的指令碼中使用。

設定這個群組的名稱。

參數

名稱	類型	說明
`name`	`String`	要為這個群組設定的名稱

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

`setName(name)`

已淘汰。此函式已淘汰，不應在新的指令碼中使用。

設定這個聯絡人群組名稱。

// The code below retrieves the contact group named "Work Friends" and renames it to
// "Work Buddies"
var group = ContactsApp.getContactGroup('Work Friends');
group.setName('Work Buddies');

參數

名稱	類型	說明
`name`	`String`	聯絡人群組的新名稱

回攻員

ContactGroup：這個聯絡人群組

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

另請參閱

getName()