DokumentationMobile SDKPlaces Service-Anleitung

Kopfzeilen und Parameter

Letzte Aktualisierung: 31. Dezember 2024
  • Themen:

Im Folgenden finden Sie die Details zu den Kopfzeilen und Parametern, die in der Places Service-REST-API verfügbar sind:

Unterstützte Header

HeaderBeschreibungMethodeBeispiel
AuthorizationIhr Bearer-TokenAlle
x-api-keyIhr API-SchlüsselAlle19776964b4cde49e08d8f62e5824f777b
x-gw-ims-org-idIhre Organisations-IDAlle18FB61145BAC2FFB0A494777@AdobeOrg
Content-TypeFormat des gesendeten oder empfangenen InhaltsPUT, POSTapplication/json
Accept-LanguageSprache für FehlermeldungenOptionalen-US

Bibliotheksparameter

ParameterBeschreibungTypLimitAnfrage oder AntwortBeispiel
idID der BibliothekZugewiesenn. z.Antwort"id": "b2488788-2d2a-462b-b1a2-305272777dda"
nameName der BibliothekZeichenfolge256 ZeichenBeide, in der Anfrage erforderlich"name": "Amazing Places"
orgIDExperience Cloud-Organisations-IDZugewiesenn. z.Antwort"orgID": "777F20F55BACA09E0A495D8F@AdobeOrg"
poiCountAnzahl der POIs in der Bibliothekintegermax. 150.000Antwort"poiCount": 25149
metadataDescriptorsAnzahl für jedes eindeutige POI-Metadaten-Schlüsselwertpaargemischtn. z.Antwort
poiCountInCitiesAnzahl für jeden eindeutigen POI-Stadtwertgemischtn. z.Antwort

POI-Parameter

ParameterBeschreibungTypLimitAnfrage oder AntwortBeispiel
dataPOI-DatenArray von POI-Detailsn. z.Beide
idID des POIZugewiesenn. z.Antwort"id": "1455462b-7f9c-4220-9f42-5bbce777a0d1"
nameName des POIZeichenfolge512 ZeichenBeide, optional*"name": "My Favorite Place"
descriptionBeschreibung des POIZeichenfolge512 ZeichenBeide, optional*"description": "This is a very good place."
locationArray von Typ und Koordinaten des POIArray (gemischt)n. z.Beide"location": {"type": "Point", "coordinates": [-122.201007, 37.604713]
typePOI-TypZeichenfolgenur „Punkt“ derzeit unterstütztBeide, in der Anfrage erforderlich"type": "Point"
coordinatesArray von Längen- und Breitengrad des POIArray (float)Längengrad: -180 bis 180, Breite -85 bis 85Beide, in der Anfrage erforderlich"coordinates": [-122.201007, 37.604713]
radiusGröße des kreisförmigen Geofence um POIfloat10 - 2000 MeterBeide, in der Anfrage erforderlich"radius": 100
countryLand für den POIZeichenfolge32 ZeichenBeide, optional*"country": "United States"
stateStatus des POIZeichenfolge32 ZeichenBeide, optional*"state": "California"
cityStadt für den POIZeichenfolge32 ZeichenBeide, optional*"city": "San Jose"
streetStraße des POIZeichenfolge256 ZeichenBeide, optional*"street": "122 Woz Way"
categoryKategorie für den POIZeichenfolge100 ZeichenBeide, optional*"category": "cafe"
iconSymbol für den POIZeichenfolge50 ZeichenBeide, optional*"icon": "star"
colorFarbe für den POIZeichenfolge8 ZeichenBeide, optional*"color": "blue"
metadataArray von Schlüssel/Wert-Paaren für den POIARRAY(Zeichenfolge)Schlüssel: 256 Zeichen, Wert: 256 Zeichen, maximal 10 PaareBeide, optional*"metadata": {"region": "Equator"}
lib_idID der Bibliothek, in der sich der POI befindetn. z.n. z.Beide, erforderlich"lib_id": "ac7a0b25-c6c2-43ba-bbc6-2b1777b80fe9"
  • Wenn der Parameterwert nicht enthalten ist, wird der Wert in der Datenbank auf empty gesetzt. Wenn das vorhandene Schlüssel/Wert-Paar nicht enthalten ist, wird das Schlüssel/Wert-Paar für diesen POI in der Datenbank entfernt.
recommendation-more-help
475fad96-f29f-4dca-a109-68bf0557e825