Segmentsuchendpunkt

Die Segmentsuche wird verwendet, um Felder zu durchsuchen, die in verschiedenen Datenquellen enthalten sind, und sie nahezu in Echtzeit zurückzugeben.

Dieses Handbuch enthält Informationen zum besseren Verständnis der Segmentsuche sowie Beispiel-API-Aufrufe zum Ausführen grundlegender Aktionen mithilfe der API.

Erste Schritte

Die in diesem Handbuch verwendeten Endpunkte sind Teil der Adobe Experience Platform Segmentation Service API. Bevor Sie fortfahren, lesen Sie bitte die Erste Schritte für wichtige Informationen, die Sie benötigen, um die API erfolgreich aufrufen zu können, einschließlich erforderlicher Kopfzeilen und Informationen zum Lesen von Beispiel-API-Aufrufen.

Zusätzlich zu den erforderlichen Kopfzeilen, die im Abschnitt "Erste Schritte"beschrieben werden, benötigen alle Anforderungen an den Segmentsuchendpunkt die folgende zusätzliche Kopfzeile:

  • x-ups-search-version: "1.0"

Suchen über mehrere Namespaces hinweg

Dieser Suchendpunkt kann verwendet werden, um über verschiedene Namespaces hinweg zu suchen und eine Liste mit Suchergebnissen zurückzugeben. Es können mehrere Parameter verwendet werden, getrennt durch das kaufmännische Und-Zeichen (&).

API-Format

GET /search/namespaces?schema.name={SCHEMA}
GET /search/namespaces?schema.name={SCHEMA}&s={SEARCH_TERM}
Parameter
Beschreibung
schema.name={SCHEMA}
(Erforderlich) Wo {SCHEMA} stellt den Schemaklasse-Wert dar, der mit den Suchobjekten verknüpft ist. Derzeit wird nur _xdm.context.segmentdefinition unterstützt.
s={SEARCH_TERM}
(Optional) Wo {SEARCH_TERM} stellt eine Abfrage dar, die der Implementierung von Microsoft entspricht. Suchsyntax von Lucene. Wenn kein Suchbegriff angegeben ist, werden alle Datensätze, die mit schema.name zurückgegeben. Eine ausführlichere Erläuterung finden Sie im Abschnitt Anhang dieses Dokuments.

Anfrage

curl -X GET \
    https://platform.adobe.io/data/core/ups/search/namespaces?schema.name=_xdm.context.segmentdefinition \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'Content-Type: application/json' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'x-ups-search-version: 1.0'

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit folgenden Informationen zurück.

{
  "namespaces": [
    {
      "namespace": "AAMTraits",
      "displayName": "AAMTraits",
      "count": 45
    },
    {
      "namespace": "AAMSegments",
      "displayName": "AAMSegment",
      "count": 10
    },
    {
      "namespace": "SegmentsAISegments",
      "displayName": "SegmentSAISegment",
      "count": 3
    }
  ],
  "totalCount": 3,
  "status": {
    "message": "Success"
  }
}

Suche nach einzelnen Entitäten

Mit diesem Suchendpunkt können Sie eine Liste aller im angegebenen Namespace indizierten Volltext-Objekte abrufen. Es können mehrere Parameter verwendet werden, getrennt durch das kaufmännische Und-Zeichen (&).

API-Format

GET /search/entities?schema.name={SCHEMA}&namespace={NAMESPACE}
GET /search/entities?schema.name={SCHEMA}&namespace={NAMESPACE}&s={SEARCH_TERM}
GET /search/entities?schema.name={SCHEMA}&namespace={NAMESPACE}&entityId={ENTITY_ID}
Parameter
Beschreibung
schema.name={SCHEMA}
(Erforderlich) Wo {SCHEMA} enthält den Wert der Schemaklasse, der mit den Suchobjekten verknüpft ist. Derzeit wird nur _xdm.context.segmentdefinition unterstützt.
namespace={NAMESPACE}
(Erforderlich) Wo {NAMESPACE} enthält den Namespace, in dem Sie suchen möchten.
s={SEARCH_TERM}
(Optional) Wo {SEARCH_TERM} enthält eine Abfrage, die mit der Microsoft-Implementierung von Suchsyntax von Lucene. Wenn kein Suchbegriff angegeben ist, werden alle Datensätze, die mit schema.name zurückgegeben. Eine ausführlichere Erläuterung finden Sie im Abschnitt Anhang dieses Dokuments.
entityId={ENTITY_ID}
(Optional) Schränkt Ihre Suche in den angegebenen Ordner ein, mit {ENTITY_ID}.
limit={LIMIT}
(Optional) Wo {LIMIT} stellt die Anzahl der zurückzugebenden Suchergebnisse dar. Der Standardwert lautet 50.
page={PAGE}
(Optional) Wo {PAGE} stellt die Seitenzahl dar, die für die Paginierung der Ergebnisse der gesuchten Abfrage verwendet wird. Beachten Sie, dass die Seitenzahl bei 0.

