Pinterest API ドキュメント

Pinterest API: ピン — ピン ID によるコメント

オーディエンスの監視、モデレーション、コンテンツ分析のために、Pinterest の ピン に関する公開の会話を取得します。

会話のテキスト、投稿者、タイムスタンプ、継続的なページネーションが必要な場合に「ピン ID によるコメント」を使用します。

メソッド GET
エンティティ ピン
バージョン 2
このエンドポイントの機能

この API メソッドで構築できるもの

まず結果と一般的なワークフローを確認し、次にパラメーターと動作するリクエスト例に進んでください。

このエンドポイントが役立つこと

レスポンスには、会話の要素、投稿者の公開データ、エンゲージメントのシグナル、ページネーションのフィールドが含まれます。

使用に適した場面

会話のテキスト、投稿者、タイムスタンプ、継続的なページネーションが必要な場合に「ピン ID によるコメント」を使用します。

主なユースケース

会話の監視

コンテンツの下や選択したオブジェクトの周辺で、オーディエンスの反応を追跡します。

モデレーション

公開メッセージを確認、分類、品質管理のキューに送ります。

コメントの分析

会話のテキストとメタデータをレポートやオーディエンス調査に活用します。

利用できるバージョン

レスポンスのバージョン

どちらのバージョンも同じタスクを解決し、同じパラメーターを受け付けます。切り替えを使ってレスポンス構造を比較し、クライアントが想定するバージョンを選んでください。

レスポンスのバージョン V2

このページでバージョンを切り替えると、同じドキュメント URL でレスポンス構造を比較できます。

共通する点

認証、必須パラメーター、リクエストの形は V1 と V2 で同じです。実際には、エンドポイントのパスを組み立てるときとレスポンスを読み取るときにバージョンを選びます。

バージョン間で異なる点

主な違いはレスポンスのエンベロープです。新しい連携では V2 を使用し、既存のクライアント契約との互換性が必要な場合にのみ V1 を残してください。

使い方

メソッドの呼び出し方

どちらのバージョンでも、同じ API キーのヘッダーと同じクエリパラメーターを使用します。このドキュメントでは、まず共通のパラメーターを示し、次に各バージョンのパスとコードスニペットを示します。

入力パラメーター

共通パラメーター
パラメーター 必須 型 例 説明
pin_id はい str 99360735500167749 Pinterest pin identifier. Example: 99360735500167749.
aggregated_pin_id いいえ str | None 99360735500167749 Optional aggregated pin identifier used for Pinterest comments. Example: 99360735500167749.
cursor いいえ str | None cursor-next-page 前のレスポンスで返された次のページのカーソル。最初のページでは省略します。
is_reversed いいえ bool False Whether to reverse the Pinterest comments order. Example: false.

バージョン別のリクエストパス

V2

エンドポイントの正確なパス、URL の例、コードスニペットをコピーするときにバージョンを選んでください。上のパラメーター一覧は変わりません。

GET /api/v2/pinterest.com/pins/comments-by-pin-id

正規化された形式

コード例

curl --request GET \
  --url "https://www.scrapestorm.net/api/v2/pinterest.com/pins/comments-by-pin-id" \
  --header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
  --get --data-urlencode 'pin_id=99360735500167749' \
  # Optional parameters:
  # --data-urlencode 'aggregated_pin_id=99360735500167749'
  # --data-urlencode 'cursor=cursor-next-page'
  # --data-urlencode 'is_reversed=False'
レスポンス例

バージョン別のライブレスポンス

プレビューには主要なフィールドとコレクションの最初の要素が含まれているため、レスポンスの形をすばやく確認できます。バージョンを切り替えると JSON の形式が変わります。

レスポンス例

V2 レスポンスの JSON

検証済みの例

このコンパクトな JSON の例は、V2 の直近の成功した検証実行から取得したものです。

{
  "success": true,
  "status": "ok",
  "pagination": {
    "cursor": "QVFB...",
    "has_more": true
  },
  "search_context": {
    "pin_id": "99360735500167749",
    "is_reversed": false
  },
  "data": {
    "comments": {
      "count": 10,
      "items": [
        {
          "url": null,
          "comment_id": "4928161013185919842",
          "text": null,
          "emails": [],
          "created_at": "2017-10-13T14:37:17+00:00",
          "author": {
            "url": "https://www.pinterest.com/agauvin000/",
            "user_id": "431501345455978386",
            "username": "agauvin000",
            "display_name": "André Gauvin",
            "is_private": false,
            "avatar_url": "https://example.com/image.jpg"
          },
          "like_count": 8,
          "reply_count": 4,
          "helpful_count": 0,
          "is_edited": null,
          "thumbnail_url": "https://example.com/image.jpg",
          "images": [
            {
              "url": "https://i.pinimg.com/originals/e3/a5/7e/e3a57eb71f35406322f327b1e338ede2.jpg",
              "width": 640,
              "height": 480
            },
            {
              "url": "https://i.pinimg.com/150x150/e3/a5/7e/e3a57eb71f35406322f327b1e338ede2.jpg",
              "width": 150,
              "height": 150
            }
          ]
        },
        {
          "url": null,
          "comment_id": "5237823761574576454",
          "text": "me gusta todo esto gracias",
          "emails": [],
          "created_at": "2022-06-18T14:55:42+00:00",
          "author": {
            "url": "https://www.pinterest.com/cartagena2522/",
            "user_id": "1053349937753928775",
            "username": "cartagena2522",
            "display_name": "Maria Pineda",
            "is_private": false,
            "avatar_url": "https://example.com/image.jpg"
          },
          "like_count": 1,
          "reply_count": 0,
          "helpful_count": 0,
          "is_edited": false,
          "thumbnail_url": null,
          "images": []
        },
        {
          "_more_items": 8
        }
      ]
    }
  }
}
次のステップ

評価を続ける

このドキュメントを最初の判断材料とし、継続的な利用のためにエンドポイントを接続する前に、料金、プラットフォームのカバー範囲、連携ルールを確認してください。

Pinterest のプラットフォームページを開く

実装の前に、関連するエンティティ、API メソッドのグループ、関連ドキュメントを比較してください。

プラットフォームページを開く

API メソッドの料金を比較する

利用を拡大する前に、公開料金表でこのメソッドの位置付けを確認してください。

料金を見る

連携ルールを確認する

入門ドキュメントで、認証、バージョン、再試行、テストと本番の違いを確認してください。

ドキュメントを開く
よくある質問

チームが実装前に尋ねる質問

これらの回答を参考に、この API メソッドがワークフロー、バージョンの選択、導入計画に合うかどうかを判断してください。

この Pinterest API メソッドはどのようなデータを返しますか?

このメソッドは ピン に対して「ピン ID によるコメント」を実行します。以下のコンパクトなレスポンス例で、フィールドの正確な構造を確認できます。

V1 と V2 のどちらを選ぶべきですか?

新しい連携では、正規化された構造を提供する V2 を選んでください。V1 は、既にプラットフォーム固有の形式を処理しているクライアントとの互換性のためにのみ使用してください。

最初のリクエストには何が必要ですか?

API キーを作成し、リクエストヘッダーで送信し、表の必須パラメーターを指定してください。コード例には、正しいパスとリクエスト構造が既に含まれています。