google-ads-api 14.1.0 → 14.2.0

package/README.md

@@ -367,6 +367,51 @@ const result = await customer.mutateResources(operations);
 
 ---
 
+## Add Policy Exemption Rules
+
+```ts
+import {
+  resources,
+  enums,
+  toMicros,
+  ResourceNames,
+  MutateOperation,
+} from "google-ads-api";
+
+// Ad Group to which you want to add the keyword
+const adGroupResourceName = 'customers/123/adGroups/456'
+
+const keyword = '24 hour locksmith harlem'
+
+const operations: MutateOperation<
+  resources.IAdGroupCriterion & { exempt_policy_violation_keys?: google.ads.googleads.v14.common.IPolicyViolationKey[]}
+>[] = [
+  {
+    entity: 'ad_group_criterion',
+    operation: "create",
+    resource: {
+      // Keyword with policy violation exemptions
+        ad_group: adGroupResourceName,
+        keyword: {
+            text: '24 hour locksmith harlem',
+            match_type: enums.KeywordMatchType.PHRASE,
+        },
+        status: enums.AdGroupStatus.ENABLED ,
+    },
+    exempt_policy_violation_keys: [
+        {
+            policy_name: 'LOCAL_SERVICES',
+            violating_text: keyword,
+        },
+    ],
+  }
+];
+
+const result = await customer.mutateResources(operations);
+```
+
+---
+
 ## Uploading Click Conversions
 
 ```ts

package/build/src/protos/autogen/serviceFactory.d.ts

@@ -167,12 +167,20 @@ export default class ServiceFactory extends Service {
          * @description create resources of type resources.IAdGroupCriterion
          * @returns services.MutateAdGroupCriteriaResponse
          */
-        create: (adGroupCriteria: (resources.IAdGroupCriterion | resources.AdGroupCriterion)[], options?: Partial<Pick<services.IMutateAdGroupCriteriaRequest, "validate_only" | "partial_failure" | "response_content_type">> | undefined) => Promise<services.MutateAdGroupCriteriaResponse>;
+        create: (adGroupCriteria: ((resources.IAdGroupCriterion & {
+            exempt_policy_violation_keys?: services.AdGroupCriterionOperation["exempt_policy_violation_keys"];
+        }) | (resources.AdGroupCriterion & {
+            exempt_policy_violation_keys?: services.AdGroupCriterionOperation["exempt_policy_violation_keys"];
+        }))[], options?: Partial<Pick<services.IMutateAdGroupCriteriaRequest, "validate_only" | "partial_failure" | "response_content_type">> | undefined) => Promise<services.MutateAdGroupCriteriaResponse>;
         /**
          * @description update resources of type resources.IAdGroupCriterion
          * @returns services.MutateAdGroupCriteriaResponse
          */
-        update: (adGroupCriteria: (resources.IAdGroupCriterion | resources.AdGroupCriterion)[], options?: Partial<Pick<services.IMutateAdGroupCriteriaRequest, "validate_only" | "partial_failure" | "response_content_type">> | undefined) => Promise<services.MutateAdGroupCriteriaResponse>;
+        update: (adGroupCriteria: ((resources.IAdGroupCriterion & {
+            exempt_policy_violation_keys?: services.AdGroupCriterionOperation["exempt_policy_violation_keys"];
+        }) | (resources.AdGroupCriterion & {
+            exempt_policy_violation_keys?: services.AdGroupCriterionOperation["exempt_policy_violation_keys"];
+        }))[], options?: Partial<Pick<services.IMutateAdGroupCriteriaRequest, "validate_only" | "partial_failure" | "response_content_type">> | undefined) => Promise<services.MutateAdGroupCriteriaResponse>;
         /**
          * @description remove resources of type string
          * @returns services.MutateAdGroupCriteriaResponse

package/build/src/service.js

@@ -123,12 +123,20 @@ class Service {
     buildMutationRequestAndService(mutations, options) {
         const service = this.loadService("GoogleAdsServiceClient");
         const mutateOperations = mutations.map((mutation) => {
-            var _a;
+            var _a, _b;
             const opKey = (0, utils_1.toSnakeCase)(`${mutation.entity}Operation`);
             const operation = {
                 [(_a = mutation.operation) !== null && _a !== void 0 ? _a : "create"]: mutation.resource,
             };
-            if (mutation.operation === "update") {
+            if (mutation.operation === "create" &&
+                (
+                //@ts-ignore
+                (_b = mutation === null || mutation === void 0 ? void 0 : mutation.exempt_policy_violation_keys) === null || _b === void 0 ? void 0 : _b.length)) {
+                //@ts-ignore
+                operation.exempt_policy_violation_keys =
+                    mutation.exempt_policy_violation_keys;
+            }
+            else if (mutation.operation === "update") {
                 // @ts-expect-error Resource operations should have updateMask defined
                 operation.update_mask = (0, utils_1.getFieldMask)(mutation.resource);
             }
@@ -146,11 +154,19 @@ class Service {
     }
     buildOperations(type, entities, message) {
         const ops = entities.map((e) => {
+            var _a;
             const op = {
                 [type]: e,
                 operation: type,
             };
-            if (type === "update") {
+            //@ts-ignore
+            if (type === "create" && ((_a = e === null || e === void 0 ? void 0 : e.exempt_policy_violation_keys) === null || _a === void 0 ? void 0 : _a.length)) {
+                // @ts-expect-error Field required for policy violation exemptions
+                op.exempt_policy_violation_keys = e.exempt_policy_violation_keys;
+                //@ts-ignore
+                delete e.exempt_policy_violation_keys;
+            }
+            else if (type === "update") {
                 // @ts-expect-error Field required for updates
                 op.update_mask = (0, utils_1.getFieldMask)(
                 // @ts-expect-error Message types have a toObject method

package/build/src/types.d.ts

@@ -53,5 +53,6 @@ export declare type MutateOperation<T> = {
     resource: T;
     entity: fields.Resource;
     operation?: "create" | "update" | "remove";
+    exempt_policy_violation_keys?: services.AdGroupCriterionOperation["exempt_policy_violation_keys"];
 } & Partial<Omit<T, "toJSON">>;
 export declare type PageToken = services.ISearchGoogleAdsResponse["next_page_token"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "google-ads-api",
-  "version": "14.1.0",
+  "version": "14.2.0",
   "description": "Google Ads API Client Library for Node.js",
   "repository": "https://github.com/Opteo/google-ads-api",
   "main": "build/src/index.js",