Anfrage

curl -X GET \
    https://platform.adobe.io/data/core/ups/search/entities?schema.name=_xdm.context.segmentdefinition&namespace=AAMSegments \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'Content-Type: application/json' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'x-ups-search-version: 1.0'

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 zurück, wobei die Ergebnisse mit der Suchabfrage übereinstimmen.

{
  "entities": [
    {
       "id": "1012667",
       "base64EncodedSourceId": "RFVGamdydHpEdy01ZTE1ZGJlZGE4YjAxMzE4YWExZWY1MzM1",
       "sourceId": "DUFjgrtzDw-5e15dbeda8b01318aa1ef533",
       "isFolder": true,
       "parentFolderId": "974139",
       "name": "aam-47995 verification (100)"
    },
    {
       "id": "14653311",
       "base64EncodedSourceId": "REVGamduLVgzdy01ZTE2ZjRhNjc1ZDZhMDE4YThhZDM3NmY1",
       "sourceId": "DEFjgn-X3w-5e16f4a675d6a018a8ad376f",
       "isFolder": false,
       "parentFolderId": "324050",
       "name": "AAM - Heavy equipment",
       "description": "AAM - Acme Equipment"
    }

 ],
  "page": {
    "totalCount": 2,
    "totalPages": 1,
    "pageOffset": 0,
    "pageSize": 10
  },
  "status": {
    "message": "Success"
  }
}

Abrufen von Strukturinformationen über ein Suchobjekt

Mit diesem Suchendpunkt können Sie die Strukturinformationen zum angeforderten Suchobjekt abrufen.

API-Format

GET /search/taxonomy?schema.name={SCHEMA}&namespace={NAMESPACE}&entityId={ENTITY_ID}
Parameter
Beschreibung
schema.name={SCHEMA}
(Erforderlich) Wo {SCHEMA} enthält den Wert der Schemaklasse, der mit den Suchobjekten verknüpft ist. Derzeit wird nur _xdm.context.segmentdefinition unterstützt.
namespace={NAMESPACE}
(Erforderlich) Wo {NAMESPACE} enthält den Namespace, in dem Sie suchen möchten.
entityId={ENTITY_ID}
(Erforderlich) Die ID des Suchobjekts, zu dem Sie die Strukturinformationen abrufen möchten, angegeben mit {ENTITY_ID}.

Anfrage

curl -X GET \
    https://platform.adobe.io/data/core/ups/search/taxonomy?schema.name=_xdm.context.segmentdefinition&namespace=AAMSegments&entityId=porsche11037 \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'Content-Type: application/json' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'x-ups-search-version: 1.0'

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit detaillierten Strukturinformationen zum angeforderten Suchobjekt zurück.

{
    "taxonomy": [
        {
            "id": "0",
            "base64EncodedSourceId": "RFVGZ01BLTVlNjgzMGZjMzk3YjQ1MThhYWExYTA4Zg2",
            "name": "AAMTraits for Cars",
            "parentFolderId": "root"
        },
        {
            "id": "150561",
            "base64EncodedSourceId": "RFVGamdpRk1BZy01ZTY4MzBmYzM5N2I0NTE4YWFhMWEwOGY1",
            "name": "Fast Cars",
            "parentFolderId": "carTraits"
        },
        {
            "id": "porsche11037",
            "base64EncodedSourceId": "REFGZ01CLTVlNjczMGZjMzk3YjQ1MThhZGIxYTA4Zg==",
            "name": "Porsche",
            "parentFolderId": "redCarsFolderId"
        }
    ],
    "status": {
        "message": "Success"
    }
}

Nächste Schritte

Nach dem Lesen dieses Handbuchs haben Sie jetzt ein besseres Verständnis davon, wie die Segmentsuche funktioniert.

Anhang appendix

Die folgenden Abschnitte enthalten zusätzliche Informationen zur Funktionsweise von Suchbegriffen. Suchabfragen werden wie folgt geschrieben: s={FieldName}:{SearchExpression}. Um beispielsweise nach einer Segmentdefinition mit dem Namen AAM oder zu suchen, Platformverwenden Sie die folgende Suchabfrage: s=segmentName:AAM%20OR%20Platform.

Für Best Practices sollte der Suchausdruck wie im oben gezeigten Beispiel HTML-kodiert sein.

Suchfelder search-fields

In der folgenden Tabelle sind die Felder aufgeführt, die im Suchabfrageparameter gesucht werden können.

