次の方法で共有

クエリ エンジン サービス

  • [アーティクル]

概要

Yield Analytics API とサービスは、REST ベースのインターフェイスを介して公開されます。 Web 2.0、AJAX、REST、およびサービス指向の開発プラットフォームで経験した開発者がカスタム機能の開発を快適にすることを目的としています。 開発者は、Yield Analytics API とサービスを使用して開発を試みる前に、AJAX、XML、JSON、HTTP(S) プロトコルなどの Web ベースのアプリケーション パラダイムに精通している必要があります。

クエリ エンジン サービスを使用すると、API 開発者は非常に柔軟なエンジンにアクセスして、Yield Analytics システムからのデータに対してクエリを実行して、Product Discovery API と Inventory API で考慮されていないユース ケースを実現できます。 クエリ エンジン サービスの柔軟性とパワーにより、多くのユース ケースを実現できますが、有効なデータが抽出されるようにクエリ エンジン クエリの作成を試みるのは、深い知識を持つユーザーのみです。 データ目標を達成するために必要なクエリ式を開発するには、Yield Analytics カスタマー サービスの連絡先にお問い合わせください。

コンテンツ タイプ

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

  • JSON - using Content-type: application/json

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

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

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

セキュリティ

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

  • cURL認証の例

    認証は、各要求で http ヘッダーを介して資格情報を渡すことによって行われます。

    - username: curl -H "username:username"
- password: curl -H "password:password"
- source: curl -H "source:client_id"

  • HTTPS 認証の例

    GET /api/v1/rest/
HTTPS/1.1
Host: yieldanalytics.xandr.com
Accept: application/xml, application/json
Content-Type: application/json
username: {{username}}
password: {{password}}
source: {{client_id}}

  • POSTMAN 認証の例

    Postman のヘッダー設定の例を次に示します。

    注:

    • 'Authorization' が "No Auth" に設定されています。次の設定は、[ヘッダー] タブに配置します。
    • Postman の使用に関する詳細なチュートリアルについては、「 Yield Analytics API での Postman の使用」を参照してください。

    Postman の標準キーと値を含む [ヘッダー] タブのスクリーンショット。

機密性

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

Paths

保存された分析の実行

GET /api/v1/rest/queryengine/analysis/{savedAnalysisId}

  • 説明

    保存された分析を検索します。 これらのレポートは、Yield Analytics UI 内または Yield Analytics API を使用して構成し、レポート ID で参照できます。

  • パラメーター

    種類 名前 説明 必須 Schema
    PathParameter savedAnalysisId savedAnalysisId true string
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    application/json

  • 生成

    • application/xml
    • application/json

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysis/100' 
-i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 
'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

  • HTTP 要求の例

    GET /api/v1/rest/queryengine/analysis/100 HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

行数を使用して保存された分析を実行する

GET /api/v1/rest/queryengine/analysis/{savedAnalysisId}/{rowCount}

  • 説明

    行数を使用して保存された分析を検索します。 これらのレポートは、Yield Analytics UI 内または Yield Analytics API を使用して構成し、レポート ID で参照することができ、結果は目的の行数に制限できます。

  • パラメーター

    種類 名前 説明 必須 Schema
    PathParameter savedAnalysisId savedAnalysisId true string
    PathParameter rowCount rowCount true integer (int32)
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    application/json

  • 生成

    • application/xml
    • application/json

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysis/100/1' -i -H 'Content-Type: application/json' -H 
'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

  • HTTP 要求の例

    GET /api/v1/rest/queryengine/analysis/100/1 HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

行数と行の開始を使用して保存された分析を実行する

GET /api/v1/rest/queryengine/analysis/{savedAnalysisId}/{rowCount}/{startRow}

  • 説明

    行数と開始行を使用して保存された分析を検索します。 これらのレポートは、Yield Analytics UI 内または Yield Analytics API を使用して構成し、レポート ID で参照できます。 行数パラメーターと行開始パラメーターを使用すると、レポート行をページングできます。

  • パラメーター

    種類 名前 説明 必須 Schema
    PathParameter savedAnalysisId savedAnalysisId true string
    PathParameter rowCount rowCount true integer (int32)
    PathParameter startRow startRow true integer (int32)
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    application/json

  • 生成

    • application/xml
    • application/json

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysis/100/1/2' -i -H 'Content-Type: application/json' 
-H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

  • HTTP 要求の例

    GET /api/v1/rest/queryengine/analysis/100/1/2 HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

動的分析の実行

POST /api/v1/rest/queryengine/analysisdynamic

  • 説明

    動的分析を実行します。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter reportDefinition reportDefinition true Report
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    • application/json
    • application/xml

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic' -i 
-X POST -H 'Content-Type: application/json;charset=UTF-8' 
-d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/analysisdynamic HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

動的分析の実行

