İstekleri Gruplama

Bu belgede, istemcinizin kurması gereken HTTP bağlantılarının sayısını azaltmak için API çağrılarının nasıl toplu olarak gönderileceği açıklanmaktadır.

Bu belge, özellikle bir HTTP isteği göndererek toplu istekte bulunma ile ilgilidir. Bunun yerine toplu istekte bulunmak için bir Google istemci kitaplığı kullanıyorsanız istemci kitaplığının dokümanlarına bakın.

Genel Bakış

İstemcinizin kurduğu her HTTP bağlantısı belirli bir ek yüke neden olur. Gmail API, istemcinizin birden fazla API çağrısını tek bir HTTP isteğine yerleştirmesine olanak tanımak için toplu işleme özelliğini destekler.

Toplu işlem kullanmak isteyebileceğiniz durumlara örnekler:

• API'yi yeni kullanmaya başladıysanız ve yüklenecek çok fazla veriniz varsa
• Bir kullanıcı, uygulamanız çevrimdışıyken (İnternet'e bağlı değilken) verilerde değişiklik yaptı. Bu nedenle, uygulamanızın çok sayıda güncelleme ve silme işlemi göndererek yerel verilerini sunucuyla senkronize etmesi gerekiyor.

Her durumda, her çağrıyı ayrı ayrı göndermek yerine bunları tek bir HTTP isteğinde gruplandırabilirsiniz. Tüm iç istekler aynı Google API'sine gitmelidir.

Tek bir toplu istekte en fazla 100 görüşme yapabilirsiniz. Bundan daha fazla arama yapmanız gerekiyorsa birden fazla toplu istek kullanın.

Not: Gmail API'nin toplu iş sistemi, OData toplu işleme sistemiyle aynı söz dizimini kullanır ancak semantik farklıdır.

Not: Daha büyük toplu işlemlerin sıklık sınırlaması tetikleme olasılığı daha yüksektir. 50'den fazla istek içeren toplu işlemler göndermeniz önerilmez.

Toplu işlem ayrıntıları

Toplu istek, tek bir HTTP isteğinde birleştirilmiş birden fazla API çağrısından oluşur. Bu istek, API keşif belgesinde belirtilen batchPath adresine gönderilebilir. Varsayılan yol /batch/api_name/api_version'dır. Bu bölümde, toplu iş söz dizimi ayrıntılı olarak açıklanmaktadır. Daha sonra bir örnek verilmiştir.

Not: Toplu olarak gönderilen n istek, kullanım sınırınıza tek bir istek olarak değil, n istek olarak dahil edilir. Toplu istek, işlenmeden önce bir dizi isteğe ayrılır.

Toplu isteğin biçimi

Toplu istek, multipart/mixed içerik türünü kullanan ve birden fazla Gmail API çağrısı içeren tek bir standart HTTP isteğidir. Bu ana HTTP isteği içinde, her bir bölüm iç içe yerleştirilmiş bir HTTP isteği içerir.

Her bölüm kendi Content-Type: application/http HTTP başlığıyla başlar. İsteğe bağlı olarak Content-ID başlığı da içerebilir. Ancak bölüm başlıkları yalnızca bölümün başlangıcını işaretlemek için kullanılır ve iç içe yerleştirilmiş istekten ayrıdır. Sunucu, toplu isteği ayrı isteklere ayırdıktan sonra bölüm üstbilgileri yoksayılır.

Her parçanın gövdesi, kendi yüklemi, URL'si, başlıkları ve gövdesi ile kendi başına eksiksiz bir HTTP isteğidir. HTTP isteği yalnızca URL'nin yol kısmını içermelidir. Toplu isteklerde tam URL'lere izin verilmez.

Content-Type gibi Content- başlıkları hariç olmak üzere, dış toplu isteğin HTTP başlıkları, topludaki her istek için geçerlidir. Belirli bir HTTP üst bilgisini hem dış istekte hem de ayrı bir çağrıda belirtirseniz ayrı çağrı üst bilgisinin değeri, dış toplu istek üst bilgisinin değerini geçersiz kılar. Tek bir aramanın başlıkları yalnızca o arama için geçerlidir.

Örneğin, belirli bir çağrı için yetkilendirme üstbilgisi sağlarsanız bu üstbilgi yalnızca söz konusu çağrı için geçerli olur. Dış istek için bir Yetkilendirme üst bilgisi sağlarsanız bu üst bilgi, kendi Yetkilendirme üst bilgileriyle geçersiz kılınmadığı sürece tüm ayrı çağrılar için geçerli olur.

Sunucu, toplu isteği aldığında dış isteğin sorgu parametrelerini ve üst bilgilerini (uygun şekilde) her bir parçaya uygular ve ardından her bir parçayı ayrı bir HTTP isteğiymiş gibi işler.

Toplu isteğe yanıt

Sunucunun yanıtı, multipart/mixed içerik türüne sahip tek bir standart HTTP yanıtıdır. Her bölüm, toplu istekteki isteklerden birine verilen yanıttır ve isteklerle aynı sıradadır.

İsteklerdeki parçalar gibi, her yanıt parçası da durum kodu, başlıklar ve gövde dahil olmak üzere eksiksiz bir HTTP yanıtı içerir. İsteklerdeki bölümler gibi, her yanıt bölümünün başında da bölümün başlangıcını belirten bir Content-Type üstbilgisi bulunur.

İsteğin belirli bir bölümünde Content-ID başlığı varsa yanıtın ilgili bölümünde, aşağıdaki örnekte gösterildiği gibi, orijinal değerin önüne response- dizesi eklenmiş şekilde eşleşen bir Content-ID başlığı bulunur.

Not: Sunucu, aramalarınızı herhangi bir sırada gerçekleştirebilir. Belirttiğiniz sırayla yürütüleceklerini varsaymayın. İki aramanın belirli bir sırada gerçekleşmesini istiyorsanız bunları tek bir istekte gönderemezsiniz. Bunun yerine, ilkini tek başına gönderin, ardından ikincisini göndermeden önce ilkine verilen yanıtı bekleyin.

Örnek

Aşağıdaki örnekte, Farm API adlı genel (kurgusal) bir demo API ile toplu işleme kullanımı gösterilmektedir. Ancak aynı kavramlar Gmail API'si için de geçerlidir.

Örnek toplu istek

POST /batch/farm/v1 HTTP/1.1
Authorization: Bearer your_auth_token
Host: www.googleapis.com
Content-Type: multipart/mixed; boundary=batch_foobarbaz
Content-Length: total_content_length

--batch_foobarbaz
Content-Type: application/http
Content-ID: <item1:[e-mail]>

GET /farm/v1/animals/pony

--batch_foobarbaz
Content-Type: application/http
Content-ID: <item2:[e-mail]>

PUT /farm/v1/animals/sheep
Content-Type: application/json
Content-Length: part_content_length
If-Match: "etag/sheep"

{
  "animalName": "sheep",
  "animalAge": "5"
  "peltColor": "green",
}

--batch_foobarbaz
Content-Type: application/http
Content-ID: <item3:[e-mail]>

GET /farm/v1/animals
If-None-Match: "etag/animals"

--batch_foobarbaz--

Örnek toplu yanıt

Bu, önceki bölümdeki örnek isteğe verilen yanıttır.

HTTP/1.1 200
Content-Length: response_total_content_length
Content-Type: multipart/mixed; boundary=batch_foobarbaz

--batch_foobarbaz
Content-Type: application/http
Content-ID: <response-item1:[e-mail]>

HTTP/1.1 200 OK
Content-Type application/json
Content-Length: response_part_1_content_length
ETag: "etag/pony"

{
  "kind": "farm#animal",
  "etag": "etag/pony",
  "selfLink": "/farm/v1/animals/pony",
  "animalName": "pony",
  "animalAge": 34,
  "peltColor": "white"
}

--batch_foobarbaz
Content-Type: application/http
Content-ID: <response-item2:[e-mail]>

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: response_part_2_content_length
ETag: "etag/sheep"

{
  "kind": "farm#animal",
  "etag": "etag/sheep",
  "selfLink": "/farm/v1/animals/sheep",
  "animalName": "sheep",
  "animalAge": 5,
  "peltColor": "green"
}

--batch_foobarbaz
Content-Type: application/http
Content-ID: <response-item3:[e-mail]>

HTTP/1.1 304 Not Modified
ETag: "etag/animals"

--batch_foobarbaz--