Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update on twitter_ads #3856

Merged
merged 3 commits into from
Nov 8, 2024
Merged

feat: update on twitter_ads #3856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4850299
feat: update on twitter_ads
aanshi07 Nov 7, 2024
bf143a0
Merge branch 'develop' into feat.update_on_twitter_ads
aanshi07 Nov 7, 2024
25332fe
Merge branch 'develop' into feat.update_on_twitter_ads
aanshi07 Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/v0/destinations/twitter_ads/data/TwitterAdsTrackConfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,13 @@
"destKey": "contents",
"sourceKeys": "properties.contents",
"required": false
},
{
"destKey": "ip_address",
"sourceKeys": ["context.ip", "request_ip"]
},
{
"destKey": "user_agent",
"sourceKeys": "context.userAgent"
}
]
24 changes: 22 additions & 2 deletions src/v0/destinations/twitter_ads/transform.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,20 @@ function processTrack(message, metadata, destination) {
identifiers.push({ twclid: message.properties.twclid });
}

if (message.properties.ip_address) {
const ipAddress = message.properties.ip_address.trim();
if (ipAddress) {
identifiers.push({ ip_address: ipAddress });
}
}

if (message.properties.user_agent) {
const userAgent = message.properties.user_agent.trim();
if (userAgent) {
identifiers.push({ user_agent: userAgent });
}
}

requestJson = populateContents(requestJson);

requestJson.identifiers = identifiers;
Expand All @@ -149,9 +163,15 @@ function validateRequest(message) {
);
}

