API'nin bu sürümünde, toplu istek yalnızca bir aboneliğin aktarımında kullanılır. Ayrıca, API'nin toplu isteğinde toplu Content-ID alanı doldurulmamış.
Bu belgede, HTTP bağlantılarının sayısını azaltmak için API çağrılarının nasıl toplu olarak kullanılacağı gösterilmektedir anlatacağım.
Bu belge özellikle, HTTP isteği. 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ük oluşturur. Admin SDK API, istemcinizin tek bir HTTP isteğine birden fazla API çağrısı yerleştirmesine olanak tanımak için toplu işlemeyi 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 (internet bağlantısı kesilmişken) verilerde değişiklik yaptığından, uygulamanızın çok sayıda güncelleme ve silme göndererek yerel verilerini sunucuyla senkronize etmesi gerekir.
Bu durumda her çağrıyı ayrı ayrı göndermek yerine tek bir HTTP isteği olarak gruplandırabilirsiniz. Dahili isteklerin tümü aynı Google API'sine gitmelidir.
Tek bir toplu istekte en fazla 1.000 arama yapabilirsiniz. Bundan daha fazla çağrı yapmanız gerekiyorsa birden çok toplu istek kullanın.
Not: Admin SDK API'nin toplu işlem sistemi, OData toplu işleme sistemiyle aynı söz dizimini kullanır ancak anlamlar farklıdır.
Grup ayrıntıları
Toplu istek, API keşif dokümanında belirtilen batchPath öğesine gönderilebilecek bir HTTP isteğinde birleştirilen birden çok API çağrısından oluşur. Varsayılan yol /batch/api_name/api_version şeklindedir. Bu bölümde, toplu söz dizimi ayrıntılı bir şekilde açıklanmaktadır; Daha sonra, bir örnek verelim.
Not: Gruplandırılmış n istekleri, kullanım sınırınıza tek bir istek olarak değil n isteği 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ün kullanıldığı birden fazla Admin SDK 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. Ayrıca isteğe bağlı bir Content-ID başlığı da olabilir. Ancak, bölüm başlıkları yalnızca bölümün başlangıcını belirtmek içindir; iç içe yerleştirilmiş istekten ayrıdır. Sunucu toplu isteği ayrı isteklere dönüştürdükten sonra parça başlıkları yoksayılır.
Her bir bölümün gövdesi, 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.
Dış toplu isteğin HTTP üstbilgileri (Content-Type gibi Content- üst bilgileri hariç), gruptaki her istek için geçerlidir. Hem dış istekte hem de tek bir çağrıda belirli bir HTTP üstbilgisi 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 çağrı için geçerlidir.
Örneğin, belirli bir çağrı için bir Yetkilendirme üstbilgisi sağlarsanız bu başlık yalnızca o çağrıya uygulanır. Dış istek için bir Yetkilendirme başlığı sağlarsanız bu başlık, kendi Yetkilendirme başlıklarıyla geçersiz kılınmadığı sürece tüm bağımsız ç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 şekilde) her bölüme uygular ve daha sonra, her bir bölümü ayrı bir HTTP isteğiymiş gibi değerlendirir.
Toplu isteğe yanıt verme
Sunucunun yanıtı, multipart/mixed içerik türüne sahip tek bir standart HTTP yanıtı olur; her bölüm, isteklerle aynı sırayla toplu istekteki isteklerden birinin yanıtıdır.
İstekteki bölümlerde olduğu gibi, her yanıt bölümü de durum kodu, başlıklar ve gövde dahil olmak üzere 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ı işaret eden 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- dizesi olacak şekilde eşleşen bir Content-ID başlığına sahiptir.
Not: Sunucu, aramalarınızı herhangi bir sırada gerçekleştirebilir. Öğelerin sizin belirttiğiniz sırayla yürütülmesine izin vermeyin. İki çağrının belirli bir sırada gerçekleşmesini istiyorsanız bunları tek bir istekte gönderemezsiniz. ilkini tek başına gönderin. İkincisini göndermeden önce ilk yanıtın verilmesini bekleyin.
Örnek
Aşağıdaki örnekte, Admin SDK API ile toplu işleme kullanımı gösterilmektedir.
Örnek toplu istek
/*This example uses comments and variables for clarity.*/ /*These are not used in JSON. Do not include these comments or verbatim*/ /*variable strings in your batch request.*/ /*To batch multiple requests in one call, use the following*/ /* */ /*POSTHTTP request, and use the following request body syntax.*/ /* */ /*POST https://www.googleapis.com/batch*/ --batch_foobar--
Örnek toplu yanıt
Bu, önceki bölümde yer alan örnek isteğin yanıtıdı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:12930812@barnyard.example.com>
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:12930812@barnyard.example.com>
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:12930812@barnyard.example.com>
HTTP/1.1 304 Not Modified
ETag: "etag/animals"
--batch_foobarbaz--