分野別トレンドの照会

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

ショッピングインサイト APIは、NAVER DataLabのショッピングインサイトデータを照会する RESTful APIです。NAVER統合検索のショッピングエリアおよびNAVERショッピングで、特定のショッピング分野における検索クリック数の推移を、ショッピング分野別に確認することができます。

リクエスト

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

メソッド	URI
POST	/shopping/v1/categories

リクエストヘッダ

NAVER API HUBで共通して使用されるヘッダの詳細は、NAVER API HUBのリクエストヘッダをご参照ください。

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`startDate`	String	Required	照会期間の開始日 (`yyyy-mm-dd`) 2017年8月1日から照会可能
`endDate`	String	Required	照会期間の終了日 (`yyyy-mm-dd`)
`timeUnit`	String	Required	区間の単位 `date` \| `week` \| `month` `date`: 日間 `week`: 週間 `month`: 月間
`category`	Array	Required	分野名と分野コードペアの配列: category 最大3つのペアまで設定可能
`device`	String	Optional	検索機器 `pc` \| `mo` `pc`: PC `mo`: モバイル機器デフォルト: すべての機器
`gender`	String	Optional	検索ユーザーの性別 `m` \| `f` `m`: 男性 `f`: 女性デフォルト: 全性別
`ages`	Array	Optional	検索ユーザーの年齢 `10` \| `20` \| `30` \| `40` \| `50` \| `60` `10`: 10~19才 `20`: 20~29才 `30`: 30~39才 `40`: 40~49才 `50`: 50~59才 `60`: 60才以上デフォルト: 全年齢

フィールド	タイプ	必須の有無	説明
`name`	String	Required	ショッピング分野の名前
`param`	Array	Required	ショッピング分野のコード NAVERショッピングでカテゴリを選択した際、URLの`cat_id`パラメータの値で確認

リクエスト例

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

curl --location --request POST https://naverapihub.apigw.ntruss.com/shopping/v1/categories
--header X-NCP-APIGW-API-KEY-ID: {Client ID}
--header X-NCP-APIGW-API-KEY: {Client Secret}
--header Content-Type: application/json
--data '{
    "startDate": "2023-11-01",
    "endDate": "2023-11-07",
    "timeUnit": "date",
    "category": [
        { "name": "ファッション・アパレル", "param": ["50000000"] },
        { "name": "化粧品/美容", "param": ["50000002"] }
    ],
    "device": "pc",
    "gender": "f",
    "ages": ["20", "30"]
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`startDate`	String	-	照会期間の開始日 (`yyyy-mm-dd`)
`endDate`	String	-	照会期間の終了日 (`yyyy-mm-dd`)
`timeUnit`	String	-	区間単位
`results`	Array	-	照会結果リスト: results

results

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

フィールド	タイプ	必須の有無	説明
`title`	String	-	ショッピング分野の名前
`category`	Array	-	ショッピング分野のコード
`data`	Array	-	区間別クリック数の推移データ: data

data

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

フィールド	タイプ	必須の有無	説明
`period`	String	-	区間別開始日 (`yyyy-mm-dd`)
`ratio`	Number	-	区間ごとのクリック数の相対的な割合区間ごとの結果のうち、最も大きな値を100として設定した相対値

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

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

レスポンス例

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

{
    "startDate": "2023-11-01",
    "endDate": "2023-11-07",
    "timeUnit": "date",
    "results": [
        {
            "title": "ファッション・アパレル",
            "category": [
                "50000000"
            ],
            "data": [
                {
                    "period": "2023-11-01",
                    "ratio": 76.30839
                },
                {
                    "period": "2023-11-02",
                    "ratio": 70.00509
                },
                {
                    "period": "2023-11-03",
                    "ratio": 58.90771
                },
                {
                    "period": "2023-11-04",
                    "ratio": 26.00485
                }
            ]
        },
        {
            "title": "化粧品/美容",
            "category": [
                "50000002"
            ],
            "data": [
                {
                    "period": "2023-11-01",
                    "ratio": 36.68978
                },
                {
                    "period": "2023-11-02",
                    "ratio": 33.19327
                },
                {
                    "period": "2023-11-03",
                    "ratio": 28.63321
                },
                {
                    "period": "2023-11-04",
                    "ratio": 9.03361
                }
            ]
        }
    ]
}

Documentation Index