を使用してソースの行レベルのデータをフィルタリングする Flow Service API

Last update: Tue Nov 14 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：

作成対象：

開発者

IMPORTANT

現在、行レベルのデータのフィルタリングのサポートは、次のソースでのみ利用できます。

このチュートリアルでは、 Flow Service API.

はじめに

このチュートリアルは、Adobe Experience Platform の次のコンポーネントを実際に利用および理解しているユーザーを対象としています。

ソース：Experience Platform を使用すると、データを様々なソースから取得しながら、Platform サービスを使用して受信データの構造化、ラベル付け、拡張を行うことができます。
サンドボックス：Experience Platform には、単一の Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。

Platform API の使用

Platform API を正常に呼び出す方法について詳しくは、Platform API の概要のガイドを参照してください。

ソースデータをフィルター

次に、ソースの行レベルのデータをフィルタリングする手順の概要を示します。

接続仕様の検索

API を使用してソースの行レベルのデータをフィルタリングする前に、まず、ソースの接続仕様の詳細を取得して、特定のソースがサポートする演算子と言語を決定する必要があります。

特定のソースの接続仕様を取得するには、に対してGETリクエストを実行します。 /connectionSpecs エンドポイント Flow Service API を使用して、ソースのプロパティ名をクエリパラメーターの一部として指定する場合。

API 形式

GET /connectionSpecs/{QUERY_PARAMS}

パラメーター

説明

{QUERY_PARAMS}

結果をフィルタリングするためのオプションのクエリパラメーターです。次を取得： Google BigQuery 接続仕様 name プロパティと指定 "google-big-query" を使用して検索できます。

リクエスト

次のリクエストは、 Google BigQuery.

curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=name=="google-big-query"' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

正常な応答は、 Google BigQuery（サポートされるクエリ言語や論理演算子に関する情報を含む）

NOTE

以下の API 応答は、簡潔にするために切り捨てられています。

"attributes": {
  "filterAtSource": {
    "enabled": true,
    "queryLanguage": "SQL",
    "logicalOperators": [
      "and",
      "or",
      "not"
    ],
    "comparisonOperators": [
      "=",
      "!=",
      "<",
      "<=",
      ">",
      ">=",
      "like",
      "in"
    ],
    "columnNameEscapeChar": "`",
    "valueEscapeChar": "'"
  }

プロパティ

説明

attributes.filterAtSource.enabled

クエリされたソースが行レベルのデータのフィルタリングをサポートするかどうかを決定します。

attributes.filterAtSource.queryLanguage

クエリされたソースがサポートするクエリ言語を決定します。

attributes.filterAtSource.logicalOperators

ソースの行レベルのデータをフィルタリングするために使用できる論理演算子を決定します。

attributes.filterAtSource.comparisonOperators

ソースの行レベルのデータをフィルタリングする際に使用できる比較演算子を決定します。比較演算子について詳しくは、次の表を参照してください。

attributes.filterAtSource.columnNameEscapeChar

列のエスケープに使用する文字を決定します。

attributes.filterAtSource.valueEscapeChar

SQL クエリを書き込む際に値を取り囲む方法を決定します。

比較演算子

演算子

説明

==

プロパティが指定された値と等しいかどうかでフィルターします。

!=

プロパティが指定された値と等しくないかどうかでフィルターします。

<

プロパティが指定された値より小さいかどうかでフィルターします。

>

プロパティが指定された値より大きいかどうかでフィルターします。

<=

プロパティが指定された値以下かどうかでフィルターします。

>=

プロパティが指定された値以上かどうかでフィルターします。

like

で使用されていることによるフィルター WHERE 句を使用して、指定したパターンを検索します。

in

プロパティが指定した範囲内にあるかどうかでフィルターします。

取り込みのフィルター条件を指定

ソースがサポートする論理演算子とクエリ言語を特定したら、プロファイルクエリ言語 (PQL) を使用して、ソースデータに適用するフィルター条件を指定できます。

次の例では、条件は、パラメーターとしてリストされたノードタイプに指定された値と等しい選択データにのみ適用されます。

{
  "type": "PQL",
  "format": "pql/json",
  "value": {
    "nodeType": "fnApply",
    "fnName": "=",
    "params": [
      {
        "nodeType": "fieldLookup",
        "fieldName": "city"
      },
      {
        "nodeType": "literal",
        "value": "DDN"
      }
    ]
  }
}

データのプレビュー

データリクエストを /explore エンドポイント Flow Service を提供する際の API filters をクエリパラメーターの一部として追加し、 Base64.

API 形式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}&preview=true&filters={FILTERS}

パラメーター

説明

{BASE_CONNECTION_ID}

ソースのベース接続 ID。

{TABLE_PATH}

検査するテーブルの path プロパティです。

{FILTERS}

