İstekleri Gruplama

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

Bu belge özellikle bir HTTP isteği göndererek toplu istek oluşturmakla ilgilidir. Bunun yerine, toplu istek yapmak için bir Google istemci kitaplığı kullanıyorsanız istemci kitaplığının dokümanlarına bakın.

Genel bakış

İstemcinizin yaptığı her HTTP bağlantısı, belirli miktarda ek yüke neden olur. Gmail API, istemcinizin tek bir HTTP isteğine birkaç API çağrısı koymasına olanak tanımak için toplu işlemi destekler.

Gruplandırmayı kullanmak isteyebileceğiniz durumlara örnekler:

• API'yi kullanmaya yeni başladınız ve yüklemeniz gereken çok fazla veri var.
• Bir kullanıcı, uygulamanız çevrimdışıyken verilerde değişiklik yapmıştır (internet bağlantısı kesilir). Bu nedenle uygulamanızın çok sayıda güncelleme ve silme işlemi göndererek yerel verilerini sunucuyla senkronize etmesi gerekir.

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

Tek bir toplu istekte 100 çağrıyla sınırlandırılırsınız. Bundan daha fazla çağrı yapmanız gerekiyorsa birden fazla toplu istek kullanın.

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

Not: Daha büyük grup boyutlarının hız sınırlamasını tetikleme olasılığı yüksektir. 50'den fazla istek içeren grupların gönderilmesi önerilmez.

Grup ayrıntıları

Toplu istek, birden fazla API çağrısının tek bir HTTP isteğinde birleştirilmesinden oluşur. Bu çağrı, API keşif belgesinde belirtilen batchPath öğesine gönderilebilir. Varsayılan yol /batch/api_name/api_version şeklindedir. Bu bölümde toplu söz dizimi ayrıntılı olarak açıklanmaktadır; daha sonra bir örnek iletilecektir.

Not: Toplu olarak toplanan bir n istek kümesi, kullanım sınırınıza tek bir istek olarak değil, n istek olarak dahil edilir. Toplu istek, işlenmeden önce bir istek grubuna ayrılır.

Toplu isteğin biçimi

Toplu istek, multipart/mixed içerik türünü kullanan birden fazla Gmail API çağrısı içeren tek bir standart HTTP isteğidir. Bu ana HTTP isteğinde, parçaların her biri 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ı Content-ID üst bilgisi de olabilir. Bununla birlikte, parça başlıkları sadece parçanın başlangıcını belirtmek için yer alır; iç içe yerleştirilmiş istekten ayrıdır. Sunucu toplu isteğin sarmalamasını ayrı isteklere açtıktan sonra parça başlıkları yoksayılır.

Her bir parçanın gövdesi de kendi yüklemi, URL'si, başlıkları ve gövdesi ile 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- üstbilgileri hariç, dış toplu isteğin HTTP üst bilgileri gruptaki her istek için geçerlidir. Hem dış istekte hem de bağımsız bir çağrıda belirli bir HTTP üst bilgisi belirtirseniz bağımsız çağrı başlığının değeri, dış toplu istek başlığının değerini geçersiz kılar. Tek bir aramanın üstbilgileri yalnızca söz konusu arama için geçerlidir.

Örneğin, belirli bir çağrı için bir Yetkilendirme başlığı 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 üstbilgi kendi Yetkilendirme üstbilgileriyle geçersiz kılınmadığı sürece, ayrı ayrı tüm çağrılar için geçerli olur.

Sunucu toplu isteği aldığında, dış isteğin sorgu parametrelerini ve başlıklarını (uygun olduğu şekilde) her bir parçaya uygular ve ardından her bir bölümü ayrı bir HTTP isteği gibi değerlendirir.

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, isteklerle aynı sırayla verilen yanıttır.

İstekteki bölümler gibi her yanıt bölümü de durum kodu, başlıklar ve gövde metni dahil eksiksiz bir HTTP yanıtı içerir. İstekteki bölümlerde olduğu gibi, her yanıt bölümünün önünde, bölümün başlangıcını belirten bir Content-Type başlığı bulunur.

İsteğin belirli bir bölümünde Content-ID başlığı varsa, yanıtın karşılık gelen bölümü, aşağıdaki örnekte gösterildiği gibi, orijinal değerin önünde response- dizesiyle birlikte eşleşen bir Content-ID başlığına sahiptir.

Not: Sunucu, çağrılarınızı herhangi bir sırada gerçekleştirebilir. Bu kodların sizin belirttiğiniz sırada yürütülmesine gerek yoktur. Belirli bir sırada iki çağrının gerçekleşmesini istiyorsanız bunları tek bir istekte gönderemezsiniz. Bunun yerine, ilk aramayı tek başına gönderin ve ardından ikinciyi göndermeden önce ilk aramanın yanıtını bekleyin.

Örnek

Aşağıdaki örnekte Çiftlik API'si adı verilen genel (kurmaca) bir demo API ile toplu hale getirme kullanımı gösterilmektedir. Ancak aynı kavramlar Gmail API 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ümde verilen ö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--