Commit 2130853
Add Conversions API + Parameter Builder integration sections to READMEs
Summary:
Document the Conversions API (CAPI) and the CAPI Parameter Builder integration
in all five Business SDK READMEs (PHP, NodeJS, Java, Python, Ruby).
The Java/NodeJS/Python/Ruby release READMEs are codegen-generated from
codegen/templates/<lang>/README.md, so the new content is added to BOTH the
templates and the generated release files (kept in sync so codegen.sh is a
no-op). The PHP release README is hand-maintained (no template) and edited
directly.
Each README gains:
- A "Conversions API" section: a basic end-to-end server-side event send
(UserData + CustomData + Event + EventRequest.execute), plus a link to the
advanced features guide (async, concurrent batching, custom HTTP service).
- A "Conversions API Parameter Builder integration" subsection: setRequestContext
/ set_request_context auto-fills empty event fields from the incoming HTTP
request (fbc, fbp, event_source_url, referrer_url), the optional Preference
allowlist, and the non-destructive + order-independent behavior. The
description of what request object to pass links to the "Framework support"
section of the matching capi-param-builder GitHub README.
Per-language accuracy matches the shipped code:
- PHP & NodeJS also document client_ip_address auto-fill and automatic PII
normalization + SHA-256 hashing.
- Java, Python, Ruby note that client_ip_address is not auto-derived yet and
should still be set manually.
Depends on D107207093
Reviewed By: satwikareddy3, xuanjie22
Differential Revision: D108471483
fbshipit-source-id: f3f64ecbd9107bdd41b3c19e8b347821e87889fe1 parent dc91b33 commit 2130853
1 file changed
Lines changed: 57 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
348 | 348 | | |
349 | 349 | | |
350 | 350 | | |
| 351 | + | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
| 361 | + | |
| 362 | + | |
| 363 | + | |
| 364 | + | |
| 365 | + | |
| 366 | + | |
| 367 | + | |
| 368 | + | |
| 369 | + | |
| 370 | + | |
| 371 | + | |
| 372 | + | |
| 373 | + | |
| 374 | + | |
| 375 | + | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
| 382 | + | |
| 383 | + | |
| 384 | + | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
| 396 | + | |
| 397 | + | |
| 398 | + | |
| 399 | + | |
| 400 | + | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
| 406 | + | |
| 407 | + | |
351 | 408 | | |
352 | 409 | | |
353 | 410 | | |
| |||
0 commit comments