共起語取得

共起語取得

共起語取得。 指定キーワードのGoogle検索上位ページから共起語(一緒に使われることが多い語)を抽出する。

SEO記事を上位表示させるために記事に含めるべき単語を把握できる。 SEO記事タイトル/見出し/記事本文を作成する前に使う。

検索上位表示できているページを対象に、本文・タイトル・見出しでの出現回数やサイト数などの指標付きで返す。

Googleは、そのキーワードで検索するユーザーの悩みを解決できる可能性の高い記事を上位表示する。 このため検索上位ページ中で共通して出現する単語は、上位表示のために記事に盛り込むべき単語である可能性が高い。

上位ページの見出し情報も欲しい場合はPOST /v1/headlineを併用する。

1リクエストあたり3クレジットを消費。

post/v1/co-occurrence

Request body

keywordstring required

共起語取得の元となる検索キーワード。1文字以上の文字列を指定する。

getDetailsboolean

URLごとの詳細情報を取得するかどうか。true にすると各共起語について検索上位ページごとの出現情報を返す。省略時は true。

sortBy'word' | 'occurrencePageCount' | 'occurrenceTitleCount' | 'occurrenceHeadingCount' | 'siteCountTotal' | 'siteCountHeading'

ソート項目。word / occurrencePageCount / occurrenceTitleCount / occurrenceHeadingCount / siteCountTotal / siteCountHeading。省略時は siteCountTotal。

orderBy'asc' | 'desc'

ソート順。asc: 昇順 / desc: 降順。省略時は desc。

limitinteger

取得件数の上限。正の整数を指定。省略時はすべての結果を返す。

Example request

{
  "keyword": "ラッコ",
  "limit": 10
}

Response

検索成功

resultboolean required

API 呼び出しの成否。正常時は true、エラー時は false。

errorsstring[] required

エラーメッセージの配列。正常時は空配列。

Example response

{
  "result": true,
  "meta": {
    "consumedCredit": 3
  },
  "data": {
    "query": {
      "keyword": "ラッコ"
    },
    "summary": {
      "totalCount": 150,
      "returnedCount": 100
    },
    "items": [
      {
        "word": "水族館",
        "metrics": {
          "occurrencePageCount": 230,
          "occurrenceTitleCount": 8,
          "occurrenceHeadingCount": 21,
          "siteCountTotal": 13,
          "siteCountHeading": 7
        },
        "pageDetails": [
          {
            "rank": 1,
            "title": "ラッコ",
            "url": "https://ja.wikipedia.org/wiki/%E3%83%A9%E3%83%83%E3%82%B3",
            "count": 3,
            "pageCount": 1
          }
        ]
      }
    ]
  },
  "errors": []
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.