@pipedream/google_ads 0.3.2 → 0.4.0

package/README.md

@@ -19,16 +19,16 @@ such as creating and managing campaigns, adding and removing keywords, and
 adjusting bids. You can also use the API to get information about your
 campaigns, such as campaign stats, keyword stats, and ad performance.
 
-## Customizing API requests with the Pipedream proxy
+## Customizing API requests from within the Pipedream workflow builder
 
-The Pipedream components interact with Google Ads API through Pipedream's proxy service, which handles authentication and developer token requirements.
+The Pipedream components interact with Google Ads API through an interal proxy service, which protects Pipedream's developer token.
 
 The component accepts a standard Google Ads API request object with the following structure:
 
 ```javascript
 const googleAdsReq = {
   method: "get|post|put|delete", // HTTP method
-  url: "/v16/...", // Google Ads API endpoint path
+  url: "/v21/...", // Google Ads API endpoint path
   headers: {
     Authorization: `Bearer ${this.googleAds.$auth.oauth_access_token}`,
   },
@@ -58,4 +58,65 @@ const googleAdsReq = {
 };
 ```
 
-The proxy endpoint will remain the same: `https://googleads.m.pipedream.net`
+**The proxy endpoint will remain the same: `https://googleads.m.pipedream.net`**
+
+## Using Google Ads with the Connect API Proxy
+
+To interface with Google Ads via the [Connect API Proxy](https://pipedream.com/docs/connect/api-proxy), you need to nest the request like this:
+
+**Important notes:**
+
+- The upstream URL in this case is Pipedream's proxy service for Google Ads: `https://googleads.m.pipedream.net`
+- Like in the above examples, you'll define the Google Ads URL with the `url` param in the `body`
+- The `method` to the Connect Proxy should always be a `POST`, since it's actually targeting the Google Ads proxy (you can define the method for the Google Ads request in `options.body.method`)
+
+### Using the Pipedream SDK
+
+```javascript
+const pd = createBackendClient({
+  apiHost: process.env.API_HOST,
+  credentials: {
+    clientId: process.env.CLIENT_ID,
+    clientSecret: process.env.CLIENT_SECRET,
+  },
+  environment: process.env.ENVIRONMENT,
+  projectId: process.env.PROJECT_ID,
+});
+
+const pdGoogleAdsUrl = "https://googleads.m.pipedream.net";
+
+const resp = await pd.makeProxyRequest(
+  {
+    searchParams: {
+      external_user_id: process.env.EXTERNAL_USER_ID,
+      account_id: process.env.ACCOUNT_ID,
+    },
+  },
+  {
+    url: pdGoogleAdsUrl,
+    options: {
+      method: "POST",
+      body: {
+        url: "/v19/customers:listAccessibleCustomers",
+        method: "GET",
+        // data: {} // If you need to send a body with a POST request, define it here
+      },
+    },
+  }
+);
+```
+
+### Using the Connect REST API
+
+- Remember to use the Base64 encoded Pipedream endpoint for Google Ads: `https://googleads.m.pipedream.net`
+
+```bash
+curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/proxy/{url_safe_base64_encoded_url}?external_user_id={external_user_id}&account_id={apn_xxxxxxx}" \
+  -H "Authorization: Bearer {access_token}" \
+  -H "x-pd-environment: {development | production}" \
+  -d '{
+    "url": "/v19/customers:listAccessibleCustomers",
+    "method": "GET",
+    # "data": {} # If you need to send a body with a POST request, define it here
+  }'
+```

package/actions/add-contact-to-list-by-email/add-contact-to-list-by-email.mjs

@@ -7,7 +7,12 @@ export default {
   key: "google_ads-add-contact-to-list-by-email",
   name: "Add Contact to Customer List by Email",
   description: "Adds a contact to a specific customer list in Google Ads. Lists typically update in 6 to 12 hours after operation. [See the documentation](https://developers.google.com/google-ads/api/docs/remarketing/audience-segments/customer-match/get-started)",
-  version: "0.1.3",
+  version: "0.1.6",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     ...common.props,

package/actions/common/props.mjs

@@ -1,5 +1,5 @@
 const DEFAULT_DOCS =
-  "https://developers.google.com/google-ads/api/rest/reference/rest/v18/UserList";
+  "https://developers.google.com/google-ads/api/reference/rpc/v21/UserList";
 
 export const getAdditionalFields = (docsLink = DEFAULT_DOCS) => ({
   type: "object",

package/actions/create-customer-list/common-constants.mjs

@@ -57,7 +57,7 @@ const USER_LIST_CRM_BASED_PROPS = {
     type: "string",
     label: "App ID",
     description:
-      "A string that uniquely identifies a mobile application from which the data was collected. [See the documentation](https://developers.google.com/google-ads/api/rest/reference/rest/v18/UserList#CrmBasedUserListInfo) for more details.",
+      "A string that uniquely identifies a mobile application from which the data was collected. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/CrmBasedUserListInfo) for more details.",
     optional: true,
   },
 };
@@ -74,7 +74,7 @@ const USER_LIST_RULE_BASED_PROPS = {
     type: "object",
     label: "Flexible Rule Customer List",
     description:
-      "Flexible rule representation of visitors with one or multiple actions. [See the documentation](https://developers.google.com/google-ads/api/rest/reference/rest/v18/UserList#FlexibleRuleUserListInfo) on how to build this object. Values will be parsed as JSON where applicable.",
+      "Flexible rule representation of visitors with one or multiple actions. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/FlexibleRuleUserListInfo) on how to build this object. Values will be parsed as JSON where applicable.",
     optional: true,
   },
 };
@@ -84,7 +84,7 @@ const USER_LIST_LOGICAL_PROPS = {
     type: "string[]",
     label: "Rules",
     description:
-      "Logical list rules that define this customer list. [See the documentation](https://developers.google.com/google-ads/api/rest/reference/rest/v18/UserList#UserListLogicalRuleInfo) on how to build each object. Values will be parsed as JSON where applicable.",
+      "Logical list rules that define this customer list. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/UserListLogicalRuleInfo) on how to build each object. Values will be parsed as JSON where applicable.",
   },
 };
 
@@ -92,7 +92,7 @@ const USER_LIST_BASIC_PROPS = {
   conversionActions: {
     type: "string[]",
     label: "Conversion action(s)",
-    description: "One or more [conversion actions](https://developers.google.com/google-ads/api/rest/reference/rest/v18/ConversionAction) to build the list with.",
+    description: "One or more [conversion actions](https://developers.google.com/google-ads/api/reference/rpc/v21/ConversionAction) to build the list with.",
     optional: true,
     options: async() => {
       const {
@@ -115,7 +115,7 @@ const USER_LIST_BASIC_PROPS = {
   remarketingActions: {
     type: "string[]",
     label: "Remarketing action(s)",
-    description: "One or more [remarketing actions](https://developers.google.com/google-ads/api/rest/reference/rest/v18/RemarketingAction).",
+    description: "One or more [remarketing actions](https://developers.google.com/google-ads/api/reference/rpc/v21/RemarketingAction).",
     optional: true,
     options: async() => {
       const {
@@ -198,21 +198,21 @@ export const USER_LIST_TYPE_OPTIONS = [
     label: "CRM-based - a list of provided customers",
     value: USER_LIST_TYPES.CRM_BASED,
     docsLink:
-      "https://developers.google.com/google-ads/api/rest/reference/rest/v18/UserList#CrmBasedUserListInfo",
+      "https://developers.google.com/google-ads/api/reference/rpc/v21/CrmBasedUserListInfo",
     props: USER_LIST_CRM_BASED_PROPS,
   },
   {
     label: "Rule-Based - a customer list generated by a rule",
     value: USER_LIST_TYPES.RULE_BASED,
     docsLink:
-      "https://developers.google.com/google-ads/api/rest/reference/rest/v18/UserList#RuleBasedUserListInfo",
+      "https://developers.google.com/google-ads/api/reference/rpc/v21/RuleBasedUserListInfo",
     props: USER_LIST_RULE_BASED_PROPS,
   },
   {
     label: "Logical - a custom combination of customer lists",
     value: USER_LIST_TYPES.LOGICAL,
     docsLink:
-      "https://developers.google.com/google-ads/api/rest/reference/rest/v18/UserList#LogicalUserListInfo",
+      "https://developers.google.com/google-ads/api/reference/rpc/v21/LogicalUserListInfo",
     props: USER_LIST_LOGICAL_PROPS,
   },
   {
@@ -220,7 +220,7 @@ export const USER_LIST_TYPE_OPTIONS = [
       "Basic - a customer list targeting as a collection of conversions or remarketing actions",
     value: USER_LIST_TYPES.BASIC,
     docsLink:
-      "https://developers.google.com/google-ads/api/rest/reference/rest/v18/UserList#BasicUserListInfo",
+      "https://developers.google.com/google-ads/api/reference/rpc/v21/BasicUserListInfo",
     props: USER_LIST_BASIC_PROPS,
   },
   {
@@ -228,7 +228,7 @@ export const USER_LIST_TYPE_OPTIONS = [
       "Lookalike - a list composed of customers similar to those of a configurable seed",
     value: USER_LIST_TYPES.LOOKALIKE,
     docsLink:
-      "https://developers.google.com/google-ads/api/rest/reference/rest/v18/UserList#LookalikeUserListInfo",
+      "https://developers.google.com/google-ads/api/reference/rpc/v21/LookalikeUserListInfo",
     props: USER_LIST_LOOKALIKE_PROPS,
   },
 ];

package/actions/create-customer-list/create-customer-list.mjs

@@ -14,8 +14,13 @@ export default {
   ...common,
   key: "google_ads-create-customer-list",
   name: "Create Customer List",
-  description: "Create a new customer list in Google Ads. [See the documentation](https://developers.google.com/google-ads/api/rest/reference/rest/v18/UserList)",
-  version: "0.0.4",
+  description: "Create a new customer list in Google Ads. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/UserList)",
+  version: "0.0.7",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     ...common.props,
@@ -33,7 +38,7 @@ export default {
     listType: {
       type: "string",
       label: "List Type",
-      description: "The [type of customer list](https://developers.google.com/google-ads/api/rest/reference/rest/v18/UserList#CrmBasedUserListInfo) to create.",
+      description: "The [type of customer list](https://developers.google.com/google-ads/api/reference/rpc/v21/CrmBasedUserListInfo) to create.",
       options: USER_LIST_TYPE_OPTIONS.map(({
         label, value,
       }) => ({

package/actions/create-report/create-report.mjs

@@ -18,8 +18,13 @@ export default {
   ...common,
   key: "google_ads-create-report",
   name: "Create Report",
-  description: "Generates a report from your Google Ads data. [See the documentation](https://developers.google.com/google-ads/api/fields/v18/overview)",
-  version: "0.1.2",
+  description: "Generates a report from your Google Ads data. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.1.5",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     ...common.props,
@@ -43,7 +48,7 @@ export default {
       docsAlert: {
         type: "alert",
         alertType: "info",
-        content: `[See the documentation](https://developers.google.com/google-ads/api/fields/v18/${value}) for more information on available fields, segments and metrics.`,
+        content: `[See the documentation](https://developers.google.com/google-ads/api/fields/v21/${value}) for more information on available fields, segments and metrics.`,
       },
       objectFilter: {
         type: "string[]",
@@ -106,7 +111,7 @@ export default {
       segments: {
         type: "string[]",
         label: "Segments",
-        description: "Select any segments you want to include in your report. See the documentation [here](https://developers.google.com/google-ads/api/fields/v18/segments)",
+        description: "Select any segments you want to include in your report. See the documentation [here](https://developers.google.com/google-ads/api/reference/rpc/v21/Segments)",
         options: resource.segments,
         default: [
           "segments.date",
@@ -117,7 +122,7 @@ export default {
       metrics: {
         type: "string[]",
         label: "Metrics",
-        description: "Select any metrics you want to include in your report. See the documentation [here](https://developers.google.com/google-ads/api/fields/v18/metrics)",
+        description: "Select any metrics you want to include in your report. See the documentation [here](https://developers.google.com/google-ads/api/reference/rpc/v21/Metrics)",
         options: resource.metrics,
         optional: true,
         reloadProps: true,

package/actions/generate-keyword-ideas/generate-keyword-ideas.mjs

@@ -0,0 +1,55 @@
+import googleAds from "../../google_ads.app.mjs";
+import { getAdditionalFields } from "../common/props.mjs";
+import {
+  parseObject, parseStringObject,
+} from "../../common/utils.mjs";
+const docLink = "https://developers.google.com/google-ads/api/reference/rpc/v22/KeywordPlanIdeaService/GenerateKeywordIdeas?transport=rest";
+
+export default {
+  key: "google_ads-generate-keyword-ideas",
+  name: "Generate Keyword Ideas",
+  description: `Generate keyword ideas using the Google Ads API. [See the documentation](${docLink})`,
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: false,
+    },
+    additionalFields: {
+      ...getAdditionalFields(docLink),
+      optional: false,
+    },
+  },
+  async run({ $ }) {
+    const additionalFields = parseObject(parseStringObject(this.additionalFields));
+    const response = await this.googleAds.generateKeywordIdeas({
+      $,
+      accountId: this.accountId,
+      customerClientId: this.customerClientId,
+      data: {
+        ...additionalFields,
+      },
+    });
+    $.export("$summary", "Successfully generated keyword ideas.");
+    return response;
+  },
+};

package/actions/send-offline-conversion/send-offline-conversion.mjs

@@ -7,8 +7,13 @@ export default {
   ...common,
   key: "google_ads-send-offline-conversion",
   name: "Send Offline Conversion",
-  description: "Send an event from to Google Ads to track offline conversions. [See the documentation](https://developers.google.com/google-ads/api/rest/reference/rest/v18/ConversionAction)",
-  version: "0.0.4",
+  description: "Send an event to Google Ads to track offline conversions. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/ConversionAction)",
+  version: "0.0.7",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     ...common.props,
@@ -20,10 +25,10 @@ export default {
     type: {
       type: "string",
       label: "Type",
-      description: "[The type](https://developers.google.com/google-ads/api/rest/reference/rest/v18/ConversionAction#ConversionActionType) of the conversion action.",
+      description: "[The type](https://developers.google.com/google-ads/api/reference/rpc/v21/ConversionActionTypeEnum.ConversionActionType) of the conversion action.",
       options: CONVERSION_TYPE_OPTIONS,
     },
-    additionalFields: getAdditionalFields("https://developers.google.com/google-ads/api/rest/reference/rest/v18/ConversionAction"),
+    additionalFields: getAdditionalFields("https://developers.google.com/google-ads/api/reference/rpc/v21/ConversionAction"),
   },
   async run({ $ }) {
     const {

package/google_ads.app.mjs

@@ -34,7 +34,7 @@ export default {
     accountId: {
       type: "string",
       label: "Use Google Ads As",
-      description: "Select an account from the list of [customers directly accessible by the authenticated user](https://developers.google.com/google-ads/api/rest/reference/rest/v18/customers/listAccessibleCustomers). This is usually a **Manager Account**, used as `login-customer-id`",
+      description: "Select an account from the list of [customers directly accessible by the authenticated user](https://developers.google.com/google-ads/api/reference/rpc/v21/CustomerService/ListAccessibleCustomers?transport=rest). This is usually a **Manager Account**, used as `login-customer-id`",
       async options() {
         const response = await this.listAccessibleCustomers();
         return response?.map(((resourceName) => ({
@@ -46,7 +46,7 @@ export default {
     customerClientId: {
       type: "string",
       label: "Managed Account",
-      description: "Select a [customer client](https://developers.google.com/google-ads/api/reference/rpc/v18/CustomerClient) from the list of [customers linked to the selected account](https://developers.google.com/google-ads/api/docs/account-management/get-account-hierarchy).",
+      description: "Select a [customer client](https://developers.google.com/google-ads/api/reference/rpc/v21/CustomerClient) from the list of [customers linked to the selected account](https://developers.google.com/google-ads/api/docs/account-management/get-account-hierarchy).",
       useQuery: true,
       optional: true,
       async options({
@@ -71,7 +71,7 @@ export default {
     leadFormId: {
       type: "string",
       label: "Lead Form ID",
-      description: "Select a [Lead Form](https://developers.google.com/google-ads/api/rest/reference/rest/v18/Asset#LeadFormAsset) to watch for new entries.",
+      description: "Select a [Lead Form](https://developers.google.com/google-ads/api/reference/rpc/v21/LeadFormAsset) to watch for new entries.",
       async options({
         accountId, customerClientId,
       }) {
@@ -121,7 +121,7 @@ export default {
     }) {
       console.log("Executing query: ", query);
       const response = await this._makeRequest({
-        path: "/v18/customers/{customerClientId}/googleAds:search",
+        path: "/v21/customers/{customerClientId}/googleAds:search",
         method: "post",
         data: {
           query,
@@ -132,7 +132,7 @@ export default {
     },
     async listAccessibleCustomers() {
       const response = await this._makeRequest({
-        path: "/v18/customers:listAccessibleCustomers",
+        path: "/v21/customers:listAccessibleCustomers",
       });
       return response.resourceNames;
     },
@@ -151,7 +151,7 @@ export default {
     },
     async createUserList(args) {
       const response = await this._makeRequest({
-        path: "v18/customers/{customerClientId}/userLists:mutate",
+        path: "/v21/customers/{customerClientId}/userLists:mutate",
         method: "post",
         ...args,
       });
@@ -216,7 +216,7 @@ export default {
     },
     async createConversionAction(args) {
       const response = await this._makeRequest({
-        path: "v18/customers/{customerClientId}/conversionActions:mutate",
+        path: "/v21/customers/{customerClientId}/conversionActions:mutate",
         method: "post",
         ...args,
       });
@@ -227,14 +227,14 @@ export default {
     }) {
       return this._makeRequest({
         method: "POST",
-        path: `/v18/${path}:addOperations`,
+        path: `/v21/${path}:addOperations`,
         ...opts,
       });
     },
     async createOfflineUserDataJob(opts = {}) {
       return this._makeRequest({
         method: "POST",
-        path: "/v18/customers/{customerClientId}/offlineUserDataJobs:create",
+        path: "/v21/customers/{customerClientId}/offlineUserDataJobs:create",
         ...opts,
       });
     },
@@ -243,9 +243,16 @@ export default {
     }) {
       return this._makeRequest({
         method: "POST",
-        path: `/v18/${path}:run`,
+        path: `/v21/${path}:run`,
         ...args,
       });
     },
+    async generateKeywordIdeas(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/v22/customers/{customerClientId}:generateKeywordIdeas",
+        ...opts,
+      });
+    },
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/google_ads",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "Pipedream Google Ads Components",
   "main": "google_ads.app.mjs",
   "keywords": [
@@ -13,7 +13,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^3.0.3",
-    "crypto": "^1.0.1"
+    "@pipedream/platform": "^3.1.1"
   }
 }

package/sources/new-campaign-created/new-campaign-created.mjs

@@ -6,8 +6,8 @@ export default {
   ...common,
   key: "google_ads-new-campaign-created",
   name: "New Campaign Created",
-  description: "Emit new event when a new campaign is created. [See the documentation](https://developers.google.com/google-ads/api/fields/v18/campaign)",
-  version: "0.0.4",
+  description: "Emit new event when a new campaign is created. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.0.6",
   type: "source",
   dedupe: "unique",
   sampleEmit,
@@ -19,7 +19,7 @@ export default {
     fields: {
       type: "string[]",
       label: "Extra Fields",
-      description: "Additional [campaign fields](https://developers.google.com/google-ads/api/fields/v18/campaign) to emit in the event",
+      description: "Additional [campaign fields](https://developers.google.com/google-ads/api/fields/v21/campaign) to emit in the event",
       options: campaign.fields,
       optional: true,
       default: [

package/sources/new-lead-form-entry/new-lead-form-entry.mjs

@@ -7,8 +7,8 @@ export default {
   ...common,
   key: "google_ads-new-lead-form-entry",
   name: "New Lead Form Entry",
-  description: "Emit new event for new leads on a Lead Form. [See the documentation](https://developers.google.com/google-ads/api/fields/v18/lead_form_submission_data)",
-  version: "0.0.4",
+  description: "Emit new event for new leads on a Lead Form. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.0.6",
   type: "source",
   dedupe: "unique",
   sampleEmit,
@@ -29,7 +29,7 @@ export default {
     docsAlert: {
       type: "alert",
       alertType: "info",
-      content: "If needed, see Google's documentation on [submission fields](https://developers.google.com/google-ads/api/reference/rpc/v18/LeadFormSubmissionField) and [custom submission fields](https://developers.google.com/google-ads/api/reference/rpc/v18/CustomLeadFormSubmissionField).",
+      content: "If needed, see Google's documentation on [submission fields](https://developers.google.com/google-ads/api/reference/rpc/v21/LeadFormSubmissionField) and [custom submission fields](https://developers.google.com/google-ads/api/reference/rpc/v21/CustomLeadFormSubmissionField).",
     },
   },
   methods: {