Google Ads - update to api v18 #15591
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ |
WalkthroughThis pull request updates several components of the Google Ads integration. The changes include version bumps, documentation URL updates from v16 to v18, changes to API endpoint paths, and a new conditional check in the customer list creation action. Additionally, dependency versions in the package configuration and minor adjustments to property requirements in event sources have been modified. Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant CreateCustomerListAction
Client->>CreateCustomerListAction: Invoke additionalProps(payload)
alt listType provided
CreateCustomerListAction->>CreateCustomerListAction: Process additional properties
CreateCustomerListAction-->>Client: Return processed properties
else listType missing
CreateCustomerListAction-->>Client: Return empty object
end
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
components/google_ads/google_ads.app.mjs (1)
96-98:⚠️ Potential issueReview the base URL configuration
The base URL appears to be pointing to a test endpoint (
eolid4dq1k0t9hi.m.pipedream.net). This should be updated to the official Google Ads API endpoint for production use.- _baseUrl() { - return "https://eolid4dq1k0t9hi.m.pipedream.net"; - }, + _baseUrl() { + return "https://googleads.googleapis.com"; + },
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (10)
components/google_ads/actions/add-contact-to-list-by-email/add-contact-to-list-by-email.mjs(1 hunks)components/google_ads/actions/common/props.mjs(1 hunks)components/google_ads/actions/create-customer-list/common-constants.mjs(5 hunks)components/google_ads/actions/create-customer-list/create-customer-list.mjs(3 hunks)components/google_ads/actions/create-report/create-report.mjs(4 hunks)components/google_ads/actions/send-offline-conversion/send-offline-conversion.mjs(2 hunks)components/google_ads/google_ads.app.mjs(9 hunks)components/google_ads/package.json(2 hunks)components/google_ads/sources/new-campaign-created/new-campaign-created.mjs(1 hunks)components/google_ads/sources/new-lead-form-entry/new-lead-form-entry.mjs(2 hunks)
✅ Files skipped from review due to trivial changes (3)
- components/google_ads/actions/create-customer-list/common-constants.mjs
- components/google_ads/actions/common/props.mjs
- components/google_ads/actions/add-contact-to-list-by-email/add-contact-to-list-by-email.mjs
🧰 Additional context used
🪛 GitHub Check: Lint Code Base
components/google_ads/sources/new-campaign-created/new-campaign-created.mjs
[warning] 16-16:
Component prop customerClientId must have a label. See https://pipedream.com/docs/components/guidelines/#props
[warning] 16-16:
Component prop customerClientId must have a description. See https://pipedream.com/docs/components/guidelines/#props
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: pnpm publish
- GitHub Check: Verify TypeScript components
- GitHub Check: Publish TypeScript components
🔇 Additional comments (13)
components/google_ads/sources/new-campaign-created/new-campaign-created.mjs (2)
9-10: LGTM! Version bump and documentation update.The version increment and documentation URL update align with the Google Ads API v18 migration.
22-22: LGTM! Documentation URL update.The fields description correctly references the v18 API documentation.
components/google_ads/sources/new-lead-form-entry/new-lead-form-entry.mjs (2)
10-11: LGTM! Version bump and documentation update.The version increment and documentation URL update align with the Google Ads API v18 migration.
32-32: LGTM! Documentation URLs update in docsAlert.The docsAlert content correctly references the v18 API documentation for both submission fields and custom submission fields.
components/google_ads/actions/send-offline-conversion/send-offline-conversion.mjs (2)
10-11: LGTM! Version bump and documentation update.The version increment and documentation URL update align with the Google Ads API v18 migration.
23-24: LGTM! Documentation URLs update.The type description and additional fields correctly reference the v18 API documentation.
Also applies to: 26-26
components/google_ads/actions/create-customer-list/create-customer-list.mjs (3)
17-18: LGTM! Version bump and documentation update.The version increment and documentation URL update align with the Google Ads API v18 migration.
36-37: LGTM! Documentation URL update.The list type description correctly references the v18 API documentation.
96-98: LGTM! Improved error handling.Good defensive programming practice to handle the case when listType is not provided.
components/google_ads/google_ads.app.mjs (1)
124-125: API paths correctly updated to v18All API endpoint paths have been consistently updated to use the v18 version of the Google Ads API.
Also applies to: 135-136, 154-155, 219-220, 230-231, 237-238, 246-247
components/google_ads/actions/create-report/create-report.mjs (1)
21-22: Documentation links correctly updated to v18All documentation references have been consistently updated to point to the v18 version of the Google Ads API documentation. Version bump is appropriate for the documentation updates.
Also applies to: 46-47, 109-110, 120-121
components/google_ads/package.json (2)
1-267: Verify all API endpoints after v18 upgradeWhile the code changes look correct, it's important to verify that all API endpoints work as expected after the upgrade to v18.
❌ Verification inconclusive
🏁 Script executed:
#!/bin/bash # Find all Google Ads API endpoint calls to ensure none were missed in the upgrade rg -l "googleads.*v1[0-9]" .Length of output: 30
Manual verification required for API endpoint version updates
The initial automated search using the pattern
"googleads.*v1[0-9]"produced no results, which means we couldn’t conclusively verify the endpoint changes through this regex alone. Please manually verify that the endpoints—particularly those implemented in files likecomponents/google_ads/google_ads.app.mjs—have been updated to v18 and work as expected after the upgrade.
- Check that any API call URLs (e.g., those referencing
googleads.googleapis.comor similar patterns) reflect the v18 endpoint.- Ensure integration tests or manual API tests cover these endpoints.
3-3: Verify compatibility with @pipedream/platform v3The update includes a major version bump of the @pipedream/platform dependency from v1 to v3. This could potentially introduce breaking changes.
Please verify:
- That the codebase is compatible with the new platform version
- Review the changelog for any breaking changes
Also applies to: 16-17
❌ Verification inconclusive
🌐 Web query:
What are the breaking changes in @pipedream/platform v3.0.0?💡 Result:
The provided search results do not explicitly mention breaking changes in @pipedream/platform v3.0.0. However, based on related updates and known issues from other versions and dependencies:
Key Potential Breaking Changes
Axios Dependency Updates
While not directly tied to v3.x.x of@pipedream/platform, earlier updates (e.g., Axios v1.x.x) introduced breaking changes affecting HTTP request handling[7]:
- Query parameters appended via
?in URLs may fail unless explicitly defined usingparams.- Changes in error handling for non-2xx status codes (previously treated as resolved promises).
Managed Authentication Changes
The transition to OAuth-based authentication for services like GitHub might require adjustments in app prop configurations[1][2]:props: { github: { type: "app", app: "github", // Requires updated OAuth setup }, },Recommendations
- Review dependency requirements (e.g.,
axiosusage) and ensure compatibility with newer versions.- Verify authentication flows when using managed auth components[1][9].
- Check for deprecated methods or configuration patterns in SDK calls[2][4].
For precise details on v3.x.x breaking changes, consult official Pipedream release notes or SDK documentation directly[10].
Citations:
- 1: https://pipedream.com/docs/components/actions-quickstart
- 2: https://pipedream.com/docs/connect/api
- 3: https://library.loudoun.gov/Portals/0/Pdf/Library_Policies/FMP_Combined_10.9.2024.pdf?ver=_6jYN9ve4uQUkcAFM3QKMg%3D%3D
- 4: https://github.com/boltops-tools/pipedream/blob/master/CHANGELOG.md
- 5: https://developer.harness.io/release-notes/continuous-integration/
- 6: https://pipedream.com/community/t/any-workflow-can-break-or-become-malicious-at-any-time-and-theres-nothing-you-can-do/5773
- 7: https://pipedream.com/community/t/axios-v1-0-0-release-breaking-changes-and-solutions/3422
- 8: https://deepakn94.github.io/assets/papers/pipedream-sosp19.pdf
- 9: https://releases.pipekit.io/v3/v3.3.2
- 10: https://changelog.pipedream.com/en
Verify compatibility with @pipedream/platform v3
Based on the web query, there isn’t an explicit listing of breaking changes in v3. However, note that:
- Axios Handling: Updates in dependencies (e.g., axios) may alter HTTP request behavior and error handling.
- OAuth/Authentication Flows: Changes in managed authentication (e.g., transitioning to OAuth-based setups) might require adjustments in configuration.
Action Items:
- Confirm that all integration points using the platform’s APIs properly handle any changes—especially around Axios request/response behavior and OAuth configurations.
- Review the official Pipedream changelog/documentation (see https://changelog.pipedream.com/en) for any details that might impact your implementations.
- Run integration tests to ensure the codebase continues to function as expected with the updated dependency.
components/google_ads/sources/new-campaign-created/new-campaign-created.mjs
Show resolved
Hide resolved
Resolves #15559
Summary by CodeRabbit