クエリ エンジン サービス

保存された分析の実行

概要

Query Engine サービスを使用して、識別子によって事前定義された保存済み分析を実行できます。 このサービスでは、動的 SQL 実行、バッチ クエリ実行、または任意のステートメント実行はサポートされていません。

コンテンツ タイプ

サービス REST API は現在、次のコンテンツ タイプをサポートするように設計されています。

  • JSON - 使用 Content-type: application/json

目的のコンテンツ タイプの選択は、API 開発者がケースバイケースで選択する必要があります。 API 機能はコンテンツ タイプ間で対称です。 API 開発者は、HTTP GET または POST メソッド パラメーターで、または AJAX または HTTP クライアント ライブラリを使用して、必要なコンテンツ タイプを指定できます。

エラー チェックと状態コード

API 開発者は、サービス REST API から返される HTTP 応答コードをチェックして、API 呼び出しから伝播されたエラーを検出する必要があります。 サービスへの呼び出しが成功すると、200 の範囲の応答コードが生成されます。 HTTP 応答の範囲が 400 から 500 の場合は、エラーを示します。 特定の応答コードとテキストは、API のベータ版開発中に変更される可能性がありますが、範囲は変更されません。

セキュリティ

サービス API は、アプリケーション データを安全な方法で公開します。 API 機能の使用は認証されたユーザーに限定され、セキュリティで保護されたトランスポート プロトコルを介して公開されます。 API へのアクセスは、次のコンテキスト内で行われる必要があります。

認証

認証の詳細については、「 Yield Analytics API - 認証プロセス」を参照してください。

機密性

機密性は、Secure Socket Layer ベースの通信を使用して Yield Analytics API と対話することで維持されます。 API 開発者は、可能な限り、安全でない通信が HTTP よりも HTTPS を使用することを優先する必要があります。 Web ブラウザー コンテキストの外部で開発する場合に HTTP over SSL を有効にする方法については、HTTP クライアント ライブラリを参照してください。

ホスト

https://api.appnexus.com/imf/

Paths

保存した分析を実行する

GET /api/v1/rest/queryengine/analysis/{savedAnalysisId}
  • 説明

    レポート ID を使用して保存された分析を検索します。

  • Parameters

    種類 名前 説明 必須 Schema
    PathParameter savedAnalysisId 保存された分析の識別子 true string
  • cURL 要求の例

    $ curl --request GET \
      --url https://api.appnexus.com/imf/api/v1/rest/queryengine/analysis/100 \
      --header 'Authorization: {{auth-token}}' \
      --header 'content-type: application/json'
    
  • HTTP 要求の例

    GET /imf/api/v1/rest/queryengine/analysis/100 HTTP/1.1
    Content-Type: application/json
    Authorization: {{auth-token}}
    Host: api.appnexus.com
    
  • HTTP 応答の例

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    {
      "row": [
        {
          "columnData": [
            {
              "name": "sample name",
              "value": "sample value"
            }
          ]
        }
      ]
    }
    

カスタムの日付範囲で保存済み分析を実行する

GET api/v1/rest/queryengine/analysis/{savedAnalysisId}?start_date= {startDate}&end_date={endDate} 
  • 説明

ユーザー設定の日付範囲を使用して、保存した分析を参照します。 指定された開始日と終了日は、レポートに保存されている日付構成を上書きします。

  • Parameters

    種類 名前 説明 必須 Schema
    PathParameter savedAnalysisId 保存された分析の識別子 true string
    PathParameter startDate 要求されたデータ範囲 (YYYY-MM-DD) の開始日 true string
    PathParameter endDate 要求されたデータ範囲 (YYYY-MM-DD) の終了日 true string
  • cURL 要求の例

    $ curl --request GET \
      --url 'https://api.appnexus.com/imf/api/v1/rest/queryengine/analysis/100?start_date=2026-01-01&end_date=2026-01-31' \
      --header 'Authorization: {{auth-token}}' \
      --header 'content-type: application/json'
    
  • HTTP 要求の例

    GET /imf/api/v1/rest/queryengine/analysis/100?start_date=2026-01-01&end_date=2026-01-31 HTTP/1.1
    Content-Type: application/json
    Authorization: {{auth-token}}
    Host: api.appnexus.com
    
  • HTTP 応答の例

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    {
      "row": [
        {
          "columnData": [
            {
              "name": "sample name",
              "value": "sample value"
            }
          ]
        }
      ]
    }
    

サポートされていない機能

次のクエリ エンジン機能はサポートされていません。

  • 動的分析の実行
  • バッチ クエリの実行
  • SQL ステートメントの直接実行
  • 任意のクエリの送信

注:

Query Engine サービスは、保存された分析の実行のみに制限されます。

製品リスティング機能は、GraphQL API を介して使用できます。 GraphQL を使用して製品リストを取得し、構造化されたクエリとフィルターを使用して製品レベルのメタデータにアクセスします。 サポートされているクエリとスキーマの詳細については、GraphQL API ドキュメントを参照してください。