でエンコードされた PQL フィルター条件。 Base64.

リクエスト

curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connections/89d1459e-3cd0-4069-acb3-68f240db4eeb/explore?objectType=table&object=TESTFAS.FASTABLE&preview=true&filters=ewogICJ0eXBlIjogIlBRTCIsCiAgImZvcm1hdCI6ICJwcWwvanNvbiIsCiAgInZhbHVlIjogewogICAgIm5vZGVUeXBlIjogImZuQXBwbHkiLAogICAgImZuTmFtZSI6ICJhbmQiLAogICAgInBhcmFtcyI6IFsKICAgICAgewogICAgICAgICJub2RlVHlwZSI6ICJmbkFwcGx5IiwKICAgICAgICAiZm5OYW1lIjogImxpa2UiLAogICAgICAgICJwYXJhbXMiOiBbCiAgICAgICAgICB7CiAgICAgICAgICAgICJub2RlVHlwZSI6ICJmaWVsZExvb2t1cCIsCiAgICAgICAgICAgICJmaWVsZE5hbWUiOiAiY2l0eSIKICAgICAgICAgIH0sCiAgICAgICAgICB7CiAgICAgICAgICAgICJub2RlVHlwZSI6ICJsaXRlcmFsIiwKICAgICAgICAgICAgInZhbHVlIjogIk0lIgogICAgICAgICAgfQogICAgICAgIF0KICAgICAgfQogICAgXQogIH0KfQ==\' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

リクエストが成功すると、次の応答が返されます。

{
  "format": "flat",
  "schema": {
    "columns": [
      {
        "name": "FIRSTNAME",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "LASTNAME",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "CITY",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "AGE",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "HEIGHT",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "ISEMPLOYED",
        "type": "boolean",
        "xdm": {
          "type": "boolean"
        }
      },
      {
        "name": "POSTG",
        "type": "boolean",
        "xdm": {
          "type": "boolean"
        }
      },
      {
        "name": "LATITUDE",
        "type": "double",
        "xdm": {
          "type": "number"
        }
      },
      {
        "name": "LONGITUDE",
        "type": "double",
        "xdm": {
          "type": "number"
        }
      },
      {
        "name": "JOINEDDATE",
        "type": "string",
        "meta:xdmType": "date-time",
        "xdm": {
          "type": "string",
          "format": "date-time"
        }
      },
      {
        "name": "CREATEDAT",
        "type": "string",
        "meta:xdmType": "date-time",
        "xdm": {
          "type": "string",
          "format": "date-time"
        }
      },
      {
        "name": "CREATEDATTS",
        "type": "string",
        "meta:xdmType": "date-time",
        "xdm": {
          "type": "string",
          "format": "date-time"
        }
      }
    ]
  },
 "data": [
    {
        "CITY": "MZN",
        "LASTNAME": "Jain",
        "JOINEDDATE": "2022-06-22T00:00:00",
        "LONGITUDE": 1000.222,
        "CREATEDAT": "2022-06-22T17:19:33",
        "FIRSTNAME": "Shivam",
        "POSTG": true,
        "HEIGHT": "169",
        "CREATEDATTS": "2022-06-22T17:19:33",
        "ISEMPLOYED": true,
        "LATITUDE": 2000.89,
        "AGE": "25"
    },
    {
        "CITY": "MUM",
        "LASTNAME": "Kreet",
        "JOINEDDATE": "2022-09-07T00:00:00",
        "LONGITUDE": 10500.01,
        "CREATEDAT": "2022-09-07T17:19:33",
        "FIRSTNAME": "Rakul",
        "POSTG": true,
        "HEIGHT": "155",
        "CREATEDATTS": "2022-09-07T17:19:33",
        "ISEMPLOYED": false,
        "LATITUDE": 2500.89,
        "AGE": "42"
    },
    {
        "CITY": "MAN",
        "LASTNAME": "Lee",
        "JOINEDDATE": "2022-09-14T00:00:00",
        "LONGITUDE": 1000.222,
        "CREATEDAT": "2022-09-14T05:02:33",
        "FIRSTNAME": "Denzel",
        "POSTG": true,
        "HEIGHT": "185",
        "CREATEDATTS": "2022-09-14T05:02:33",
        "ISEMPLOYED": true,
        "LATITUDE": 123.89,
        "AGE": "16"
    }
  ]
}

フィルター済みデータのソース接続を作成する

ソース接続を作成し、フィルターされたデータを取り込むには、 /sourceConnections エンドポイントを使用して、body パラメーターの一部としてフィルター条件を指定できます。

API 形式

POST /sourceConnections

リクエスト