GET /api/v1/rest/queryengine/analysisdynamic/{reportDefinition}

  • 説明

    動的分析を実行します。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter reportDefinition reportDefinition true Report
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    application/json

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic' -i 
-X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/analysisdynamic HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

行数を使用して動的分析を実行する

GET /api/v1/rest/queryengine/analysisdynamic/{reportDefinition}/{rowCount}

  • 説明

    行数を使用して動的分析を実行します。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter reportDefinition reportDefinition true Report
    PathParameter rowCount rowCount true integer (int32)
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    application/json

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic/1' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/analysisdynamic/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

行数と行の開始を使用して動的分析を実行する

GET /api/v1/rest/queryengine/analysisdynamic/{reportDefinition}/{rowCount}/{startRow}

  • 説明

    行数と行の開始を使用して動的分析を実行します。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter reportDefinition reportDefinition true Report
    PathParameter rowCount rowCount true integer (int32)
    PathParameter startRow startRow true integer (int32)
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    application/json

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic/1/2' -i -X POST 
   -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/analysisdynamic/1/2 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

行数を使用して動的分析を実行する

POST /api/v1/rest/queryengine/analysisdynamic/{rowCount}

  • 説明

    行数を使用して動的分析を実行します。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter reportDefinition reportDefinition true Report
    PathParameter rowCount rowCount true integer (int32)
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    • application/json
    • application/xml

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic/1' -i -X POST 
-H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/analysisdynamic/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

行数と行の開始を使用して動的分析を実行する

POST /api/v1/rest/queryengine/analysisdynamic/{rowCount}/{startRow}

  • 説明

    行数と行の開始を使用して動的分析を実行します。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter reportDefinition reportDefinition true Report
    PathParameter rowCount rowCount true integer (int32)
    PathParameter startRow startRow true integer (int32)
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    • application/json
    • application/xml

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic/1/2' -i -X POST 
-H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/analysisdynamic/1/2 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

POST を使用してレポート定義で動的アナライザー レポートを取得する

POST /api/v1/rest/queryengine/analysisdynamicchart

  • 説明

    レポート定義によって定義されたレポートは、ターゲット アナライザーから動的に取得できます。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter reportDefinition reportDefinition true Report
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    • application/json
    • application/xml

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

GET を使用してレポート定義で動的アナライザー レポートを取得する

GET /api/v1/rest/queryengine/analysisdynamicchart/{reportDefinition}

  • 説明

    レポート定義によって定義されたレポートは、ターゲット アナライザーから動的に取得できます。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter reportDefinition reportDefinition true Report
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK CountResponse

  • 消費

    application/json

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamicchart/' -i -X POST 
-H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/analysisdynamicchart/ HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{
  "successfulStatements" : [ "sample successful statement" ],
  "failedStatements" : [ "sample failed statement" ]
}

バッチ クエリ POST

POST /api/v1/rest/queryengine/batch

  • 説明

    クエリ エンジン サービスのバッチ呼び出しでは、SQL ステートメントの任意のシーケンスを実行し、結果セットを返すことができます。 これらは、CRUD 操作や選択を実行するために使用できます。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter queryStringRequest queryStringRequest true QueryStringRequest
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK CountResponse

  • 消費

    • application/json
    • application/xml

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/batch' -i 
-X POST -H 'Content-Type: application/json;charset=UTF-8' -d 
'{
  "query" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2010-07-01','2010-07-31') 
   group by consumption_date order by consumption_date asc",
  "batchQueryParams" : [ {
    "first" : "INVENTORY_CLASS",
    "second" : [ "GUARANTEED" ]
  } ]
}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/batch HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 268

{
  "query" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2010-07-01','2010-07-31') 
   group by consumption_date order by consumption_date asc",
  "batchQueryParams" : [ {
    "first" : "INVENTORY_CLASS",
    "second" : [ "GUARANTEED" ]
  } ]
}

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 326

{
  "queryString" : "SELECT * FROM TABLE",
  "batchQueryResults" : [ {
    "batchId" : "1",
    "batchParams" : "sample batch param",
    "resultData" : {
      "row" : [ {
        "columnData" : [ {
          "name" : "sample name",
          "value" : "sample value"
        } ]
      } ]
    },
    "resultCode" : 1
  } ]
}

バッチ クエリ GET

