Skip to content

Commit 8ffd839

Browse files
Jiaming Youmeta-codesync[bot]
authored andcommitted
list sent params in README Conversions API step
Summary: The "Send ... to the Conversions API" step in each SDK README only said "Send fbc and fbp", which no longer reflects what the example payload sends. Reword the step heading in all five READMEs to list the actual parameters and their Conversions API placement: `event_source_url` and `referrer_url` at the event level, and `fbc` / `fbp` (plus `client_ip_address`, `em`, `ph` for the NodeJS and PHP SDKs, which also expose client-IP and hashed-PII getters) inside `user_data`. The example payload bodies are unchanged — only the step heading was inaccurate. Java, Python, and Ruby expose only `fbc` / `fbp`, so their headings list just those under `user_data`; NodeJS and PHP additionally list `client_ip_address`, `em`, and `ph`, matching their richer getter set. ___ Differential Revision: D107944008 fbshipit-source-id: c00dad9e3596afab82db2b53fba31ee1883837f6
1 parent 8dd0ede commit 8ffd839

5 files changed

Lines changed: 15 additions & 7 deletions

File tree

java/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,9 @@ String eventSourceUrl = paramBuilder.getEventSourceUrl();
207207
String referrerUrl = paramBuilder.getReferrerUrl();
208208
```
209209

210-
7. Send fbc and fbp back to the Conversions API.
210+
7. Send the parameters back to the Conversions API. `event_source_url` and
211+
`referrer_url` are sent at the event level; `fbc` and `fbp` are sent inside
212+
`user_data`.
211213

212214
```
213215
data=[

nodejs/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,8 +197,9 @@ API is to get normalized and hashed (sha256) PII from input piiValue, supported
197197
198198
```
199199

200-
6. Send fbc, fbp, client_ip_address, email and phone back through Conversions
201-
API under UserData section:
200+
6. Send the parameters back to the Conversions API. `event_source_url` and
201+
`referrer_url` are sent at the event level; `fbc`, `fbp`, `client_ip_address`,
202+
`em` (email) and `ph` (phone) are sent inside `user_data`:
202203

203204
```
204205
data=[

php/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,8 +220,9 @@ API is to get normalized and hashed (sha256) PII from input piiValue, supported
220220
221221
```
222222

223-
6. Send fbc, fbp, client_ip_address, email and phone back through Conversions
224-
API.
223+
6. Send the parameters back to the Conversions API. `event_source_url` and
224+
`referrer_url` are sent at the event level; `fbc`, `fbp`, `client_ip_address`,
225+
`em` (email) and `ph` (phone) are sent inside `user_data`.
225226

226227
```
227228
data=[

python/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,9 @@ event_source_url = paramBuilder.get_event_source_url()
153153
referrer_url = paramBuilder.get_referrer_url()
154154
```
155155

156-
7. Send fbc and fbp back with Conversion API.
156+
7. Send the parameters back to the Conversions API. `event_source_url` and
157+
`referrer_url` are sent at the event level; `fbc` and `fbp` are sent inside
158+
`user_data`.
157159

158160
```
159161
data=[

ruby/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,9 @@ referrer_url = builder.get_referrer_url()
207207
208208
```
209209

210-
7. Send fbc and fbp back with the Conversions API.
210+
7. Send the parameters back to the Conversions API. `event_source_url` and
211+
`referrer_url` are sent at the event level; `fbc` and `fbp` are sent inside
212+
`user_data`.
211213

212214
```
213215

0 commit comments

Comments
 (0)