リンクグループ更新API
複数の短縮URLをまとめて管理・更新するためのAPIです。
グループ単位で設定を変更し、キャンペーン運用を効率的にコントロールできます。 有効期限・パスワード・Webhookなどの共通設定も一括で更新可能です。
グループ設定を変更すると、該当グループ内のすべてのリンクに反映されます。
個別リンク設定とグループ設定が重複する場合は、グループ設定が優先されます。
PUT
/api/link-group/v1/update
{
"grpIdx": 5066,
"nm": "Instagram Group",
"memo": "A group of links used in Instagram ads.",
"strtYmdt": "2026-03-01 00:00:00",
"endYmdt": "2026-03-31 23:59:59",
"expireUrl": "https://example.com/event-expired"
}
Request Parameters
- grpIdx integer required
-
グループIDXです。
更新するグループのIDXを指定します。 - nm string
-
グループ名です。
リンクを分類し、管理するためのグループ名を設定します。 - memo string
-
グループ管理用メモです。
グループの用途や管理に関する情報を自由に記録できます。 - notfSubscYn string
- Default:N
-
Enum:
YN
-
プッシュ通知サブスクリプションリンクとして作成するかを設定します。
Y: プッシュ通知専用リンクとして作成されます。
N: 通常のリンクとして作成されます。
ユーザーがプッシュ通知リンクにアクセスすると、ブラウザのプッシュ通知購読リクエストが表示されます。 - qrBypassYn string
- Default:N
-
Enum:
YN
-
QRコード経由でアクセスした際のリダイレクト方式を設定します。
Y: QRコードアクセス時、元のURLへ直接移動します。(クリック統計は記録されません)
N: 短縮リンクURLを経由して移動します。(クリック統計が記録されます) - blockOverseasSticsYn string
- Default:N
-
Enum:
YN
-
海外からのアクセスを統計に含めるかどうかを設定します。
Y: 海外アクセスは統計から除外されます。
N: すべての国からのアクセスが統計に含まれます。 - pushNotifyYn string
- Default:N
-
Enum:
YN
-
クリック数に応じたプッシュ通知の送信有無を設定します。
Y: 設定した条件に到達するとプッシュ通知が送信されます。
N: プッシュ通知は送信されません。
この機能はパーソナルプラン以上で利用できます。 - mailNotifyYn string
- Default:N
-
Enum:
YN
-
クリック数に応じたメール通知の送信有無を設定します。
Y: 設定した条件に到達するとメール通知が送信されます。
N: メール通知は送信されません。
この機能はパーソナルプラン以上で利用できます。 - nonmemberSticsPwd string
-
非会員ユーザーがクリック統計を閲覧する際のパスワードです。
非会員にもクリック統計を公開する場合、統計ページにアクセスする際に入力するパスワードを設定します。 - strtYmdt datetime
-
リンクの有効開始日時です。
指定した日時以降からリンクへのアクセスが可能になります。
例:2026-03-01 00:00:00 - endYmdt datetime
-
リンクの有効期限日時です。
指定した日時を過ぎるとリンクへのアクセスはブロックされます。
例:2026-03-31 23:59:59 - expireUrl string
-
リンクの有効期限が切れた後に移動するURLです。
設定しない場合は、デフォルトの案内ページが表示されます。
例:https://example.com/event-expired - pwd string
-
リンクアクセス用パスワードです。
設定された場合、ユーザーはリンクへアクセスする際にパスワードを入力する必要があります。 - acesMaxCnt integer
-
最大クリック許可回数です。
設定した回数を超えるとリンクへのアクセスはブロックされます。(0は制限なし) - webhookEnableYn string
- Default:N
-
Enum:
YN
-
Webhook機能の使用有無を設定します。
グローバルWebhookが有効化されている必要があります。
この機能はエンタープライズプランでのみ利用できます。 - webhookCallbackUrl string
-
Webhookイベントを受信するサーバーURLです。
webhookEnableYnがYの場合に必須となり、ユーザーのサーバーでイベントデータを受信するエンドポイントを指定します。
例:https://api.example.com/webhook - webhookMetric string
- Default:C
-
Enum:
CP
-
Webhook送信の基準です。
C:クリック数 기준, P:ユーザー数 기준(ユニーククリック数) - webhookFrequency integer
- Default:1
-
Enum:
1501002003005001000
-
Webhook送信頻度です。
1:クリックごと、50:50回ごと、100:100回ごと、300:300回ごと、500:500回ごと、1000:1,000回ごと
{
"code": 0,
"message": "",
"result": null // When the ‘webhookEnableYn’ parameter is set to ‘Y’, a secret key is specified.
}
Response Parameters
- code integer
- 応答コード: 0 = 成功、それ以外の値 = エラー
- message string
- 応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
- result string
-
webhookEnableYnがYに設定されている場合、secret key が生成され返されます。
すでにwebhookSecretKeyが存在する場合、新しいキーは生成されず返されません。
このAPIを利用する場面
短縮URLを個別に管理・更新するのが非効率な場合に適しています。
- 広告キャンペーンのリンクを一括で無効化、または期間を変更したい場合
- 特定のイベント終了後にすべてのリンクのアクセスを制限したい場合
- 同じ設定を複数のリンクにまとめて適用したい場合
主な機能と設定の影響
このAPIは単なる更新ではなく、リンク運用の動作やポリシーを制御するためのものです。
アクセス制御
- 非会員ユーザーのアクセス制限
- QRコードのアクセス制限 → 特定ユーザーのみ許可
分析・フィルタリング
- ボットトラフィックの除外 → データ精度に直接影響
通知設定
- プッシュ通知・メール通知 → リンクイベントにリアルタイムで対応可能
期間設定
- 開始日・終了日設定 → 自動で有効化/無効化
有効期限管理
- 期限切れ時のリダイレクト設定 → ユーザー体験を維持
Webhook設定
- イベント発生時に外部サーバーへデータ送信 → システム連携・自動化が可能
活用例
- マーケティングキャンペーン: イベント終了時にリンクを一括で無効化し、期限切れURLへ自動リダイレクト
- SaaSサービス: 機能ごとにリンクをグループ化し、アクセス権限や利用期間を一元管理
- 大規模リンク運用: Webhookでクリックイベントを社内システムとリアルタイム連携
- セキュリティ: パスワードを定期的に更新して安全性を維持
利用時の注意点
- グループ設定の変更は、すべてのリンクに即時反映されます
- 期間設定を誤ると、すべてのリンクへのアクセスが制限される可能性があります
- Webhook設定は外部サーバーの状態により遅延が発生する場合があります
- 統計フィルタの変更により、既存データの解釈が変わる可能性があります