GET /api/v1/rest/queryengine/batch/{queries}/{query}

  • 説明

    クエリ エンジン サービスのバッチ呼び出しでは、SQL ステートメントの任意のシーケンスを実行し、結果セットを返すことができます。 これらは、CRUD 操作や選択を実行するために使用できます。

  • パラメーター

    種類 名前 説明 必須 Schema
    PathParameter クエリ クエリ true string
    BodyParameter queryVars queryVars false object
    PathParameter query query true string
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK BatchQueryResponse

  • 消費

    application/json

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/batch/select%20consumption_date,
%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01','2010-07-31')
%20group%20by%20consumption_date%20order%20by%20consumption_date%20ascconsumptionFilter;
INVENTORY_CLASS=GUARANTEED;CONSUMPTION_TYPE=DIRECT;CONSUMPTION_TYPE=CONTAINED;PRIORITY%3E=5/select%20consumption_date,
%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01','2010-07-31')%20group%20by%20
consumption_date%20order%20by%20consumption_date%20asc' -i -H 'Content-Type: application/json;charset=UTF-8' 
-d '"{\"relativeDate\":\"2020-03-19\", \"title\":\"test\"}"'

  • HTTP 要求の例

    GET /api/v1/rest/queryengine/batch/select%20consumption_date,%20sum(consumed)%20from%20OLPCS(network_products(),
'2010-07-01','2010-07-31')%20group%20by%20consumption_date%20order%20by%20consumption_date%20ascconsumptionFilter;
INVENTORY_CLASS=GUARANTEED;CONSUMPTION_TYPE=DIRECT;CONSUMPTION_TYPE=CONTAINED;PRIORITY%3E=5/select%20consumption_date,
%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01','2010-07-31')%20group%20by%20consumption_date%
20order%20by%20consumption_date%20asc HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 55

"{\"relativeDate\":\"2020-03-19\", \"title\":\"test\"}"

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 326

{
  "queryString" : "SELECT * FROM TABLE",
  "batchQueryResults" : [ {
    "batchId" : "1",
    "batchParams" : "sample batch param",
    "resultData" : {
      "row" : [ {
        "columnData" : [ {
          "name" : "sample name",
          "value" : "sample value"
        } ]
      } ]
    },
    "resultCode" : 1
  } ]
}

GET を使用してステートメントを実行する

GET /api/v1/rest/queryengine/execute/{statement}

  • 説明

    API を介して渡された SQL ステートメントを実行します。

  • パラメーター

    種類 名前 説明 必須 Schema
    PathParameter ステートメント ステートメント true string
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK CountResponse

  • 消費

    application/json

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/execute/select%20*%20from%20list_aliases()%20where%
20data_source_type%20=%20'ORDER_LINE'' -i -H 'Content-Type: application/json' -H 'Accept: application/json' 
-H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

  • HTTP 要求の例

    GET /api/v1/rest/queryengine/execute/select%20*%20from%20list_aliases()%20where%20data_source_type%20=%20'ORDER_LINE' 
HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{
  "successfulStatements" : [ "sample successful statement" ],
  "failedStatements" : [ "sample failed statement" ]
}

POST を使用してステートメントを実行する

POST /api/v1/rest/queryengine/execute/{statement}

  • 説明

    API を介して渡された SQL ステートメントを実行します。

  • パラメーター

    種類 名前 説明 必須 Schema
    PathParameter ステートメント ステートメント true string
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK CountResponse

  • 消費

    • application/json
    • application/xml

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/execute/select%20*%20from%20list_aliases()%20
where%20data_source_type%20=%20'ORDER_LINE'' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' 
-H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/execute/select%20*%20from%20list_aliases()%20where%20data_source_type%20=%20'ORDER_LINE' 
HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{
  "successfulStatements" : [ "sample successful statement" ],
  "failedStatements" : [ "sample failed statement" ]
}

要求オブジェクトで SQL クエリ ステートメントを実行する

POST /api/v1/rest/queryengine/executerequest

  • 説明

    Query Request オブジェクトを渡して SQL ステートメントを実行します。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter statementHolder statementHolder true QueryRequest
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK CountResponse

  • 消費

    • application/json
    • application/xml

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/executerequest' -i 
-X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "queryRequest" : {
    "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
  }
}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/executerequest HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 194

{
  "queryRequest" : {
    "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
  }
}

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{
  "successfulStatements" : [ "sample successful statement" ],
  "failedStatements" : [ "sample failed statement" ]
}

body ステートメントによるクエリ

POST /api/v1/rest/queryengine/query

  • 説明

    投稿の本文の一部として SQL like ステートメントを渡します。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter query query true string
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    • application/json
    • application/xml

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/query' -i -X POST 
-H 'Content-Type: application/json;charset=UTF-8' -d '{
  "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/query HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 167

{
  "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
}

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

GET を使用してステートメントでクエリを実行する

GET /api/v1/rest/queryengine/query/{query}

  • 説明

    パス パラメーターとして SQL クエリを渡します。 複数のステートメントを実行するには、ステートメントをセミコロンで区切る必要があります。 データにセミコロンが含まれている場合は、この呼び出しの POST バージョンを利用します。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter query query true string
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    • application/json
    • application/xml

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/query/select%20consumption_date,%20sum(consumed)%20
from%20OLPCS(network_products(),'2010-07-01','2010-07-31')%20group%20by%20consumption_date%20order%20by%20consumption_date%20asc' 
-i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'username: {{username}}' 
-H 'password: {{password}}' -H 'source: {{source}}'

  • HTTP 要求の例

    GET /api/v1/rest/queryengine/query/select%20consumption_date,%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01',
