API Description

キーワードグループ

キーワードグループの作成

このメソッドはプロジェクトのキーワードにグループを追加する事ができます。

パラメータ’

名称 必須 説明
name はい 追加されたプロジェクト キーワード グループ名
site_id はい キーワード グループを追加したプロジェクト ID

リクエスト フォーマット

Title of the code block
コピー
POST https://api4.seranking.com/keyword-groups

{

"name": "groupname",

"site_id": 1

}

結果

成功すると、サーバーは201 HTTP コードと、プロジェクト キーワード グループのIDが含まれます。

名称 必須 説明
group_id はい 追加されたプロジェクトのキーワード グループのID

レスポンス例

Title of the code block
コピー
{

    "group_id": 123456

}

エラー

HTTP コード エラーメッセージ
404Empty name
404Empty site_id

キーワードを別にグループに移動

このメソッドは、あるグループから別のグループへプロジェクト キーワードを移動させる事ができます。

パラメータ

名称 必須 説明
keywords_ids はい 移動されたキーワードのIDの配列

リクエスト フォーマット

Title of the code block
コピー
POST /keyword-groups/{group_id}/keywords

{

"keywords_ids": [1,2,3,4,5]

}

結果

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

エラー

HTTP コード エラーメッセージ
404Group not found

キーワード グループ名の変更

このメソッドは、プロジェクト キーワード グループ名を変更する事ができます。

パラメータ

名称 必須 説明
name はい 新しいキーワード グループ名

リクエスト フォーマット

Title of the code block
コピー
PUT /keyword-groups/{group_id}

{

    "name": "new name"

}

結果

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

エラー

HTTP コード エラーメッセージ
404Empty name
404Group not found

キーワード グループの削除

このメソッドはプロジェクト キーワード グループを削除する事ができます。

リクエスト フォーマット

Title of the code block
コピー
DELETE /keyword-groups/{group_id}

結果

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

エラー

HTTP コード エラーメッセージ
404Group not found

キーワード グループのリスト取得

このメソッドは、特定のプロジェクトのキーワード グループのリストを取得する事ができます。

リクエスト フォーマット

Title of the code block
コピー
GET /keyword-groups/{site_id}

結果

成功すると、サーバーは特定のプロジェクトのキーワード グループの配列を返します。

名称 必須 説明
id はい プロジェクト キーワード グループ ID
name はい 新しいキーワード グループ名
creation_date はい プロジェクト キーワード グループ作成日

レスポンス例

Title of the code block
コピー
[

    {

        "id": "123",

        "name": "NewKeyGroup",

        "creation_date": "2018-08-27"

    },

    {

        "id": "456",

        "name": "NewKeyGroup1",

        "creation_date": "2018-08-27"

    },

    {

        "id": "789",

        "name": "NewKeyGroup2",

        "creation_date": "2018-08-27"

    }

]

エラー

HTTP コード エラーメッセージ
404Group not found
404 No keywords ids in request