TikTokクリエイターが商品を宣伝した動画を、紐づく商品、エンゲージメント、帰属売上とともに返します。クォータ消費の大きいプレミアムなコマースエンドポイントです。
GET
/api/v1/tiktok/user/shop/video/ad/listクォータ消費: このエンドポイントへの成功したリクエスト 1 件あたり、プランのクォータが 10 単位消費されます。
リクエストパラメータ
必須パラメータ
| 名前 | 位置 | 型 | 説明 |
|---|---|---|---|
unique_id | query | string | unique_id example: popmart.usshop |
任意パラメータ
| 名前 | 位置 | 型 | 説明 |
|---|---|---|---|
sort_field | query | string | Sort field: revenue_amount, views_count, ads_deal_rate, ads_view_rate, ads_roas_rate |
sort_type | query | string | Sort order: asc = ascending, desc = descending |
page | query | integer | Page number |
レスポンスフィールド
| 名前 | 型 | 説明 |
|---|---|---|
success | boolean | Success |
code | integer | Code |
message | string | Message |
data | object | - |
data.items | array<object> | Items |
data.total | integer | Total |
data.page | integer | Page |
data.page_size | integer | Page Size |
data.total_pages | integer | Total Pages |
お試し実行
https://openapi.scdata.cc/api/v1/tiktok/user/shop/video/ad/list
ダッシュボードのAPIキーを選択
リクエストを送信する前にAPIキーを入力してください。ダッシュボードを開く
クエリパラメータ
unique_id*sort_fieldsort_typepagecURL の例
bash
curl -X GET "https://openapi.scdata.cc/api/v1/tiktok/user/shop/video/ad/list?unique_id=popmart.usshop" \-H "Authorization: YOUR_API_KEY"
レスポンス例 (200 application/json)
json
{"success": true,"code": 200,"message": "Request successful","data": {"items": [{"video_id": "7483378078563962142","video_description": "I love.❤️ #popmart #skullpanda #wintersymphony #blindbox #vinyl #plush ","video_url": "https://www.tiktok.com/@popmart.usshop/video/7483378078563962142","video_cover_url": "https://d3uucz7wx6jq40.cloudfront.net/tiktok.video/7483378078563962142/cover.png","video_publish_at": "2024-03-29","revenue_amount": "309.90","view_count": 47129,"like_count": 18310,"comment_count": 197,"share_count": 1198,"ads_deal_rate": "0","ads_view_rate": "0","ads_roas_rate": "0"}],"total": 47,"page": 1,"page_size": 10,"total_pages": 5}}
ユースケース
- クリエイティブのベンチマーク — 新しいブリーフを作る前に、クリエイターのどの商品動画が最も転換したかを分析します。
- カテゴリ経験の確認 — クリエイターが自社カテゴリの商品を販売した実績があるかを確認します。