'2010-07-31')%20group%20by%20consumption_date%20order%20by%20consumption_date%20asc HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

POST を使用したステートメントによるクエリ

POST /api/v1/rest/queryengine/query/{query}

  • 説明

    パス パラメーターとして SQL クエリを渡します。 複数のステートメントを実行するには、ステートメントをセミコロンで区切る必要があります。 データにセミコロンが含まれている場合は、この呼び出しの POST バージョンを利用します。

  • パラメーター

    種類 名前 説明 必須 Schema
    PathParameter query query true string
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    • application/json
    • application/xml

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/query/select%20consumption_date,
%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01','2010-07-31')%20group%20by%20consumption_date%20order%20by
%20consumption_date%20asc' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' 
-H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/query/select%20consumption_date,%20sum(consumed)%20from%20OLPCS(network_products(),
'2010-07-01','2010-07-31')%20group%20by%20consumption_date%20order%20by%20consumption_date%20asc HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

クエリ要求によるクエリ

POST /api/v1/rest/queryengine/queryrequest/{decode}

  • 説明

    Query Request オブジェクトを渡してエンジンにクエリを実行します。

  • パラメーター

    種類 名前 説明 必須 Schema 既定値
    BodyParameter query query true QueryRequest
    QueryParameter デコード デコード false ブール値 true
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    • application/json
    • application/xml

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/queryrequest/true' -i -X POST -H 
'Content-Type: application/json;charset=UTF-8' -d '{
  "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/queryrequest/true HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 167

{
  "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') group by 
consumption_date order by consumption_date asc"
}

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

GET を使用したクエリ セット

GET /api/v1/rest/queryengine/queryset

  • 説明

    Query Engine Service クエリセットの呼び出しでは、SQL ステートメントの任意のシーケンスを実行し、結果セットを返すことができます。 これらは、CRUD 操作や選択を実行するために使用できます。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter querySet querySet true QuerySet
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    application/json

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/queryset' -i -H 'Content-Type: application/json;
charset=UTF-8' -d '{
  "querySet" : {
    "title" : "test",
    "relativeDate" : "2020-03-19",
    "requests" : [ {
      "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
    } ]
  }
}'

  • HTTP 要求の例

    GET /api/v1/rest/queryengine/queryset HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 278

{
  "querySet" : {
    "title" : "test",
    "relativeDate" : "2020-03-19",
    "requests" : [ {
      "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
    } ]
  }
}

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

POST を使用したクエリ セット

POST /api/v1/rest/queryengine/queryset

  • 説明

    Query Engine Service クエリセットの呼び出しでは、SQL ステートメントの任意のシーケンスを実行し、結果セットを返すことができます。 これらは、CRUD 操作や選択を実行するために使用できます。

  • パラメーター

    種類 名前 説明 必須 Schema
    BodyParameter querySet querySet true QuerySet
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryResultData

  • 消費

    • application/json
    • application/xml

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

  • cURL要求の例

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/queryset' -i -X POST -H 
'Content-Type: application/json;charset=UTF-8' -d '{
  "querySet" : {
    "title" : "test",
    "relativeDate" : "2020-03-19",
    "requests" : [ {
      "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
    } ]
  }
}'

  • HTTP 要求の例

    POST /api/v1/rest/queryengine/queryset HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 278

{
  "querySet" : {
    "title" : "test",
    "relativeDate" : "2020-03-19",
    "requests" : [ {
      "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
    } ]
  }
}

  • HTTP 応答の例

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

ターゲット アナライザーで定義および保存されたレポートは、REST ベースのサービスとして実行できます

GET /api/v1/rest/queryengine/xml/{query}

  • 説明

    保存したアナライザー レポートを ID で取得します。

  • パラメーター

    種類 名前 説明 必須 Schema
    PathParameter query 実行する必要があるクエリ true string
    HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string
    HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string
    HeaderParameter source Yield Analytics API にアクセスするためのクライアント ソース true string

  • 応答

    HTTP コード 説明 Schema
    200 OK QueryEngineXML

  • 消費

    application/json

  • 生成

    • application/json
    • application/xml

  • Tags

    クエリ エンジン リソース

関数

クエリ エンジンでは、大量の組み込み汎用データベース関数がサポートされています。 Yield Analytics 関数も用意されており、インベントリ モデルの操作を容易にします。

