Ana sayfa ayarlarını taşıma

Merchant API, özel bir Homepage kaynağı sunar. Bu kaynak, ana sayfa hak talebinizi yönetmek için yeni yöntemler sunarak klasik Content API for Shopping'in ötesinde özellikler sağlar.

Online mağazanızın özelliklerine erişmek iki adımlı bir işlemdir: Önce sahipliği doğrulamanız, ardından site için hesabınız adına hak talebinde bulunmanız gerekir. Son adımı tamamlamak için accounts.homepage.claim kullanın.

Temel farklar

Merchant API, Content API for Shopping'e kıyasla ana sayfayla ilgili çeşitli değişiklikler yapar:

  • Özel kaynak: Merchant API, ana sayfayla ilgili tüm işlemler için ayrı bir Homepage kaynağı (accounts.homepage) sağlar. (Content API for Shopping'de hak talebi işlemini gerçekleştirmek için accounts.claimwebsite yöntemini kullandınız. Ana sayfa URL'si (website_url) Account kaynağının, hak talebi durumu (website_claimed) ise AccountStatus kaynağının bir parçasıydı.)
  • Ayrıntılı yöntemler: Merchant API, aşağıdaki işlemleri gerçekleştirmek için özel yöntemler sunar:
  • Merkezi bilgiler: Merchant API Homepage kaynağı, hem uri (ana sayfa URL'si) hem de claimed durumunu doğrudan içerir. Homepage kaynağında çalışan tüm yöntemler bu kaynağı döndürerek mevcut durum hakkında anında geri bildirim sağlar. Content API for Shopping'de accounts.claimwebsite, güncellenen durumu döndürmedi. Ayrı çağrılar yapılması gerekiyordu.
  • Açıkça reddetme: Content API for Shopping'de reddetme işlemi genellikle Account.website_url değerini boş bir dizeye güncelleyerek yapılıyordu. Merchant API, özel bir homepage.unclaim yöntemi sunar.
  • Hak talebinin üzerine yazma: Her iki API de hak talebi süreci sırasında, sahipliğin doğrulanabilmesi durumunda başka bir hesaptan hak talebini devralmak için bir overwrite parametresini destekler.

İstekler

Merchant API, ana sayfanın farklı yönlerini yönetmek için farklı RESTful uç noktaları kullanır.

İstek açıklaması Alışveriş için Content API for Shopping Merchant API
Ana sayfa ayrıntılarını alma accounts.get (Account.website_url okumak için), accountstatuses.get (AccountStatus.website_claimed okumak için) GET /accounts/v1/accounts/{account}/homepage
Ana sayfa URI'sini güncelleme accounts.update (ayar Account.website_url) PATCH /accounts/v1/accounts/{account}/homepage
Ana sayfa için hak talebinde bulunma veya ana sayfayı yeniden doğrulama POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (accounts.update kullanılarak ayarlanan Account.website_url üzerinde işlem yapıldı) POST /accounts/v1/accounts/{account}/homepage:claim
Ana sayfayı reddetme accounts.update (Account.website_url boş dizeye ayarlanıyor) POST /accounts/v1/accounts/{account}/homepage:unclaim

Tanımlayıcılar

Merchant API'de kaynak tanımlama basitleştirildi.

Tanımlayıcı açıklaması Content API for Shopping Merchant API
Kaynak erişimi için hesap tanımlayıcısı Yolda merchantId (gelişmiş hesap) ve accountId (alt hesap) account (name alanının bir parçası, örneğin, accounts/{account_id}/homepage)
Ana sayfa kaynak tanımlayıcısı Geçerli değil (Account kaynağı için örtük) name: accounts/{account_id}/homepage (Homepage alt kaynağını tanımlar)

Yöntemler

Content API for Shopping'deki hak talebinde bulunma işlemine odaklanan accounts.claimwebsite yöntemi, artık Merchant API'nin Homepage kaynağındaki daha geniş bir işlev grubunun parçasıdır.

Content API for Shopping yöntemi Merchant API yöntemi Kullanılabilirlik ve Notlar
accounts.claimwebsite accounts.homepage.claim Doğrudan bir web sitesi hak talebi başlatır veya yeniden doğrular. Daha önce homepage.update kullanılarak ayarlanan uri üzerinde işlem yapar. overwrite parametresi içerir. Mevcut uri ve claimed durumuyla Homepage kaynağını döndürür.
accounts.get (Account.website_url okumak için), accountstatuses.get (AccountStatus.website_claimed okumak için) accounts.homepage.getHomepage Mevcut ana sayfayı uri ve claimed durumunu tek bir çağrıda almak için yeni özel yöntem.
accounts.update (Account.website_url ayarlamak için) accounts.homepage.updateHomepage Ana sayfayı ayarlamak veya değiştirmek için yeni özel yöntem uri.
accounts.update (hak talebini iptal etmek için geçici çözüm olarak Account.website_url boş dizeye ayarlanıyor) accounts.homepage.unclaim Bir ana sayfanın hak talebini açıkça iptal etmek için yeni özel yöntem.

Ayrıntılı alan değişiklikleri

Ana sayfa bilgilerinin yapılandırılma ve erişilme şekli önemli ölçüde değişti ve Merchant API'deki açık Homepage kaynağına geçildi.

Content API for Shopping Merchant API Açıklama
merchantId (accounts.claimwebsite için yol parametresi) name (Homepage yöntemleri için yol parametresi, biçim: accounts/{account}/homepage) Merchant API'deki name dizesinin account kısmı, Content API for Shopping'deki accountId değerine karşılık gelir.
accountId (accounts.claimwebsite için yol parametresi) name (Homepage yöntemleri için yol parametresi, biçim: accounts/{account}/homepage) Ana sayfası yönetilen belirli hesabın tanımlayıcısı.
overwrite (ContentAccountsClaimwebsiteRequest gövdesinde ve AccountsCustomBatchRequestEntry içinde boole) ClaimHomepageRequest.overwrite (homepage.claim istek gövdesinde boole) İsteğe bağlıdır. true ise web sitesi için hak talebinde bulunmaya çalışır ve talepte bulunan hesap tarafından sahiplik doğrulanabilirse başka bir hesaptan gelen mevcut hak talebini kaldırabilir.
Account.website_url (Account kaynağındaki alan, accounts.update kullanılarak ayarlanır, accounts.get kullanılarak okunur) Homepage.uri (Homepage kaynağındaki alan) Mağazanın ana sayfasının URI'si (URL'si). Merchant API'de bu, Homepage kaynağında açık bir alandır. accounts.homepage.updateHomepage kullanılarak ayarlanır ve tüm Homepage yöntemleri tarafından döndürülür.
AccountStatus.website_claimed (AccountStatus kaynağındaki alan, accountstatuses.get kullanılarak okunur) Homepage.claimed (Homepage kaynağındaki output_only boole alanı) uri için hak talebinde bulunulup bulunulmadığını ve doğrulanıp doğrulanmadığını gösterir. Bu durum, ilişkili tüm Merchant API yöntemleri tarafından döndürülen Homepage kaynağında doğrudan kullanılabilir.
Yok UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage istek gövdesi parametresi) Homepage kaynağının hangi alanlarının (ör. uri) güncellendiğini belirtmek için homepage.update için isteğe bağlı bir alan maskesi.