Websites im Tarif auflisten

Antworten

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.

Gibt alle Verzeichnis-Websites der Plattformen zurück, die im Tarif des aktuellen Kontos enthalten sind. Jeder Eintrag enthält einen ganzzahligen Wert für id, einen Anzeigenamen (name), die url der Website, die Liste der von der Website akzeptierten ISO-Ländercodes (supportedCountries) und die Länder, in denen die Option zum Ausblenden der Adresse bzw. zur Kennzeichnung eines Einzugsgebiets berücksichtigt wird (hideAddressSupportedCountries).

Anwendungsfall: eine Auswahl gültiger Website-IDs erstellen. Rufen Sie diesen Endpunkt auf, bevor Sie Plattformen für einen Standort aktivieren oder deaktivieren, um zu erfahren, welche numerischen Website-IDs für den Tarif existieren. Nur die hier zurückgegebenen IDs dürfen an anderer Stelle in der API übergeben werden. Ordnen Sie id den Werten name/url zu, um eine verständliche Ansicht der Übermittlungseinstellungen darzustellen.

Anwendungsfall: das Land eines Standorts vorab prüfen. Filtern Sie die Antwort nach Websites, deren supportedCountries den Wert countryIso des Standorts enthält, damit Sie nur Plattformen anbieten, die den Eintrag tatsächlich akzeptieren. Prüfen Sie bei Unternehmen mit Einzugsgebiet zusätzlich hideAddressSupportedCountries, um festzustellen, wo die Adresse ausgeblendet werden kann.

Stolperfallen.

Diese Liste ist auf den Tarif beschränkt und nicht paginiert: Sie gibt den vollständigen Website-Katalog für den Tarif in einer einzigen Antwort zurück, daher gibt es keinen Cursor. Rechnen Sie mit Dutzenden von Einträgen und speichern Sie das Ergebnis im Cache, statt den Endpunkt bei jeder Anfrage aufzurufen.
supportedCountries und hideAddressSupportedCountries können jeweils 50 oder mehr ISO-Codes enthalten; das obige Beispiel ist gekürzt.
Für diesen Endpunkt gilt das gemeinsame Anfragelimit des Kontos; beachten Sie bei 429 den Header Retry-After.

Parameter

Antworten