今日からGoogleコンタクトが操作できるGASのコード一覧

  • このエントリーをはてなブックマークに追加
  • Pocket
  • LINEで送る
Googleコンタクトアイコン

ContactAppの概要

ContactAppとは、Google Apps Scriptで連絡先の操作を行う際に利用するコードのことですが、ContactAppに用意されているメソッドでは、次のような操作がプログラム上で実行できます。

  • 既存連絡先から情報取得
  • 新規連絡先の作成
  • 既存連絡先の修正
  • 既存連絡先の削除

クラス名一覧

ContactApp AddressFeild CompanyField Contact
ContactGroup CustomField DateField EmailField
IMField PhotoField UrlField

※クリックすると対象場所にジャンプします

列挙型一覧

 ExtendedField  Field Gender
 Priority  Sensitivity

※クリックすると対象場所にジャンプします

クラス別メソッド名一覧

Class ContactApp

メソッド名  返り値  簡単な説明
 createContact  Contact 新規連絡先を作成
 createContentGroup  ContactGroup 新規コンタクトグループを作成
 deleteContact  Void 連絡先を削除
 deleteContactGroup  Void コンタクトグループを削除
 getContact  Contact Eメールアドレスから連絡先を取得
 getContactById  Contact IDから連絡先を取得
 getContactGroup  ContactGroup グループ名からコンタクトグループを取得
 getContactGroupById  ContactGroup グループIDからコンタクトグループを取得
 getContactGroups  ContactGroup[] すべてのコンタクトグループを配列で取得
 getContacts  Contact[] すべての連絡先を配列で取得
 getContactsByAddress  Contact[] 指定住所に一致する連絡先を配列で取得
 getContactsByCompany  Contact[] 指定会社に一致する連絡先を配列で取得
 getContactsByCustomField  Contact[] 指定カスタムフィールドに一致する連絡先を配列で取得
 getContactsByDate  Contact[] 特定のカスタムフィールドの日付に一致する連絡先を配列で取得
 getContactsByEmailAddress  Contact[] 指定Eメールアドレスに一致する連絡先を配列で取得
 getContactsByGroup  Contact[] 指定グループに属する連絡先を配列で取得
 getContactsByIM  Contact[] 指定インスタントメッセンジャーアドレスに一致する連絡先を配列で取得
 getContactsByJobTitle  Contact[] 指定役職に一致する連絡先を配列で取得
 getContactsByName  Contact[] 指定の名前に一致する連絡先を配列で取得
 getContactsByNotes  Contact[] 指定の文字列にメモの内容が一致する連絡先を配列で取得
 getContactsByPhone  Contact[] 指定電話番号に一致する連絡先を配列で取得
 getContactsByUrl  Contact[] 指定URLに一致する連絡先を配列で取得

Class AddressField

メソッド名  返り値  簡単な説明
 deleteAddressField  Void 住所欄を削除
 getAddress  String 住所を取得
 getLabel  Object ラベルを取得
 isPrimary  Boolean 主住所かどうかを真偽値で取得
 setAddress  AddressField 住所を設定
 setAsPrimary  AddressField 主住所として設定
 setLabel  AddressField ラベルを設定

Class CompanyField

メソッド名  返り値  簡単な説明
 deleteCompanyField  Void 勤務先欄を削除
 getCompanyName  String 勤務先を取得
 getJobTitle  String 役職名を取得
 isPrimary  Boolean 主勤務先かどうかを真偽値で取得
 setAsPrimary  CompanyField 主勤務先として設定
 setCompanyName  CompanyField 勤務先を設定
 setJobTitle  CompanyField 役職を設定

Class Contact

