Toplu İstekler

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 istek göndermek için 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 bir ek yüke neden olur. Manufacturer Center 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şleme özelliğini kullanmak isteyebileceğiniz durumlara örnekler:

• Çok sayıda ürün yükleme

• Çok sayıda ürünü silme

• Çok sayıda ürün alınıyor.

Her durumda, her aramayı 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 1.000 çağrı yapabilirsiniz. Bundan daha fazla arama yapmanız gerekiyorsa birden fazla toplu istek kullanın.

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

Toplu işlem ayrıntıları

Toplu istek, API keşif belgesinde belirtilen batchPath adresine gönderilebilen ve tek bir HTTP isteğinde birleştirilmiş birden fazla API çağrısından oluşur. Varsayılan yol /batch/api_name/api_version'dir. 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ü kullanarak birden fazla Manufacturer Center API çağrısı içeren tek bir standart HTTP isteğidir. Bu ana HTTP isteğinde, her 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 üst bilgileri 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 bölümü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 arama için yetkilendirme üstbilgisi sağlarsanız bu üstbilgi yalnızca söz konusu arama için geçerli olur. 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 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, çağrıları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, Manufacturer Center API ile toplu işleme kullanımı gösterilmektedir.

Örnek toplu istek

POST https://manufacturers.googleapis.com/batch
Authorization: Bearer your_auth_token
Content-Type: multipart/mixed; boundary=--batch_item

--batch_item
Content-Type: application/http
Content-ID: 

PUT /v1/accounts/account_id/products/targetCountry:contentLanguage:productId
Content-Type: application/json

{
   "gtin": "gtin",
   "product_name": "product_name",
   "description": "description",
   "image_link": {
       "image_url": "image_url"
   }
}
--batch_item
Content-Type: application/http
Content-ID: 

GET /v1/accounts/account_id/products/targetCountry:contentLanguage:productId
--batch_item
Content-Type: application/http
Content-ID: 

DELETE /v1/accounts/account_id/products/targetCountry:contentLanguage:productId
--batch_item--

Örnek toplu yanıt

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

--batch_OycPgXWaQD5f20sVgri2ETiygT65fMaa
Content-Type: application/http
Content-ID: 

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Vary: Origin
Vary: X-Origin
Vary: Referer

{}

--batch_OycPgXWaQD5f20sVgri2ETiygT65fMaa
Content-Type: application/http
Content-ID: 

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Vary: Origin
Vary: X-Origin
Vary: Referer

{
  "parent": "accounts/account_id",
  "name": "targetCountry:contentLanguage:productId",
  "targetCountry": "targetCountry",
  "contentLanguage": "contentLanguage",
  "productId": "productId"
}

--batch_OycPgXWaQD5f20sVgri2ETiygT65fMaa
Content-Type: application/http
Content-ID: 

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Vary: Origin
Vary: X-Origin
Vary: Referer

{}

--batch_OycPgXWaQD5f20sVgri2ETiygT65fMaa--

Ön koşullar

Manufacturer Center hesabı

Toplu İşlem Örneği

Aşağıdaki kodda, Java kullanarak ürün güncellemelerinin toplu olarak nasıl gönderileceği gösterilmektedir.

Java

String parent = "accounts/123456";
String newProductName = "US:en:product_id_1";

Image image = new Image();
image.setUrl("http://www.example.com/example.png");

Attributes attributes = new Attributes();
attributes.setGtin(ImmmutableList.of("1234567890"));
attributes.setImageLink(image);

// Creates a new BatchRequest object from the ManufacturerCenter object.
BatchRequest batch = manufacturerCenter.batch();

// JsonBatchCallback generic type is Empty to match the return type of update API.
JsonBatchCallback updateProductCallback =  new JsonBatchCallback() {
    public void onSuccess(Empty empty, HttpHeaders responseHeaders) {
        System.out.printf("Product updated successfully.\n");
    }

    public void onFailure(GoogleJsonError error, HttpHeaders responseHeaders)
            throws IOException {
        System.out.printf("Error updating product: %s.\n", error.getMessage());
    }
}

// Adds update product request to batch object.
manufacturerCenter.accounts().products().update(parent, newProductName, attributes)
    .queue(batch, updateProductCallback);

String getProductName = "US:en:product_id_2";

// JsonBatchCallback generic type is Product to match the return type of get API.
JsonBatchCallback getProductCallback =  new JsonBatchCallback() {
    public void onSuccess(Product product, HttpHeaders responseHeaders) {
        System.out.printf("Found product: %s.\n", product.getName());
    }

    public void onFailure(GoogleJsonError error, HttpHeaders responseHeaders)
            throws IOException {
        System.out.printf("Error retrieving product: %s.\n", error.getMessage());
    }
}

// Adds get product request to batch object.
manufacturerCenter.accounts().products().get(parent, getProductName)
    .queue(batch, getProductCallback);

// Sends batch request to Manufacturer Center API.
batch.execute();