Develop

.github/workflows/publish.yml

@@ -29,7 +29,7 @@ jobs:
     environment: production
     permissions: write-all
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Download build artifact
         uses: actions/download-artifact@v3
@@ -38,7 +38,7 @@ jobs:
           path: build
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 20
           registry-url: 'https://registry.npmjs.org'

.github/workflows/template.yml

@@ -27,15 +27,15 @@ jobs:
     name: Generate google ads api ${{ inputs.google-ads-api-version }} for Node ${{ inputs.node-version }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Install protobuf-compiler
         run: |
           sudo apt-get update -y
           sudo apt-get install protobuf-compiler -y
 
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ inputs.node-version }}
           cache: 'yarn'
@@ -50,6 +50,14 @@ jobs:
         if: ${{ inputs.test }}
         run: yarn test
 
+      - name: Test report with Node ${{ inputs.node-version }} and Google Ads API ${{ inputs.google-ads-api-version }}
+        uses: dorny/test-reporter@v1
+        if: ${{ inputs.test }} && always()
+        with:
+          name: Test report with Node ${{ inputs.node-version }} and Google Ads API ${{ inputs.google-ads-api-version }}
+          path: junit.xml
+          reporter: jest-junit
+
       - name: Write COVERALLS_TOKEN to .coveralls.yml
         if: ${{ inputs.test }}
         run: |

.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
     needs: export-google-ads-api-version
     strategy:
       matrix:
-        node: [16, 18, 20]
+        node: [18, 20, 22]
     uses: ./.github/workflows/template.yml
     with:
       node-version: ${{ matrix.node }}

.gitignore

@@ -111,4 +111,6 @@ build
 
 generated
 
-googleapis
+googleapis
+
+junit.xml

README.md

@@ -1,8 +1,8 @@
 <h1 align="center">Google Ads API Nodejs Client Library</h1>
 
 <p align="center">
-  <a href="https://developers.google.com/google-ads/api/docs/release-notes#v16">
-    <img src="https://img.shields.io/badge/google%20ads-v16-009688.svg?style=flat-square">
+  <a href="https://developers.google.com/google-ads/api/docs/release-notes#v17">
+    <img src="https://img.shields.io/badge/google%20ads-v17-009688.svg?style=flat-square">
   </a>
   <a href="https://www.npmjs.com/package/@htdangkhoa/google-ads">
     <img src="https://img.shields.io/npm/v/@htdangkhoa/google-ads.svg?style=flat-square">
