amp user-properties

このページはまだあなたの言語に翻訳されていません。 現在取り組んでいますので、後でもう一度確認してください。

amp user-properties manages a project's user properties. Read commands require taxonomy:read; create, update, and delete require taxonomy:write.

amp user-properties list

List user properties for a project.

bash
amp user-properties list --project <project_id> --limit 5

Requires the taxonomy:read scope.

amp user-properties get

Get user property.

bash
amp user-properties get --project <project_id> --property <property_name>

Requires the taxonomy:read scope.

amp user-properties create

Creates a user property and adds it to the project's tracking plan. Same idempotency semantics as creating an event property.

bash
amp user-properties create --project <project_id> --property <property_name> --display-name "Property name" --data-type string

Requires the taxonomy:write scope.

amp user-properties update

Updates metadata on a user property. Returns 422 not_in_schema if the property is ingested-only. Same patch semantics as updating an event property (field absent = unchanged, null = clear, arrays replace).

Only display_name, description, is_hidden, and classifications are mutable via PATCH today. Type/shape fields (data_type, is_array_type, enum_values, regex) are settable only at creation. is_official is read-only in this API version.

bash
amp user-properties update --project <project_id> --property <property_name> --description "Updated description"

Requires the taxonomy:write scope.

amp user-properties delete

Deletes a user property. Preview the deletion with --dry-run. At a terminal, the command asks for confirmation; pass --yes to skip the prompt.

bash
amp user-properties delete --project <project_id> --property <property_name> --dry-run
amp user-properties delete --project <project_id> --property <property_name> --yes

Requires the taxonomy: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.

このページでは