Feldname
Beschreibung
folderId
Der Ordner oder die Ordner mit der Ordner-ID der angegebenen Suche.
folderLocation
Der Speicherort bzw. die Speicherorte mit dem Ordnerspeicherort der angegebenen Suche.
parentFolderId
Die Segmentdefinition oder der Ordner mit der übergeordneten Ordner-ID der angegebenen Suche.
segmentId
Die Segmentdefinition, die mit der Segment-ID Ihrer angegebenen Suche übereinstimmt.
segmentName
Die Segmentdefinition, die dem Segmentnamen der angegebenen Suche entspricht.
segmentDescription
Die Segmentdefinition, die mit der Segmentbeschreibung der angegebenen Suche übereinstimmt.

Suchausdruck search-expression

In der folgenden Tabelle finden Sie die Details zur Funktionsweise von Suchabfragen bei der Verwendung der Segmentsuche-API.

Die folgenden Beispiele werden in einem nicht-HTML-kodierten Format angezeigt, um eine bessere Übersichtlichkeit zu erzielen. Best Practices finden Sie unter HTML-Kodierung Ihres Suchausdrucks.

Beispielsuchausdruck
Beschreibung
foo
Suchen Sie nach einem beliebigen Wort. Dies gibt Ergebnisse zurück, wenn das Wort "foo"in einem der durchsuchbaren Felder gefunden wird.
foo AND bar
Boolesche Suche. Dies gibt Ergebnisse zurück, wenn both Die Wörter "foo" und "bar" befinden sich in allen durchsuchbaren Feldern.
foo OR bar
Boolesche Suche. Dies gibt Ergebnisse zurück, wenn entweder das Wort "foo" oder das Wort "bar" finden Sie in allen durchsuchbaren Feldern.
foo NOT bar
Boolesche Suche. Dies gibt Ergebnisse zurück, wenn das Wort "foo"gefunden wird, das Wort "bar"jedoch in keinem der durchsuchbaren Felder gefunden wird.
name: foo AND bar
Boolesche Suche. Dies gibt Ergebnisse zurück, wenn both Die Wörter "foo" und "bar" finden Sie im Feld "name".
run*
Eine Platzhaltersuche. Die Verwendung eines Sternchens (*) entspricht 0 oder mehr Zeichen, d. h. es werden Ergebnisse ausgegeben, wenn der Inhalt eines durchsuchbaren Felds ein Wort enthält, das mit "run"beginnt. Dies gibt beispielsweise Ergebnisse zurück, wenn die Wörter "wird ausgeführt", "läuft", "runner"oder "runt"angezeigt werden.
Cam?
Eine Platzhaltersuche. Verwenden eines Fragezeichens (?) entspricht nur genau einem Zeichen. Das bedeutet, dass Ergebnisse ausgegeben werden, wenn der Inhalt eines durchsuchbaren Felds mit "cam"und einem zusätzlichen Buchstaben beginnt. Dies gibt beispielsweise Ergebnisse zurück, wenn die Wörter "Camp"oder "Cams"angezeigt werden, aber keine Ergebnisse zurückgeben, wenn die Wörter "Camera"oder "Campfire"angezeigt werden.
"blauer Regenschirm"
Eine Satzsuche. Dies gibt Ergebnisse zurück, wenn der Inhalt eines durchsuchbaren Felds den vollständigen Wortlaut "blauer Schirm"enthält.
blue~
Eine unscharfe Suche. Optional können Sie eine Zahl zwischen 0 und 2 nach der Tilde (~) setzen, um den Bearbeitungsabstand anzugeben. Beispielsweise würde "blue~1""blue", "blues"oder "kleue"zurückgeben. Unscharfe Suche kann only auf Begriffe, nicht auf Sätze angewendet werden. Sie können jedoch am Ende jedes Wortes in einer Wortgruppe Tildes anhängen. Beispielsweise würde "camping~ in~ the~ summer~"mit "camping im Sommer"übereinstimmen.
"Hotel Airport"~5
Näherungssuche. Diese Art der Suche wird verwendet, um Begriffe zu finden, die in einem Dokument nahe beieinander liegen. Beispielsweise die Wortgruppe "hotel airport"~5 findet die Begriffe "Hotel" und "Flughafen" innerhalb von 5 Wörtern voneinander in einem Dokument.
/a[0-9]+b$/
Suche nach regulären Ausdrücken. Diese Art der Suche findet eine Übereinstimmung basierend auf dem Inhalt zwischen Schrägstrichen "/", wie in der RegExp-Klasse dokumentiert. Um beispielsweise Dokumente zu finden, die "motel"oder "hotel"enthalten, geben Sie /[mh]otel/. Die Suche nach regulären Ausdrücken wird mit einzelnen Wörtern abgeglichen.

Eine ausführlichere Dokumentation zur Abfragesyntax finden Sie im Abschnitt Dokumentation zur Lucene-Abfragesyntax.

recommendation-more-help
770bc05d-534a-48a7-9f07-017ec1e14871