@@ -317,7 +317,7 @@ See more at [Node.js gRPC Library](https://grpc.github.io/grpc/node/module-src_c
     yarn generate <GOOGLE_ADS_API_VERSION>
 
     # example
-    yarn generate v16
+    yarn generate v17
     ```
 3. Make sure the version number in the `src` folder is correct (it should match the version number you passed to the `generate` command)
 

example/ad-group-ad.ts

@@ -1,8 +1,8 @@
 import { google } from 'googleapis';
 
 import { GoogleAds } from '../src/lib';
-import { AdTextAsset } from '../src/generated/google/ads/googleads/v16/common/ad_asset';
-import { AdGroupAdStatusEnum_AdGroupAdStatus } from '../src/generated/google/ads/googleads/v16/enums/ad_group_ad_status';
+import { AdTextAsset } from '../src/generated/google/ads/googleads/v17/common/ad_asset';
+import { AdGroupAdStatusEnum_AdGroupAdStatus } from '../src/generated/google/ads/googleads/v17/enums/ad_group_ad_status';
 
 const authClient = new google.auth.JWT({
   keyFile: process.env.GOOGLE_APPLICATION_CREDENTIALS,

example/ad-group.ts

@@ -1,8 +1,8 @@
 import { google } from 'googleapis';
 
 import { GoogleAds } from '../src/lib';
-import { AdGroupStatusEnum_AdGroupStatus } from '../src/generated/google/ads/googleads/v16/enums/ad_group_status';
-import { AdGroupTypeEnum_AdGroupType } from '../src/generated/google/ads/googleads/v16/enums/ad_group_type';
+import { AdGroupStatusEnum_AdGroupStatus } from '../src/generated/google/ads/googleads/v17/enums/ad_group_status';
+import { AdGroupTypeEnum_AdGroupType } from '../src/generated/google/ads/googleads/v17/enums/ad_group_type';
 
 const authClient = new google.auth.JWT({
   keyFile: process.env.GOOGLE_APPLICATION_CREDENTIALS,

example/asset.ts

@@ -1,8 +1,8 @@
 import { google } from 'googleapis';
 
 import { GoogleAds } from '../src/lib';
-import { Asset } from '../src/generated/google/ads/googleads/v16/resources/asset';
-import { MutateOperation } from '../src/generated/google/ads/googleads/v16/services/google_ads_service';
+import { Asset } from '../src/generated/google/ads/googleads/v17/resources/asset';
+import { MutateOperation } from '../src/generated/google/ads/googleads/v17/services/google_ads_service';
 
 const authClient = new google.auth.JWT({
   keyFile: process.env.GOOGLE_APPLICATION_CREDENTIALS,

jest.config.js

@@ -12,4 +12,5 @@ module.exports = {
   ],
   testPathIgnorePatterns: ['/node_modules/', '/build/'],
   testTimeout: 20000,
+  reporters: ['default', 'jest-junit'],
 };

package.json

@@ -15,37 +15,47 @@
     "[email protected]"
   ],
   "license": "MIT",
-  "main": "build/lib/index.js",
+  "main": "dist/cjs/lib/index.js",
+  "module": "dist/esm/lib/index.js",
   "files": [
-    "build/lib",
-    "build/generated"
+    "dist"
   ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": "./dist/esm/lib/index.js",
+      "require": "./dist/cjs/lib/index.js"
+    }
+  },
   "scripts": {
     "test": "jest --runInBand --no-cache",
     "test:cov": "npm run test && coveralls < coverage/lcov.info",
-    "prebuild": "rimraf build",
+    "prebuild": "rimraf dist",
     "build": "tsc",
+    "postbuild": "esm2cjs --in dist/esm --out dist/cjs -l error",
     "generate": "./scripts/generate.sh"
   },
   "dependencies": {
-    "@grpc/grpc-js": "^1.10.4",
+    "@grpc/grpc-js": "^1.10.9",
     "deepmerge": "^4.3.1",
     "log4js": "^6.9.1",
-    "protobufjs": "^7.2.6"
+    "protobufjs": "^7.3.2"
   },
   "devDependencies": {
+    "@alcalzone/esm2cjs": "^1.1.2",
     "@types/glob": "^8.1.0",
     "@types/jest": "^29.5.12",
-    "@types/node": "^20.11.30",
-    "coveralls-next": "^4.2.0",
-    "glob": "^10.3.10",
-    "googleapis": "^134.0.0",
+    "@types/node": "^20.14.5",
+    "coveralls-next": "^4.2.1",
+    "glob": "^10.4.2",
+    "googleapis": "^140.0.0",
     "jest": "^29.7.0",
-    "rimraf": "^5.0.5",
-    "ts-jest": "^29.1.2",
+    "jest-junit": "^16.0.0",
+    "rimraf": "^5.0.7",
+    "ts-jest": "^29.1.5",
     "ts-node": "^10.9.2",
-    "ts-proto": "^1.170.0",
-    "typescript": "5.4.3"
+    "ts-proto": "^1.180.0",
+    "typescript": "5.4.5"
   },
   "publishConfig": {
     "access": "public",

src/lib/Customer.ts

@@ -6,7 +6,7 @@ import { CustomerServiceClient } from '../generated/google';
 import {
   ListAccessibleCustomersRequest,
   ListAccessibleCustomersResponse,
-} from '../generated/google/ads/googleads/v16/services/customer_service';
+} from '../generated/google/ads/googleads/v17/services/customer_service';
 
 export class Customer extends Service {
   protected get callMetadata(): Metadata {

src/lib/GoogleAds.ts

@@ -12,7 +12,7 @@ import {
   SearchGoogleAdsStreamResponse,
   MutateGoogleAdsRequest,
   MutateGoogleAdsResponse,
-} from '../generated/google/ads/googleads/v16/services/google_ads_service';
+} from '../generated/google/ads/googleads/v17/services/google_ads_service';
 
 export class GoogleAds extends Service {
   private customerOptions: CustomerOptions;

src/lib/constants.ts

@@ -1,5 +1,5 @@
 export const HOST = 'googleads.googleapis.com' as const;
 
-export const VERSION = 'v16' as const;
+export const VERSION = 'v17' as const;
 
 export const FAILURE_KEY = `google.ads.googleads.${VERSION}.errors.googleadsfailure-bin`;

src/lib/utils.ts

@@ -1,6 +1,7 @@
 import { credentials, OAuth2Client, ServiceError } from '@grpc/grpc-js';
-import { GoogleAdsFailure } from '../generated/google/ads/googleads/v16/errors/errors';
+import { GoogleAdsFailure } from '../generated/google/ads/googleads/v17/errors/errors';
 import { FAILURE_KEY } from './constants';
+import { MutateGoogleAdsResponse } from '../generated/google/ads/googleads/v17/services/google_ads_service';
 
 export const getCredentials = (authClient: OAuth2Client) => {
   const ssl = credentials.createSsl();
@@ -34,3 +35,27 @@ export const getGoogleAdsError = (
 
   return decodeGoogleAdsFailureBuffer(buffer);
 };
+
+export const decodePartialFailureError = (
+  response: MutateGoogleAdsResponse,
+) => {
+  if (!response.partial_failure_error) return response;
+
+  const { details } = response.partial_failure_error;
+
+  if (!details) return response;
+
+  const { value } =
+    details.find((detail) =>
+      detail.type_url?.includes('errors.GoogleAdsFailure'),
+    ) ?? {};
+
+  if (!value) return response;
+
+  const buffer = Buffer.from(value);
+
+  return {
+    ...response,
+    partial_failure_error: decodeGoogleAdsFailureBuffer(buffer),
+  };
+};