メソッド名  返り値  簡単な説明
 addAddress  AddressField 住所を追加
 addCompany  CompanyField 勤務先を追加
 addCustomField  CustomField カスタムフィールドを追加
 addDate  DateField 日付フィールドを追加
 addEmail  EmailField Eメールアドレスを追加
 addIM  IMField インスタントメッセンジャーアドレスを追加
 addPhone  PhoneField 電話番号を追加
 addToGroup  Contact 指定グループに連絡先を追加
 addUrl  UrlField URLを追加
 deleteContact  Void 連絡先を削除
 getAddresses  AddressField アドレスを取得
 getCompanies  CompanyField[] 勤務先を配列で取得
 getContactGroups  ContactGroup[] コンタクトグループを配列で取得
 getCustomFields  CustomField[] カスタムフィールドを配列で取得
 getDates  DateField[] 日付フィールドを配列で取得
 getEmails  EmailField[] Eメールアドレスを配列で取得
 getFamilyName  String 苗字を取得
 getFullName  String 氏名を取得
 getGivenName  String 名前を取得
 getIMs  IMField[] インスタントメッセンジャーアドレスを配列で取得
 getId  String コンタクトIDを取得
 getInitials  String イニシャルを取得
 getLastUpdated  Date 連絡先データの最終更新日を取得
 getMaidenName  String 旧姓を取得
 getMiddleName  String ミドルネームを取得
 getNickname  String ニックネームを取得
 getNotes  String メモ欄の内容を取得
 getPhones  PhoneField[] 電話番号を配列で取得
 getPrefix  String 敬称を取得
 getPrimaryEmail  String 主Eメールアドレスを取得
 getShortName  String 短縮名を取得
 getSuffix  String 称号を取得
 getUrls  UrlField[] URLを配列で取得
 removeFromGroup  Contact コンタクトグループから削除
 setFamilyName  Contact 苗字を設定
 setFullName  Contact 氏名を設定
 setGivenName  Contact 名前を設定
 setInitials  Contact イニシャルを設定
 setMaidenName  Contact 旧姓を設定
 setMiddleName  Contact ミドルネームを設定
 setNickname  Contact ニックネームを設定
 setNotes  Contact メモ書きを設定
 setPrefix  Contact 敬称を設定
 setShortName  Contact 短縮名を設定
 setSuffix  Contact 称号を設定

Class ContactGroup

メソッド名  返り値  簡単な説明
 addContact  ContactGroup 連絡先を追加
 deleteGroup  Void コンタクトグループを削除
 getContacts  Contact[] 所属する連絡先を配列で取得
 getId  String コンタクトグループIDを取得
 getName  String コンタクトグループ名を取得
 isSystemGroup  Boolean 削除不可能なグループかどうかを真偽値で取得
 removeContact  ContactGroup 連絡先の所属を解除
 setName  ContactGroup コンタクトグループ名を設定

Class CustomField

メソッド名  返り値  簡単な説明
 deleteCustomField  Void カスタムフィールドを削除
 getLabel  Object ラベルを取得
 getValue  Object 値を取得
 setLabel  CustomField ラベルを設定
 setValue  CustomField 値を設定

Class DateField

メソッド名  返り値  簡単な説明
 deleteDateField  Void 日付欄を削除
 getDay  Integer 日を取得
 getLabel  Object ラベルを取得
 getMonth  Month 月を取得
 getYear  Integer 年を取得
 setDate  DateField 日付フィールドに値を設定
 setLabel  DateField 日付フィールドにラベルを設定

Class EmailField

メソッド名  返り値  簡単な説明
 deleteEmailField  Void Eメール欄を削除
 getAddress  String Eメールアドレスを取得
 getDisplayName  String 表示名を取得
 getLabel  Object ラベルを取得
 isPrimary  Boolean 主Eメールアドレスかどうかを真偽値で取得
 setAddress  EmailField Eメールアドレスを設定
 setAsPrimary  EmailField 主Eメールアドレスとして設定
 setDisplayName  EmailField 表示名を設定
 setLabel  EmailField ラベルを設定

Class IMField

メソッド名  返り値  簡単な説明
 deleteIMField  Void インスタントメッセンジャー欄を削除
 getAddress  String インスタントメッセンジャーアドレスを取得
 getLabel  Object インスタントメッセンジャーアドレスのラベルを取得
 isPrimary  Boolean 主インスタントメッセンジャーアドレスかどうかを真偽値で取得
 setAddress  IMField インスタントメッセンジャーアドレスを設定
 setAsPrimary  IMField 主インスタントメッセンジャーアドレスとして設定
 setLabel  IMField インスタントメッセンジャーアドレスのラベルを設定

Class PhotoField

メソッド名  返り値  簡単な説明
 deletePhoneField  Void 電話番号欄を削除
 getLabel  Object 電話番号のラベルを取得
 getPhoneNumber  String 電話番号を取得
 isPrimary  Boolean 主番号かどうかを真偽値で取得
 setAsPrimary  PhoneField 主番号として設定
 setLabel  PhoneField 電話番号のラベルを設定
 setPhoneNumber  PhoneField 電話番号を設定

Class UrlField

