amp guides

이 페이지는 아직 귀하의 언어로 번역되지 않았습니다. 현재 작업 중이므로 곧 다시 확인해 주십시오.

amp guides manages guides: in-app tours, modals, banners, and tooltips. Read commands require guides:read; create, update, and archive require guides:write. Publish and schedule guides in Amplitude.

amp guides list

Returns guides in the project. Results use the standard Developer API list envelope with cursor pagination (cursor, limit).

Full-text search (q) and custom sort orders are not supported yet.

bash
amp guides list --project <project_id> --limit 10

Requires the guides:read scope.

amp guides get

Get guide.

bash
amp guides get --project <project_id> --guide <guide_id> --include-unpublished-changes

Requires the guides:read scope.

amp guides create

Creates an unpublished draft guide. Publish, schedule, and test instrumentation are not available via API in v1. At most one content variant is accepted on create; the control key is reserved.

bash
amp guides create --project <project_id> --title "Welcome tour"

Requires the guides:write scope.

amp guides update

Updates metadata, targeting, and content variants. For published guides, changes apply to a draft until publish in the UI. latest_version is required and must match the current draft, otherwise the update returns 409. The check runs before the write rather than atomically with it, so it reduces but does not fully prevent lost updates from concurrent writers. Publish, schedule, and test instrumentation are not available via API in v1. Status fields on the response are derived read-only. When variants is sent, it must list every existing variant by id with its unchanged variant key; steps within a variant can be added, edited, reordered, or removed. tags is not writable in v1 and returns 400.

bash
amp guides update --project <project_id> --guide <guide_id> --latest-version <version> --title "Welcome tour v2"

Requires the guides:write scope.

amp guides archive

Archives an unpublished guide. A guide counts as published while its flag is enabled, unless it's only in test mode without a schedule; archiving a published guide returns 409 with error_code: cannot_archive_published. Unpublish it in Amplitude first. Use dry_run=true to check whether a guide can be archived. An already archived guide returns 404, like GET.

Requires --yes to apply changes, or --dry-run when supported to validate without applying changes.

bash
amp guides archive --project <project_id> --guide <guide_id> --dry-run

Requires the guides:write scope.

이 내용이 도움이 되었나요?

For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

이 페이지에서