Googleカレンダ - メソッド

パラメタ

説明

Add Calendar Subscription

指定されたカレンダにユーザをサブスクライブします。

カレンダID

サブスクリプションを指定したカレンダIDに追加します。このパラメータは、追加／修正するイベントの位置付けるために使用されます。

エラーコード

Magic xpiのエラーコードが戻ります。

Add User to Access Control

ユーザをアクセス制御リストに追加し、ユーザのアクセス権を設定します。

カレンダID

ユーザとユーザのアクセス権を指定したカレンダIDのアクセス制御リストに追加します。

ユーザ

アクセス制御リストに追加したいユーザID。以下のようなユーザのGmailアドレスを入力します。:xyz@gmail.com

権利

ドロップダウンリストからユーザクラスに従って、以下のアクセス権を選択します。

• FREEBUSY

• READ

• EDITOR

• OWNER

エラーコード

Magic xpiのエラーコードが戻ります。

Create Calendar

新しい第2のカレンダを作成します(ユーザのメインカレンダは作成できません)。

タイトル

カレンダのタイトル

説明

カレンダの説明

ロケーション

カレンダの場所

タイムゾーン

カレンダのタイムゾーン。例：”Asia/Tokyo”

非表示

カレンダがインタフェース内に表示されるかどうかを指定します。ドロップダウンリストから、どちらかを選択してください。:

• False

• True

選択

カレンダがインタフェースから選択できるかどうかを指定します。ドロップダウンリストから、どちらかを選択してください。

• False

• True

色

カレンダのユーザインターフェイスの色

カレンダID

新しく作成されたカレンダのAtom ID

エラーコード

Magic xpiのエラーコードが戻ります。

Create Calendar Event

指定されたGoogleカレンダ内の単一イベントを作成します。

カレンダID

(デフォルトの)メインアカウント以外のカレンダアカウントを指定します。

タイトル

イベントのタイトル

説明

イベントの説明

ロケーション

イベントの場所

終日イベント

イベントが終日行われるものかどうかを指定します。ドロップダウンリストから、どちらかを選択してください:

• No (デフォルト)

• Yes

イベント開始日

イベントの開始日

イベント開始時刻

イベントの開始時刻

期間（分）

イベントの期間

イベント終了日

イベントの終了日

［終日イベント］がYesに設定された場合のみ有効です。

イベントの繰り返し

イベントの繰り返し間隔を選択します。ドロップダウンリストから、どちらかを選択してください。

• 繰返なし

• 日次

• 週次

• 月次

• 年次

毎回繰り返し

繰り返しで選択された値の繰返し頻度を指定します。

［イベントの繰り返し］パラメータが繰返なし以外に設定された場合に有効です。

繰り返し終了日

イベントの終了日。ここに、値を設定しない場合、永久に繰り返されます。

［イベントの繰り返し］パラメータが繰返なし以外に設定された場合に有効です。

毎週繰返し

イベントが毎週どの曜日に実行されるかを、数値で指定します。

• 1= 日曜日

• 2= 月曜日

• 3= 火曜日

• 4= 水曜日

• 5= 木曜日

• 6= 金曜日

• 7= 土曜日

例えば、イベントを日曜日と水曜日、金曜日に実行させる場合は、1,4,6と指定します。

［イベントの繰り返し］パラメータが週次に設定された場合以外で有効です。

毎月繰返し

イベントが毎月繰り返される日付をドロップダウンリストから選択します。有効な値は1-31です。

［イベントの繰り返し］パラメータが月次に設定された場合以外で有効です。

参加者

参加者の電子メールアドレスをカンマ区切りで入力します。通知は、指定された全てのアドレスに送信されます。

リマインダーのメソッド

Googleカレンダから通知をを受け取る方法を選択します。ドロップダウンリストから、どちらかを選択してください。

• 通知なし (デフォルト)

• デフォルト

• アラート

• 電子メール

• SMS

リマインダーの期間

Googleカレンダから通知を受け取る頻度を数値で指定します。

この値は、［通知頻度タイプ］パラメータで指定された頻度で通知を行います。

［通知方法］パラメータがアラート、電子メール、またはSMSに設定される場合、このパラメータは有効です。

