tagru campaigns
キャンペーン(プレゼント企画など、応募を受け付けるページ)の一覧・設定・配布リンクを表示します。見るだけのコマンドです。 キャンペーンはワークスペースごとにあり、TAGRU の画面の「キャンペーン」と同じものです。
試験的なコマンドです
キャンペーン機能はまだ一般公開前のため、このコマンドは試験的です。出力の項目(--json の項目名・値を含む)は予告なく変わることがあり、コマンドごと取り下げることもあります。
text
tagru campaigns [list] [--limit <n>] [--workspace <id>] [--target <prod|test|localhost>] [--json]
tagru campaigns get <campaign-id> [--workspace <id>] [--target <prod|test|localhost>] [--json]
tagru campaigns links <campaign-id> [--workspace <id>] [--target <prod|test|localhost>] [--json]サブコマンド
| サブコマンド | 内容 |
|---|---|
list(省略可) | キャンペーンの一覧(作成日時の新しい順)。tagru campaigns は tagru campaigns list と同じです |
get <campaign-id> | キャンペーン 1 件の設定(公開の状態・応募期間・賞品・応募方法・応募フォームの項目など) |
links <campaign-id> | キャンペーン 1 件の配布リンク(UTM 付きの短縮リンク)の一覧と、あと作れる本数 |
オプション
| オプション | 内容 |
|---|---|
--limit <n> | 一覧の件数(既定 20、1〜100)。list のみ |
--workspace <id> | ワークスペース(tagru use で保存した値より優先) |
-t, --target <name> | 接続先 |
--json | JSON で出力する |
- ワークスペースを選んでいない(
tagru useも--workspaceも無い)ときは、通信せずに使い方のエラー(usage_error)になります - 参加が承認されているワークスペースのキャンペーンだけを表示できます(招待中・未参加は
403) - キャンペーン機能を公開していない接続先では、どのワークスペースでも
403になります - 読み取りだけのログイン(
cli:read)で使えます - キャンペーンの作成・編集・公開・非公開・URL の作り直し・配布リンクの作成と無効化・抽選・応募者の閲覧は、CLI からは行えません(TAGRU の画面から行ってください)。応募者の情報は CLI では表示しません
出力例
text
$ tagru campaigns
ワークスペース: ws-xxxx
ID 名前 応募期間 媒体 当選の決め方 当選数
campaign-0002 秋のプレゼント 2 2026-11-01 00:00 〜 2026-11-30 15:00 Threads 先着 3(補欠 1)
campaign-0001 秋のプレゼント 1 2026-11-01 00:00 〜 2026-11-30 15:00 Instagram, X 抽選 3(補欠 1)
`tagru campaigns get <ID>` で設定を、`tagru campaigns links <ID>` で配布リンクを表示できます。続きがあるときは 続きがあります(--limit で増やせます) と出ます。
text
$ tagru campaigns get campaign-0001
ワークスペース: ws-xxxx
ID: campaign-0001
名前: 秋のプレゼント 1
公開: 公開中
応募期間: 2026-11-01 00:00 〜 2026-11-30 15:00
媒体: Instagram, X
当選の決め方: 抽選
抽選日時: 2026-12-01 03:00
結果発表: 2026-12-02 03:00
賞品: A賞 サンプル: 当選 2(補欠 1)
B賞 ステッカー: 当選 1(補欠 0)
応募方法: アカウントをフォローして応募
応募フォーム: メール(email・必須)
住所(address・必須・当選後)
説明: 新商品のサンプルを
プレゼントします
更新日時: 2026-10-11 09:00公開は未公開(一度も公開していない)・非公開・公開中・予約公開のどれかです。予約公開のときは公開予定も出ます抽選日時・結果発表は、当選の決め方が抽選のときだけ出ます- 別のワークスペースのキャンペーン ID を指定すると、
キャンペーンが見つかりません: …のエラー(404)になります
text
$ tagru campaigns links campaign-0001
ワークスペース: ws-xxxx
キャンペーン: campaign-0001
あと作れる本数: 61
リンク ID コード source medium campaign content 状態
s01 code000000000000000001 x social autumn post1 有効
s02 code000000000000000002 x social autumn post2 無効
s03 code000000000000000003 x social autumn post3 公開 URL の変更で無効状態 は、使えるものが 有効、無効にしたものが 無効、公開 URL を作り直す前のものが 公開 URL の変更で無効 です。 配布リンクは 1 キャンペーンに 64 本まで作れます。
--json
tagru campaigns --json と tagru campaigns links --json は一覧の外枠(items)、tagru campaigns get --json は詳細の外枠(item)で出します。
一覧(list)の items
| 項目 | 型 | 内容 |
|---|---|---|
id | string | キャンペーンの ID(get / links に渡す) |
name | string | 名前 |
platforms | string[] | 告知する媒体(instagram / x / tiktok / threads) |
startsAt | string | null | 応募の開始日時(ISO 8601) |
endsAt | string | null | 応募の終了日時(ISO 8601) |
winMethod | string | null | 当選の決め方(lottery 抽選 / first 先着 / instant 即時抽選) |
winnerCount | number | null | 賞品ごとの当選数の合計 |
backupCount | number | null | 賞品ごとの補欠数の合計 |
version | number | null | 設定の版(保存のたびに増える) |
createdAt | string | null | 作成日時(ISO 8601) |
updatedAt | string | null | 更新日時(ISO 8601) |
hasMore が true なら続きがあります(--limit で増やせます)。
詳細(get)の item
一覧の項目に加えて、次を出します。
json
{
"target": "prod",
"workspaceId": "ws-xxxx",
"item": {
"id": "campaign-0001",
"name": "秋のプレゼント 1",
"platforms": ["instagram", "x"],
"startsAt": "2026-11-01T00:00:00+00:00",
"endsAt": "2026-11-30T15:00:00+00:00",
"winMethod": "lottery",
"winnerCount": 3,
"backupCount": 1,
"version": 4,
"createdAt": "2026-10-01T00:00:00+00:00",
"updatedAt": "2026-10-11T09:00:00+00:00",
"visibility": "public",
"publishAt": null,
"description": "新商品のサンプルを\nプレゼントします",
"howToEnter": "アカウントをフォローして応募",
"drawAt": "2026-12-01T03:00:00+00:00",
"resultsAt": "2026-12-02T03:00:00+00:00",
"prizes": [
{ "rank": "A賞", "name": "サンプル", "winners": 2, "backup": 1 },
{ "rank": "B賞", "name": "ステッカー", "winners": 1, "backup": 0 }
],
"formFields": [
{ "key": "email", "label": "メール", "type": "email", "required": true, "timing": "entry" },
{ "key": "shipping", "label": "住所", "type": "address", "required": true, "timing": "after_win" }
]
}
}| 項目 | 型 | 内容 |
|---|---|---|
visibility | string | null | 公開の状態(hidden 非公開 / public 公開中 / scheduled 予約公開。一度も公開していなければ null) |
publishAt | string | null | 予約公開の日時(ISO 8601) |
description | string | 説明 |
howToEnter | string | 応募方法 |
drawAt | string | null | 抽選日時(ISO 8601) |
resultsAt | string | null | 結果発表の日時(ISO 8601) |
prizes | object[] | 賞品(rank 賞の名前・name 賞品名・winners 当選数・backup 補欠数) |
formFields | object[] | 応募フォームの項目の定義(key・label・type・required・timing(entry 応募時 / after_win 当選後))。応募者が入力した内容は含みません |
winnerCount・backupCount は、prizes の合計です。
配布リンク(links)
外枠に campaignId(キャンペーンの ID)と remaining(あと作れる本数)が付きます。1 キャンペーンの配布リンクは全件を返すため、hasMore は常に false です。
| 項目 | 型 | 内容 |
|---|---|---|
linkId | string | 配布リンクの ID |
code | string | 短縮リンクのコード |
utmSource | string | UTM の source(配る場所) |
utmMedium | string | UTM の medium(配り方) |
utmCampaign | string | UTM の campaign |
utmContent | string | UTM の content |
enabled | boolean | 無効にしていないか |
active | boolean | 今の公開 URL で使えるか(無効にした・公開 URL を作り直した後は false) |