Kaynağı Depolama
Not
Mağaza kaynağı yalnızca kapalı beta katılımcıları tarafından kullanılabilir. Kapalı beta veya açık beta programına katılma hakkında bilgi için lütfen hesap yöneticinize başvurun.
Tüm Store programlama öğeleri ve belgeleri beta sırasında değiştirilebilir.
Kullanıcının sahip olduğu depoları yönetmek için Mağaza kaynağını kullanın. Mağaza ekleyebilir, belirli bir mağazayı alabilir veya kullanıcının sahip olduğu tüm mağazaları alabilirsiniz. Daha fazlasını okuyun.
Temel URI
Aşağıda , şablonları eklediğiniz temel URI'dir.
https://content.api.ads.microsoft.com/v9.1/bmc
Örneğin, bir mağaza eklemek veya kullanıcının sahip olduğu mağazaların listesini almak için aşağıdaki uç noktayı kullanın:
https://content.api.ads.microsoft.com/v9.1/bmc/stores
Şablonlar
Bunlar, bir HTTP uç noktası oluşturmak için temel URI'ye eklediğiniz şablonlardır.
/stores şablonu
HTTP Fiili | Açıklama | Kaynak |
---|---|---|
YAYINLA | Bir mağaza ekler. Aşağıdaki sınırlar geçerlidir ve değiştirilebilir:
|
İstek: MağazaOluştur Yanıt: Mağaza |
AL | Kullanıcıya ait mağazaların listesini alır. | İstek: Yok Yanıt: StoreCollection |
/stores/{merchantId} şablonu
HTTP Fiili | Açıklama | Kaynak |
---|---|---|
AL | Belirtilen depoyu alır. Almak istediğiniz mağazanın kimliğine ayarlayın {merchantId} . |
İstek: Yok Yanıt: Mağaza |
Sorgu parametreleri
İstek aşağıdaki sorgu parametrelerini içerebilir:
Parametre | Açıklama |
---|---|
kuru çalıştırma | Isteğe bağlı. Uygulamanızı test etmek veya hatalarını ayıklamak için kullanın. Bu parametreyi içeren çağrılar üretim verilerini etkilemez (depolar eklenmez); ancak yanıt, çağrının oluşturduğu hataları içerir. Bu parametreyi kullanırken aşağıdaki sınırlamaları göz önünde bulundurun.
|
Üstbilgi
İstek ve yanıt üst bilgileri aşağıdadır.
Üstbilgi | Açıklama |
---|---|
AuthenticationToken | İstek üst bilgisi. Bu üst bilgiyi bir OAuth erişim belirteci olarak ayarlayın. Erişim belirteci alma hakkında bilgi için bkz. Kimlik bilgilerinizin kimliğini doğrulama. |
İçerik Türü | İstek üst bilgisi. Tüm POST istekleri bu üst bilgiyi belirtmelidir ve olarak application/json ayarlanmalıdır. |
CustomerAccountId | İstek üst bilgisi. Üst bilgide CustomerId belirtilen müşteri adına yönettiğiniz herhangi bir hesabın hesap kimliği. Hangi hesabı belirttiğiniz önemli değildir. Bu üst bilgiyi yalnızca müşteri adına bir hesabı yönetiyorsanız belirtin. |
Customerıd | İstek üst bilgisi. Mağazasını yönettiğiniz müşterinin müşteri kimliği. Bu üst bilgiyi yalnızca mağazayı müşteri adına yönetiyorsanız belirtin. Bu üst bilgiyi ayarlarsanız üst bilgiyi de ayarlamanız CustomerAccountId gerekir. |
DeveloperToken | İstek üst bilgisi. İstemci uygulamasının geliştirici belirteci. Her istek bu üst bilgiyi içermelidir. Belirteç alma hakkında bilgi için bkz. Microsoft Advertising kimlik bilgileriniz ve geliştirici belirteciniz var mı? |
WebRequestActivityId | Yanıt üst bilgisi. İsteğin ayrıntılarını içeren günlük girdisinin kimliği. Bir hata oluşursa her zaman bu kimliği yakalamanız gerekir. Sorunu belirleyemiyor ve çözemiyorsanız, destek ekibine sağladığınız diğer bilgilerle birlikte bu kimliği de ekleyin. |
İstek ve yanıt nesneleri
API tarafından kullanılan istek ve yanıt nesneleri aşağıda verilmiştır.
Nesne | Açıklama |
---|---|
Hata | Bir hata tanımlar. |
ErrorResponse | En üst düzey hata nesnesini tanımlar. |
Mağazası | Microsoft Merchant Center'da bir mağaza tanımlar. |
StoreCollection | Microsoft Merchant Center'da bir mağaza koleksiyonunu tanımlar. |
MağazaOluştur | Microsoft Merchant Center'a eklenecek bir mağaza tanımlar. |
StoreStatus | Mağazanın durumunu tanımlar. |
Error
Bir hata tanımlar.
Name | Değer | Tür |
---|---|---|
Kod | İsteğin başarısız olmasının nedeni. Örneğin, alan doğrulanamadıysa storeName kod InvalidStoreNameErr olur. |
Dize |
ileti | Hatanın açıklaması. | Dize |
ErrorResponse
En üst düzey hata nesnesini tanımlar.
Name | Değer | Tür |
---|---|---|
Hata | İstek işlenirken oluşan hataların listesi. | Hata[] |
Mağazası
Microsoft Merchant Center'da bir mağaza tanımlar.
Name | Değer | Tür |
---|---|---|
isBlockAggregator | Toplayıcıların mağazanızdan herhangi bir reklam yayınlamasını engellemek isteyip istemediğinizi gösteren Boole değeri. Toplayıcılar, birden çok, genellikle ilgisiz işletmeden gelen ürün tekliflerini birleştirir. Varsayılan olarak, toplayıcılar katalogunuzu reklamlarına ekleyebilir. Ürünlerinizin Bing'de toplayıcıların reklamlarında gösterilmesini engellemek istiyorsanız doğrudur . Kullanan http://www.contoso.com iki mağazanız (biri Birleşik Devletler ve biri Birleşik Krallık için) varsa ve bunlardan biri toplayıcıları engelliyorsa, her iki mağaza da toplayıcıları engeller. |
Boole |
isSslCheckout | Deponuzun SSL etkin olup olmadığını gösteren boole değeri. Tüm depolarda SSL oturum açma ve kullanıma alma sayfaları olmalıdır. Mağazanızın web sitesi SSL etkinse doğrudur . | Boole |
merchantId | Mağazanın kimliği. | İşaretsiz uzun |
notificationEmail | Bildirim e-postaları alacak alıcıların listesi. E-postalar, mağaza onaylandığında veya mağazayla ilgili doğrulama hataları olup olmadığını size bildirir. | Dize[] |
notificationLanguage | Bildirim e-postalarını yazmak için kullanılan dil. Dil, <dil-ülke></bölge> biçimindedir. Örneğin, en-US. | Dize |
storeDescription | Mağazanın kullanımını açıklayan açıklama. | Dize |
Storename | Mağazanın adı. | Dize |
storeStatus | Mağazanın durumu. | StoreStatus |
storeUrl | Mağazanın hedef URL'si. Hedef URL, kişilerin reklamınıza tıkladığında yönlendirildiği web sayfasıdır. | Dize |
StoreCollection
Mağaza listesini tanımlar.
Name | Değer | Tür |
---|---|---|
Mağaza | Kullanıcının sahip olduğu mağazaların listesi. | Mağaza[] |
MağazaOluştur
Microsoft Merchant Center'a eklenecek bir mağaza tanımlar.
Name | Değer | Tür | Gerekli |
---|---|---|---|
isBlockAggregator | Toplayıcıların mağazanızdan herhangi bir reklam yayınlamasını engellemek isteyip istemediğinizi gösteren Boole değeri. Toplayıcılar, birden çok, genellikle ilgisiz işletmeden gelen ürün tekliflerini birleştirir. Varsayılan olarak, toplayıcılar katalogunuzu reklamlarına ekleyebilir. Ürünlerinizin Bing'de toplayıcıların reklamlarında gösterilmesini önlemek için true olarak ayarlayın. Kullanan http://www.contoso.com iki mağazanız (biri Birleşik Devletler ve biri Birleşik Krallık için) varsa ve bunlardan biri toplayıcıları engelliyorsa, her iki mağaza da toplayıcıları engeller. Varsayılan değer false'tur. |
Boole | Hayır |
isSslCheckout | Deponuzun SSL etkin olup olmadığını gösteren boole değeri. Tüm depolarda SSL oturum açma ve kullanıma alma sayfaları olmalıdır. Mağazanızın web sitesi SSL etkinse true olarak ayarlayın.
False ise mağaza onaylanmamıştır. Varsayılan değer true'dır. |
Boole | Hayır |
notificationEmail | Bildirim e-postaları alacak alıcıların listesi. E-postalar, mağaza onaylandığında veya mağazayla ilgili doğrulama hataları olup olmadığını size bildirir. Belirtebilecek en fazla e-posta adresi sayısı 14'tür. | Dize[] | Evet |
notificationLanguage | Bildirim e-postalarını yazmak için kullanılan dil. Dil, <dil-ülke></bölge> biçimindedir. Aşağıda, belirtebilecek olası büyük/küçük harfe duyarlı olmayan değerler yer alır.
|
Dize | Evet |
storeDescription | Mağazanın kullanımını açıklayan açıklama. Açıklama en fazla 350 karakterle sınırlıdır ve yalnızca alfasayısal karakterler ([a-zA-Z0-9]) içerebilir. | Dize | Hayır |
Storename | Mağazanın adı. Mağazanın adı ürün reklamlarınızda göründüğünden, web sitenizi doğru şekilde temsil eden bir ad kullandığınızdan emin olun. Ad:
|
Dize | Evet |
storeUrl | Mağazanın hedef URL'si. Hedef URL, kişilerin reklamınıza tıkladığında yönlendirildiği web sayfasıdır. URL başka bir konuma yeniden yönlendirilmemelidir. URL iyi biçimlendirilmiş olmalı ve en fazla 1.024 karaktere sahip olmalıdır. Web sitenizin URL'sini doğrulamanız ve talep etmeniz gerekir. Microsoft web sitenizin SSL uyumlu olduğunu doğrulayamazsa mağazalar onaylanmamaktadır. Satıcı web sitelerinin SSL oturum açma ve kullanıma alma sayfaları olmalıdır. SSL sertifikalarınızın geçerli olduğunu doğrulayın. | Dize | Evet |
StoreStatus
Mağazanın durumunu tanımlar.
Name | Değer | Tür |
---|---|---|
ileti | Mağazanın onaylanmama nedeni. nesnesi bu alanı yalnızca status Onaylanmadıysa içerir. |
Dize |
Durum | Mağazanın durumu. Olası değerler şunlardır.
message .Başlangıçta otomatik olarak onaylanan bir mağaza Onaylandı'dan ManualReview'a geçebilir. El ile gözden geçirilecek bir mağazaya ürün ekleyemezsiniz ve mağazadaki ürünler hizmet vermez. Onaylanmama nedenine bağlı olarak, Microsoft Ads uygulamasını kullanarak sorunu çözebilirsiniz. Aksi takdirde, uygun değerlerle yeni bir depo oluşturmanız gerekir. |
Dize |
HTTP durum kodları
İstekler aşağıdaki HTTP durum kodlarını döndürebilir.
Durum kodu | Açıklama |
---|---|
200 | Başarı. |
201 | Mağaza başarıyla eklendi. |
400 | Hatalı istek. Büyük olasılıkla POST isteğinin gövdesi geçersiz veri içeriyor veya hatalı biçimlendirilmiş. |
401 | Yetki -siz. Kullanıcının kimlik bilgileri geçerli değil. |
404 | Bulunamadı. İstenen depo bulunamadı. |
500 | Sunucu hatası. |
Hata kodları
İstekler aşağıdaki hata kodlarını döndürebilir.
Hata kodu | Açıklama |
---|---|
AdultAdvertiserErr | Yetişkin reklamcılar mağaza oluşturamayabilir. |
DomainNotOwnedByCustomerErr | storeUrl alanında belirtilen etki alanı müşteriye ait değil. Müşterinin etki alanının sahibi olduğunu doğruladığından emin olun. |
DuplicateStoreNameErr | Belirtilen depo adına sahip başka bir depo var; mağaza adları Microsoft Merchant Center ile benzersiz olmalıdır. |
ExceededMaxStoresForCustomerErr | Müşteri, oluşturabileceği mağaza sayısını aştı. Sınırlar için bkz. Mağaza POST'larını ekleme. |
ExceededMaxStoresForDestinationUrlErr | Müşteri, aynı hedef URL'yi kullanarak oluşturabileceği mağaza sayısını aştı. Sınırlar için bkz. Mağaza POST'larını ekleme. |
InvalidStoreDescriptionErr | Mağazanın açıklaması geçerli değil. Sınırlar için bkz. storeDescription. |
InvalidStoreDestinationUrlErr | storeUrl alanında belirttiğiniz mağazanın hedef URL'si geçerli değil. |
InvalidStoreNameErr | Mağazanın adı geçerli değil. Sınırlar için bkz. storeName. |
MarketNotSupportedErr | notificationLanguage alanında belirttiğiniz pazar geçerli değil. |
NoDomainsFoundForCustomerErr | Müşterinin sahip olduğu doğrulanmış etki alanı yok. |