search

Prev Next

Classic/VPC環境で利用できます。

テーマグループに対する NAVER統合検索の期間別トレンドデータ統計を年齢、性別、検索環境別に分析して JSON形式で提供します。

参考

NAVER DataLabの検索キーワードのトレンドの検索結果と同じです。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /search

リクエストヘッダ

Search Trend APIで共通して使用されるヘッダの詳細は、Search Trendの共通ヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
startDate String Required データ照会の開始日(yyyy-MM-dd)
  • 2016年01月01日から照会可能
endDate String Required データ照会の終了日(yyyy-MM-dd)
timeUnit String Required データ照会区間の単位
  • date | week | month
    • date: 日間データ照会
    • week: 週間データ照会
    • month: 月間データ照会
keywordGroups Array<String> Required
device String Optional 検索デバイス環境フィルタ
  • pc | mo
    • pc: PC環境
    • mo: モバイル環境
ages Array<String> Optional 年齢フィルタ
  • 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11
    • 1: 0~12歳
    • 2: 13~18歳
    • 3: 19~24歳
    • 4: 25~29歳
    • 5: 30~34歳
    • 6: 35~39歳
    • 7: 40~44歳
    • 8: 45~49歳
    • 9: 50~54歳
    • 10: 55~59歳
    • 11: 60歳以上
gender String Optional 性別フィルタ
  • m | f
    • m: 男性
    • f: 女性

keywordGroups

keywordGroupsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
groupName String Required グループ名(テーマ)
  • データを照会する検索キーワードをまとめてグループ単位で統合
keywords String Required グループの検索キーワードリスト
  • データグループごとに最大20個の検索キーワード照会をサポート

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://naveropenapi.apigw.ntruss.com/datalab/v1/search' \
--header 'X-NCP-APIGW-API-KEY-ID: {アプリの登録時に発行された Client ID}' \
--header 'X-NCP-APIGW-API-KEY: {アプリの登録時に発行された Client Secret}' \
--header 'Content-Type: application/json' \
--data '{
    "startDate": "2024-08-15",
    "endDate": "2024-08-19",
    "timeUnit": "date",
    "keywordGroups": [
        {
            "groupName": "マーラータン",
            "keywords": [
                "マーラータン",
                "クォバロウ",
                "卵チャーハン"
            ]
        }
    ],    
    "device": "mo",
    "ages": [
        "4",
        "5"
    ],
    "gender": "f"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
startDate String - データ照会の開始日(yyyy-MM-dd)
  • 2016年01月01日から照会可能
endDate String - データ照会の終了日(yyyy-MM-dd)
timeUnit String - データ照会区間の単位
  • date | week | month
    • date: 日間データ照会
    • week: 週間データ照会
    • month: 月間データ照会
results Array - グループ情報

results

resultsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
title String - グループ名(テーマ)
keywords String - グループの検索キーワードリスト
data Array - 区間別情報

data

dataの説明は次の通りです。

フィールド タイプ 必須の有無 説明
period String - データ照会の区間別開始日(yyyy-MM-dd)
ratio Integer - データ照会区間別検索/クリック数の割合
  • 結果のうち最も大きい値を100に設定

レスポンスステータスコード

Search Trend APIで共通して使用されるレスポンスステータスコードの詳細は、Search Trendの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "startDate": "2024-08-15",
    "endDate": "2024-08-19",
    "timeUnit": "date",
    "results": [
        {
            "title": "マーラータン",
            "keywords": [
                "マーラータン",
                "クォバロウ",
                "卵チャーハン"
            ],
            "data": [
                {
                    "period": "2024-08-15",
                    "ratio": 100
                },
                {
                    "period": "2024-08-16",
                    "ratio": 84.81543
                },
                {
                    "period": "2024-08-17",
                    "ratio": 88.33892
                },
                {
                    "period": "2024-08-18",
                    "ratio": 97.31543
                }
            ]
        }
    ]
}