taşıma, uyumluluk

Bölge yönetimini taşıma

Bu kılavuzda, entegrasyonunuzu RegionsServiceContent API for Shopping'den Hesaplar alt API'sindeki RegionsService'ye 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 alanlar tanımlamanıza olanak tanır. Bölgeleri RegionalInventory ve ShippingSettings gibi hizmetlerle kullanabilirsiniz.

Temel farklılıklar

  • 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 alanlarda artık Merchant API'deki standart optional alanları kullanılı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 sunar (başlangıçta TRUST_TESTER görünürlüğüyle).
    • Toplu işlem 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şturma /content/v2.1/{merchant_id}/regions /accounts/v1/{parent=accounts/*}/regions Merchant API, parent kullanır. region_id, istek metnindeki bir alandır.
Yolu güncelleme /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 dizesinin bir parçası) Kaynak adı dizesine yerleştirilmiş hesap kimliğini bulun (örneğin, 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ı İstekler için kesin olarak kullanılmaz. name: accounts/{account}/regions/{region} Get/Update/Delete istekleri için standart tanımlayıcı.
Ebeveyn Adı İstekler için kesin olarak 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ısı 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. İç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öntem kullanımınızı aşağıdaki şekilde değiştirin:

Öğe Content API for Shopping Merchant API Açıklama
Get Region (Bölgeyi Al) GetRegion GetRegion İstek name kullanıyor.
Bölge Oluştur 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ü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.
Bölgeleri Listeleme ListRegions ListRegions İstek parent kullanıyor. page_size ve page_token davranışları 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 kuruluşunun bir parçası) Kaynak name dizelerine entegre edilir. Bu durum, Region (yanıt) ve CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest ile ListRegionsRequest gibi API istekleri oluşturmak için kullanılan protobuf mesajlarını 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 CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest ve ListRegionsRequest gibi API istekleri oluşturmak için kullanılan protobuf mesajlarını etkiler.
Bölge Adı (Çıkış) region_id name Yanıtın 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.
Maskeyi güncelleme update_mask update_mask Region tarla yolları Bu durum UpdateRegionRequest öğesini etkiler.

Daha fazla bilgi