リンクグループ一覧 (v2)

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

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

GET

/api/link-group/v2/list?nm={nm}&pages={pages} 

{
    "nm": "My+group",
    "pages": 1
}

Request Parameters

grpIdxinteger
リンクグループ (IDX)。
nmstring
リンクグループ (名前)。部分検索が可能です。
空白や日本語などの文字が含まれる場合は、URLエンコードを推奨します。 
{
    "code": 0,
    "message": "",
    "result": {
        "extra": {
            "pages": 1,
            "nextPages": 1,
            "nextYn": "N",
            "count": 2,
            "totalCount": 2
        },
        "list": [
            {
                "idx":1,
                "nm":"Amazon Electronics",
                "memo":"Products between $100 and $500",
                "linkCnt":112,
                "blockOverseasSticsYn":"N",
                "notfSubscYn":"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",
                "qrBypassYn":"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

code integer
応答コード: 0 = 成功、それ以外 = エラー
message string
応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
result object
extra object
ページおよびデータ件数情報。
pages integer
現在のページ番号
nextPages integer
次のページ番号
nextYn string
次のページが存在するかどうか
count integer
現在のページのデータ件数
totalCount integer
全データ件数
list array
グループ情報
idxinteger
グループIDX。
nmstring
グループ名。
memostring
グループ管理用メモ。
linkCntinteger
グループに紐づくリンク数。
notfSubscYnstring
プッシュ購読リンクかどうか。
qrBypassYn string
QRコードをスキャンした際、短縮URLを経由せずにユーザーが設定した元のURLへ直接アクセスするかどうかを制御します。
Y: 短縮URLを経由せず元のURLへ直接リダイレクトします。（QRスキャン統計は記録されません）
N: 短縮URLを経由して元のURLへリダイレクトします。（QRスキャン統計は記録されます）
pushNotifyYnstring
クリック数のプッシュ通知を有効にするかどうか。
mailNotifyYnstring
クリック数のメール通知を有効にするかどうか。
webhookEnableYn string
Enum:
YN
Webhookの有効化設定。
webhookCallbackUrl string
WebhookのコールバックURL。
webhookMetric string
Enum:
CP
Webhookの受信基準。
C: クリック数基準, P: ユーザー数基準（ユニーククリック）。
webhookFrequency integer
Enum:
1501002003005001000
Webhookの受信頻度。
1: 毎回クリック時, 50: 50回ごと, 100: 100回ごと, 300: 300回ごと, 500: 500回ごと, 1000: 1,000回ごと。
regYmdtdatetime
作成日時。
modYmdtdatetime
更新日時。