メソッド名  返り値  簡単な説明
 deleteUrlField  Void URL欄を削除
 getAddress  String URLを取得
 getLabel  Object URLのラベルを取得
 isPrimary  Boolean 主URLかどうかを真偽値で取得
 setAddress  UrlField URLを設定
 setAsPrimary  UrlField 主URLとして設定
 setLabel  UrlField URLのラベルを設定

列挙型名一覧

Enums ExtendedField

 プロパティ  タイプ  説明
 HOBBY  Enum コンタクトの趣味
 MILEAGE  Enum コンタクトのマイレージ
 LANGUAGE  Enum コンタクトの言語
 GENDER  Enum コンタクトの性別
 BILLING_INFORMATION  Enum コンタクトの請求情報
 DIRECTORY_SERVER  Enum
 SENSITIVITY  Enum コンタクトの感性
 PRIORITY  Enum コンタクトの優先度
 HOME  Enum コンタクトの自宅情報
 WORK  Enum コンタクトの仕事情報
 USER  Enum コンタクトのユーザー情報
 OTHER  Enum コンタクトのその他の情報

Enums Field

 プロパティ  タイプ  説明
 FULL_NAME  Enum  連絡先のフルネーム
 GIVEN_NAME  Enum  連絡先の名前
 MIDDLE_NAME  Enum  連絡先のミドルネーム
 FAMILY_NAME  Enum  連絡先の苗字
 MAIDEN_NAME  Enum  連絡先の旧姓
 NICKNAME  Enum  連絡先のニックネーム
 SHORT_NAME  Enum  連絡先の短縮名
 INITIALS  Enum  連絡先のイニシャル
 PREFIX  Enum  連絡先の敬称
 SUFFIX  Enum  連絡先の称号
 HOME_EMAIL  Enum  連絡先の個人メールアドレス
 WORK_EMAIL  Enum  連絡先の会社メールアドレス
 BIRTHDAY  Enum  連絡先の誕生日
 ANNIVERSARY  Enum  連絡先の記念日
 HOME_ADDRESS  Enum  連絡先の個人住所
 WORK_ADDRESS  Enum  連絡先の会社住所
 ASSISTANT_PHONE  Enum  連絡先の秘書電話番号
 CALLBACK_PHONE  Enum  連絡先のコールバック用電話番号
 MAIN_PHONE  Enum  連絡先のメイン電話番号
 PAGER  Enum  連絡先のポケベル
 HOME_FAX  Enum  連絡先の個人ファックス
 WORK_FAX  Enum  連絡先の会社ファックス
 HOME_PHONE  Enum  連絡先の個人電話番号
 WORK_PHONE  Enum  連絡先の会社電話番号
 MOBILE_PHONE  Enum  連絡先の携帯番号
 GOOGLE_VOICE  Enum  連絡先のGoogleボイス
 NOTES  Enum  連絡先のメモ
 GOOGLE_TALK  Enum  連絡先のハングアウト
 AIM  Enum  連絡先のAOLインスタントメッセンジャー
 YAHOO  Enum  連絡先のYahooメッセンジャー
 SKYPE  Enum  連絡先のSkype
 QQ  Enum  連絡先のQQ
 MSN  Enum  連絡先のMSN
 ICQ  Enum  連絡先のICQ
 JABBER  Enum  連絡先のJabber
 BLOG  Enum  連絡先のブログURL
 FTP  Enum  連絡先のFTP URL
 PROFILE  Enum  連絡先のプロフィールURL
 HOME_PAGE  Enum  連絡先のホームページURL
 WORK_WEBSITE  Enum  連絡先の会社ウェブサイトURL
 HOME_WEBSITE  Enum  連絡先の個人ウェブサイトURL
 JOB_TITLE  Enum  連絡先の役職
 COMPANY  Enum  連絡先の会社名

Enums Gender

 プロパティ  タイプ  説明
 MAIL  Enum  男性
 FEMAIL  Enum  女性

Enums Priority

 プロパティ  タイプ  説明
 HIGH  Enum  優先順位高
 LOW  Enum  優先順位低
 NORMAL  Enum  優先順位中

Enums Sensitivity

 プロパティ  タイプ  説明
 CONFIDENTIAL  Enum 秘匿
 NORMAL  Enum 通常
 PERSONAL  Enum 個人用
 PRIVATE  Enum 個人用

SNSでもご購読できます。

コメントを残す

*