リンクグループ一覧

リンクグループ一覧を取得するAPIです。

ユーザーが作成したすべてのリンクグループ情報を返します。
リンク作成時に特定のグループを指定する場合、このAPIでグループ一覧を取得するか、ダッシュボードで確認できます。

GET

/api/link-group/v1/list?nm={nm}

{
    "nm": "My+group"
}

Request Parameters

grpIdxinteger
リンクグループ (IDX)。
nmstring
リンクグループ (名前)。部分検索が可能です。
空白や日本語などの文字が含まれる場合は、URLエンコードを推奨します。 
{
    "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",
            "webhookEnableYn": "Y",
            "webhookCallbackUrl": "https://yourdomain.com/webhook/callback/vivoldi",
            "webhookMetric": "P",
            "webhookFrequency": 1,
            "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",
            "webhookEnableYn": "N",
            "webhookCallbackUrl": null,
            "webhookMetric": "C",
            "webhookFrequency": 1,
            "regYmdt":"2024-07-20 02:42:00",
            "modYmdt":"2025-02-12 11:20:50"
        }
    ]
}

Response Parameters

codeinteger
レスポンスコード: 0 = 成功、それ以外 = エラー
messagestring
レスポンスメッセージ。レスポンスコードが0以外の場合、エラー内容のメッセージが返されます。
resultarray
idxinteger
グループIDX。
nmstring
グループ名。
memostring
グループ管理用メモ。
linkCntinteger
グループに紐づくリンク数。
notfSubscYnstring
プッシュ購読リンクかどうか。
pushNotifyYnstring
クリック数のプッシュ通知を有効にするかどうか。
mailNotifyYnstring
クリック数のメール通知を有効にするかどうか。
webhookEnableYnstring
Enum:
YN
Webhookの有効化設定。
webhookCallbackUrlstring
WebhookのコールバックURL。
webhookMetricstring
Enum:
CP
Webhookの受信基準。
C: クリック数基準, P: ユーザー数基準（ユニーククリック）。
webhookFrequencyinteger
Enum:
1501002003005001000
Webhookの受信頻度。
1: 毎回クリック時, 50: 50回ごと, 100: 100回ごと, 300: 300回ごと, 500: 500回ごと, 1000: 1,000回ごと。
regYmdtdatetime
作成日時。
modYmdtdatetime
更新日時。