STRATCONN-6780 - [Pinterest CAPI] - new events and fields#3820
Open
joe-ayoub-segment wants to merge 17 commits into
Open
STRATCONN-6780 - [Pinterest CAPI] - new events and fields#3820joe-ayoub-segment wants to merge 17 commits into
joe-ayoub-segment wants to merge 17 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds support for additional Pinterest Conversions API (CAPI) fields in the pinterest-conversions destination’s reportConversionEvent action, extending the mapped payload and updating tests/snapshots accordingly.
Changes:
- Expanded supported
event_namechoices and updated Pinterest event name constants. - Added new payload fields (
advertiser_tracking_enabled,app_info,device_info) and newcustom_datafields (content_*,predicted_ltv,np) to the outbound request payload. - Updated unit tests and snapshots to reflect the new payload shape.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/destination-actions/src/destinations/pinterest-conversions/reportConversionEvent/index.ts | Adds new action fields and includes them in the request payload mapping. |
| packages/destination-actions/src/destinations/pinterest-conversions/reportConversionEvent/generated-types.ts | Updates generated Payload typings for new fields. |
| packages/destination-actions/src/destinations/pinterest-conversions/reportConversionEvent/tests/index.test.ts | Updates assertions to validate new payload fields without full-body string equality. |
| packages/destination-actions/src/destinations/pinterest-conversions/reportConversionEvent/tests/snapshots/index.test.ts.snap | Updates snapshots to include newly added payload fields. |
| packages/destination-actions/src/destinations/pinterest-conversions/pinterest-capi-custom-data.ts | Adds new custom_data schema fields (including predicted_ltv). |
| packages/destination-actions/src/destinations/pinterest-conversions/constants.ts | Expands Pinterest event name constants and fixes SIGNUP value. |
joe-ayoub-segment
changed the title
- Map app_info.app_id to context.app.build - Map device_info.brand to context.device.manufacturer - Map device_info.carrier to context.network.carrier - Add window_height/window_width defaults to app_info - Change install_time to datetime with unix conversion Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Introduces a `data_format` choice field that controls field visibility: - "Structured Fields" (default for new instances): shows flat custom data fields, contents array, app_info, and device_info objects - "Legacy Fields" (or undefined for existing instances): shows the original nested custom_data object and flat app/device fields Existing integrations are unaffected — they have no value for data_format (undefined), which is treated as legacy via depends_on conditions. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- custom_data_2: object field with all custom data properties except contents - contents: standalone array field with proper @arrayPath default mapping - Both defined with depends_on DEPENDS_ON_STRUCTURED - custom_data_field_2 exported from pinterest-capi-custom-data.ts Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
joe-ayoub-segment
added
the
needs-stage-test
- Define PinterestEventPayload, LegacyPinterestEventPayload, CustomData, UserData, ContentsItem, AppInfo, DeviceInfo in types.ts - Wire up return types on buildCustomData and createPinterestPayload - Fix convertInstallTime to handle 0 correctly - Remove app_id and os_family default mappings - Add advertiser_tracking_enabled assertions to tests - Add test for undefined data_format (existing subscriptions) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
packages/destination-actions/src/destinations/pinterest-conversions/reportConversionEvent/index.ts:439
- The user_data validation rejects payloads that only provide
phone, but the error message explicitly lists Phone Number as an accepted identifier. This can cause valid conversions (phone-only) to fail with a 400 IntegrationError.
if (
isEmpty(payload.user_data?.email) &&
isEmpty(payload.user_data?.hashed_maids) &&
!(payload.user_data?.client_ip_address && payload.user_data?.client_user_agent)
) {
Contributor
There was a problem hiding this comment.
⚠️ Not ready to approve
There’s a confirmed timestamp conversion bug for numeric-string install_time inputs and a misleading user-facing error message that should be corrected for accuracy.
Copilot's findings
- Files reviewed: 8/8 changed files
- Comments generated: 3
Note
Your feedback helps us improve the quality of this feature.
Please use 👍 or 👎 to tell us whether this assessment is correct.
Comment on lines
+489
to
+494
| value: typeof payload.custom_data_2?.value === 'number' ? String(payload.custom_data_2.value) : undefined, | ||
| content_ids: payload.custom_data_2?.content_ids, | ||
| contents: payload.contents?.map((item) => ({ | ||
| ...item, | ||
| item_price: typeof item.item_price === 'number' ? String(item.item_price) : undefined | ||
| })), |
Comment on lines
+502
to
+505
| predicted_ltv: | ||
| typeof payload.custom_data_2?.predicted_ltv === 'number' | ||
| ? String(payload.custom_data_2.predicted_ltv) | ||
| : undefined, |
Comment on lines
+13
to
+19
| const DEPENDS_ON_LEGACY: DependsOnConditions = { | ||
| match: 'any', | ||
| conditions: [ | ||
| { fieldKey: 'data_format', operator: 'is', value: 'legacy' }, | ||
| { fieldKey: 'data_format', operator: 'is', value: undefined } | ||
| ] | ||
| } |
Comment on lines
+468
to
+475
| function buildAppInfo(payload: Payload) { | ||
| const appInfo = { | ||
| ...payload.app_info, | ||
| install_time: convertInstallTime(payload.app_info?.install_time) | ||
| } | ||
| const hasContent = Object.values(appInfo).some((v) => v !== undefined && v !== null) | ||
| return hasContent ? appInfo : undefined | ||
| } |
Comment on lines
+483
to
+487
| function buildCustomData(payload: Payload): CustomData { | ||
| const isStructured = payload.data_format === 'latest' | ||
|
|
||
| if (isStructured) { | ||
| return { |
Comment on lines
24
to
28
| VIEW_CATEGORY: 'view_category', | ||
| WATCH_VIDEO: 'watch_video' | ||
| VIEW_CONTENT: 'view_content', | ||
| WATCH_VIDEO: 'watch_video', | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pinterest CAPI destiantion - adding support for new events and fields.
contact, customize_product, find_location, initiate_checkout, schedule, start_trial, submit_application,
subscribe, view_content
custom_data.content_brand, custom_data.content_category, custom_data.content_name, custom_data.predicted_ltv,
custom_data.np, and contents[].item_brand, contents[].item_brand_id, contents[].item_category,
contents[].item_name
(standalone array with @arrayPath defaults from Segment ecommerce spec), app_info, and device_info
app_name, app_version, device_brand, device_carrier, device_model, device_type, os_version fields
legacy via depends_on conditions
Trial, Subscribe, View Content) mapped to Segment spec event names
partner_name)
LegacyPinterestEventPayload, CustomData, UserData, ContentsItem, AppInfo, DeviceInfo)
dates
Testing
To be tested in Staging
Unt test changes:
Removed:
Restructured existing tests:
behavior
New tests added:
no app_info/device_info)
- Verifies app_name is not required when data_format: 'latest' (succeeds without it)
- Verifies app_name is required when data_format: 'legacy' (throws without it)
Assertions added to existing tests:
Security Review
Please ensure sensitive data is properly protected in your integration.
type: 'password'New Destination Checklist
verioning-info.tsfile. example