Commit 54bc252
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 3ac00cd commit 54bc252
1 file changed
Lines changed: 59 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
408 | 408 | | |
409 | 409 | | |
410 | 410 | | |
| 411 | + | |
| 412 | + | |
| 413 | + | |
| 414 | + | |
| 415 | + | |
| 416 | + | |
| 417 | + | |
| 418 | + | |
| 419 | + | |
| 420 | + | |
| 421 | + | |
| 422 | + | |
| 423 | + | |
| 424 | + | |
| 425 | + | |
| 426 | + | |
| 427 | + | |
| 428 | + | |
| 429 | + | |
| 430 | + | |
| 431 | + | |
| 432 | + | |
| 433 | + | |
| 434 | + | |
| 435 | + | |
| 436 | + | |
| 437 | + | |
| 438 | + | |
| 439 | + | |
| 440 | + | |
| 441 | + | |
| 442 | + | |
| 443 | + | |
| 444 | + | |
| 445 | + | |
| 446 | + | |
| 447 | + | |
| 448 | + | |
| 449 | + | |
| 450 | + | |
| 451 | + | |
| 452 | + | |
| 453 | + | |
| 454 | + | |
| 455 | + | |
| 456 | + | |
| 457 | + | |
| 458 | + | |
| 459 | + | |
| 460 | + | |
| 461 | + | |
| 462 | + | |
| 463 | + | |
| 464 | + | |
| 465 | + | |
| 466 | + | |
| 467 | + | |
| 468 | + | |
| 469 | + | |
411 | 470 | | |
412 | 471 | | |
413 | 472 | | |
| |||
0 commit comments