Markaları listeleme | Listings API

Parametreler

Sorgu

Ad	Tür	Zorunlu	Açıklama	Varsayılan
filters	string	isteğe bağlı	JSON-encoded filter object with two fields. `statuses` (array of strings, required inside the object) selects which brand states to return: `ACTIVE` or `ARCHIVED`. `profileName` (string, optional) is a case-insensitive substring match on the brand name. Omit the parameter entirely to return active brands.	—
page	integer	isteğe bağlı	1-based page number. Defaults to 1.	—
size	integer	isteğe bağlı	Rows per page. Defaults to 20.	—

Yanıtlar

200A page of brands plus `pageInfo` for paging.

Response

{  "data": {    "listSocialProfiles": {      "profiles": [        {          "id": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",          "profileName": "Jenny Home",          "archived": false,          "logo": null,          "profileLogo": null,          "siteUrl": "https://jennyhome.example",          "countryIso": "US",          "bio": "Handmade furniture for real homes.",          "businessIntent": "A family-run home furnishings store selling handmade furniture and textiles.",          "categories": ["Furniture Store", "Home Goods"],          "brandHashtags": ["jennyhome", "handmadefurniture"],          "competitorHashtags": [],          "connectedChannelCount": 3,          "timezone": {            "label": "(GMT-05:00) Eastern Time",            "tzCode": "America/New_York",            "name": "Eastern Standard Time",            "utc": "-05:00"          },          "contentPreferredLanguage": "en"        },        {          "id": "a90f7c22-5db1-4e83-9f40-2b7c6a1e5d33",          "profileName": "Jenny Home Eastside",          "archived": false,          "logo": null,          "profileLogo": null,          "siteUrl": null,          "countryIso": "US",          "bio": null,          "businessIntent": "general",          "categories": [],          "brandHashtags": [],          "competitorHashtags": [],          "connectedChannelCount": 0,          "timezone": {            "label": "(GMT-06:00) Central Time",            "tzCode": "America/Chicago",            "name": "Central Standard Time",            "utc": "-06:00"          },          "contentPreferredLanguage": "en"        }      ],      "pageInfo": {        "total": 11,        "hasNextPage": true,        "totalEngagementPosts": 0,        "totalPublishedPosts": 0      }    }  }}

401Unauthenticated, missing or invalid API key.

Hesabınızdaki markaları sayfa sayfa listeler. Her satır, GET /social/brands/{brandId} tarafından tek bir marka için döndürülen marka nesnesiyle aynıdır; bu nedenle bir marka seçici göstermek için genellikle ikinci bir istek göndermeden bu listeyi kullanmanız yeterlidir.

Kullanım örneği: kendi kullanıcı arayüzünüzde bir marka seçici. Kullanıcı yayınlama ekranınızı açtığında bunu bir kez çağırın ve her satırda profileName ile logo değerlerini gösterin. connectedChannelCount değeri 0 olan bir markaya henüz hiçbir sosyal hesap bağlanmamıştır ve bu marka yayın yapamaz; bunu bir rozetle belirtin ve kullanıcıyı bir bağlantı kurma bağlantısına yönlendirin. pageInfo.hasNextPage değeri true olduğu sürece page ve size ile sayfalar arasında ilerleyin.

Kullanım örneği: kayıtlarınızı uzlaştırma. Her gece tüm sayfaları dolaşın ve id değerini oluşturma sırasında sakladığınız marka kimlikleriyle eşleştirin. Varsayılan listeden kaybolan bir marka arşivlenmiştir; bu markayı görmek için filters={"statuses":["ARCHIVED"]} gönderin.

Notlar.

id, Social API'nin diğer bölümlerinde brandId yol belirteci olarak, istek gövdelerinde ise socialProfileId olarak kullanılan yalın UUID'dir.
Filtreler, ayrı parametreler olarak değil, filters sorgu parametresinde JSON olarak kodlanmış tek bir dize olarak iletilir. Bu dizeyi URL kodlamasından geçirin. filters gönderirseniz mutlaka statuses içermelidir; bunun yanında profileName isteğe bağlıdır.
Sayfalama, Locations ve Reviews uç noktalarındaki gibi imleç tabanlı değil, ofset tabanlıdır (page / size). pageInfo.total, bu sayfadaki marka sayısı değil, eşleşen markaların toplam sayısıdır. pageInfo.totalEngagementPosts ve totalPublishedPosts, gönderi listesiyle paylaşılan gönderi sayaçlarıdır ve burada değerleri 0 olur.
connectedChannelCount yalnızca etkin bağlantıları sayar; bağlantısı kesilen bir kanal derhal sayımdan çıkarılır. Kanalların kendilerini almak için GET /social/brands/{brandId}/connections çağrısını yapın.
timezone.tzCode, o markanın tüm zamanlamalarının hangi saat dilimine göre belirleneceğini gösteren IANA tanımlayıcısıdır; diğer üç saat dilimi alanı görüntüleme etiketleridir.
Karşılaştırma yapabileceğiniz bir marka üst sınırı yoktur. API planlarında marka sayısı sınırsızdır; dolayısıyla bu listenin uzunluğu bilgi amaçlıdır. Üst sınır uygulanan sayı bağlantı sayısıdır: bu sayıyı GET /social/limits üzerinden okuyun. Bir markayı arşivlemek bağlantılarını hemen çevrimdışı yapar, ancak bağlantı kontenjanları faturalandırma dönemi sona erene kadar maxConnections sınırına dahil edilmeye devam eder. Bu nedenle, bu listeden çıkan bir marka yenilemeye kadar kontenjanları tutmaya devam edebilir.