Bölge yönetimini taşıma

Bu kılavuzda, entegrasyonunuzu RegionsService Content API for Shopping'den Accounts alt API'sindeki RegionsService taşıma işlemi açıklanmaktadır.

Bölgeler hizmeti, bölgesel fiyatlandırma ve kargo geçersiz kılma gibi kullanım alanları için özel coğrafi bölgeler tanımlamanıza olanak tanır. RegionalInventory ve ShippingSettings gibi hizmetlerle bölgeleri kullanabilirsiniz.

Temel farklar

  • API yapısı: Bölgeler hizmeti artık Merchant API'deki Accounts alt API'sinin bir parçasıdır (örneğin, merchantapi.googleapis.com/accounts/v1/...).
  • Kaynak adları: Merchant API, Get, Update ve Delete işlemleri için URL yolunda ayrı merchant_id ve region_id parametreleri yerine kaynak adlarını (accounts/{account}/regions/{region}) kullanır.
  • AIP uyumluluğu: Merchant API yöntemleri, standart API Geliştirme Önerisi kalıplarını (ör. List/Create için parent, Get/Delete için name ve standart update_mask kullanımı) izler.
  • Sarmalayıcı türleri: Content API'de daha önce google.protobuf.StringValue veya google.protobuf.BoolValue kullanılan alanlar artık Merchant API'de standart optional alanlarını kullanıyor.
  • Yeni özellikler:
    • Merchant API, bir nokta etrafındaki yarıçapa göre bölgeleri tanımlamak için Region kaynağında RadiusArea türünü kullanıma sunuyor (başlangıçta TRUST_TESTER görünürlüğüyle).
    • Toplu iş yöntemleri (BatchCreateRegions, BatchUpdateRegions, BatchDeleteRegions) kullanılabilir.
  • Hata işleme: Hata kodları ve mesajları daha ayrıntılı geri bildirim sağlar.

İstekler

İstek kalıpları şu şekilde değişir:

Öğe Content API for Shopping Merchant API Açıklama
Uç nokta https://shoppingcontent.googleapis.com https://merchantapi.googleapis.com Temel alan değişir.
Get Path /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Merchant API, accounts alt API'sini ve name kaynağını kullanır.
Liste Yolu /content/v2.1/{merchant_id}/regions /accounts/v1/{parent=accounts/*}/regions Merchant API, hesabı belirtmek için parent kullanır.
Yol Oluştur /content/v2.1/{merchant_id}/regions /accounts/v1/{parent=accounts/*}/regions Merchant API, parent kullanır. region_id, istek gövdesindeki bir alandır.
Güncelleme yolu /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Merchant API'deki kaynak adı, gövdedeki region nesnesinin bir parçasıdır.
Yolu Sil /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} name kaynağını kullanır.

Tanımlayıcılar

Tanımlayıcıları kullanım şeklinizi aşağıdaki gibi değiştirin:

Öğe Content API for Shopping Merchant API Açıklama
Hesap merchant_id (tam sayı) account (tamsayı, name veya parent dizenin bir parçası) Kaynak adı dizesine yerleştirilmiş hesap kimliğini bulun (ör. accounts/{account}).
Bölge region_id (dize) {region} (dize, name dizesinin bir parçası) Kaynak adı dizesine yerleştirilmiş bölge kimliğini bulun (ör. accounts/{account}/regions/{region}).
Kaynak Adı Kesinlikle istekler için kullanılmaz. name: accounts/{account}/regions/{region} Get/Update/Delete istekleri için standart tanımlayıcı.
Ebeveyn adı Kesinlikle istekler için kullanılmaz. parent: accounts/{account} Liste/Oluşturma istekleri için standart tanımlayıcı.

Kaynaklar

Region kaynak yapısında küçük değişiklikler var:

Öğe Content API for Shopping Merchant API Açıklama
Kaynak tanımlayıcı region_id (dize), merchant_id (int64) name (dize): accounts/{account}/regions/{region} Merchant API, kaynak tanımlayıcı olarak tek bir name alanı kullanır.
display_name google.protobuf.StringValue optional string Sarmalayıcı türü kaldırıldı.
radius_area Kullanılamıyor (Yok) RadiusArea Bu yeni tür, bölgeleri yarıçapa göre tanımlar. Şunları içerir: region_code, lat_lng, radius, radius_units. Varsayılan olarak görünürlük kısıtlanır.
regional_inventory_eligible google.protobuf.BoolValue (yalnızca çıkış) optional bool (yalnızca çıkış) Sarmalayıcı türü kaldırıldı.
shipping_eligible google.protobuf.BoolValue (yalnızca çıkış) optional bool (yalnızca çıkış) Sarmalayıcı türü kaldırıldı.

Yöntemler

Yöntemleri aşağıdaki şekilde kullanın:

Öğe Content API for Shopping Merchant API Açıklama
Get Region GetRegion GetRegion İstek name kullanıyor.
Bölge Oluşturma CreateRegion CreateRegion İstek, URL'den parent değerini alır. İstek gövdesi ise region nesnesini ve region_id değerini içerir.
Bölgeyi güncelleme UpdateRegion UpdateRegion İstek, region (region.name dahil olmalıdır) ve update_mask kullanıyor.
Bölgeyi Sil DeleteRegion DeleteRegion İstek name kullanıyor.
List Regions ListRegions ListRegions İstek parent kullanıyor. page_size ve page_token davranışı tutarlıdır.
Toplu Oluşturma Yok BatchCreateRegions Bu yeni bir yöntemdir.
Toplu güncelleme Yok BatchUpdateRegions Bu yeni bir yöntemdir.
Toplu Silme Yok BatchDeleteRegions Bu yeni bir yöntemdir.

Yeniden adlandırılan alanlar

Öğe Content API for Shopping Merchant API Açıklama
Hesap Kimliği merchant_id account (name veya parent'nin bir parçası) Kaynak name dizelerine entegre edilir. Bu durum, Region (yanıt) ve API istekleri yapmak için kullanılan protobuf mesajlarını (ör. CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest ve ListRegionsRequest) etkiler.
Bölge Kimliği region_id region (name'ın bir parçası), region_id Çoğu için name ile entegre, CreateRegionRequest içinde ayrı region_id alanı. Bu durum, Region (yanıt) ve API istekleri yapmak için kullanılan protobuf mesajlarını (ör. CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest ve ListRegionsRequest) etkiler.
Bölge Adı (Çıkış) region_id name Yanıttaki birincil tanımlayıcı alanı artık tam kaynak name'dır. Bu durum Region öğesini etkiler.
Görünen Ad display_name display_name Tür, StringValue'dan optional string'ye değişir. Bu durum Region öğesini etkiler.
Uygunluk işaretleri ...eligible ...eligible Tür, BoolValue'dan optional bool'ye değişir. Bu durum Region öğesini etkiler.
Güncelleme maskesi update_mask update_mask Region tarla yolları Bu durum UpdateRegionRequest öğesini etkiler.

Daha fazla bilgi