Search Events（イベントの検索）
Google Calendarアカウントのイベントを検索します。
スコープ
このカードで必要なOAuthスコープのリストは「アクションカード」を参照してください。
オプション
| フィールド | 定義 | タイプ | 必須 |
|---|---|---|---|
|
Calendar（カレンダー） |
検索するイベントが含まれているカレンダーを選択します。 |
ドロップダウン |
TRUE |
|
Result Set（結果セット） |
次のいずれかのオプションを選択します。
|
ドロップダウン |
TRUE |
入力
| フィールド | 定義 | タイプ | 必須 |
|---|---|---|---|
|
Event（イベント） |
|||
|
Query（クエリ） |
拡張プロパティを除く任意のフィールドで一致するイベントを特定するための自由テキストの検索用語。 |
テキスト |
FALSE |
|
Order By (並べ替え順序) |
［Start Time］：イベントの開始日時で並べ替えます（昇順）。単一のイベントをクエリーする場合のみ使用します。 ［Updated］：最終変更日時で並べ替えます（昇順）。 |
ドロップダウン |
FALSE |
|
Show Deleted（削除済みの表示） |
結果に削除済みのイベント（ステータスがcanceledに等しいもの）を含めるかどうかを示します。 |
ドロップダウン |
FALSE |
|
Show Hidden Invitations（非表示の招待の表示） |
結果に非表示の招待を含めるかどうかを示します。 |
ドロップダウン |
FALSE |
|
Single Events（単一のイベント） |
繰り返しイベントをインスタンスに拡張し、単一の1回限りのイベントと繰り返しイベントのインスタンスのみを返し、基になっている繰り返しイベント自体は返さないかどうかを示します。 |
ドロップダウン |
FALSE |
|
ICalUID（ICalUID） |
RFC5545で定義されているイベントの一意識別子。複数のカレンダーシステムにまたがってイベントを一意に識別するために使用され、importメソッドを介してイベントをインポートする際に指定する必要があります。 |
テキスト |
FALSE |
|
Max Attendees（最大参加者数） |
検索に含める参加者の最大人数。 |
数値 |
FALSE |
|
Private Extended Property（プライベート拡張プロパティ） |
propertyName=valueで指定される拡張プロパティ制約。プライベートプロパティのみを照合します。 |
テキスト |
FALSE |
|
Shared Extended Property（共有拡張プロパティ） |
propertyName=valueで指定される拡張プロパティ制約。共有プロパティのみを照合します。 |
テキスト |
FALSE |
|
Time Min（最小日時） |
カレンダーが使用可能かどうかを調べる開始日時。入力はYYYY-MM-DDTHH:MM:SSZの形式にする必要があります。 |
日時 |
FALSE |
|
Time Max（最大日時） |
カレンダーが使用可能かどうかを調べる終了日時。入力はYYYY-MM-DDTHH:MM:SSZの形式にする必要があります。 |
日時 |
FALSE |
|
Updated Min（最小更新日時） |
フィルタリングの条件とするイベントの最終変更日時の下限（RFC3339タイムスタンプ）。 |
日時 |
FALSE |
|
Time Zone（タイムゾーン） |
次の形式のタイムゾーン。
|
日時 |
FALSE |
入力フィールドを空白のままにした場合、検索結果はすべてのカレンダーイベントを返します。
出力
| フィールド | 定義 | タイプ |
|---|---|---|
|
フィールド |
||
|
Type（タイプ） |
イベントのタイプ。 これはカレンダーイベントであるため、多くの場合はcalendar#eventとして返されます。 |
テキスト |
|
Event ID（イベントID） |
情報を取得するイベントのUnique ID。 |
テキスト |
|
Status（ステータス） |
イベントのステータス。
|
テキスト |
|
Html Link（HTMLリンク） |
Google Calendar Web UI内のこのイベントへの絶対リンク。読み取り専用。 |
テキスト |
|
Created Time（作成日時） |
イベントが作成された日時。ISO形式（YYYY-MM-DDThh:mm:ss+00:00）です。 +00:00はタイムゾーンオフセットです。 |
テキスト |
|
Updated Time（更新日時） |
イベントが最後に更新された日時。ISO形式（YYYY-MM-DDThh:mm:ss+00:00）です。 +00:00はタイムゾーンオフセットです。 |
テキスト |
|
Summary（概要） |
カレンダーイベントの名前の見出し。 |
テキスト |
|
Description（説明） |
参加者向けの詳細を含むイベントの説明。 |
テキスト |
|
ICalUID |
RFC5545で定義されているイベントの一意識別子。複数のカレンダーシステムをまたがってイベントを一意に識別するために使用され、importメソッドを介してイベントをインポートする際に指定する必要があります。 ICalUIDとidは同一ではなく、イベントの作成時にはどちらか1つのみ指定する必要があります。 繰り返しイベントにおけるセマンティクス的違いの1つは、1つのイベントのすべての出現が異なるidを持つのに対し、すべてのICalUIDは同一であるということです。 |
テキスト |
|
Start Time（開始日時） |
イベントを開始する日時。ISO形式（YYYY-MM-DDThh:mm:ss+00:00）です。 +00:00はタイムゾーンオフセットです。 |
テキスト |
|
End Time（終了日時） |
イベントを終了する日時。ISO形式（YYYY-MM-DDThh:mm:ss+00:00）です。 +00:00はタイムゾーンオフセットです。 |
テキスト |
|
Location（ロケーション） |
イベントの地理的な場所（自由形式のテキスト） |
テキスト |
|
Attendee Emails（参加者メール） |
イベントに招待されるゲストのメールアドレス。このフィールドは空白のままにすることができます。 イベントは、それが作成されたカレンダーに表示されます。 |
テキスト |
|
リマインダー |
||
|
Method（方式） |
リマインダーの送信方式。オプションにはpopupとemailがあります。 |
テキスト |
|
Minutes（分数） |
リマインダー発行までに経過する必要がある時間（単位は分）。範囲は1～40320。 |
テキスト |