リンクグループ作成
リンクグループを作成するためのAPIです。
リンクグループを使用すると、複数の短縮リンクを1つのグループとしてまとめて管理できます。
リンク数が増えると、個別リンクごとの設定管理が複雑になる場合があります。
リンクをグループ化することで、有効期限、クリック制限、パスワード、通知、統計設定などをグループ単位でまとめて適用できます。
グループに設定したオプションは、そのグループに含まれるすべてのリンクに共通で適用されます。 個別リンク設定とグループ設定が重複する場合は、グループ設定が優先されます。
また、リンクをキャンペーン、プロジェクト、マーケティングチャネルなどの目的別に整理することで、 グループ単位での分析やリンク管理がより効率的になります。
作成されたグループIDは、リンク作成APIで利用できます。
POST
/api/link-group/v1/create
{
"nm": "Youtube Group",
"memo": "A group of links included in the description section of a YouTube video.",
"nonmemberSticsPwd": "123456"
}
Request Parameters
- nm string required
-
グループ名です。
リンクを分類し、管理するためのグループ名を設定します。 - 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": {
"grpIdx": 5066, // group idx
"webhookSecretKey": null // When the ‘webhookEnableYn’ parameter is set to ‘Y’, a secret key is specified.
}
}
Response Parameters
- codeinteger
- レスポンスコード: 0 = 成功、それ以外 = エラー
- messagestring
- レスポンスメッセージ。レスポンスコードが0以外の場合、エラー内容のメッセージが返されます。
- resultobject
- grpIdx integer
- グループIDX。
- webhookSecretKey string
-
webhookEnableYnがYの場合、secret key が返されます。