関数 説明 例
ACTIVE_RATE_CARD_PRODUCTS は、システム内のすべてのアクティブレートカード製品 ID (PID) を返します テストの例
ACTIVE_REPORTING_PRODUCTS は、システム内のすべてのアクティブなレポート製品 ID (PID) を返します。 テストの例
ALL_RATE_CARD_PRODUCTS は、システム内カード製品 ID (PID) のすべてのレートを返します テストの例
ALL_RATE_CARD_PRODUCTS は、システム内のすべてのレポート製品 ID (PID) を返します テストの例
PRODUCT_GROUP groupNames
は、指定された名前を持つターゲット グループ内のすべての製品 ID を返します		 テストの例
PRODUCTS_BY_CHARACTERISTICS 特性 - 例: size=120x90、size=460x80、sex=male、行動!=political
指定された特性に一致するすべての製品 ID を返します		 テストの例
PRODUCTS_BY_MATCHPRASE matchphrases テストの例
PRODUCTS_BY_NAME names テストの例

エイリアス

ALIAS_KEY DATASOURCE_TYPE
アクション <>ACTION_NAME_TOTAL_ACTIONS_POST_IMPRESSIONS
アクション <>ACTION_NAME_TOTAL_ACTIONS
アクション <>ACTION_NAME_ECPA
広告 主 ORDER_LINE
代理店 ORDER_LINE
可用性 製品
AVERAGE_FREQUENCY_DAILY 製品
AVERAGE_FREQUENCY_WEEKLY 製品
AVERAGE_UNIQUES_DAILY 製品
AVERAGE_UNIQUES_WEEKLY 製品
BOOKED_CPM ORDER_LINE
BOOKED_IMPRESSIONS ORDER_LINE
BOOKED_VALUE ORDER_LINE
BOOKING_TYPE OLP_IMPRESSIONS
CAMPAIGN_NAME ORDER_LINE
CLOSE_DATE ORDER_LINE
CONSUMED_IMPRESSIONS OLP_IMPRESSIONS
CONSUMED_IMPRESSIONS_LIFETIME OLP_IMPRESSIONS
CONSUMED_VALUE ORDER_LINE
CONSUMPTION_DATE OLP_IMPRESSIONS
CONSUMPTION_TYPE OLP_IMPRESSIONS
CONTRACT_TYPE ORDER_LINE
CONTRACTED_CPD ORDER_LINE
CONTRACTED_CPD_OLTP Oltp
CONTRACTED_CPM ORDER_LINE
CONTRACTED_IMPRESSIONS ORDER_LINE
CONTRACTED_IMPRESSIONS_CPM_ONLY ORDER_LINE
CONTRACTED_IMPRESSIONS_CPM_ONLY_OLTP Oltp
CONTRACTED_IMPRESSIONS_GOAL_BASED_ONLY ORDER_LINE
CONTRACTED_IMPRESSIONS_LIFETIME ORDER_LINE
CONTRACTED_IMPRESSIONS_OLTP Oltp
CONTRACTED_IMPRESSIONS_TOTAL ORDER_LINE
CONTRACTED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE ORDER_LINE
CONTRACTED_RATE ORDER_LINE
CONTRACTED_REVENUE ORDER_LINE
CONTRACTED_REVENUE_CPD_ONLY ORDER_LINE
CONTRACTED_REVENUE_CPD_ONLY_FULL ORDER_LINE
CONTRACTED_REVENUE_CPD_ONLY_OLTP Oltp
CONTRACTED_REVENUE_CPM_ONLY ORDER_LINE
CONTRACTED_REVENUE_CPM_ONLY_FULL ORDER_LINE
CONTRACTED_REVENUE_CPM_ONLY_OLTP Oltp
CONTRACTED_REVENUE_FULL ORDER_LINE
CONTRACTED_REVENUE_LIFETIME ORDER_LINE
CONTRACTED_REVENUE_OLTP Oltp
CONTRACTED_REVENUE_SALES_DISCOUNT_CALCULABLE ORDER_LINE
CONTRACTED_REVENUE_SALES_DISCOUNT_CALCULABLE_FULL ORDER_LINE
CONTRACTED_REVENUE_SALES_DISCOUNT_CALCULABLE_OLTP Oltp
CONTRACTED_REVENUE_UNDERDELIVERY_CALCULABLE ORDER_LINE
CONTRACTED_REVENUE_UNDERDELIVERY_CALCULABLE_OLTP Oltp
CONTRACTED_REVENUE_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME Oltp
CURRENT_PRODUCT_ID ORDER_LINE
DATA_ELEMENTS_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME Oltp
DAYS_IN_CPD_ONLY ORDER_LINE
DAYS_IN_CPD_ONLY_OLTP Oltp
DAYS_TO_DELIVERY OLP_IMPRESSIONS
DAYS_TO_DELIVERY_CUM OLP_IMPRESSIONS
DELIVERABLE_GUARANTEED_IMPRESSIONS ORDER_LINE
DELIVERABLE_IMPRESSIONS ORDER_LINE
DELIVERABLE_IMPRESSIONS_LIFETIME ORDER_LINE
DELIVERABLE_IMPRESSIONS_UNDERDELIVERY_CALCULABLE OLP_IMPRESSIONS
DELIVERABLE_IMPRESSIONS_UNDERDELIVERY_CALCULABLE_OLTP Oltp
DELIVERABLE_IMPRESSIONS_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME Oltp
DELIVERED_CLICKS OLP_CLICKS
DELIVERED_CLICKS_LIFETIME OLP_CLICKS
DIRECT_AVERAGE_FREQUENCY_DAILY ORDER_LINE
DIRECT_AVERAGE_FREQUENCY_WEEKLY ORDER_LINE
DIRECT_AVERAGE_UNIQUES_DAILY ORDER_LINE
DIRECT_AVERAGE_UNIQUES_WEEKLY ORDER_LINE
DIRECT_LIFETIME_UNIQUES ORDER_LINE
EARNED_IMPRESSIONS ORDER_LINE
EARNED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE ORDER_LINE
EARNED_REVENUE ORDER_LINE
EARNED_REVENUE_LIFETIME ORDER_LINE
EARNED_REVENUE_UNDERDELIVERY_CALCULABLE ORDER_LINE
EARNED_REVENUE_UNDERDELIVERY_CALCULABLE_OLTP Oltp
EARNED_REVENUE_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME Oltp
END_DATE ORDER_LINE
ESTABLISHED_ASP 製品
EXTERNAL_ID ORDER_LINE
FLOOR 製品
FOCUSED_CONSUMED_VALUE OLP_IMPRESSIONS
FOCUSED_EARNED_IMPRESSIONS OLP_IMPRESSIONS
FOCUSED_EARNED_REVENUE OLPEVENT
HARD_CUTOFF ORDER_LINE
IMPRESSION_CAP_PER_DAY ORDER_LINE
IMPRESSION_CAPACITY 製品
IN_NETWORK ORDER_LINE
業界 ORDER_LINE
INVENTORY_CLASS ORDER_LINE
MASTER_ID ORDER_LINE
MC_TYPE ORDER_LINE
NETWORK_STATUS 製品
順序 ORDER_LINE
ORDER_EXTERNAL_ID ORDER_LINE
ORDER_LINE ORDER_LINE
ORDER_LINE_DELIVERY_SCOPE_TARGET ORDER_LINE
ORDER_LINE_ID ORDER_LINE
ORDER_LINE_SITE_NAME ORDER_LINE
ORDER_LINE_SIZE ORDER_LINE
ORDER_LINE_STATUS ORDER_LINE
ORDER_LINE_TARGET ORDER_LINE
ORDER_LINE_TARGET_ATTRIBUTE ORDER_LINE
ORDER_LINE_TARGET_EXPRESSION ORDER_LINE
ORDER_LINE_TARGET_EXTERNAL_ID ORDER_LINE
ORDER_LINE_TARGET_ID ORDER_LINE
ORDER_NAME ORDER_LINE
ORDER_STATE ORDER_LINE
PACKAGE_ID ORDER_LINE
PARENT_TARGET 製品
PRICING_TYPE ORDER_LINE
優先 順位 ORDER_LINE
製品 製品
製品 RATE_CARD
製品 REPORTING_TYPE
製品 REVENUE_CAPACITY
製品 SELL_STATUS
製品 ステータス
製品 TARGET_ATTRIBUTE
製品 TARGET_CREATION_DATE
製品 TARGET_GROUP
製品 TARGET_ID
製品 TARGET_OVERLAP
製品 TARGET_TYPE
製品 UNMET_DEMAND
製品 WEIGHTED_RATE_CARD
製品 <>ACTION_NAME_TOTAL_ACTIONS_POST_CLICKS
PRODUCT_EXPRESSION製品 PRODUCT_EXTERNAL_ID
RANGE_END ORDER_LINE
RANGE_START ORDER_LINE
RATE_CARD_REVENUE ORDER_LINE
RATE_CARD_REVENUE_CPM_ONLY ORDER_LINE
RATE_CARD_REVENUE_CPM_ONLY_OLTP Oltp
RATE_CARD_REVENUE_SALES_DISCOUNT_CALCULABLE ORDER_LINE
RATE_CARD_REVENUE_SALES_DISCOUNT_CALCULABLE_FULL Oltp
RATE_CARD_REVENUE_SALES_DISCOUNT_CALCULABLE_OLTP Oltp
SALES_PERSON ORDER_LINE
SALES_TEAM_MEMBER ORDER_LINE
SCHEDULED_IMPRESSIONS ORDER_LINE
SCHEDULED_IMPRESSIONS_LIFETIME ORDER_LINE
SCHEDULED_IMPRESSIONS_OLTP Oltp
SCHEDULED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE OLP_IMPRESSIONS
SCHEDULED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE_OLTP Oltp
SCHEDULED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME Oltp
SOLD_AS_PRODUCT ORDER_LINE
SOLD_AS_PRODUCT_ID ORDER_LINE
START_DATE ORDER_LINE
SYSTEM_OF_RECORD ORDER_LINE
TILE_IDS ORDER_LINE
TILE_NAMES ORDER_LINE

