リンクグループ一覧
リンクグループ一覧APIでは、ユーザーが作成したすべてのリンクグループ情報を取得できます。
リンクを作成する際に特定のグループを指定するには、まずこのAPIでグループ一覧を取得し、目的のグループのIDX値を確認してください。
そのIDX値をリンク作成リクエストに含めると、該当グループの設定が自動的にリンクに適用され、より効率的に管理できます。
Http Header
GET /api/link-group/v1/list
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: -
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"nm": "My group"
}| フィールド | フィールドの説明 | 説明 | 必須 | タイプ |
|---|---|---|---|---|
| grpIdx | グループIDX | 指定されたグループIDXと完全に一致するグループを取得します。 | int | |
| nm | グループ名 | 指定された文字列を含むグループ名でグループを検索します。 グループ名の一部だけ一致していても検索されます。 | string |
Response
{
"code": 0,
"message": "",
"result": [
{
"idx":1,
"nm":"Amazon Electronics",
"memo":"Products between $100 and $500",
"linkCnt":112,
"blockOverseasSticsYn":"N",
"notfSubscYn":"N",
"kakaoNotifyYn":"N",
"pushNotifyYn":"N",
"mailNotifyYn":"N",
"regYmdt":"2024-07-20 02:30:00",
"modYmdt":"2024-08-15 17:45:10"
},
{
"idx":2,
"nm":"XXX Advertiser Group",
"memo":"2-year contract",
"linkCnt":68,
"blockOverseasSticsYn":"N",
"notfSubscYn":"Y",
"kakaoNotifyYn":"N",
"pushNotifyYn":"Y",
"mailNotifyYn":"N",
"regYmdt":"2024-07-20 02:42:00",
"modYmdt":"2025-02-12 11:20:50"
}
]
}| フィールド | 説明 | タイプ | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | レスポンスコード（0：成功） | int | ||||||||||||||||||||||||||||||||||||||||||||||||
| message | codeが0以外の場合に含まれ、失敗の原因を示すエラーメッセージが格納されます。 | string | ||||||||||||||||||||||||||||||||||||||||||||||||
| result |
| array |