次のリクエストは、データを取り込むためのソース接続を作成します。 test1.fasTestTable 場所 city = DDN.

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "BigQuery Source Connection",
      "description": "Source Connection for Filter test",
      "baseConnectionId": "89d1459e-3cd0-4069-acb3-68f240db4eeb",
      "data": {
        "format": "tabular"
      },
      "params": {
        "tableName": "test1.fasTestTable",
        "filters": {
          "type": "PQL",
          "format": "pql/json",
          "value": {
            "nodeType": "fnApply",
            "fnName": "=",
            "params": [
              {
                "nodeType": "fieldLookup",
                "fieldName": "city"
              },
              {
                "nodeType": "literal",
                "value": "DDN"
              }
            ]
          }
        }
      },
      "connectionSpec": {
        "id": "3c9b37f8-13a6-43d8-bad3-b863b941fedd",
        "version": "1.0"
      }
    }'

応答

リクエストが成功した場合は、新たに作成されたソース接続の一意の ID（id）が返されます。

{
    "id": "b7581b59-c603-4df1-a689-d23d7ac440f3",
    "etag": "\"ef05d265-0000-0200-0000-6019e0080000\""
}

付録

この節では、様々なペイロードのフィルタリングのその他の例を示します。

特異条件

最初の fnApply を返します。

{
  "type": "PQL",
  "format": "pql/json",
  "value": {
    "nodeType": "fnApply",
    "fnName": "like",
    "params": [
      {
        "nodeType": "fieldLookup",
        "fieldName": "firstname"
      },
      {
        "nodeType": "literal",
        "value": "%s"
      }
    ]
  }
}

の使用 `in` 演算子

演算子の例については、以下のサンプルペイロードを参照してください in.

{
  "type": "PQL",
  "format": "pql/json",
  "value": {
    "nodeType": "fnApply",
    "fnName": "and",
    "params": [
      {
        "nodeType": "fnApply",
        "fnName": "in",
        "params": [
          {
            "nodeType": "fieldLookup",
            "fieldName": "firstname"
          },
          {
            "nodeType": "literal",
            "value": [
              "Ramen",
              "John"
            ]
          }
        ]
      }
    ]
  }
}

の使用 `isNull` 演算子

演算子の例については、以下のサンプルペイロードを参照してください isNull.

{
  "type": "PQL",
  "format": "pql/json",
  "value": {
    "nodeType": "fnApply",
    "fnName": "isNull",
    "params": [
      {
        "nodeType": "fieldLookup",
        "fieldName": "complaint_type"
      }
    ]
  }
}

の使用 `NOT` 演算子

演算子の例については、以下のサンプルペイロードを参照してください NOT.

{
  "type": "PQL",
  "format": "pql/json",
  "value": {
    "nodeType": "fnApply",
    "fnName": "NOT",
    "params": [
      {
        "nodeType": "fnApply",
        "fnName": "isNull",
        "params": [
          {
            "nodeType": "fieldLookup",
            "fieldName": "complaint_type"
          }
        ]
      }
    ]
  }
}

ネストされた条件の例

複雑なネスト条件の例については、以下のサンプルペイロードを参照してください。

{
  "type": "PQL",
  "format": "pql/json",
  "value": {
    "nodeType": "fnApply",
    "fnName": "and",
    "params": [
      {
        "nodeType": "fnApply",
        "fnName": ">=",
        "params": [
          {
            "nodeType": "fieldLookup",
            "fieldName": "age"
          },
          {
            "nodeType": "literal",
            "value": 20
          }
        ]
      },
      {
        "nodeType": "fnApply",
        "fnName": "<=",
        "params": [
          {
            "nodeType": "fieldLookup",
            "fieldName": "age"
          },
          {
            "nodeType": "literal",
            "value": 30
          }
        ]
      },
      {
        "nodeType": "fnApply",
        "fnName": "or",
        "params": [
          {
            "nodeType": "fnApply",
            "fnName": "!=",
            "params": [
              {
                "nodeType": "fieldLookup",
                "fieldName": "city"
              },
              {
                "nodeType": "literal",
                "value": "PUD"
              }
            ]
          },
          {
            "nodeType": "fnApply",
            "fnName": "=",
            "params": [
              {
                "nodeType": "fieldLookup",
                "fieldName": "joinedDate"
              },
              {
                "nodeType": "literal",
                "value": "2020-04-22"
              }
            ]
          }
        ]
      }
    ]
  }
}

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089

を使用してソースの行レベルのデータをフィルタリングする Flow Service API

はじめに

Platform API の使用

ソースデータをフィルター

接続仕様の検索

比較演算子

取り込みのフィルター条件を指定

データのプレビュー

フィルター済みデータのソース接続を作成する

付録

特異条件

の使用 in 演算子

の使用 isNull 演算子

の使用 NOT 演算子

ネストされた条件の例

の使用 `in` 演算子

の使用 `isNull` 演算子

の使用 `NOT` 演算子