Elenca i siti del piano

Risposte

200Array of plan site objects. Country arrays are truncated below for brevity; the live response lists every supported country.

Response

{  "data": {    "planSites": [      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 1,        "name": "Google Maps",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "maps.google.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 184,        "name": "Facebook",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "facebook.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "GB"],        "id": 2,        "name": "Yelp",        "supportedCountries": ["US", "CA", "GB", "DE", "FR"],        "url": "yelp.com"      }    ]  }}

401Unauthenticated, missing or invalid API key.

429Rate limit exceeded. Retry after the `Retry-After` header value.

Restituisce tutti i siti di directory delle piattaforme di pubblicazione inclusi nel piano associato all'account corrente. Ogni voce contiene un id intero, un name da visualizzare, il url del sito, l'elenco dei codici paese ISO accettati dal sito (supportedCountries) e i paesi in cui il flag hide-address / service-area viene rispettato (hideAddressSupportedCountries).

Caso d'uso: crea un selettore di ID sito validi. Prima di abilitare o disabilitare le piattaforme di pubblicazione per una sede, chiama questo endpoint per sapere quali ID sito numerici sono disponibili per il piano. Solo gli ID restituiti qui possono essere passati validamente ad altre parti dell'API. Associa id a name/url per mostrare una schermata delle impostazioni di invio comprensibile all'utente.

Caso d'uso: verifica preliminarmente il paese di una sede. Filtra la risposta per includere i siti il cui supportedCountries contiene il countryIso della sede, in modo da proporre solo le piattaforme di pubblicazione che accetteranno effettivamente la scheda. Per le attività con un'area di servizio, verifica anche hideAddressSupportedCountries per sapere dove è possibile nascondere l'indirizzo.

Aspetti da tenere presenti.

Questo elenco è limitato al piano e non è paginato: restituisce l'intero catalogo dei siti del piano in un'unica risposta, quindi non è presente alcun cursore. Aspettati decine di voci e memorizza il risultato nella cache anziché chiamare l'endpoint a ogni richiesta.
supportedCountries e hideAddressSupportedCountries possono contenere ciascuno 50 o più codici ISO; l'esempio sopra è troncato.
Condivide il limite di frequenza delle richieste dell'account; in caso di 429, rispetta l'header Retry-After.

Parametri

Risposte