Adding documentation for using Google Ads in the Connect Proxy #16548
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Skipped Deployments
|
WalkthroughThe README documentation for the Google Ads component was updated to clarify the scope of API request customization within the Pipedream workflow builder. The example Google Ads API endpoint version was updated from v16 to v18. The description of the internal proxy service was revised to emphasize its role in protecting the developer token. A new section was added detailing how to use Google Ads with the Connect API Proxy, including example code for both the Pipedream SDK and Connect REST API, and guidance on structuring requests through the proxy. Changes
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
dannyroosevelt
changed the title
![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
🧹 Nitpick comments (2)
components/google_ads/README.md (2)
22-24: Fix typo and improve clarity in documentation heading
There's a typo in "interal proxy service" and the heading could be more concise.Proposed diff:
- ## Customizing API requests from within the Pipedream workflow builder + ## Customizing API Requests in the Pipedream Workflow Builder - The Pipedream components interact with Google Ads API through an interal proxy service, which protects Pipedream's developer token. + The Pipedream components interact with the Google Ads API through an internal proxy service that protects Pipedream's developer token.
129-133: Remove inline comments from JSON payload
JSON does not support comments. The inline# "data": {} #may confuse users or break thecurlcommand. Consider removing it from the payload and moving the note into the narrative text.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/google_ads/README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
components/google_ads/README.md
[duplication] ~70-~70: Possible typo: you repeated a word.
Context: ... Google Ads URL with the url param in the body - The method to the Connect Proxy should al...
(ENGLISH_WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Verify TypeScript components
- GitHub Check: pnpm publish
- GitHub Check: Publish TypeScript components
- GitHub Check: Lint Code Base
🔇 Additional comments (3)
components/google_ads/README.md (3)
61-61: Confirmation: Proxy endpoint unchanged
The clarification that the proxy endpoint remainshttps://googleads.m.pipedream.netis clear and accurate.
63-71: New section on Connect API Proxy is clear
The "Using Google Ads with the Connect API Proxy" section and its important notes are well-structured and informative.🧰 Tools
🪛 LanguageTool
[duplication] ~70-~70: Possible typo: you repeated a word.
Context: ... Google Ads URL with theurlparam in thebody- Themethodto the Connect Proxy should al...(ENGLISH_WORD_REPEAT_RULE)
76-106: Verify support for thev19endpoint in the SDK example
The Pipedream SDK example nests a Google Ads request at/v19/customers:listAccessibleCustomers. Ensure that the Connect Proxy currently supports v19. If not, update to the supported version and clarify in the docs.
WHY
Summary by CodeRabbit