リマインダーの期間タイプ

通知頻度のタイプをドロップダウンリストから選択します。

• 分

• 時

• 日

• 週

［通知方法］パラメータがアラート、電子メール、またはSMSに設定される場合、このパラメータは有効です。

イベント期間を表示

イベントの有効性を表示します。ドロップダウンリストから、どちらかを選択してください。

• 使用可能

• ビジー状態 (デフォルト)

プライバシー

必要なプライバシーレベルをドロップダウンリストから選択します。

• デフォルト  (デフォルト)

• プライベート

• パブリック

拡張プロパティ

拡張されたプロパティ(任意の名前の組合せ)をカレンダイベントに追加することができます。追加された内容は、アプリケーション固有のIDまたはGoogleカレンダとアクセスする際にアプリケーションに必要な情報を保存するために使用されます。

プロパティの名前は、最大47桁まで指定できます。値は最大1024桁までの文字を含めることができます。拡張されたプロパティは、カレンダのユーザインターフェイス内で表示されないAPIを使用してのみアクセスできます。

これらは、以下の例に従って<名前>,<値>のフラットファイルフォーマットで指定します。

• Pr1,56

• Pr2,user

• Pr3,password

イベントID

新しく作成されたイベントID

エラーコード

Magic xpiのエラーコードが戻ります。

Delete Calendar

ユーザがオーナ権利を持っているカレンダを削除します。

カレンダID

削除したいカレンダID

エラーコード

Magic xpiのエラーコードが戻ります。

Delete Calendar Event

指定されたGoogleカレンダからイベントIDに基づくカレンダイベントを削除します。(イベントが繰り返し可能になっている場合、すべてのイベントが削除されます。)

カレンダID

このパラメータは、(デフォルトの)メインアカウント以外のカレンダアカウントを指定します。

イベントID

削除したいイベントのID

エラーコード

Magic xpiのエラーコードが戻ります。

Delete Calendar Subscription

カレンダをユーザのアカウントから削除します。

カレンダID

このカレンダIDへのユーザの登録を削除します。

エラーコード

Magic xpiのエラーコードが戻ります。

Modify Calendar

ユーザがオーナ権利を持っているカレンダを更新します。

カレンダID

更新したいカレンダID

タイトル

カレンダのタイトル

説明

カレンダの説明

ロケーション

カレンダの場所

タイムゾーン

カレンダのタイムゾーン。例：”Japan/Tokyo”

非表示

カレンダがインタフェース内に表示されるかどうかを指定します。ドロップダウンリストから、どちらかを選択してください。

• False

• True

選択

カレンダがインタフェースから選択できるかどうかを指定します。ドロップダウンリストから、どちらかを選択してください。

• False

• True

色

カレンダのユーザインターフェイスの色

エラーコード

Magic xpiのエラーコードが戻ります。

Modify Calendar Event

指定されたGoogleカレンダ内のイベントを更新します。

カレンダID

(デフォルトの)メインアカウント以外のカレンダアカウントが指定できます。このパラメータは、追加／修正したいイベントの位置付けを行うために使用されます。

イベントID

更新したいイベントID

タイトル

カレンダのタイトル

説明

カレンダの説明

ロケーション

イベントの場所

終日イベント

イベントが終日行われるものかどうかを指定します。ドロップダウンリストから、どちらかを選択してください。

• 変更なし (デフォルト)

• No

• Yes

イベント開始日

更新されるイベントの開始日

［終日イベント］がYes/Noに設定された場合のみ有効です。

イベント開始時刻

更新されるイベントの開始時刻

［終日イベント］がNoに設定された場合のみ有効です。

期間（分）

更新されるイベントの期間

［終日イベント］がNoに設定された場合のみ有効です。

イベント終了日

イベントの終了日

［終日イベント］がYesに設定された場合のみ有効です。

イベントの繰り返し

イベントの繰り返し間隔を選択します。ドロップダウンリストから、どちらかを選択してください。

• 変更なし (デフォルト)

• 繰り替しの削除

• 日次

• 週次

• 月次

• 年次

 毎回繰返す

繰り返しで選択された値の繰返し頻度を指定します。

