Bölge yönetimini taşıma

Bu kılavuzda, entegrasyonunuzu Content API for Shopping'deki RegionsService hizmetinden Accounts alt API'sindeki RegionsService hizmetine nasıl taşıyacağınız 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. Bölgeleri RegionalInventory ve ShippingSettings gibi hizmetlerle kullanabilirsiniz.

Temel farklar

  • API yapısı: Bölgeler hizmeti artık Merchant API'deki Accounts alt API'sinin bir parçasıdır (ör. 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ına (ör. Listeleme/Oluşturma için parent, Alma/Silme için name ve standart update_mask kullanımı) uygundur.
  • Sarmalayıcı türleri: Content API'de daha önce google.protobuf.StringValue veya google.protobuf.BoolValue kullanan alanlar, artık Merchant API'de standart optional alanlarını kullanıyor.
  • Yeni özellikler:
    • Merchant API, bir noktanın etrafındaki yarıçapa göre bölgeleri tanımlamak için Region kaynağında bir RadiusArea türü sunar (başlangıçta TRUST_TESTER görünürlüğü ile).
    • Toplu yöntemler (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 adı değişir.
Yolu Al /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şturma /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 silme /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ı kullanımınızı aşağıdaki şekilde değiştirin:

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

Kaynaklar

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

Öğ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 Mevcut değil (Yok) RadiusArea Bu yeni tür, bölgeleri yarıçapa göre tanımlar. region_code, lat_lng, radius, radius_units içerir. 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 kullanma şeklinizi aşağıdaki gibi değiştirin:

Öğe Content API for Shopping Merchant API Açıklama
Bölgeyi alma GetRegion GetRegion İstek, name kullanıyor.
Bölge oluşturma CreateRegion CreateRegion İstek, URL'den parent değerini alırken istek gövdesi region nesnesini ve region_id değerini içerir.
Bölgeyi güncelle UpdateRegion UpdateRegion İstek, region (region.name içermelidir) ve update_mask kullanıyor.
Bölgeyi Sil DeleteRegion DeleteRegion İstek, name kullanıyor.
Bölgeleri listeleme ListRegions ListRegions İstek, parent kullanıyor. page_size ve page_token davranışı tutarlı.
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 kapsamında) name kaynak dizesine entegre edildi. Bu durum, Region (yanıt) ve API istekleri göndermek için kullanılan protobuf mesajlarını (ör. CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest ve ListRegionsRequest) etkiler.
Bölge Kimliği region_id region (name kapsamında), region_id Çoğu için name ile entegre, CreateRegionRequest için ayrı region_id alanı. Bu durum, Region (yanıt) ve API istekleri göndermek 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. Bu durum Region öğeyi etkiliyor.
Görünen Ad display_name display_name StringValue olan tür, optional string olarak değiştirildi. Bu durum Region öğeyi etkiliyor.
Uygunluk işaretleri ...eligible ...eligible BoolValue olan tür, optional bool olarak değiştirildi. Bu durum Region öğeyi etkiliyor.
Maskeyi güncelleme update_mask update_mask Region alan yolu. Bu durum UpdateRegionRequest öğeyi etkiliyor.

Daha fazla bilgi