if (!properties.email && !properties.phone && !properties.twclid) {
if (
!properties.email &&
!properties.phone &&
!properties.twclid &&
!properties.ip_address &&
!properties.user_agent
) {
throw new InstrumentationError(
'[TWITTER ADS]: one of twclid, phone or email must be present in properties.',
'[TWITTER ADS]: one of twclid, phone, email, ip_address or user_agent must be present in properties.',
);
}
}
Expand Down
233 changes: 232 additions & 1 deletion test/integrations/destinations/twitter_ads/processor/data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ export const data = [
conversion_time: '2023-06-01T06:03:08.739Z',
number_items: 2,
price_currency: 'USD',
user_agent: 'chrome',
value: '25',
conversion_id: '213123',
contents: [
Expand Down Expand Up @@ -290,7 +291,8 @@ export const data = [
},
},
statusCode: 400,
error: '[TWITTER ADS]: one of twclid, phone or email must be present in properties.',
error:
'[TWITTER ADS]: one of twclid, phone, email, ip_address or user_agent must be present in properties.',
statTags: {
errorCategory: 'dataValidation',
errorType: 'instrumentation',
Expand Down Expand Up @@ -424,6 +426,7 @@ export const data = [
conversion_time: '2023-06-01T06:03:08.739Z',
number_items: 2,
price_currency: 'USD',
user_agent: 'chrome',
value: '25.55',
conversion_id: '213123',
identifiers: [
Expand Down Expand Up @@ -842,6 +845,7 @@ export const data = [
conversion_time: '2023-06-01T06:03:08.739Z',
number_items: 2,
price_currency: 'USD',
user_agent: 'chrome',
value: '25',
conversion_id: '213123',
contents: [
Expand Down Expand Up @@ -894,6 +898,233 @@ export const data = [
},
},
},
{
name: 'twitter_ads',
description: 'Test case for track event with ip_address as an identifier',
feature: 'processor',
module: 'destination',
version: 'v0',
input: {
request: {
body: [
{
message: {
type: 'track',
event: 'Home Page Viewed',
channel: 'web',
context: {
source: 'test',
userAgent: 'chrome',
traits: {
anonymousId: '50be5c78-6c3f-4b60-be84-97805a316fb1',
email: '[email protected]',
phone: '+1234589947',
ge: 'male',
},
device: {
advertisingId: 'abc123',
},
library: {
name: 'rudder-sdk-ruby-sync',
version: '1.0.6',
},
},
messageId: '7208bbb6-2c4e-45bb-bf5b-ad426f3593e9',
timestamp: '2020-08-14T05:30:30.118Z',
properties: {
affiliation: 'Google Store',
checkout_id: 'fksdjfsdjfisjf9sdfjsd9f',
ip_address: '8.25.197.25',
},
anonymousId: '50be5c78-6c3f-4b60-be84-97805a316fb1',
integrations: {
All: true,
},
},
metadata: {
secret: {
consumerKey: 'qwe',
consumerSecret: 'fdghv',
accessToken: 'dummyAccessToken',
accessTokenSecret: 'testAccessTokenSecret',
},
},
destination: {
Config: {
pixelId: 'dummyPixelId',
rudderAccountId: '2EOknn1JNH7WK1MfNku4fGYKkRK',
twitterAdsEventNames: [
{
rudderEventName: 'ABC Searched',
twitterEventId: 'tw-234234324234',
},
{
rudderEventName: 'Home Page Viewed',
twitterEventId: 'tw-odt2o-odt2q',
},
],
},
},
},
],
},
},
output: {
response: {
status: 200,
body: [
{
output: {
version: '1',
type: 'REST',
method: 'POST',
endpoint: 'https://ads-api.twitter.com/12/measurement/conversions/dummyPixelId',
headers: {
Authorization: authHeaderConstant,
'Content-Type': 'application/json',
},
params: {},
body: {
JSON: {
conversions: [
{
conversion_time: '2020-08-14T05:30:30.118Z',
user_agent: 'chrome',
event_id: 'tw-odt2o-odt2q',
identifiers: [
{
ip_address: '8.25.197.25',
},
],
},
],
},
JSON_ARRAY: {},
XML: {},
FORM: {},
},
files: {},
userId: '',
},
metadata: {
secret: {
consumerKey: 'qwe',
consumerSecret: 'fdghv',
accessToken: 'dummyAccessToken',
accessTokenSecret: 'testAccessTokenSecret',
},
},
statusCode: 200,
},
],
},
},
},
{
name: 'twitter_ads',
description: 'Test case for track event with user_agent as an identifier',
feature: 'processor',
module: 'destination',
version: 'v0',
input: {
request: {
body: [
{
message: {
type: 'track',
event: 'Home Page Viewed',
channel: 'web',
context: {
source: 'test',
traits: {
anonymousId: '50be5c78-6c3f-4b60-be84-97805a316fb1',
email: '[email protected]',
phone: '+1234589947',
ge: 'male',
},
},
properties: {
affiliation: 'Google Store',
user_agent:
' Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36.',
},
anonymousId: '50be5c78-6c3f-4b60-be84-97805a316fb1',
integrations: {
All: true,
},
},
metadata: {
secret: {
accessTokenSecret: 'testAccessTokenSecret',
},
},
destination: {
Config: {
pixelId: 'dummyPixelId',
rudderAccountId: '2EOknn1JNH7WK1MfNku4fGYKkRK',
twitterAdsEventNames: [
{
rudderEventName: 'ABC Searched',
twitterEventId: 'tw-234234324234',
},
{
rudderEventName: 'Home Page Viewed',
twitterEventId: 'tw-odt2o-odt2q',
},
],
},
},
},
],
},
},
output: {
response: {
status: 200,
body: [
{
output: {
version: '1',
type: 'REST',
method: 'POST',
endpoint: 'https://ads-api.twitter.com/12/measurement/conversions/dummyPixelId',
headers: {
Authorization: authHeaderConstant,
'Content-Type': 'application/json',
},
params: {},
body: {
JSON: {
conversions: [
{
event_id: 'tw-odt2o-odt2q',
identifiers: [
{
user_agent:
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36.',
},
],
},
],
},
JSON_ARRAY: {},
XML: {},
FORM: {},
},
files: {},
userId: '',
},
metadata: {
secret: {
accessTokenSecret: 'testAccessTokenSecret',
},
},
statusCode: 200,
},
],
},
},
},
].map((tc) => ({
...tc,
mockFns: (_) => {
Expand Down
1 change: 1 addition & 0 deletions test/integrations/destinations/twitter_ads/router/data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ export const data = [
],
number_items: 2,
price_currency: 'USD',
user_agent: 'chrome',
value: '25',
},
],
Expand Down
Loading