リンクの編集
作成済みの短縮URL情報を更新するためのAPIです。
リンクタイプが URL の場合にのみ編集が可能です。
投稿リンク、フォームリンク、ボタンリンク、カードリンクなど、その他のタイプは更新リクエストを送信しても変更は適用されません。
Http Header
PUT /api/link/v2/update
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"linkId": "4Rt3",
"domain": "https://vvd.bz",
"ttl": "new title",
"memo": "new my memo"
}
フィールド | フィールドの説明 | 説明 | 必須 | タイプ |
---|---|---|---|---|
linkId | リンクID | 生成されたショートリンクのID 例: ショートリンクのアドレスが "https://vvd.bz/fML" の場合、リンクIDは fML です。 | string | |
domain | ドメイン | ショートリンクアドレスのドメイン。 例: ショートリンクのアドレスが "https://vvd.bz/fML" の場合、ドメインは https://vvd.bz です。 重要: https:// または http:// の値を必ず入力する必要があります。 生成されたショートリンクのドメイン以外のドメインに設定すると、エラーが発生します。 | string | |
redirectType | Redirect方法 | 短いURLから長いURLに移動する方法を設定します。 HTTPのステータス応答コードとして200、301、302のいずれかを選択することができます。デフォルト値: 302 Redirect方法の詳細は「用語まとめ」ページで確認してください。 | int | |
grpIdx | グループID | 生成されたリンクのグループを変更します。 グループIDを確認するには、「グループリスト」APIを呼び出して確認する必要があります。 | int | |
url | 長いURL | 長いURLを変更します。 プレミアムプランから長いURLを変更することができます。 | string | |
ttl | リンクタイトル | 値が空の場合、リンクタイトルは修正されません。 | string | |
description | Metaの内容 | 「redirectType」の値が「200」のとき、ページのメタタグであるdescriptionを設定することができます。 「redirectType」の値が「301」、「302」の時はこの値は無視されます。 | string | |
metaImg | メタ画像 | リダイレクトタイプが「200」の場合のみ、メタ画像タグを設定できます。 メタ画像の値は、URL形式で「https://」で始まる必要があります。 リダイレクトタイプが「301」または「302」の場合、値は無視されます。 | string | |
memo | メモ | ユーザーに公開されず、管理に必要な付加情報を設定することができます。 値が空の場合、メモは修正されません。 | string | |
notfSubscYn | プッシュリンク | 値がYの場合、生成されたリンクをクリックすると、長いリンクに移動する前にWebプッシュ通知ポップアップが表示され、ユーザーがプッシュ通知を許可した場合、許可したすべてのユーザーにプッシュメッセージを送信することができます。 通知ポップアップに同意しない場合、またはキャンセルする場合、すぐに元の長いURLに移動します。 値を入力しない場合、デフォルト値はNです。 プッシュサブスクリプションリンクの詳細については、ここをクリックしてください。 | Y or N | |
pushNotifyYn | クリック数プッシュ通知 | 値がYの場合、「設定 -> 環境設定」ページのリンク設定で設定されたリンククリック数に達するたびに、Vivoldiアプリがインストールされたモバイルデバイスにクリック数プッシュ通知を受け取ることができます。 この機能はパーソナルプランから利用できます。 | Y or N | |
mailNotifyYn | クリック数メール通知 | 値がYの場合、「設定 -> 環境設定」ページのリンク設定で設定されたリンククリック数に達するたびに、Vivoldiに登録されたメールでクリック数情報を受け取ることができます。 この機能はパーソナルプランから利用できます。 | Y or N | |
delYmd | リンク削除日 | 設定した日付が過ぎると、リンクがシステムによって自動的に削除されます。 削除周期: 1時間ごと はい: 2025-12-31 | Date |
Response
{
"code": 0,
"message": "",
"result": null
}
フィールド | 説明 | タイプ |
---|---|---|
code | 応答コード (0:成功) | int |
message | 応答メッセージ、応答コードが0でない場合、関連メッセージが返されます。 | string |