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.

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: google ads new UI #1782

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

feat: google ads new UI #1782

wants to merge 1 commit into from

Conversation

aashishmalik
Copy link
Contributor

@aashishmalik aashishmalik commented Nov 4, 2024

What are the changes introduced in this PR?

Write a brief explainer on your code changes.

What is the related Linear task?

Resolves INT-XXX

Please explain the objectives of your changes below

Put down any required details on the broader aspect of your changes. If there are any dependent changes, mandatorily mention them here

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

N/A

Any new dependencies introduced with this change?

N/A

Any new checks got introduced or modified in test suites. Please explain the changes.

N/A


Developer checklist

  • My code follows the style guidelines of this project

  • No breaking changes are being introduced.

  • All related docs linked with the PR?

  • All changes manually tested?

  • Any documentation changes needed with this change?

  • I have executed schemaGenerator tests and updated schema if needed

  • Are sensitive fields marked as secret in definition config?

  • My test cases and placeholders use only masked/sample values for sensitive fields

  • Is the PR limited to 10 file changes & one task?

Reviewer checklist

  • Is the type of change in the PR title appropriate as per the changes?

  • Verified that there are no credentials or confidential data exposed with the changes.

Summary by CodeRabbit

  • New Features

    • Enhanced Google Ads configuration with a modular structure for improved usability.
    • Introduced new fields for Conversion ID and consent settings.
    • Added redirectGroups section for better event mapping and conversion tracking.
  • Improvements

    • Enhanced error handling with specific messages for Conversion ID.
    • Improved organization of configuration settings for easier navigation.

Copy link

coderabbitai bot commented Nov 4, 2024

Walkthrough

The pull request introduces a significant restructuring of the uiConfig for the Google Ads destination within the ui-config.json file. The previous array format has been replaced with an object structure featuring baseTemplate and sdkTemplate sections. This update includes new fields like Conversion ID and consentSettingsTemplate, enhances error handling, and introduces a redirectGroups section for event mapping. Overall, the modifications aim to improve the organization and usability of configuration settings.

Changes

File Path Change Summary
src/configurations/destinations/googleads/ui-config.json Restructured uiConfig from array to object; added Conversion ID, consentSettingsTemplate, and redirectGroups; improved error handling and modularity.

Possibly related PRs

Suggested reviewers

  • lvrach
  • am6010
  • AchuthaSourabhC
  • ssbeefeater
  • debanjan97
  • cisse21
  • ruchiramoitra
  • 1abhishekpandey
  • ItsSudip
  • sandeepdsvs
  • shrouti1507

🐰 In the fields of code, I hop with glee,
New structures and templates, oh what a spree!
Conversion IDs and consent in sight,
Our Google Ads config is now just right!
With modular changes, we dance and play,
A user-friendly interface, hip-hip-hooray! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Nov 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (300f547) to head (5753a0e).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff            @@
##           develop     #1782   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           53        53           
  Branches         7         7           
=========================================
  Hits            53        53           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (4)
src/configurations/destinations/googleads/ui-config.json (4)

251-252: Standardize visibility notes across templates

There are inconsistent "not visible in the ui" notes in different sections. Consider standardizing how visibility is handled across templates instead of using text notes.

Also applies to: 345-345


15-22: Document the Conversion ID regex pattern

The regex pattern allows for template variables, environment variables, and actual conversion IDs, but this flexibility isn't documented in the UI. Consider adding a note explaining the accepted formats:

  • Template variables: {{variable||fallback}}
  • Environment variables: env.VARIABLE
  • Actual conversion IDs: AW-XXXXXXXX

Line range hint 365-371: Optimize feature flag conditions

The feature flag conditions appear redundant. When using OR logic, checking for both value: false and existence is unnecessary as the existence check will always evaluate to true.

            "featureFlags": [
              {
                "configKey": "AMP_enable-gcm",
                "value": false
-              },
-              {
-                "configKey": "AMP_enable-gcm"
              }
            ],

Also applies to: 385-391, 464-470


292-295: Add documentation for Enhanced Conversions

The "Allow Enhanced Conversions" setting should include a note about:

  • Required user data fields (email, phone, etc.)
  • Privacy implications and data handling
  • Link to Google's documentation about enhanced conversions
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 300f547 and 5753a0e.

📒 Files selected for processing (1)
  • src/configurations/destinations/googleads/ui-config.json (5 hunks)

Comment on lines +529 to +531
"name": "Purchase",
"value": "purchase"
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix inconsistent event name casing

The "purchase" event name uses lowercase while all other event names use PascalCase.

                      {
                        "name": "Purchase",
-                        "value": "purchase"
+                        "value": "Purchase"
                      }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"name": "Purchase",
"value": "purchase"
}
"name": "Purchase",
"value": "Purchase"
}

Comment on lines +594 to +595
"label": "Map your RudderStack Events to Facebook Pixel IDs",
"note": "Input the RudderStack event to map to Facebook's pixel id.",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix incorrect provider name in legacy conversion mapping

The label mentions "Facebook Pixel IDs" instead of "Google Ads conversion IDs".

-            "label": "Map your RudderStack Events to Facebook Pixel IDs",
-            "note": "Input the RudderStack event to map to Facebook's pixel id.",
+            "label": "Map your RudderStack Events to Google Ads Conversion IDs",
+            "note": "Input the RudderStack event to map to Google Ads conversion ID.",
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"label": "Map your RudderStack Events to Facebook Pixel IDs",
"note": "Input the RudderStack event to map to Facebook's pixel id.",
"label": "Map your RudderStack Events to Google Ads Conversion IDs",
"note": "Input the RudderStack event to map to Google Ads conversion ID.",

@aashishmalik
Copy link
Contributor Author

OLD SS:

Screenshot 2024-11-04 at 9 42 32 AM Screenshot 2024-11-04 at 9 42 47 AM Screenshot 2024-11-04 at 9 43 33 AM Screenshot 2024-11-04 at 9 43 52 AM

New UI:
Screenshot 2024-11-04 at 9 44 14 AM

Screenshot 2024-11-04 at 9 44 30 AM Screenshot 2024-11-04 at 9 46 05 AM Screenshot 2024-11-04 at 9 46 31 AM Screenshot 2024-11-04 at 9 46 44 AM

@aashishmalik aashishmalik marked this pull request as draft November 4, 2024 05:12
@aashishmalik aashishmalik marked this pull request as ready for review November 6, 2024 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant