\n\n## Usage\n\n### Authentication\n\n```ts\nimport { UserRefreshClient, JWT } from 'google-auth-library';\n\n// for web application\nconst authClient = new UserRefreshClient({\n clientId: '',\n clientSecret: '',\n refreshToken: '',\n});\n\n// or use JWT for service account\nconst authClient = new JWT({\n keyFile: '',\n subject: '',\n scopes: ['https://www.googleapis.com/auth/adwords'],\n});\n```\n\n### Customer\n\n```ts\nimport { Customer } from '@htdangkhoa/google-ads';\n\nconst service = new Customer({\n auth: authClient,\n developer_token: '',\n});\n\nconst { resource_names: customers } = await service.listAccessibleCustomers();\n\n// ...\n```\n\n### Search\n\n```ts\nimport { GoogleAds } from '@htdangkhoa/google-ads';\n\nconst service = new GoogleAds(\n {\n auth: authClient,\n developer_token: '',\n },\n {\n customer_id: '',\n },\n);\n\nconst customerClients = await service.search({\n query: `\n SELECT\n customer_client.descriptive_name,\n customer_client.resource_name,\n customer_client.client_customer,\n customer_client.level,\n customer_client.manager\n FROM customer_client\n `,\n});\n\n// ...\n```\n\n### Search stream\n\n```ts\nimport { GoogleAds } from '@htdangkhoa/google-ads';\n\nconst service = new GoogleAds(\n {\n auth: authClient,\n developer_token: '',\n }, {\n customer_id: '',\n }\n);\n\nconst response = service\n .setCustomerId('') // you can switch customer id\n .setLoginCustomerId('')\n .searchStream({\n query: `\n SELECT\n campaign.id,\n campaign.name,\n campaign.status\n FROM campaign\n `,\n });\n\nfor await (const { results } of response) {\n // ...\n}\n```\n\n### Campaign\n\n```ts\nimport { GoogleAds } from '@htdangkhoa/google-ads';\n\nconst service = new GoogleAds(\n {\n auth: authClient,\n developer_token: '',\n },\n {\n customer_id: '',\n login_customer_id: '',\n },\n);\n\nconst campaigns = await service.search({\n query: `\n SELECT\n campaign.id,\n campaign.name,\n campaign.status\n FROM campaign\n `,\n});\n\n// ...\n```\n\n### Mutate\n\n```ts\nimport { GoogleAds } from '@htdangkhoa/google-ads';\n\nconst service = new GoogleAds(\n {\n auth: authClient,\n developer_token: '',\n },\n {\n customer_id: '',\n login_customer_id: '',\n },\n);\n\nconst response = await service.mutate({\n mutate_operations: [\n {\n campaign_operation: {\n create: {\n // ...\n },\n update: {\n // ...\n },\n remove: '',\n },\n },\n ],\n partial_failure: true,\n});\n\n// ...\n```\n\n### Query Builder\n\n```ts\nimport { QueryBuilder } from '@htdangkhoa/google-ads';\n\nconst query = new QueryBuilder()\n .select(\n 'campaign.id',\n 'campaign.name',\n 'segments.device',\n 'metrics.clicks',\n )\n .from('campaign')\n .where(\n {\n attribute: 'metrics.impressions',\n operator: Operators.GREATER_THAN,\n value: \"0\",\n },\n {\n attribute: 'segments.device',\n operator: Operators.EQUALS,\n value: \"MOBILE\",\n },\n {\n attribute: 'segments.date',\n operator: Operators.DURING,\n value: Functions.LAST_30_DAYS,\n },\n )\n .orderBy(\n {\n attribute: 'metrics.clicks',\n direction: Order.DESC,\n },\n )\n .limit(10)\n .build();\n\nconst response = await service.search({ query });\n```\n\n## Logging\n\nRequests are logged with a one line summary and the full request/response body and headers.\n\n| Log type | Log name | Success level | Failure level |\n|----------|---------------------------------|---------------|---------------|\n| SUMMARY | Google::Ads::GoogleAds::Summary | INFO | WARN |\n| DETAIL | Google::Ads::GoogleAds::Detail | DEBUG | INFO |\n\n### Basic\n\n```ts\nimport { GoogleAds } from '@htdangkhoa/google-ads';\n\nconst service = new GoogleAds(\n {\n auth: authClient,\n developer_token: '',\n logging: true,\n },\n {\n customer_id: '',\n },\n);\n```\n\n### Specific Log Type (SUMMARY or DETAIL)\n\n```ts\nimport { GoogleAds } from '@htdangkhoa/google-ads';\n\nconst service = new GoogleAds(\n {\n auth: authClient,\n developer_token: '',\n logging: {\n summary: true,\n detail: false,\n },\n },\n {\n customer_id: '',\n },\n);\n```\n\n## gRPC Client Options\n\nThe `ServiceOptions` is extended from `@grpc/grpc-js` [ClientOptions](https://grpc.github.io/grpc/node/grpc.Client.html#~ClientOptions:~:text=to%20the%20server-,options,-Object), so you can pass any options you want to the client.\n\n```ts\nimport { GoogleAds } from '@htdangkhoa/google-ads';\n\nconst service = new GoogleAds(\n {\n auth: authClient,\n developer_token: '',\n logging: {\n summary: true,\n detail: false,\n },\n interceptors: [\n // your interceptors\n ],\n },\n {\n customer_id: '',\n },\n);\n```\n\n## Interceptors\n\nSee more at [Node.js gRPC Library](https://grpc.github.io/grpc/node/module-src_client_interceptors.html) and some examples [here](https://github.com/grpc/proposal/blob/master/L5-node-client-interceptors.md).\n\n## Development\n\n> [!WARNING] \n> This library is using `ts-proto` to generate the gRPC client. Since v2, `ts-proto` has changed the way to encode the request for image upload. Don't migrate to `ts-proto` v2 or higher until the issue is fixed.\n\n### Prerequisites\n\n- Protocol Buffer Compiler (protoc) version 3.0.0 or greater. The latest version can be downloaded from [here](https://grpc.io/docs/protoc-installation/)\n- Node.js version 16 or greater (LTS recommended) and npm version 8 or greater. The latest version of Node.js can be downloaded from [here](https://nodejs.org/en/download/)\n\n### Building\n\n1. Install dependencies\n\n ```sh\n yarn install\n ```\n\n2. Pull in the new protos and compile them\n\n ```sh\n yarn generate \n\n # example\n yarn generate v25\n ```\n3. Make sure the version number in the `src` folder is correct (it should match the version number you passed to the `generate` command)\n\n4. Run tests to make sure everything worked (you may need to update the version numbers here)\n\n ```sh\n yarn test\n ```\n\n5. Build the library\n\n ```sh\n yarn build\n ```\n\n6. Make a pull request, get it approved and merged into `main`\n\n## Known Issues\n\n- With `ImageAsset`, you might get an error if you provide it as either `Uint8Array` or `Buffer`. The root cause is that the proto is `bytes` but the generator is generating to `Buffer/Uint8Array` which is the wrong type ([#166](https://github.com/htdangkhoa/google-ads/issues/166#issuecomment-2851472905)). The solution is to convert it to base64 string as shown below:\n\n ```ts\n const imageAsset = ImageAsset.create({\n // @ts-expect-error\n data: Buffer.from(asset.file.buffer).toString('base64'),\n });\n\n // or\n\n const imageAsset: ImageAsset = {\n // @ts-expect-error\n data: Buffer.from(asset.file.buffer).toString('base64'),\n };\n ```\n Reference: https://developers.google.com/google-ads/api/rest/reference/rest/latest/Asset#imageasset\n\n## License\nThe code in this project is released under the [MIT License](LICENSE).\n","readmeFilename":"README.md"}
![](\"https://img.shields.io/badge/google%20ads-v25%202026--07--22-009688.svg?style=flat-square\"){kind=icon}
\n \n \n ![](\"https://img.shields.io/npm/v/@htdangkhoa/google-ads.svg?style=flat-square\")
\n \n \n 
\n \n \n 
\n \n