Pinterest User Pins
Pinterestユーザーのピンは、プロフィールに紐付く公開のビジュアル投稿で、タイトル、説明文、投稿者情報、メディアの参照、カテゴリ、ハッシュタグ、タイムスタンプ、表示中のエンゲージメントで構成されます。これらのコンテンツと観測情報は、プロフィール単位のアーカイブ、ビジュアルトピックのリサーチ、出典の記録、取得時点ごとの比較に活用できます。
Pinterest User Pins API の主な機能
- プロフィールからのピン取得1つ以上の公開PinterestプロフィールURLを受け付け、プロフィールのメタデータではなく、送信した各プロフィールに紐付くピンのレコードを返します。
- プロフィールごとの取得件数results_limit はプロフィールURLごとに個別に適用されます。デフォルトは100で、1〜2,000の範囲で指定できます。
- ピン・投稿者・メディアの正規化レコードピンの識別子、URL、タイトル、本文、公開されている投稿者フィールド、画像または動画の参照を、一貫した形式の結果として返します。
- エンゲージメントとソースの情報取得可能な場合、表示中のいいね数・コメント数・投稿者のフォロワー数を、公開日時、collected_at、分類フィールド、discovery_input とともに保持します。
Pinterest User Pins API のパラメータ
| パラメータ | 必須 | 説明 |
|---|---|---|
urls | 必須 | 必須。予約語ではないパスセグメントをちょうど1つ含む、HTTPまたはHTTPSの公開PinterestプロフィールURLのリストです。ピン、検索、アイデア、pin.itのURLは受け付けません。 |
results_limit | 任意 | プロフィールURLごとに取得するピンの最大件数です。デフォルトは100で、1〜2,000の整数を指定できます。 |
Pinterest User Pins API の使い方
公開PinterestプロフィールURLをプロフィールごとの取得件数上限とともに送信し、非同期タスクを追跡して、正規化されたピンをカーソルページネーションで読み取ります。
- プロフィールのパスセグメントが1つだけの公開PinterestプロフィールURLを1つ以上用意します。
- urls と任意の results_limit を /v1/pinterest/user-pins に POST し、返された task_id を保存します。
- タスクが成功するか失敗が返るまで /v1/tasks/{task_id} をポーリングします。
- data.results.items を読み取り、has_more が true の間は返された next_cursor で続きを取得します。
curl -X POST "https://api.socq.ai/v1/pinterest/user-pins" \
-H "Authorization: Bearer $SOCQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"urls":["https://www.pinterest.com/example/"],"results_limit":100}'
# Poll GET /v1/tasks/{task_id}
# Read data.results.items and follow next_cursor while has_more is truePinterest User Pins API の主なユースケース
- 公開プロフィールのピンのアーカイブ: 指定したプロフィールURLについて、ピンID、元URL、タイトル、本文、投稿者フィールド、メディアの参照、タイムスタンプ、discovery_input を保存します。
- ビジュアルと分類のリサーチ: メディアの種類、post_type、categories、hashtags、タイトル、本文を使い、選定した公開プロフィールで繰り返し使われる形式やテーマを分析します。
- プロフィール間の指標比較: プロフィールごとのコレクション間で、表示中のいいね数・コメント数を投稿者のフォロワー数とあわせて比較し、collected_at で各観測の時点を特定します。
Pinterest User Pins API 活用のヒント
- プロフィールのパスセグメントをちょうど1つ含む公開PinterestプロフィールURLを送信してください。ピンのリンク、pin.it短縮リンク、検索ページ、より深い階層のパスはプロフィールの検証を通過しません。
- 上限はプロフィールごとに個別に適用されるため、取得件数とリクエスト前のクレジット見積もりは urls の数に results_limit を掛けて計算してください。
- すべてのピンに discovery_input と collected_at を保存し、後続のデータセットでも送信したプロフィールと観測時刻を保持できるようにしてください。
- media、created_at、categories、hashtags、source、投稿者情報、個々の指標は任意フィールドとして扱ってください。また、分類が返されない場合に、ピンが作成されたものか保存されたものかを推測しないでください。
関連API
Pinterest User Pins API 以外に別の種類の公開Pinterestデータが必要な場合は、これらのAPIをご利用ください。
- Pinterest Pins API — 公開ピンのURLから、正規化されたコンテンツ、クリエイター、メディア、分類、タイムスタンプ、表示中の指標を取得します。
- Pinterest Profiles API — プロフィールURLから、公開プロフィールのアカウント情報、プロフィール文、画像、Webサイト、表示中のアカウントのカウント、取得情報を取得します。
- Pinterest Search API — テキストクエリで公開ピンを検索します。取得件数の上限を指定でき、正規化されたコンテンツ、クリエイター、メディア、分類、タイムスタンプ、表示中の指標を返します。
- Pinterest User Boards API — プロフィールURLからPinterestのボードを一覧にし、名前、説明、カバー画像、作成日と、ピン・フォロワー・セクション・コラボレーターの数を返します。
- Pinterest Board Pins API — ボードのURLから、Pinterestボードのピンを並び順どおりに、ピンのテキスト、保存したアカウント、フルサイズ画像、ピンのリンクとともに取得します。
- Pinterest Topic API — アイデアページのURLから、各トピックの月間検索数、更新日時、配下に提案される細かいトピックを読み取ります。