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

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

グループIDXや名称でフィルタリングでき、リンクの作成・更新・削除APIで必要なgrpIdxの確認に利用できます。

GET

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


GET /api/link-group/v2/list
     ?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
更新日時。

このAPIを利用する場面

リンクの作成や更新時にグループID（grpIdx）が必要な場合に利用します。

ダッシュボードにアクセスできない環境や、自動化スクリプトでグループIDを動的に取得する必要がある場合に有効です。

全グループ一覧を取得してドロップダウンUIを構築したり、特定のグループを検索して状態を確認する用途にも適しています。
単なる取得にとどまらず、運用フローの起点として活用されます。

フィルタリングの活用方法

grpIdxを指定すると、特定のグループを取得できます。
nmは部分一致検索に対応しており、名前の一部を入力するだけで該当する結果が返されます。

名前にスペースや日本語などのUnicode文字が含まれる場合は、正確な結果を得るためにURLエンコードを適用してください。

レスポンス構造と活用方法

이 API는 페이지 기반 구조화된 데이터를 반환합니다.
조회 결과는 단순 출력이 아니라 후속 API와 연결되는 기준 데이터로 사용됩니다.

페이지 정보 (extra)

  • pages → 현재 페이지
  • nextPages → 다음 페이지 존재 여부
  • count → 현재 페이지 데이터 수
  • totalCount → 전체 그룹 수

대량 데이터 처리 시 반복 조회 로직 구성 기준이 됩니다.

설정 정보 포함 구조

응답에는 그룹의 운영 설정도 함께 포함됩니다.

예:

  • 접근 제어 (notSubscYn, qrBypassYn)
  • 알림 (pushNotifyYn, mailNotifyYn)
  • Webhook (webhookEnableYn, webhookCallbackUrl)
  • totalCount → 전체 그룹 수

별도 조회 없이 현재 상태를 즉시 파악 가능합니다.

活用例

  • 自動化パイプライン: リンク作成前にグループ一覧を取得し、grpIdxを取得
  • グループ管理UI: 全グループを読み込み、ドロップダウンの選択肢として表示
  • 特定グループ検索: nmに名前の一部を入力して対象グループを迅速に抽出
  • ページング処理: pagesを順次増やして全グループを走査

利用時の注意点

  • nmパラメータにスペースやUnicode文字が含まれる場合は、必ずURLエンコードを適用してください。
    適用しない場合、検索結果が正確に取得できない可能性があります。
  • pagesはページ番号を示し、1から開始されます。
    nextYnがNの場合は最終ページとなるため、処理を終了できます。
  • レスポンスのidxは、リンクの作成・更新・削除APIで使用するgrpIdxと同一の値です。
    混同しないようご注意ください。