ProductStatuses Kaynağı
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.
Bir mağazadaki ürün tekliflerinin durumunu almak için ProductStatuses kaynağını kullanın.
Temel URI
Aşağıda , şablonları eklediğiniz temel URI'dir.
https://content.api.ads.microsoft.com/v9.1/bmc
Örneğin, bir mağazadaki ürün tekliflerinin durumunun özet görünümünü almak için aşağıdaki uç noktayı kullanın:
https://content.api.ads.microsoft.com/v9.1/bmc/stores/{merchantId}/productstatusessummary
Şablonlar
Bunlar, bir HTTP uç noktası oluşturmak için temel URI'ye eklediğiniz şablonlardır.
/stores/{merchantId}/productstatusessummary
HTTP Fiili | Açıklama | Kaynak |
---|---|---|
Al | Bir mağazadaki ürün tekliflerinin durumunun özet görünümünü alır. Hizmet, mağazada onaylanan, onaylanmamış ve süresi dolan teklif sayısını döndürür. Durumları almak için mağazanın kimliğine ayarlayın {merchantId} .Teklifin durumunun özet görünümüne yansıtıldığında değişmesi iki saat kadar sürebilir. |
İstek: Yok Yanıt: ProductStatusesSummary |
/stores/{merchantId}/productstatuses
HTTP Fiili | Açıklama | Kaynak |
---|---|---|
Al | Mağazadaki ürün tekliflerinin durumunun ayrıntılı bir görünümünü alır. Ayrıntılar yalnızca Onaylanmadı veya Uyarı durumundaki ürünler için döndürülür. Durumlarını almak istediğiniz mağazanın kimliğine ayarlayın {merchantId} .Max-results sorgu parametresi, hizmetin döndürdüğü teklif sayısını belirler. Tüm teklifleri sayfalandırmak için continuation-token sorgu parametresini kullanın. |
İstek: Yok Yanıt: ProductStatuses |
Sorgu parametreleri
İstek aşağıdaki sorgu parametrelerini içerebilir:
Ü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. |
ProductStatus | Ürün teklifinin durumunu tanımlar. |
ProductStatuses | Sorunları olan ürün tekliflerinin listesini tanımlar. |
ProductStatusesSummary | Bir mağazadaki ürün tekliflerinin durumunun özet görünümünü tanımlar. |
ProductStatusItemLevelIssue | Ürün teklifiyle ilgili bir sorunu tanımlar. |
Error
Bir hata tanımlar.
Name | Değer | Tür |
---|---|---|
Kod | İsteğin başarısız olmasının nedeni. | 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[] |
ProductStatus
Ürün teklifinin durumunu tanımlar.
Name | Değer | Tür |
---|---|---|
Creationdate | Ürün teklifinin oluşturulduğu tarih ve saat. | Datetime |
expirationDate | Ürün teklifinin süresi dolmak üzere ayarlandığı tarih ve saat. | Datetime |
itemLevelIssues | Ürün teklifiyle ilgili sorunların listesi. | ProductStatusItemLevelIssue[] |
lastUpdateDate | Ürün teklifinin son güncelleştirildiği tarih ve saat. | Datetime |
Productıd | Ürünün kimliği. | Dize |
Durum | Ürünün onay durumu. Olası değerler şunlardır:
|
Dize |
Başlık | Ürünün başlığı | Dize |
ProductStatuses
Sorunları olan ürün tekliflerinin listesini tanımlar.
Name | Değer | Tür |
---|---|---|
nextPageToken | Alınabilecek daha fazla ürün teklifi varsa continuation-token sorgu parametresinin ayarlanacağı belirteç. | Dize |
Kaynak | Sorunları olan ürün tekliflerinin listesi. Max-results sorgu parametresi listedeki teklif sayısı üst sınırını belirler; döndürülen gerçek sayı daha az olabilir. | ProductStatus[] |
ProductStatusesSummary
Bir mağazadaki ürün tekliflerinin durumunun özet görünümünü tanımlar. Mağaza yeni oluşturulduysa, tüm değerler sıfır olur.
Name | Değer | Tür |
---|---|---|
Onaylı | Mağazada onaylanan toplam ürün sayısı. | Tamsayı |
Onaylanmadı | Mağazadaki hatalar nedeniyle onaylanmamış toplam ürün sayısı. | Tamsayı |
Süresi dolan | Mağazadaki son kullanma tarihi önümüzdeki 72 saat içinde dolacak olan toplam ürün sayısı. | Tamsayı |
merchantId | Ürünlerin içinde olduğu mağazanın kimliği. | İşaretsiz uzun |
Bekleyen | Gözden geçirmeyi bekleyen ürünlerin toplam sayısı. | Tamsayı |
ProductStatusItemLevelIssue
Ürün teklifiyle ilgili bir sorunu tanımlar.
Name | Değer | Tür |
---|---|---|
Attributename | Soruna neden olan ürün teklifinin özelliğinin adı. Tüm sorunlar bir özelliği tanımlamaz. Örneğin, sorun birden fazla özellikten kaynaklanıyorsa nesne bu alanı içermez. | Dize |
Kod | Sorunu tanımlayan hata kodu. Örneğin, TitleTooLongErr. | Dize |
Açıklama | özelliğiyle ilgili sorunu açıklayan bir açıklama. | Dize |
servability | Sorunun teklifin sunulmasını engelleyip engellemediğini gösteren bir değer. Olası değerler şunlardır:
|
Dize |
HTTP durum kodları
İstekler aşağıdaki HTTP durum kodlarını döndürebilir.
Durum kodu | Açıklama |
---|---|
200 | Başarı. |
400 | Hatalı istek. Büyük olasılıkla istek geçersiz bir sorgu parametresi veya parametre değeri belirtir. |
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 |
---|---|
ContinuationTokenInvalidErr |
continuation-token sorgu parametre değeri geçerli değil.
ProductStatuses nesnesinin nextPageToken alanındaki değeri kullanarak parametresini ayarladığınızdan emin olun. |