［イベントの繰り返し］パラメータが変更なし以外に設定された場合に有効です。

毎週繰返す

イベントが毎週どの曜日に実行されるかを、数値で指定します。

• 1= 日曜日

• 2= 月曜日

• 3= 火曜日

• 4= 水曜日

• 5= 木曜日

• 6= 金曜日

• 7= 土曜日

例えば、イベントを日曜日と水曜日、金曜日に実行させる場合は、1,4,6と指定します。

［イベントの繰り返し］パラメータが週次に設定された場合以外で有効です。

毎月繰返す

イベントが毎月繰り返される日付をドロップダウンリストから選択します。有効な値は1-31です。

［イベントの繰り返し］パラメータが月次に設定された場合以外で有効です。

繰り返し終了日

イベントの終了日。ここに、値を設定しない場合、永久に繰り返されます。

［イベントの繰り返し］パラメータが変更なし以外に設定された場合に有効です。

参加者アクション

カレンダが更新された場合の、参加者のメールアドレスの対応を指定します。ドロップダウンリストから、どちらかを選択してください。

• 変更なし (デフォルト)

• 追加

• 削除 (［参加者］パラメータで指定されたアドレスを削除します)

• 上書

参加者

参加者の電子メールアドレスをカンマ区切りで入力します。通知は、指定された全てのアドレスに送信されます。

［参加者への対応]パラメータが、変更しない以外の場合のみ有効です。

リマインダーのメソッド

Googleカレンダから通知をを受け取る方法を選択します。ドロップダウンリストから、どちらかを選択してください。

• 変更なし (デフォルト)

• リマインダー削除

• アラート

• 電子メール

• SMS

リマインダーの索引

このパラメータは、特定のイベントに対する通知を設定します。例えば、イベントを実施する2日前に通知を受け取ったり、15分前にSMSで受け取ることができます。ドロップダウンリストから、必要なインデックスを選択してください。

• 最初のリマインダー

• 2番目のリマインダー

• 3番目のリマインダー

• 4番目のリマインダー

• 5番目のリマインダー

［通知方法］パラメータがリマインダー削除、アラート、電子メール、またはSMSに設定された場合に有効になります。

リマインダーの期間

Googleカレンダから通知を受け取る頻度を数値で指定します。この値は、通知頻度タイプで指定された頻度で通知を行います。

［通知方法］パラメータがアラート、電子メール、またはSMSに設定された場合に有効になります。

リマインダーの期間タイプ

通知期間のタイプをドロップダウンリストから選択します。

• 分

• 時

• 日

• 週

［通知方法］パラメータがアラート、電子メール、またはSMSに設定された場合に有効になります。

イベント期間を表示

イベントの有効性を表示します。ドロップダウンリストから、どちらかを選択してください。

• 変更なし (デフォルト)

• 使用可能

• ビジー状態

プライバシー

必要なプライバシーレベルをドロップダウンリストから選択します。

• 変更しない (デフォルト)

• デフォルト

• プライベート

• パブリック

拡張プロパティ

拡張されたプロパティ(任意の名前の組合せ)をカレンダイベントに追加することができます。追加された内容は、アプリケーション固有のIDまたはGoogleカレンダとアクセスする際にアプリケーションに必要な情報を保存するために使用されます。

プロパティの名前は、最大47桁まで指定できます。値は最大1024桁までの文字を含めることができます。拡張されたプロパティは、カレンダのユーザインターフェイス内で表示されないAPIを使用してのみアクセスできます。

これらは、以下の例に従って<名前>,<値>のフラットファイルフォーマットで指定します。

• Pr1,56

• Pr2,user

• Pr3,password

エラーコード

Magic xpiのエラーコードが戻ります。

Modify Calendar Subscription 

カレンダの個人設定を更新します。

カレンダID

このカレンダーIDに対する登録情報を更新します。

色

カレンダのユーザインタフェース色

UIで非表示

カレンダ情報がユーザインターフェイス内で表示されるかどうかを指定します。ドロップダウンリストから、どちらかを選択してください。

• ' '
  • 変更なし (デフォルト)

  • ' '
    • False

    • ' '
      True

UIで選択

カレンダがユーザインターフェイスで選択できるかどうかを指定します。ドロップダウンリストから、どちらかを選択してください。

