クエリテンプレートエンドポイント

最終更新日： 2024年7月16日

トピック：

作成対象：

開発者

サンプル API 呼び出し

以下の節では、Query Service API を使用して作成できる様々な API 呼び出しについて説明します。各呼び出しでは一般的な API 形式、必須ヘッダーを示すリクエスト例および応答例が示されています。

Experience Platform UI を使用してテンプレートを作成する方法について詳しくは、UI クエリテンプレートのドキュメントを参照してください。

クエリテンプレートのリストの取得

/query-templates エンドポイントに対してGETリクエストを行うことで、組織のすべてのクエリテンプレートのリストを取得できます。

API 形式

GET /query-templates
GET /query-templates?{QUERY_PARAMETERS}

プロパティ	説明
`{QUERY_PARAMETERS}`	（オプション）リクエストパスに追加されるパラメーター。このリクエストパスは応答で返される結果を設定します。複数のパラメーターを使用する場合は、アンパサンド（`&`）で区切ります。使用できるパラメーターは以下のとおりです。

クエリパラメーター

次に、クエリテンプレートを一覧表示するために使用可能なクエリパラメータ－のリストを示します。これらのパラメーターはすべてオプションです。パラメーターを指定しないでこのエンドポイントを呼び出すと、組織で使用可能なすべてのクエリテンプレートが取得されます。

パラメーター	説明
`orderby`	結果の並べ替えに使用するフィールドを指定します。サポートされているフィールドは `created` と `updated` です。例えば、`orderby=created` は、昇順で結果を並べ替えます。作成前に `-` を追加する（`orderby=-created`）と、項目が作成日の降順で並べ替えられます。
`limit`	ページサイズの制限を指定して、ページに含める結果の数を制御します。（デフォルト値：20）
`start`	結果を並べ替える ISO 形式タイムスタンプを指定します。開始日を指定しない場合、API 呼び出しによって最も古く作成されたテンプレートが最初に返され、次に、より新しい結果が引き続きリストされます。ISO タイムスタンプ使用すると、日付と時間に様々なレベルの精度を設定できます。基本の ISO タイムスタンプは、2020 年 9 月 7 日を表すために `2020-09-07` の形式を取ります。より複雑な例は、`2022-11-05T08:15:30-05:00` と記述され、2022 年 11 月 5 日午前 8:15:30 分（米国東部標準時）に対応します。タイムゾーンには UTC オフセットを指定でき、サフィックス「Z」（`2020-01-01T01:01:01Z`）で示されます。タイムゾーンが指定されない場合は、デフォルトで 0 に設定されます。
`property`	フィールドに基づいて結果をフィルタリングします。フィルターは HTML エスケープする必要があります。複数のコンマを使用して、複数のフィルターを組み合わせます。サポートされているフィールドは `name` と `userId` です。サポートされている演算子は `==`（等しい）だけです。例えば、`name==my_template` は、`my_template` という名前を持つすべてのクエリテンプレートを返します。

リクエスト

次のリクエストでは、組織に対して作成された最新のクエリテンプレートを取得します。

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

応答

応答が成功すると、HTTP ステータス 200 が、指定された組織のクエリテンプレートのリストと共に返されます。次の応答は、組織に対して作成された最新のクエリテンプレートを返します。

{
    "templates": [
        {
            "sql": "SELECT *\nFROM\n  accounts\nLIMIT 10\n",
            "name": "Test",
            "id": "f7cb5155-29da-4b95-8131-8c5deadfbe7f",
            "updated": "2019-11-21T21:50:01.469Z",
            "userId": "{USER_ID}",
            "created": "2019-11-21T21:50:01.469Z",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/query-templates/f7cb5155-29da-4b95-8131-8c5deadfbe7f",
                    "method": "GET"
                },
                "delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/query-templates/f7cb5155-29da-4b95-8131-8c5deadfbe7f",
                    "method": "DELETE"
                },
                "update": {
                    "href": "https://platform.adobe.io/data/foundation/query/query-templates/f7cb5155-29da-4b95-8131-8c5deadfbe7f",
                    "method": "PUT",
                    "body": "{\"sql\": \"new sql \", \"name\": \"new name\"}"
                }
            }
        }
    ],
    "_page": {
        "orderby": "-created",
        "start": "2019-11-21T21:50:01.469Z",
        "next": "2019-11-21T21:50:01.469Z",
        "count": 1
    },
    "_links": {
        "next": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates?orderby=-created&start=2019-11-21T21:50:01.469Z"
        },
        "prev": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates?orderby=-created&start=2019-11-21T21:50:01.469Z&isPrevLink=true"
        }
    },
    "version": 1
}

NOTE

_links.delete の値を使用してクエリテンプレートを削除できます。

クエリテンプレートの作成

/query-templates エンドポイントに POST リクエストを実行することで、クエリテンプレートを作成できます。

API 形式

POST /query-templates

リクエスト

curl -X POST https://platform.adobe.io/data/foundation/query/query-templates
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
        "sql": "SELECT account_balance FROM user_data WHERE user_id='$user_id';",
        "name": "Sample query template",
        "queryParameters": {
            user_id : {USER_ID}
            }
    }'

プロパティ

説明

sql

作成する SQL クエリ。標準 SQL またはパラメーターの置き換えを使用できます。 SQL でパラメーター置換を使用するには、パラメーターキーの前に $ を付ける必要があります。例えば、$key と SQL で使用されるパラメーターを JSON キーと値のペアとして「queryParameters」フィールドに入力します。ここで渡される値は、テンプレートで使用されるデフォルトのパラメーターになります。これらのパラメーターを上書きする場合は、POSTリクエストで上書きする必要があります。

