段搜索終結點

段搜索用於搜索包含在各種資料源中的欄位，並以接近即時的方式返回這些欄位。

本指南提供資訊，幫助您更好地瞭解段搜索，並包括使用API執行基本操作的示例API調用。

快速入門

本指南中使用的端點是 Adobe Experience Platform Segmentation Service API。 在繼續之前，請查看 入門指南 要成功調用API，您需要瞭解的重要資訊，包括必需的標頭以及如何讀取示例API調用。

除了入門部分中概述的必需標頭外，所有對段搜索終結點的請求都需要以下附加標頭：

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

跨多個命名空間搜索

此搜索終結點可用於跨各種命名空間搜索，返回搜索計數結果的清單。 可以使用多個參數，用和符號(&)分隔。

API格式

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

要求

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'

回應

成功響應返回HTTP狀態200，並返回以下資訊。

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

搜索單個實體

此搜索終結點可用於檢索指定命名空間中所有全文索引對象的清單。 可以使用多個參數，用和符號(&)分隔。

API格式

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}

要求

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'

回應

成功的響應返回HTTP狀態200，結果與搜索查詢匹配。

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

獲取有關搜索對象的結構資訊

此搜索端點可用於獲取有關所請求搜索對象的結構資訊。

API格式

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

要求

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'

回應

成功的響應返回HTTP狀態200，其中包含有關所請求搜索對象的詳細結構資訊。

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

後續步驟

閱讀本指南後，您現在可以更好地瞭解段搜索的工作方式。

附錄

以下各節提供了有關搜索詞如何工作的附加資訊。 搜索查詢的編寫方式如下： s={FieldName}:{SearchExpression}。 例如，要搜索名為或的AAM段 Platform，將使用以下搜索查詢： s=segmentName:AAM%20OR%20Platform。

!![NOTE] 對於最佳做法，搜索表達式應像上面所示的示例那樣進行HTML編碼。

搜索欄位

下表列出了可在搜索查詢參數中搜索的欄位。

搜索表達式

下表列出了使用段搜索API時搜索查詢的具體工作方式。

!![NOTE] 以下示例以非HTML編碼格式顯示，以便更清晰。 為了獲得最佳實踐，HTML對搜索表達式進行編碼。

有關查詢語法的更詳細文檔，請閱讀 Lucene查詢語法文檔。

Business.Adobe.com資源