GET/api/v4/sub-categories

Alt kategorileri listeleme

Konumları oluştururken veya güncellerken sınıflandırmak için kullanılan alt kategorilerin tam kataloğunu döndürür.

API anahtarı gerektirir. Başlık biçimi ve anahtar yenileme için Kimlik doğrulama bölümüne bakın.

Parametreler

Bu uç nokta parametre almaz.

Yanıtlar

200The full list of subcategory objects.
Response
{  "data": {    "subcategories": [      {        "databaseId": 639,        "id": "U3ViQ2F0ZWdvcnk6NjM5",        "key": "3d-printing",        "name": "3D Printing",        "primary": true      },      {        "databaseId": 4589,        "id": "U3ViQ2F0ZWdvcnk6NDU4OQ==",        "key": "3d-printing-service",        "name": "3D printing service",        "primary": true      },      {        "databaseId": 3268,        "id": "U3ViQ2F0ZWdvcnk6MzI2OA==",        "key": "aadhaar-center",        "name": "Aadhaar center",        "primary": true      }    ]  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Bir konumun faaliyet alanını sınıflandıran alt kategorilerin tam kataloğunu döndürür. Bu hesap yaklaşık 6.000 kayıt döndürür; bu nedenle kataloğu büyük ve çoğunlukla sabit bir başvuru kaynağı olarak ele alın, bir kez alın, önbelleğe kaydedin ve her oluşturma/güncelleme işlemi sırasında çağırmak yerine düzenli aralıklarla yenileyin.

Her öğe şunları içerir:

  • databaseId: bir konum oluştururken veya güncellerken subCategoryId olarak iletilecek ve ek kategoriler için additionalCategoryIds dizisine dahil edilecek tam sayı.
  • id: aynı kaydın Base64 ile kodlanmış Relay tanımlayıcısı.
  • key: kategori adının URL uyumlu slug değeri.
  • name: insanların okuyabileceği etiket.
  • primary: kategorinin bir konumun birincil alt kategorisi olmaya uygun olup olmadığı.

Bir konum oluşturmadan önce kategoriyi belirleme

Bir konumu sisteme eklerken genellikle işletme türünü serbest metin olarak ("3D baskı hizmeti") bilirsiniz, ancak createLocation sayısal bir subCategoryId bekler. İzlenecek yöntem şudur: bu listeyi bir kez alın, kendi kodunuzda bir name → databaseId eşlemesi oluşturun, ardından oluşturma sırasında id değerini bu eşlemeden bulun.

JavaScript
const res = await fetch('https://listingsapi.com/api/v4/sub-categories', {  headers: { Authorization: 'API ' + process.env.LISTINGSAPI_KEY },});const { data } = await res.json();const byName = new Map(data.subcategories.map((s) => [s.name.toLowerCase(), s.databaseId])); const subCategoryId = byName.get('3d printing service'); // 4589

Bir konumu birden fazla kategoriyle etiketlemek için birincil kategoriyi subCategoryId alanında, en fazla 9 ek kategori id değerini ise additionalCategoryIds alanında iletin. Bu alanların nasıl kullanıldığı hakkında bilgi için Konum oluşturma ve Konum güncelleme bölümlerine bakın.

Yanıt, sayfalandırılmamış tek bir dizidir. Diğer tüm çağrılar gibi hesabınızın istek hızı sınırına dahil edilir; bu nedenle her konum için yeniden almak yerine önbelleğe kaydedin; 429 yanıtı bir Retry-After üst bilgisi içerir.

Request
curl -X GET 'https://listingsapi.com/api/v4/sub-categories' \  -H "Authorization: API $LISTINGSAPI_KEY"