Zoekeindpunt segment

Het Onderzoek van het segment wordt gebruikt om gebieden te zoeken die zich over diverse gegevensbronnen bevinden en hen in bijna real time terug te keren.

Deze gids verstrekt informatie om u te helpen het Onderzoek van het Segment beter begrijpen en omvat steekproefAPI vraag voor het uitvoeren van basisacties gebruikend API.

Aan de slag

De eindpunten die in deze handleiding worden gebruikt, maken deel uit van de API van Adobe Experience Platform Segmentation Service . Alvorens verder te gaan, te herzien gelieve begonnen gidsvoor belangrijke informatie die u moet kennen om vraag aan API met succes te maken, met inbegrip van vereiste kopballen en hoe te om voorbeeld API vraag te lezen.

Naast de vereiste kopballen die in de begonnen sectie worden geschetst, vereisen alle verzoeken aan het eindpunt van het Onderzoek van het Segment de volgende extra kopbal:

Zoeken in meerdere naamruimten

Dit onderzoekseindpunt kan worden gebruikt om over diverse namespaces te zoeken, die een lijst van de resultaten van het onderzoeksaantal terugkeren. U kunt meerdere parameters gebruiken, gescheiden door ampersands (&).

API formaat

GET /search/namespaces?schema.name={SCHEMA}
GET /search/namespaces?schema.name={SCHEMA}&s={SEARCH_TERM}

Verzoek

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'

Reactie

Een succesvolle reactie retourneert HTTP status 200 met de volgende informatie.

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

Individuele entiteiten zoeken

Dit zoekeindpunt kan worden gebruikt om een lijst van alle volledige tekst geïndexeerde voorwerpen binnen gespecificeerde namespace terug te winnen. U kunt meerdere parameters gebruiken, gescheiden door ampersands (&).

API formaat

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}

Verzoek

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'

Reactie

Een geslaagde reactie retourneert HTTP-status 200 met resultaten die overeenkomen met de zoekquery.

{
  "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"
  }
}

Structuurgegevens ophalen over een zoekobject

Dit zoekeindpunt kan worden gebruikt om de structurele informatie over het gevraagde onderzoeksvoorwerp te krijgen.

API formaat

GET /search/taxonomy?schema.name={SCHEMA}&namespace={NAMESPACE}&entityId={ENTITY_ID}

Verzoek

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'

Reactie

Een geslaagde reactie retourneert HTTP-status 200 met gedetailleerde structurele informatie over het gevraagde zoekobject.

{
    "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"
    }
}

Volgende stappen

Na het lezen van deze handleiding hebt u nu een beter inzicht in hoe Segment Search werkt.

Bijlage appendix

In de volgende secties vindt u aanvullende informatie over de werking van zoektermen. Zoekopdrachten worden als volgt geschreven: s={FieldName}:{SearchExpression} . Als u bijvoorbeeld zoekt naar een segmentdefinitie met de naam AAM of Platform , gebruikt u de volgende zoekquery: s=segmentName:AAM%20OR%20Platform .

Voor de beste werkwijzen moet de zoekopdracht worden gecodeerd met HTML, net als in het bovenstaande voorbeeld.

Zoeken in velden search-fields

De volgende tabel bevat een lijst met velden die kunnen worden doorzocht binnen de zoekqueryparameter.

Zoekopdracht search-expression

De volgende lijst maakt een lijst een lijst van specifieke van hoe de onderzoeksvragen werken wanneer het gebruiken van het Onderzoek API van het Segment.

De volgende voorbeelden worden voor meer duidelijkheid weergegeven in een indeling zonder HTML-codering. Voor beste praktijken, codeer HTML uw onderzoeksuitdrukking.

Voor meer gedetailleerde documentatie over de vraagsyntaxis, te lezen gelieve de documentatie van de de vraagsyntaxis van Lucene.