被リンク
被リンクリスト
このメソッドはウェブサイトの被リンクのリストを取得する事ができます。
リクエスト フォーマット
GET /backlinks/{site_id}?limit=100&offset=100 リクエスト パラメータ
| 名称 | 必須 | 説明 |
| limit | いいえ | リンクの合計数。リンク数最大 – 1000 |
| offset | いいえ | Oオフセット値 |
結果
成功すると、サーバーはウェブサイトの被リンクのリストを返します。
例
[
{
"anchor": "SE Ranking",
"category": "",
"charge_period": null,
"charge_start": null,
"date_added": "2018-06-11",
"date_lost": "2021-10-10",
"date_placement": "2018-10-11",
"domain": "highpoweredseo.com",
"duration": "",
"fb_likes": "2",
"from_domainid": "4630",
"from_url": "http://highpoweredseo.com/how-to-become-a-better",
"gin_index": "11",
"gin_index_check_date": "2018-10-05",
"http_status": "1",
"id": "53",
"is_blocked_meta": "1",
"is_blocked_robotstxt": "1",
"is_forced_status": "0",
"is_image": "1",
"is_link_not_found": "1",
"is_nofollow": "1",
"is_redir": "1",
"last_crawler_visit": "2018-10-05",
"link_manager": "",
"link_type": "",
"notes": "ghjg",
"price": null,
"source": null,
"src_domain_country": "USA",
"src_domain_ip": "184.168.221.40",
"src_domain_yandex_x": null,
"src_domain_yandex_x_date": null,
"to_url": "http://tourl.ru/",
"total_ext_links": "2",
"yin_index": "12",
"yin_index_check_date": "2018-10-05"
},
...
]レスポンス パラメータ
| 名称 | 説明 |
| anchor | 被リンク アンカー テキスト |
| id | リンク ID |
| category | ターゲット 被リンク カテゴリ |
| charge_period | チャージ 期間。 (1回, 月毎, 四半期毎, 半年毎, 年毎) |
| charge_start | チャージ 開始日 |
| date_added | 被リンクが追加された日付 |
| date_lost | 被リンクが消えた日付 |
| date_placement | 被リンクが設置された日付 |
| domain | あなたのサイトにリンクしているページのドメイン |
| duration | 提供者との同意に基づく被リンク設定期間 |
| fb_likes | 指定ページをFacebookでシェアした人の合計数 |
| from_domainid | 被リンク ドメイン ID |
| from_url | あなたのサイトにリンクしているページのURL |
| gin_index | 被リンク元のページがGoogleにインデックスされているかどうか |
| gin_index_check_date | チェック日 |
| http_status | 被リンクを含むページのHTTP ステータス |
| is_blocked_meta | メタタグによるページのブロック |
| is_blocked_robots.txt | robots.txtよるページのブロック |
| is_disavow | 否認されている被リンク |
| is_forced_status | ステータスが手動で変更された |
| is_image | L画像のリンク |
| is_link_not_found | ページ 被リンク が見つかりません |
| is_nofollow | リンクはインデックスされません |
| is_redir | 別のページへのリダイレクトページ |
| is_sponsored | sponsoredの被リンク |
| last_crawler_visit | 最後にクロールした日付 |
| link_manager | 担当者 |
| link_type | 被リンク アンカー テキストのタイプ |
| notes | ノート |
| num_links | 被リンクの数 |
| price | 被リンク 設置の費用 |
| source | ソース |
| src_domain_country | 国 |
| src_domain_inlink_rank | ドメインランク |
| src_domain_ip | 参照 IP |
| src_domain_region_id | Region id (地域id) |
| src_domain_yandex_x | Yandex X |
| src_domain_yandex_x_date | チェック 日 |
| title | ページタイトル |
| to_url | 参照先ページ |
| total_ext_links | 被リンクを含むページで検知された外部リンクの合計数 |
| ugc | UGC (ユーザー生成コンテンツ) |
| yin_index | Yandexにインデックスされている被リンクを含むページ |
| yin_index_check_date | チェック日 |
エラー
| HTTP コード | エラーメッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
被リンク追加
POST /backlinks/{site_id}
{
"url": "http://backlink.test/",
"price": 1,
"charge_period": "onetime",
"charge_start": "2018-01-01"
}リクエスト パラメータ
| 名称 | 必須 | 説明 |
| url | はい | 被リンク URL |
| price | いいえ | 被リンク 費用 |
| currency | いいえ | 通貨コード ISO 4217 (USD, CAD, AUD, etc.) |
| charge_period | いいえ | チャージ (1回, 月毎) |
| charge_start | いいえ | Pチャージ 開始日 |
結果
成功すると、サーバーは追加された被リンクの ID を返します。
例
{
"id": 1
}エラー
| HTTP コード | Eエラーメッセージ |
| 400 | 無効な URL |
| 400 | 被リンク数の上限を超えました |
| 400 | 被リンクは既に存在します |
| 403 | アクセスが拒否されました (wrong site_id) |
被リンクリストインポート
このメソッドはウェブサイトの被リンクのリストをインポートする事ができます。
リクエスト フォーマット
POST /backlinks/{site_id}/list
{
"group_id": 1,
"price": 100,
"currency": "USD",
"manager": "manager",
"charge_period": "onetime",
"charge_start": "2021-10-10",
"list": [
"https://google.com",
"https://yandex.ru"
]
}
リクエスト パラメータ
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
| list | Yes | 被リンクの配列 |
| price | No | 価格 |
| currency | No | 通貨コード ISO 4217 (USD, CAD, AUD, etc.) |
| charge_period | No | チャージ期間 (1回, 月毎, 四半期毎, 半年毎, 年毎) |
| charge_start | No | 支払い開始日 (Y-m-d) |
| group_id | No | 被リンク ID グループ |
| manager | No | 担当者 |
結果
成功すると、サーバーは追加された被リンク数、重複数、合計被リンク数を返します。
レスポンス例
{
"added": 2,
"duplicates": 0,
"total": 2
}リクエスト パラメータ
| 名称 | 説明 |
| added | 追加済み被リンク数 |
| duplicates | 重複被リンク数 |
| total | 被リンク数の合計 |
被リンクインポート実施の設定更新
このメソッドは、Google Search Consoleからの自動被リンクインポート設定を更新する事ができます。
リクエスト フォーマット
PUT /backlinks/{site_id}/settings
{
"gsc_autoimport": true,
} Request parameters
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
| gsc_autoimport | Yes | true or false – GSCからの自動インポートの有効化・無効化 |
結果
成功すると、サーバーは 204 HTTP コードを返します。
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
Google Search Consoleからの被リンクインポート実行
このメソッドはGoogle Search Consoleからの被リンクインポートを実行する事ができます。
リクエスト フォーマット
POST /backlinks/{site_id}/import-gscリクエスト パラメータ
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
結果
成功すると、サーバーはインポートタスクステータスと今後ステータスチェックに使用できるインポートタスクトークンを返します。
レスポンス例
{
"status": "queued",
"token": "1c84d0375d44725521647919c17f1cb9"
}リクエスト パラメータ
| 名称 | 説明 |
| status | インポートタスクステータス |
| token | インポートタスクトークン |
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
Google Search Consoleからの被リンクインポートステータスの取得
このメソッドは、Google Search Consoleからの被リンクインポートステータスを取得する事ができます。
リクエスト フォーマット
GET /backlinks/{site_id}/import-statusリクエスト パラメータ
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
| token | Yes | 被リンクインポートメソッドの実行で取得されるインポートタスクトークン |
結果
成功すると、サーバーはインポートタスクステータスとタイムスタンプ形式の時刻を返します。
レスポンス例
{
"time": 1635417036150,
"status": "queued"
}リクエスト パラメータ
| 名称 | 説明 |
| status | インポートタスクステータス |
| time | タイムスタンプ形式の時刻 |
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
被リンクリストの削除
このメソッドは、ウェブサイトの被リンクリストを削除する事ができます。
リクエスト フォーマット
POST /backlinks/{site_id}/delete
{
"backlink_ids": [
1,
2,
3
]
}リクエスト パラメータ
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
| backlink_ids | Yes | 被リンク ID の配列 |
結果
成功すると、サーバーは204 HTTPコードを返します。
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
| 400 | 無効なID |
被リンクインデックス/ステータスチェックの実行
このメソッドは被リンクリストに関してインデックやステータスチェックを一行する事ができます。
リクエスト フォーマット
POST /backlinks/{site_id}/recheck
{
"backlink_ids": [
1,
2
],
"recheck_type":"index"
}リクエスト パラメータ
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
| backlink_ids | Yes | 被リンク ID の配列 |
| recheck_type | No | チェックタイプ 値は status または index が利用可能。パラメータを指定しなかった場合、recheck_type=status が標準で使用されます。 |
結果
成功すると、サーバーは204 HTTP コードを返します。
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
| 400 | 無効なID |
被リンク 統計
リクエスト フォーマット
GET /backlinks/{site_id}/stat リクエスト パラメータ
| 名称 | 必須 | 説明 |
| backlink_id | はい | 被リンク ID |
レスポンス例
{
"total": 9,
"anchors": 1,
"ip": 8,
"domains": 9,
"dofollow": 0,
"nofollow": 1,
"limit": 988
}レスポンス パラメータ
| 名称 | 説明 |
| total | 被リンクの合計数 |
| anchors | ユニーク アンカーテキストの合計数 |
| ip | ユニーク IP アドレスの合計数 |
| domains | ユニーク ドメインの合計数 |
| dofollow | dofollow リンクの合計数 |
| nofollow | nofollow リンクの合計数 |
| limit | リンク追加制限。今日追加可能な数。 |
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
リンク否認のリスト
このメソッドは、リンク否認のリストと数を取得する事ができます。
リクエスト フォーマット
GET /backlink-disavow/{site_id}?limit=100&offset=0リクエスト パラメータ
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
| limit | No | 否認被リンクの数 |
| offset | No | オフセット値 |
結果
成功すると、サーバーはリンク否認リストと数を返します。
レスポンス例
{
"total_disavow_links": 2,
"disavow_links": [
{
"id": 3,
"url": "https://yandex.ru",
"type": "url",
"exported": 0,
"yandex_x": null,
"domain_inlink_rank": 96
},
{
"id": 4,
"url": "https://google.com",
"type": "url",
"exported": 0,
"yandex_x": null,
"domain_inlink_rank": 100
}
]
}レスポンス パラメータ
| 名称 | 説明 |
| total_disavow_links | リンク否認の合計数 |
| disavow_links | リンク否認の配列 |
| id | 否認被リンク ID |
| url | 否認被リンク URL |
| type | 被リンクタイプ |
| exported | 被リンクがエクスポートされているかどうか |
| yandex_x | Yandex X ratingの値 |
| domain_inlink_rank | ドメインランク |
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
被リンク否認リストの追加
このメソッドは、被リンク否認のリストを追加する事ができます。
リクエスト フォーマット
POST /backlink-disavow/{site_id}
{
"list": [
"https://google.com",
"https://yandex.ru"
]
}リクエスト パラメータ
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
| list | Yes | 被リンクの配列 |
結果
成功すると、サーバーは追加された否認被リンクの数を返します。
レスポンス例
{
"added": 2
}レスポンス パラメータ
| 名称 | 説明 |
| added | 追加された否認被リンクの数 |
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
| 400 | 無効なリスト |
否認被リンクの削除
このメソッドは、リンク否認リストから否認被リンクを削除する事ができます。
リクエスト フォーマット
DELETE /backlink-disavow/{site_id}?id={disavow_link_id}リクエスト パラメータ
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
| disavow_link_id | Yes | 否認被リンク ID |
結果
成功すると、サーバーは204 HTTPコードを返します。
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
| 400 | 無効な否認リンクID |
| 400 | 否認リンクは存在しません |