定義

AdditionalDimension

Analyzer Report の AdditionalDimension の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
groupingModifier 追加ディメンションのグループ化修飾子 true string
キー 追加ディメンションのキー true string

AdditionalMetric

AdditionalMetric of Analyzer Report の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
キー 追加ディメンションのキー true string

AnalyzerReport

AnalyzerReport の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
additionalDimensions 追加のディメンションのコレクション false MapOfstringAndAdditionalDimension 配列
additionalMetrics 追加メトリックのコレクション false MapOfstringAndAdditionalMetric 配列
dashboardDateRange アナライザー レポートのダッシュボード日付の怒り false DateRangeData
dashboardDimension アナライザー レポートのダッシュボード ディメンション false string
dashboardTableData アナライザー レポートのダッシュボード テーブル データ false TableState
dateRange アナライザー レポートの日付範囲 false DateRangeData
dateRangeFilters レポートの日付範囲フィルターのコレクション false MapOfstringAndReportDateRangeFilter 配列
dimensionFilters ディメンション フィルターのコレクション false MapOfstringAndFilter 配列
includeZeroValues アナライザー レポートの [値を含める] フィールド false string
keyValueFilters レポート キー値フィルターのコレクション false MapOfstringAndReportKeyValueFilter 配列
leftYAxis アナライザー レポートの左側の Y 軸 true string
metricFilters メトリック フィルターの一覧への名前のマップ true MapOfstringAndMetricFilterEntry 配列
numericRangeFilters フィールドには、数値範囲フィルターの一覧が含まれています false MapOfstringAndReportNumericRangeFilter 配列
Orderby アナライザー レポートのフィールド別の順序 false string
Pagesize アナライザー レポートのページ サイズ false integer (int32)
rightYAxis アナライザー レポートの右 Y 軸 false string
selectedTab アナライザー レポートの選択したタブ false string
sizeBy アナライザー レポートのフィールドごとのサイズ false string
Sortby アナライザー レポートの [並べ替え] フィールド false string
stackBy アナライザー レポートのフィールド別のスタック false string
stackbyIncrement アナライザー レポートの増分フィールドによるスタック false string
tabDateRanges テーブルの日付範囲への名前のマップ true MapOfstringAndDateRangeEntry 配列
tablePageSize アナライザー レポートのテーブル ページ サイズ false integer (int32)
tableState アナライザー レポートのテーブルの状態 false TableState
tabs フィールドにはタブの一覧が含まれています true MapOfstringAndTab 配列
trendPoints 傾向点のコレクション false MapOfstringAndTrendPoint 配列
view アナライザー レポートのビュー false string
widgetCacheWarm アナライザー レポートのウィジェット キャッシュウォーム フィールド false string
widgetFilter アナライザー レポートのウィジェット フィルター false WidgetFilter
widgetNumericType アナライザー レポートのウィジェット数値型 false enum (NEGATIVE_ONLY, POSITIVE_ONLY)
widgetView アナライザー レポートのウィジェット ビュー false string
xAxis アナライザー レポートの x 軸 true string
xAxisIncrement アナライザー レポートの x 軸の増分 false string

