Merchant API, özel bir Homepage kaynağı sunar. Bu kaynak, ana sayfa hak talebinizi yönetmek için yeni yöntemler sunar ve klasik Content API for Shopping'in ötesinde özellikler sağlar.
Online mağazanızın özelliklerine erişmek için iki adımlı bir işlem yapmanız gerekir: önce sahipliği doğrulamanız, ardından siteyi hesabınız için talep etmeniz 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
Homepagekaynağı (accounts.homepage) sağlar. (Content API for Shopping'de hak talebi işlemini gerçekleştirmek içinaccounts.claimwebsitekullanıyordunuz, ana sayfa URL'si (website_url)Accountkaynağının, hak talebi durumu (website_claimed) iseAccountStatuskaynağının bir parçasıydı.) - Ayrıntılı yöntemler: Merchant API, aşağıdaki işlemler için özel yöntemler sunar:
- Ana sayfa ayrıntılarını alma:
accounts.homepage.getHomepage - Ana sayfa URI'sini güncelleyin:
accounts.homepage.updateHomepage - Ana sayfayı talep etme:
accounts.homepage.claim - Ana sayfayı reddetme:
accounts.homepage.unclaimContent API for Shopping, hak talebi işlemi içinaccounts.claimwebsite, URL'yi ayarlamak içinaccounts.update(ve boş bir URL ayarlayarak etkili bir şekilde reddetmek) ve sırasıyla URL ile hak talebi durumunu almak içinaccounts.get/accountstatuses.getkullanır.
- Ana sayfa ayrıntılarını alma:
- Merkezi bilgiler: Merchant API
Homepagekaynağı hemuri(ana sayfa URL'si) hem declaimeddurumunu doğrudan içerir.Homepagekaynağında çalışan tüm yöntemler, mevcut durumla ilgili anında geri bildirim sağlayarak bu kaynağı döndürür. Content API for Shopping'de,accounts.claimwebsitegüncellenen durumu döndürmedi; ayrı çağrılar gerekiyordu. - Açıkça sorumluluk reddi beyanı: Content API for Shopping'de sorumluluk reddi beyanı genellikle
Account.website_urlboş bir dize olarak güncellenerek yapılıyordu. Merchant API, özel birhomepage.unclaimyöntem sunar. - İddianın üzerine yazma: Her iki API de, sahiplik doğrulanabiliyorsa başka bir hesaptaki iddiayı devralmak için iddia süreci sırasında bir
overwriteparametresini destekler.
İstekler
Merchant API, ana sayfanın farklı özelliklerini yönetmek için farklı RESTful uç noktaları kullanır.
| İstek açıklaması | 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 sayfayla ilgili hak talebinde bulunma veya sayfayı yeniden doğrulama | POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (accounts.update kullanılarak belirlenen Account.website_url üzerinde işlem yapıldı) |
POST /accounts/v1/accounts/{account}/homepage:claim |
| Ana sayfayı reddetme | accounts.update (Account.website_url ayarını boş dize olarak ayarlama) |
POST /accounts/v1/accounts/{account}/homepage:unclaim |
Tanımlayıcılar
Merchant API'de kaynak tanımlama işlemi kolaylaştırıldı.
| 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 geçerlidir) |
name: accounts/{account_id}/homepage (Homepage alt kaynağını tanımlar) |
Yöntemler
Content API for Shopping'deki accounts.claimwebsite yöntemi, daha önce hak talebinde bulunma işlemine odaklanıyordu. Bu yöntem artık Merchant API'nin Homepage kaynağındaki daha geniş bir işlevler 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 talebini başlatır veya yeniden doğrular. homepage.update kullanılarak daha önce ayarlanan uri üzerinde işlem yapar. overwrite parametresini 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ıyla almak için yeni bir yöntem. |
accounts.update (Account.website_url değerini ayarlamak için) |
accounts.homepage.updateHomepage |
Ana sayfayı ayarlamak veya değiştirmek için yeni bir yöntem eklendi uri. |
accounts.update (hak talebini iptal etmeyi geçici olarak çözmek için Account.website_url ayarı boş dizeye ayarlanıyor) |
accounts.homepage.unclaim |
Ana sayfanın sahipliğini açıkça kaldırmak için yeni bir 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. Artık Merchant API'deki açık Homepage kaynağı kullanılıyor.
| 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 ile eşleşir. |
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 metninde boole) |
İsteğe bağlıdır. true, web sitesi için hak talebinde bulunursa ve sahiplik, talepte bulunan hesap tarafından doğrulanabilirse başka bir hesaptaki mevcut hak talebi kaldırılabilir. |
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). Merchant API'de bu, Homepage kaynağındaki açık bir alandır. accounts.homepage.updateHomepage kullanılarak ayarlanır ve tüm Homepage yöntemleriyle 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 öğesinin talep edilip doğrulandığını belirtir. 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.update için isteğe bağlı bir alan maskesi.Homepage kaynağının hangi alanlarının (ör. uri) güncellendiğini belirtir. |