API
プロジェクト グループ
プロジェクトグループの追加
このメソッドは、ユーザーアカウントに新しいプロジェクトグループを追加する事ができます。
リクエスト フォーマット
POST https://api4.seranking.com/site-groups
{ "name" : "text" }パラメータ
| 名称 | 必須 | 説明 |
| name | はい | N追加されるプロジェクトグループ名 |
結果
成功すると、サーバーは削除ステータスを含む配列を返します。
| 名称 | 必須 | 説明 |
| group_id | はい | 追加されたプロジェクトグループのID |
レスポンス例
{
"group_id": 9545
}エラー
| HTTP コード | エラーメッセージ/th> |
| 400 | Empty name |
プロジェクトグループ名の変更
リクエスト フォーマット
PUT https://api4.seranking.com/site-groups/{group_id}
{
"name": "new name"
}パラメータ
| 名称 | 必須 | 説明 |
| name | はい | N追加されるプロジェクトグループ名 |
結果
成功すると、サーバーは 200 HTTP コードを返します。
エラー
| HHTTP コード | エラーメッセージ |
| 400 | Empty name |
| 404 | Group not found |
プロジェクトグループの削除
リクエスト フォーマット
DELETE https://api4.seranking.com/site-groups/{group_id}
結果
成功すると、サーバーは 204 HTTP コードを返します。
エラー
| HHTTP コード | エラーメッセージ |
| 404 | Group not found |
プロジェクトグループのリスト
このメソッドは、ユーザーアカウントから全てのグループのリストを取得する事ができます。
リクエスト フォーマット
GET https://api4.seranking.com/site-groups
結果
成功すると、サーバーはグループのリストを返します。
| 名称 | 必須 | 説明 |
| id | はい | プロジェクト グループ ID |
| name | はい | プロジェクト グループ名 |
レスポンス例
[
{
"id": "123",
"name": "Group1"
},
{
"id": "456",
"name": "Group2"
}
]グループへプロジェクトを移動
このメソッドは、あるグループから別のグループへプロジェクトを移動させることができます
Parameters
| 名称 | 必須 | 説明 |
| site_ids | はい | 移動されたウェブサイトのIDを含む配列 |
リクエスト フォーマット
POST https://api4.seranking.com/site-groups/{group_id}/sites
{
"site_ids" : [1,2,3,4,5]
}結果
成功すると、サーバーは 204 HTTP コードを返します。
エラー
| HHTTP コード | エラーメッセージ |
| 404 | Group not found |
