How do I set `user_properties` on identify calls with ampli?

This page here say that the ampli will generate an identify method with an overload that looks like:

ampli.identify('user_id', {/* user props */}, {/* amplitude options */ })<br />

but that isn’t what I see with `@amplitude/ampli/1.31.0 darwin-arm64 node-v18.14.1` / `@amplitude/analytics-browser@1.9.1`

  /**<br />   * Identify a user and set user properties.<br />   *<br />   * @param userId The user's id.<br />   * @param options Optional event options.<br />   */<br />  identify(<br />    userId: string | undefined,<br />    options?: EventOptions,<br />  ): PromiseResult<Result> {<br />    if (!this.isInitializedAndEnabled()) {<br />      return getVoidPromiseResult();<br />    }<br /><br />    if (userId) {<br />      options = {...options,  user_id: userId};<br />    }<br /><br />    const amplitudeIdentify = new amplitude.Identify();<br />    return this.amplitude!.identify(<br />      amplitudeIdentify,<br />      options,<br />    );<br />  }<br />

type `EventOptions` looks promising, especially the `.extra` field -- but when passing values into that field, do not see them in the user_properties event of the outgoing identify requests.

I can and will drop down to the untyped SDK, but how am I supposed to do this with the ampli wrapper?

Find more posts tagged with

User Properties

Ampli SDK

Accepted answers

PatrickGravity

I was able to get help in another channel.

The issue is that user properties are also strongly typed by Ampli, so I needed the product team to add this to the tracking plan on amplitude, not just ask me to provide the property. Once that happened, Ampli generated the necessary code to handle the new properties.

All comments

PatrickGravity

The empty user_properties even is created here in the event-builder:

At that point, the eventOptions are dropped. It seems like the Ampli SDK is failing to set any of the event properties except for the userId and device id on the Identify class instance, and the event-builder expects them to be on the Identify instance not the eventOptions (it just runs Identify.get)

So you’d expect this addition to the generated code to fix it:

And it does:

This is starting to feel like a “your problem” thing.

Jeremie Gluckman

Hi PatrickGravity, please excuse the delay here. Somehow we missed your reply. Were you able to make progress here?

PatrickGravity

I was able to get help in another channel.

Quick Links

Unanswered Questions

time format on import from Big Query
I am running into a loop when attempting to import data from BigQuery. At origin, my data is already in milliseconds since epoch. If I query: event_time as time, I get the error: 1.'time' column should be a TIMESTAMP_NTZ column (Snowflake) or a TIMESTAMP column (BigQuery). example for the type of 'time' column is…
Import data from one amplitude account to another
How do I transfer data from one amplitude account to another? It seems all the community chats about this have completely broken links. Easy to export, no way to import, very frustrating. :(
@amplitude/plugin-web-vitals-browser build fails on CRA v4 (react-scripts@4.0.3)
When using @amplitude/plugin-web-vitals-browser with Create React App v4 (react-scripts@4.0.3), the build fails with: ./node_modules/@amplitude/plugin-web-vitals-browser/node_modules/web-vitals/dist/web-vitals.js<br /><br />SyntaxError:…
Question about Amplitude Export API Data Delay
Hello, I'm using SpringBoot and Kotlin to integrate with the Amplitude Export API. The official Amplitude documentation (https://amplitude.com/docs/apis/analytics/export) states that "data is available to export at a minimum within 2 hours of when the servers received it." However, there's no clear information about the…
Retrieve via the API users based on a user property
Hello, Is there a way to make a query like: “Give me all the users that have the user property X equal to 10”, by using just any of the APIs, without making a cohort first through the Amplitude’s UI? Thank you!