被リンクグループ
被リンクグループのリストを取得
このメソッドは、被リンクグループのリストと数を取得する事ができます
リクエスト フォーマット
GET /backlink-groups/{site_id}
リクエスト パラメータ
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
結果
成功すると、サーバーは被リンクグループのリストと数を返します。
レスポンス例
{
"total_groups": 2,
"groups": [
{
"id": 1,
"name": "General",
"count": 5
},
{
"id": 2,
"name": "Second group",
"count": 1
}
]
}
レスポンス パラメータ
| 名称 | 説明 |
| total_groups | 合計グループ数 |
| groups | グループの配列 |
| id | グループ ID |
| name | グループ名 |
| count | グループの被リンク数 |
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
被リンクのグループ作成
このメソッドは、ウェブサイト被リンクのグループを作成する事ができます。
リクエスト フォーマット
POST /backlink-groups/{site_id}
{
"name": "Group name"
}
リクエスト パラメータ
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
| name | Yes | グループ名 |
結果
成功すると、サーバーは被リンクグループIDを返します。
レスポンス例
レスポンス パラメータ
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
| 400 | 無効な名称 |
| 400 | グループは既に存在します |
被リンクグループの削除
このメソッドは、ウェブサイト被リンクのグループを削除する事ができます。
リクエスト フォーマット
DELETE /backlink-groups/{site_id}?id={id}
リクエスト パラメータ
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
| id | Yes | 被リンクグループ ID |
結果
成功すると、サーバーは204 HTTPコードを返します。
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
| 400 | 無効なグループID |
| 400 | グループは存在しません |
被リンクグループの名前変更
このメソッドは被リンクグループの名称を変更する事ができます。
リクエスト フォーマット
PUT /backlink-groups/{site_id}
{
"id": 2,
"name": "New group name"
}
リクエスト パラメータ
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
| id | Yes | 被リンクグループ ID |
| name | Yes | 新しい被リンクグループ名 |
結果
成功すると、サーバーは204 HTTPコードを返します。
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
| 400 | 無効な名称 |
| 400 | グループは既に存在します |
被リンクを別のグループに移動
このメソッドは、あるグループから被リンクを別のグループに移す事ができます。
リクエスト フォーマット
POST /backlink-groups/{site_id}/move
{
"id": 1,
"backlink_ids": [1],
"group_ids": [2]
}
リクエスト パラメータ
| 名称 | 必須 | 説明 |
| site_id | Yes | ウェブサイト ID |
| id | Yes | 移動先の被リンクグループ ID |
| backlink_ids | No | 移動される被リンク ID の配列 |
| group_ids | No | 移動される被リンクグループ ID の配列 |
結果
成功すると、サーバーは204 HTTPコードを返します。
エラー
| HTTP コード | エラー メッセージ |
| 403 | アクセスが拒否されました (wrong site_id) |
| 400 | 無効なグループID |
| 400 | 被リンクグループID |
| 400 | グループIDまたは被リンクは必須です |