name

テンプレートのクエリ名。

queryParameters

SQL 文内のパラメータ化された値を置き換えるためのキー値のペア。指定する SQL 内でパラメーター置換を使用する場合 のみ必須です 使用しない場合）。これらのキーと値のペアについては、値タイプのチェックは行われません。

応答

正常な応答は、HTTP ステータス 202（受け入れ済み）と、新しく作成されたクエリテンプレートの詳細を返します。

{
    "sql": "SELECT account_balance FROM user_data WHERE user_id='$user_id';",
    "name": "Sample query template",
    "id": "0094d000-9062-4e6a-8fdb-05606805f08f",
    "updated": "2020-01-09T00:20:09.670Z",
    "userId": "{USER_ID}",
    "created": "2020-01-09T00:20:09.670Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "DELETE"
        },
        "update": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "PUT",
            "body": "{\"sql\": \"new sql \", \"name\": \"new name\"}"
        }
    }
}

NOTE

_links.delete の値を使用してクエリテンプレートを削除できます。

指定されたクエリテンプレートの取得

/query-templates/{TEMPLATE_ID} エンドポイントに GET リクエストを実行して、リクエストパスにクエリテンプレートの ID を指定することで、特定のクエリテンプレートを取得できます。

API 形式

GET /query-templates/{TEMPLATE_ID}

プロパティ

説明

{TEMPLATE_ID}

取得するクエリテンプレートの id 値。

リクエスト

curl -X GET https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

正常な応答は、HTTP ステータス 200 と指定されたクエリテンプレートの詳細を返します。

{
    "sql": "SELECT * FROM accounts;",
    "name": "Sample query template",
    "id": "0094d000-9062-4e6a-8fdb-05606805f08f",
    "updated": "2020-01-09T00:20:09.670Z",
    "userId": "A5A562D15E1645480A495CE1@techacct.adobe.com",
    "created": "2020-01-09T00:20:09.670Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "DELETE"
        },
        "update": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "PUT",
            "body": "{\"sql\": \"new sql \", \"name\": \"new name\"}"
        }
    }
}

NOTE

_links.delete の値を使用してクエリテンプレートを削除できます。

指定されたクエリテンプレートの更新

/query-templates/{TEMPLATE_ID} エンドポイントに PUT リクエストを実行して、リクエストパスにクエリテンプレートの ID を指定することで、特定のクエリテンプレートを更新できます。

API 形式

PUT /query-templates/{TEMPLATE_ID}

プロパティ

説明

{TEMPLATE_ID}

取得するクエリテンプレートの id 値。

リクエスト

NOTE

PUTリクエストでは、sql フィールドと name フィールドの両方に値を入力する必要があり、そのクエリテンプレートの現在のコンテンツが 上書き されます。

curl -X PUT https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
    "sql": "SELECT account_balance FROM user_data WHERE user_id='$user_id';",
    "name": "Sample query template",
    "queryParameters": {
            user_id : {USER_ID}
        }
    }'

プロパティ

説明

sql

作成する SQL クエリ。標準 SQL またはパラメーターの置き換えを使用できます。 SQL でパラメーター置換を使用するには、パラメーターキーの前に $ を付ける必要があります。例えば、$key と SQL で使用されるパラメーターを JSON キーと値のペアとして「queryParameters」フィールドに入力します。ここで渡される値は、テンプレートで使用されるデフォルトのパラメーターになります。これらのパラメーターを上書きする場合は、POSTリクエストで上書きする必要があります。

name

テンプレートのクエリ名。

queryParameters

SQL 文内のパラメータ化された値を置き換えるためのキー値のペア。指定する SQL 内でパラメーター置換を使用する場合 のみ必須です 使用しない場合）。これらのキーと値のペアについては、値タイプのチェックは行われません。

応答

正常な応答は、HTTP ステータス 202（受け入れ済み）と、指定されたクエリテンプレートの更新された情報を返します。

{
    "sql": "SELECT * FROM accounts LIMIT 20;",
    "name": "Sample query template",
    "id": "0094d000-9062-4e6a-8fdb-05606805f08f",
    "updated": "2020-01-09T00:29:20.028Z",
    "lastUpdatedBy": "{USER_ID}",
    "userId": "{USER_ID}",
    "created": "2020-01-09T00:20:09.670Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/query_templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/query_templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "DELETE"
        },
        "update": {
            "href": "https://platform.adobe.io/data/foundation/query/query_templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "PUT",
            "body": "{\"sql\": \"new sql \", \"name\": \"new name\"}"
        }
    }
}

NOTE

_links.delete の値を使用してクエリテンプレートを削除できます。

指定されたクエリテンプレートの削除

/query-templates/{TEMPLATE_ID} に DELETE リクエストを実行して、リクエストパスにクエリテンプレートの ID を指定することで、特定のクエリテンプレートを削除できます。

API 形式

DELETE /query-templates/{TEMPLATE_ID}

プロパティ

説明

{TEMPLATE_ID}

取得するクエリテンプレートの id 値。

リクエスト

curl -X DELETE https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

成功応答は、HTTP ステータス 202（許可済み）とともに次のメッセージを返します。

{
    "message": "Deleted",
    "statusCode": 202
}

recommendation-more-help