アプリケーションが HTTP 接続を行うたびに、一定量のオーバーヘッドが発生します。このライブラリではバッチ処理がサポートされており、アプリケーションで複数の API 呼び出しを 1 つの HTTP リクエストにまとめることができます。バッチ処理は次のような状況で使用します。
- 小さなリクエストが多数送信されており、HTTP リクエストのオーバーヘッドを最小限に抑えたいと考えています。
- アプリがオフライン中にユーザーがデータを変更したため、アプリは、多数の更新と削除を送信してローカルデータをサーバーと同期する必要があります。
注: 1 つのバッチ リクエストでは 1,000 回まで呼び出しが可能です。これよりも多くの呼び出しを行う必要がある場合は、複数のバッチ リクエストを使用してください。
注: バッチ リクエストでメディア アップロード オブジェクトを使用することはできません。
詳細
バッチ リクエストを作成するには、BatchRequest
オブジェクトをインスタンス化し、実行するリクエストごとに Queue
メソッドを呼び出します。リクエストごとに、アプリがこのリクエストへのレスポンスを受信したときに呼び出されるコールバックを渡します。コールバック関数の引数は次のとおりです。
- コンテンツ
- コンテンツ レスポンス。リクエストが失敗した場合は
null
。 - error
- エラー。または、リクエストが成功した場合は
null
。 - index
- 個々のリクエストのインデックス。
- message
- すべてのヘッダーとコンテンツを含む完全な HTTP メッセージ。
ExecuteAsync
メソッドを呼び出してリクエストを行います。
次のコード スニペットでは、2 つの API リクエストが 1 つの HTTP リクエストにバッチ処理され、各 API リクエストにコールバックが与えられています。
UserCredential credential; using (var stream = new FileStream("client_secrets.json", FileMode.Open, FileAccess.Read)) { credential = await GoogleWebAuthorizationBroker.AuthorizeAsync( GoogleClientSecrets.Load(stream).Secrets, new[] { CalendarService.Scope.Calendar }, "user", CancellationToken.None, new FileDataStore("Calendar.Sample.Store")); } // Create the service. var service = new CalendarService(new BaseClientService.Initializer() { HttpClientInitializer = credential, ApplicationName = "Google Calendar API Sample", }); // Create a batch request. var request = new BatchRequest(service); request.Queue<CalendarList>(service.CalendarList.List(), (content, error, i, message) => { // Put your callback code here. }); request.Queue<Event>(service.Events.Insert( new Event { Summary = "Learn how to execute a batch request", Start = new EventDateTime() { DateTime = new DateTime(2014, 1, 1, 10, 0, 0) }, End = new EventDateTime() { DateTime = new DateTime(2014, 1, 1, 12, 0, 0) } }, "YOUR_CALENDAR_ID_HERE"), (content, error, i, message) => { // Put your callback code here. }); // You can add more Queue calls here. // Execute the batch request, which includes the 2 requests above. await request.ExecuteAsync();