• 変更なし (デフォルト)

• False

• True

エラーコード

Magic xpiのエラーコードが戻ります。

Modify User Access Rights

カレンダのアクセス制御リスト内のユーザ許可を更新します。

カレンダID

アクセス制御リストを更新したいカレンダID

ユーザ

アクセス制御リストで修正したいユーザのID。以下のようなGmailアドレスを入力します。 xyz@gmail.com.

権利

ドロップダウンリストからユーザクラスに従って、以下のアクセス権を選択します。

• FREEBUSY

• READ

• EDITOR

• OWNER

エラーコード 

Magic xpiのエラーコードが戻ります。

Read Calendar Events

指定されたGoogleカレンダからフィルタパラメータを基にカレンダーイベントを参照します。

カレンダID

(デフォルトの)メインアカウント以外のカレンダアカウントが指定できます。

イベント開始日

イベントの日付範囲の開始日付(空白の場合は、01/01/1970が割り当てられます。)

イベント開始時刻

イベントの時刻範囲の開始時刻 

イベント終了日

イベントの日付範囲の終了日付(空白の場合は、01/01/2031が割り当てられます。)

イベント終了時刻

イベントの時刻範囲の終了時刻

フルテキスト検索

すべてのカレンダイベント内のテキストを検索をするための文字列を入力します。

シングルイベントとして読込

単一イベントとしてイベントを読み込むかどうかを指定します。ドロップダウンリストから、どちらかを選択してください。

• Yes (デフォルト)

• No

出力タイプ

取得されるイベントの出力タイプ。ドロップダウンリストから、どちらかを選択してください。

• ファイル (デフォルト)

• BLOB

出力構造

取得されるイベントの出力フォーマット。ドロップダウンリストから、どちらかを選択してください。

• XML (デフォルト)

• フラットファイル

ファイルへの出力

取得されたイベントを保持するファイル名をフルパスで指定します。

［出力タイプ］がファイルの場合のみ有効です。

出力

このパラメータは、(XMLまたはフラットファイルを保持する)BLOB変数を選択します。

［出力タイプ］がBLOBの場合のみ有効です。

エラーコード

Magic xpiのエラーコードが戻ります。

Remove User Access

ユーザをカレンダのアクセス制御リストから削除します。

カレンダID

ユーザのアクセス権を削除したいカレンダのID

ユーザ

アクセス権を削除したいユーザ。以下のようなGmailアドレスを入力します。 xyz@gmail.com.

エラーコード

Magic xpiのエラーコードが戻ります。

Retrieve Access Control List

カレンダへのアクセス権をのリストをカンマ区切りで作成します。

カレンダID

識別用のカレンダID

ユーザ権利リスト

カンマは<ユーザ>,<アクセス権>のフラットファイルを区切ります。アクセス権は、以下のユーザ分類に基づきます。

• FREEBUSY……このユーザは、フリー/ビジーの情報のみ参照できます。

• READ……このユーザは、すべてのイベント詳細を参照することができます。

• EDITOR……このユーザは、イベントを変更することができます。

• OWNER……このユーザは、変更や共有管理を行うことができます。

エラーコード

Magic xpiのエラーコードが戻ります。

Retrieve Calendar List

ユーザのGoogleカレンダのユーザインターフェイスに表示されるカレンダのリストを取得します。

リストタイプフィルタ

取得されるカレンダのリストに表示されるカレンダを制御します。ドロップダウンリストから、どちらかを選択してください。

• 全カレンダ(メイン、２番目、入力されたカレンダー)

• 自身のカレンダ(メイン、２番目のみ)

出力タイプ

取得されるカレンダリストの出力タイプ。XMLフォーマットでのみ出力されます。ドロップダウンリストから、どちらかを選択してください。

• ファイル (デフォルト)

• 変数

ファイルへの出力

取得されたイベントを保持するファイル名をフルパスで指定します。

［出力タイプ］がファイルの場合のみ有効です。

出力

このパラメータは、（XMLを保持する)BLOB変数を選択します。

［出力タイプ］が 変数 の場合のみ有効です。

エラーコード

Magic xpiのエラーコードが戻ります。