BatchQueryParams

バッチ クエリパラメーターを保持する JSON オブジェクト。

名前 説明 必須 Schema
まずは バッチ クエリ パラメーターの最初のフィールド true string
2 番目 2 番目のフィールドのコレクション true 文字列配列

BatchQueryResponse

バッチ クエリ応答の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
batchQueryResults バッチ クエリ結果のコレクション false BatchQueryResult 配列
Querystring バッチ クエリ応答のクエリ文字列 true string

BatchQueryResult

バッチ クエリ結果の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
batchId バッチ クエリ結果のバッチ ID true string
batchParams バッチ クエリ結果のバッチ パラメーター true string
resultCode バッチ クエリ結果の結果コード true integer (int32)
resultData バッチ クエリ結果のクエリ結果データ true QueryResultData

Column

名前 説明 必須 Schema
name ヘッダーの名前 false string
値 ヘッダーの値 false string

ColumnData

列データの結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
name 列データの名前 true string
値 列データの値オブジェクト true string

ColumnFilter

アナライザー レポートの ColumnFilter の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
フィールド 列フィルターのフィールド true string
ロジック 列フィルターのロジック true string
operator 演算子のコレクション true 文字列配列
値 値のコレクション true 文字列配列

ColumnSort

アナライザー レポートの ColumnSort の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
方向 列の並べ替えの方向 true string
フィールド 列の並べ替えのフィールド true string

CountResponse

カウント応答の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
failedStatements 失敗したステートメントの数 false 文字列配列
successfulStatements 正常なステートメントの数 false 文字列配列

DateRangeData

