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.
amp user-properties list --project <project_id> --limit 5
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--cursor | string | No | Opaque cursor from pagination.next_cursor on the previous response. Numeric offsets are capped by the underlying search index (10,000 results per query). Well-formed pagination stops before that window; requests whose cursor would exceed it return 400 pagination_not_supported. Alias: --next-cursor. |
--limit | integer | No | Number of items to return. Defaults to 50, max 200. |
--q | string | No | Full-text search query. Alias: --query. |
Requires the taxonomy:read scope.
amp user-properties get
Get user property.
amp user-properties get --project <project_id> --property <property_name>
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--property | string | Yes | Public user property identifier. Equal to property_name. URL-encode when the property name contains spaces or special characters. Alias: --property-name, --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.
amp user-properties create --project <project_id> --property <property_name> --display-name "Property name" --data-type string
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--idempotency-key | string | No | Generated automatically when omitted. Header acceptance alone does not guarantee retry deduplication. |
--property | string | Yes | Alias: --property-name, --name. |
--display-name | string | No | |
--description | string | No | |
--data-type | string: string, number, boolean, object, enum, any | No | Logical data type of a property. null means untyped at the source; clients should treat it as string for ingestion. Alias: --type. |
--is-array | boolean | No | |
--enum-values | array | No | JSON array, or a comma-separated list for strings. |
--regex | string | No | |
--is-hidden | boolean | No | |
--classifications | array | No | JSON array, or a comma-separated list for strings. |
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.
amp user-properties update --project <project_id> --property <property_name> --description "Updated description"
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--property | string | Yes | Public user property identifier. Equal to property_name. URL-encode when the property name contains spaces or special characters. Alias: --property-name, --name. |
--idempotency-key | string | No | Generated automatically when omitted. Header acceptance alone does not guarantee retry deduplication. |
--display-name | string | No | |
--description | string | No | |
--is-hidden | boolean | No | |
--classifications | array | No | JSON array, or a comma-separated list for strings. |
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.
amp user-properties delete --project <project_id> --property <property_name> --dry-run
amp user-properties delete --project <project_id> --property <property_name> --yes
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--property | string | Yes | Public user property identifier. Equal to property_name. URL-encode when the property name contains spaces or special characters. Alias: --property-name, --name. |
--dry-run | boolean | No | Validate request without performing mutation. |
--idempotency-key | string | No | Generated automatically when omitted. Header acceptance alone does not guarantee retry deduplication. |
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.