被リンクグループ

被リンクグループのリストを取得

このメソッドは、被リンクグループのリストと数を取得する事ができます

リクエスト フォーマット

GET /backlink-groups/{site_id}

リクエスト パラメータ

名称必須説明
site_idYesウェブサイト 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_idYesウェブサイト ID
nameYesグループ名

結果

成功すると、サーバーは被リンクグループIDを返します。

レスポンス例

{
“group_id”: 2
}

レスポンス パラメータ

名称説明
group_id被リンクグループ ID

エラー

HTTP コードエラー メッセージ
403アクセスが拒否されました (wrong site_id)
400無効な名称
400グループは既に存在します

被リンクグループの削除

このメソッドは、ウェブサイト被リンクのグループを削除する事ができます。

リクエスト フォーマット

DELETE /backlink-groups/{site_id}?id={id}

リクエスト パラメータ

名称必須説明
site_idYesウェブサイト ID
idYes被リンクグループ ID

結果

成功すると、サーバーは204 HTTPコードを返します。

エラー

HTTP コードエラー メッセージ
403アクセスが拒否されました (wrong site_id)
400無効なグループID
400グループは存在しません

被リンクグループの名前変更

このメソッドは被リンクグループの名称を変更する事ができます。

リクエスト フォーマット

PUT /backlink-groups/{site_id}
{
“id”: 2,
“name”: “New group name”
}

リクエスト パラメータ

名称必須説明
site_idYesウェブサイト ID
idYes被リンクグループ ID
nameYes新しい被リンクグループ名

結果

成功すると、サーバーは204 HTTPコードを返します。

エラー

HTTP コードエラー メッセージ
403アクセスが拒否されました (wrong site_id)
400無効な名称
400グループは既に存在します

被リンクを別のグループに移動

このメソッドは、あるグループから被リンクを別のグループに移す事ができます。

リクエスト フォーマット

POST /backlink-groups/{site_id}/move
{
“id”: 1,
“backlink_ids”: [1],
“group_ids”: [2]
}

リクエスト パラメータ

名称必須説明
site_idYesウェブサイト ID
idYes移動先の被リンクグループ ID
backlink_idsNo移動される被リンク ID の配列
group_idsNo移動される被リンクグループ ID の配列

結果

成功すると、サーバーは204 HTTPコードを返します。

エラー

HTTP コードエラー メッセージ
403アクセスが拒否されました (wrong site_id)
400無効なグループID
400被リンクグループID
400グループIDまたは被リンクは必須です