アナライザー レポートの DateRangeData の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
customCalendarId 日付範囲データのカスタム予定表 ID false string
customPeriod 日付範囲データの THe カスタム期間フィールド false ブール値
endDate 日付範囲データの終了日 false string
rangeLength 日付範囲データの範囲の長さ false integer (int32)
rangeUnits 日付範囲データの範囲単位 false string
startDate 日付範囲データの開始日 false string
trimToRemainderOfCustomPeriod 日付範囲データのユーザー設定期間フィールドの残りの部分へのトリミング false ブール値
type 日付範囲データの種類 true string

DateRangeEntry

DateRangeEntry を保持する JSON オブジェクト。

名前 説明 必須 Schema
dateRange DateRangeEntry の dateRange フィールド false DateRangeData
string DateRangeEntry の文字列フィールド true string

Filter

アナライザー レポートのフィルターの結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
name フィルターの名前 true string
operator フィルターの演算子 true string
値 フィルターの値 true string

アナライザー レポートのフィルターの結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
生成 ヘッダーの生成された文字列 false string
query ヘッダーのクエリ文字列 false string

MetricFilterEntry

MetricFilterEntry を保持する JSON オブジェクト。

名前 説明 必須 Schema
list フィルターのコレクション false object
string MetricFilterEntry の文字列フィールド true string

QueryEngineXML

クエリ結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
ヘッダー クエリ エンジン xml のヘッダー true Header
Resultset クエリ エンジン xml の結果セット true Resultset

QueryRequest

クエリ結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
queryRequest false QueryRequest
Sql クエリ エンジンへの SQL 入力 true string

QueryResultData

クエリ結果データの結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
row 行データのコレクション false RowData 配列

RowData

行データの結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
columnData 列データのコレクション true ColumnData 配列

QuerySet

クエリ結果データの結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
querySet false QuerySet
relativeDate クエリ セットの相対データ true string
要求 クエリ要求のコレクション false QueryRequest 配列
title クエリ セットのタイトル true string

QueryStringRequest

クエリ文字列要求を保持する JSON オブジェクト。

名前 説明 必須 Schema
batchQueryParams バッチ クエリ パラメーターのコレクション true BatchQueryParams 配列
query クエリ文字列要求のクエリ フィールド true string

レポート

クエリ文字列要求を保持する JSON オブジェクト。

名前 説明 必須 Schema
レポート false AnalyzerReport

ReportDateRangeFilter

アナライザー レポートの ReportDateRangeFilter の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
dataSetKey レポートの日付範囲フィルターのデータ セット キー true string
dateRange レポートの日付範囲フィルターの日付範囲データ true DateRangeData
キー レポートの日付範囲フィルターのキー true string

ReportKeyValueFilter

アナライザー レポートの ReportKeyValueFilter の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
dataSetKey レポート キー値フィルターのデータ セット キー true string
キー レポート キー値フィルターのキー true string
name レポート キー値フィルターの名前 true string
operator レポート キー値フィルターの演算子 true string
値 レポート キー値フィルターの値 true string
valueMatchTypeValue レポート キー値フィルターの値一致型の値 true string

ReportNumericRangeFilter

アナライザー レポートの ReportNumericRangeFilter の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
dataSetKey レポート数値範囲フィルターのデータ セット キー true string
highValue レポートの数値範囲フィルターの高い値 true number (double)
id レポート数値範囲フィルターの ID true integer (int32)
キー レポート数値範囲フィルターのキー true string
lowValue レポートの数値範囲フィルターの値が小さい true number (double)

Resultset

アナライザー レポートの ReportNumericRangeFilter の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
rows 行のコレクション false 行 配列

行

名前 説明 必須 Schema
columns 列のコレクション false 列 配列

Column

名前 説明 必須 Schema
name ヘッダーの名前 false string
値 ヘッダーの値 false string

RowData

行データの結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
columnData 列データのコレクション true ColumnData 配列

Tab

アナライザー レポートの Tab の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
displayName タブの表示名 true string
id タブの ID true string
name タブの名前 true string
選択 タブの選択したフィールド true ブール値

TableState

アナライザー レポートの TableState の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
ascending テーブル状態の昇順フィールド true ブール値
columnFilters 列フィルターのコレクション false ColumnFilter 配列
columnOrdering 列の順序付けのコレクション true object
columnSorts 列の並べ替えのコレクション false ColumnSort 配列
キー テーブル状態のキー false string
Sortby テーブル状態の並べ替えフィールド true string

TrendPoint

アナライザー レポートの TrendPoint の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
キー トレンドポイントのキー true string

WidgetFilter

WidgetFilter of Analyzer Report の結果を保持する JSON オブジェクト。

名前 説明 必須 Schema
defaultSelections ウィジェット フィルターの既定の選択 true string
reportParamType ウィジェット フィルターのレポート パラメーターの種類 true string
selectionLabels ウィジェット フィルターの選択ラベル true string
selectionValues ウィジェット フィルターの選択値 true string

Yield Analytics API