Merchant API, özel bir
Homepage
kaynağı sunar. Bu kaynak, ana sayfa 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 gerçekleştirmeniz 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
simgesini kullanın.
Temel farklılıklar
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çinaccounts.claimwebsite
kullanıyordunuz, ana sayfa URL'si (website_url
)Account
kaynağının, hak talebi durumu (website_claimed
) iseAccountStatus
kaynağının bir parçasıydı.) - Ayrıntılı yöntemler: Merchant API, şu işlemleri yapmanıza olanak tanıyan belirli 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.unclaim
Alışveriş İçin İçerik API'si, talep işlemi içinaccounts.claimwebsite
, URL'yi ayarlamak (ve boş bir URL ayarlayarak etkili bir şekilde reddetmek) içinaccounts.update
, URL'yi ve talep durumunu sırasıyla almak içinaccounts.get
/accountstatuses.get
kullanır.
- Ana sayfa ayrıntılarını alma:
- Merkezi bilgiler: Merchant API
Homepage
kaynağı hemuri
(ana sayfa URL'si) hem declaimed
durumunu doğrudan içerir.Homepage
kaynağı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.claimwebsite
güncellenen durum döndürülmedi; ayrı çağrılar gerekiyordu. - Açıkça sorumluluk reddi beyanı: Content API for Shopping'de sorumluluk reddi beyanı genellikle
Account.website_url
boş bir dize olarak güncellenerek yapılırdı. Merchant API, özel birhomepage.unclaim
yöntem sunar. - İddiayı geçersiz kılma: Sahiplik doğrulanabiliyorsa her iki API de, iddia sürecinde başka bir hesaptaki iddiayı devralmak için
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ı | 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 (Account.website_url ayarı) |
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 Account.website_url tarihinde ayarlandı) |
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ı | Yoldaki 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
Alışveriş için Content API'deki accounts.claimwebsite
yöntemi, talep etme işlemine odaklanıyordu ve artık Merchant API'nin Homepage
kaynağındaki daha geniş bir işlevler grubunun parçası.
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. uri , daha önce homepage.update kullanılarak ayarlanmış olmalıdır. overwrite parametresi içerir. Mevcut uri ve claimed durumuyla birlikte 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 özel 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 talebinde bulunmamak için geçici çözüm olarak Account.website_url ayarını boş dizeye ayarlama) |
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. Bu değişiklik, Merchant API'deki açık Homepage
kaynağına doğru bir geçişi ifade ediyor.
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 gövdesinde boole) |
İsteğe bağlı. true , web sitesi için hak talebinde bulunursa sahiplik talep eden hesap tarafından doğrulanabildiği takdirde başka bir hesabın 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 boolean 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) |
Hangi alanların (ör.homepage.update Homepage kaynağının uri ) güncelleniyor. |