Skip to content

Commit 54a73fe

Browse files
feat: [Many APIs] add request/response debug logging to gapics, update templates to gax 5
* chore: update typescript gapic generator to 4.8.1 feat: add request/response debug logging to gapics, update templates to gax 5 and node 18 (#1671) fix: add json files to tsconfig templates (#1692) (ba6be1d) PiperOrigin-RevId: 735896588 Source-Link: googleapis/googleapis@3419af7 Source-Link: googleapis/googleapis-gen@f35ba11 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFkcy1hZG1hbmFnZXIvLk93bEJvdC55YW1sIiwiaCI6ImYzNWJhMTE0MmY0ZTE2ODIyMjMyN2Q4OTJiNWY2ZWU5MDhlNWQ0NjEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFpLWdlbmVyYXRpdmVsYW5ndWFnZS8uT3dsQm90LnlhbWwiLCJoIjoiZjM1YmExMTQyZjRlMTY4MjIyMzI3ZDg5MmI1ZjZlZTkwOGU1ZDQ2MSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFuYWx5dGljcy1hZG1pbi8uT3dsQm90LnlhbWwiLCJoIjoiZjM1YmExMTQyZjRlMTY4MjIyMzI3ZDg5MmI1ZjZlZTkwOGU1ZDQ2MSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFuYWx5dGljcy1kYXRhLy5Pd2xCb3QueWFtbCIsImgiOiJmMzViYTExNDJmNGUxNjgyMjIzMjdkODkyYjVmNmVlOTA4ZTVkNDYxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwaS1hcGlrZXlzLy5Pd2xCb3QueWFtbCIsImgiOiJmMzViYTExNDJmNGUxNjgyMjIzMjdkODkyYjVmNmVlOTA4ZTVkNDYxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwaS1zZXJ2aWNlY29udHJvbC8uT3dsQm90LnlhbWwiLCJoIjoiZjM1YmExMTQyZjRlMTY4MjIyMzI3ZDg5MmI1ZjZlZTkwOGU1ZDQ2MSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwaS1zZXJ2aWNlbWFuYWdlbWVudC8uT3dsQm90LnlhbWwiLCJoIjoiZjM1YmExMTQyZjRlMTY4MjIyMzI3ZDg5MmI1ZjZlZTkwOGU1ZDQ2MSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwaS1zZXJ2aWNldXNhZ2UvLk93bEJvdC55YW1sIiwiaCI6ImYzNWJhMTE0MmY0ZTE2ODIyMjMyN2Q4OTJiNWY2ZWU5MDhlNWQ0NjEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwcGVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiZjM1YmExMTQyZjRlMTY4MjIyMzI3ZDg5MmI1ZjZlZTkwOGU1ZDQ2MSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwcHMtbWVldC8uT3dsQm90LnlhbWwiLCJoIjoiZjM1YmExMTQyZjRlMTY4MjIyMzI3ZDg5MmI1ZjZlZTkwOGU1ZDQ2MSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFyZWExMjAtdGFibGVzLy5Pd2xCb3QueWFtbCIsImgiOiJmMzViYTExNDJmNGUxNjgyMjIzMjdkODkyYjVmNmVlOTA4ZTVkNDYxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNoYXQvLk93bEJvdC55YW1sIiwiaCI6ImYzNWJhMTE0MmY0ZTE2ODIyMjMyN2Q4OTJiNWY2ZWU5MDhlNWQ0NjEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFjY2Vzc2FwcHJvdmFsLy5Pd2xCb3QueWFtbCIsImgiOiJmMzViYTExNDJmNGUxNjgyMjIzMjdkODkyYjVmNmVlOTA4ZTVkNDYxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFkdmlzb3J5bm90aWZpY2F0aW9ucy8uT3dsQm90LnlhbWwiLCJoIjoiZjM1YmExMTQyZjRlMTY4MjIyMzI3ZDg5MmI1ZjZlZTkwOGU1ZDQ2MSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFsbG95ZGIvLk93bEJvdC55YW1sIiwiaCI6ImYzNWJhMTE0MmY0ZTE2ODIyMjMyN2Q4OTJiNWY2ZWU5MDhlNWQ0NjEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFwaWdhdGV3YXkvLk93bEJvdC55YW1sIiwiaCI6ImYzNWJhMTE0MmY0ZTE2ODIyMjMyN2Q4OTJiNWY2ZWU5MDhlNWQ0NjEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFwaWdlZWNvbm5lY3QvLk93bEJvdC55YW1sIiwiaCI6ImYzNWJhMTE0MmY0ZTE2ODIyMjMyN2Q4OTJiNWY2ZWU5MDhlNWQ0NjEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFwaWdlZXJlZ2lzdHJ5Ly5Pd2xCb3QueWFtbCIsImgiOiJmMzViYTExNDJmNGUxNjgyMjIzMjdkODkyYjVmNmVlOTA4ZTVkNDYxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFwaWh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZjM1YmExMTQyZjRlMTY4MjIyMzI3ZDg5MmI1ZjZlZTkwOGU1ZDQ2MSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFwcGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZjM1YmExMTQyZjRlMTY4MjIyMzI3ZDg5MmI1ZjZlZTkwOGU1ZDQ2MSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 5d8bb18 commit 54a73fe

143 files changed

Lines changed: 24854 additions & 1603 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

packages/google-ads-admanager/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
4444
1. [Select or create a Cloud Platform project][projects].
4545
1. [Enable billing for your project][billing].
4646
1. [Enable the Google Ad Manager API API][enable_api].
47-
1. [Set up authentication][auth] so you can access the
47+
1. [Set up authentication with a service account][auth] so you can access the
4848
API from your local workstation.
4949

5050
### Installing the client library
@@ -233,4 +233,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
233233
[projects]: https://console.cloud.google.com/project
234234
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
235235
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=admanager.googleapis.com
236-
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
236+
[auth]: https://cloud.google.com/docs/authentication/getting-started

packages/google-ads-admanager/protos/protos.json

Lines changed: 0 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/google-ads-admanager/src/v1/ad_unit_service_client.ts

Lines changed: 88 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ import type {
2929
import {Transform} from 'stream';
3030
import * as protos from '../../protos/protos';
3131
import jsonProtos = require('../../protos/protos.json');
32+
import {loggingUtils as logging} from 'google-gax';
3233

3334
/**
3435
* Client JSON configuration object, loaded from
@@ -53,6 +54,8 @@ export class AdUnitServiceClient {
5354
private _defaults: {[method: string]: gax.CallSettings};
5455
private _universeDomain: string;
5556
private _servicePath: string;
57+
private _log = logging.log('admanager');
58+
5659
auth: gax.GoogleAuth;
5760
descriptors: Descriptors = {
5861
page: {},
@@ -87,7 +90,7 @@ export class AdUnitServiceClient {
8790
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
8891
* the environment variable GCLOUD_PROJECT for your project ID. If your
8992
* app is running in an environment which supports
90-
* {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
93+
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
9194
* your project ID will be detected automatically.
9295
* @param {string} [options.apiEndpoint] - The domain name of the
9396
* API remote host.
@@ -519,7 +522,31 @@ export class AdUnitServiceClient {
519522
name: request.name ?? '',
520523
});
521524
this.initialize();
522-
return this.innerApiCalls.getAdUnit(request, options, callback);
525+
this._log.info('getAdUnit request %j', request);
526+
const wrappedCallback:
527+
| Callback<
528+
protos.google.ads.admanager.v1.IAdUnit,
529+
protos.google.ads.admanager.v1.IGetAdUnitRequest | null | undefined,
530+
{} | null | undefined
531+
>
532+
| undefined = callback
533+
? (error, response, options, rawResponse) => {
534+
this._log.info('getAdUnit response %j', response);
535+
callback!(error, response, options, rawResponse); // We verified callback above.
536+
}
537+
: undefined;
538+
return this.innerApiCalls
539+
.getAdUnit(request, options, wrappedCallback)
540+
?.then(
541+
([response, options, rawResponse]: [
542+
protos.google.ads.admanager.v1.IAdUnit,
543+
protos.google.ads.admanager.v1.IGetAdUnitRequest | undefined,
544+
{} | undefined,
545+
]) => {
546+
this._log.info('getAdUnit response %j', response);
547+
return [response, options, rawResponse];
548+
}
549+
);
523550
}
524551

525552
/**
@@ -629,7 +656,33 @@ export class AdUnitServiceClient {
629656
parent: request.parent ?? '',
630657
});
631658
this.initialize();
632-
return this.innerApiCalls.listAdUnits(request, options, callback);
659+
const wrappedCallback:
660+
| PaginationCallback<
661+
protos.google.ads.admanager.v1.IListAdUnitsRequest,
662+
| protos.google.ads.admanager.v1.IListAdUnitsResponse
663+
| null
664+
| undefined,
665+
protos.google.ads.admanager.v1.IAdUnit
666+
>
667+
| undefined = callback
668+
? (error, values, nextPageRequest, rawResponse) => {
669+
this._log.info('listAdUnits values %j', values);
670+
callback!(error, values, nextPageRequest, rawResponse); // We verified callback above.
671+
}
672+
: undefined;
673+
this._log.info('listAdUnits request %j', request);
674+
return this.innerApiCalls
675+
.listAdUnits(request, options, wrappedCallback)
676+
?.then(
677+
([response, input, output]: [
678+
protos.google.ads.admanager.v1.IAdUnit[],
679+
protos.google.ads.admanager.v1.IListAdUnitsRequest | null,
680+
protos.google.ads.admanager.v1.IListAdUnitsResponse,
681+
]) => {
682+
this._log.info('listAdUnits values %j', response);
683+
return [response, input, output];
684+
}
685+
);
633686
}
634687

635688
/**
@@ -686,6 +739,7 @@ export class AdUnitServiceClient {
686739
const defaultCallSettings = this._defaults['listAdUnits'];
687740
const callSettings = defaultCallSettings.merge(options);
688741
this.initialize();
742+
this._log.info('listAdUnits stream %j', request);
689743
return this.descriptors.page.listAdUnits.createStream(
690744
this.innerApiCalls.listAdUnits as GaxCall,
691745
request,
@@ -750,6 +804,7 @@ export class AdUnitServiceClient {
750804
const defaultCallSettings = this._defaults['listAdUnits'];
751805
const callSettings = defaultCallSettings.merge(options);
752806
this.initialize();
807+
this._log.info('listAdUnits iterate %j', request);
753808
return this.descriptors.page.listAdUnits.asyncIterate(
754809
this.innerApiCalls['listAdUnits'] as GaxCall,
755810
request as {},
@@ -869,7 +924,33 @@ export class AdUnitServiceClient {
869924
parent: request.parent ?? '',
870925
});
871926
this.initialize();
872-
return this.innerApiCalls.listAdUnitSizes(request, options, callback);
927+
const wrappedCallback:
928+
| PaginationCallback<
929+
protos.google.ads.admanager.v1.IListAdUnitSizesRequest,
930+
| protos.google.ads.admanager.v1.IListAdUnitSizesResponse
931+
| null
932+
| undefined,
933+
protos.google.ads.admanager.v1.IAdUnitSize
934+
>
935+
| undefined = callback
936+
? (error, values, nextPageRequest, rawResponse) => {
937+
this._log.info('listAdUnitSizes values %j', values);
938+
callback!(error, values, nextPageRequest, rawResponse); // We verified callback above.
939+
}
940+
: undefined;
941+
this._log.info('listAdUnitSizes request %j', request);
942+
return this.innerApiCalls
943+
.listAdUnitSizes(request, options, wrappedCallback)
944+
?.then(
945+
([response, input, output]: [
946+
protos.google.ads.admanager.v1.IAdUnitSize[],
947+
protos.google.ads.admanager.v1.IListAdUnitSizesRequest | null,
948+
protos.google.ads.admanager.v1.IListAdUnitSizesResponse,
949+
]) => {
950+
this._log.info('listAdUnitSizes values %j', response);
951+
return [response, input, output];
952+
}
953+
);
873954
}
874955

875956
/**
@@ -926,6 +1007,7 @@ export class AdUnitServiceClient {
9261007
const defaultCallSettings = this._defaults['listAdUnitSizes'];
9271008
const callSettings = defaultCallSettings.merge(options);
9281009
this.initialize();
1010+
this._log.info('listAdUnitSizes stream %j', request);
9291011
return this.descriptors.page.listAdUnitSizes.createStream(
9301012
this.innerApiCalls.listAdUnitSizes as GaxCall,
9311013
request,
@@ -990,6 +1072,7 @@ export class AdUnitServiceClient {
9901072
const defaultCallSettings = this._defaults['listAdUnitSizes'];
9911073
const callSettings = defaultCallSettings.merge(options);
9921074
this.initialize();
1075+
this._log.info('listAdUnitSizes iterate %j', request);
9931076
return this.descriptors.page.listAdUnitSizes.asyncIterate(
9941077
this.innerApiCalls['listAdUnitSizes'] as GaxCall,
9951078
request as {},
@@ -1626,6 +1709,7 @@ export class AdUnitServiceClient {
16261709
close(): Promise<void> {
16271710
if (this.adUnitServiceStub && !this._terminated) {
16281711
return this.adUnitServiceStub.then(stub => {
1712+
this._log.info('ending gRPC channel');
16291713
this._terminated = true;
16301714
stub.close();
16311715
});

packages/google-ads-admanager/src/v1/company_service_client.ts

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ import type {
2929
import {Transform} from 'stream';
3030
import * as protos from '../../protos/protos';
3131
import jsonProtos = require('../../protos/protos.json');
32+
import {loggingUtils as logging} from 'google-gax';
3233

3334
/**
3435
* Client JSON configuration object, loaded from
@@ -53,6 +54,8 @@ export class CompanyServiceClient {
5354
private _defaults: {[method: string]: gax.CallSettings};
5455
private _universeDomain: string;
5556
private _servicePath: string;
57+
private _log = logging.log('admanager');
58+
5659
auth: gax.GoogleAuth;
5760
descriptors: Descriptors = {
5861
page: {},
@@ -87,7 +90,7 @@ export class CompanyServiceClient {
8790
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
8891
* the environment variable GCLOUD_PROJECT for your project ID. If your
8992
* app is running in an environment which supports
90-
* {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
93+
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
9194
* your project ID will be detected automatically.
9295
* @param {string} [options.apiEndpoint] - The domain name of the
9396
* API remote host.
@@ -510,7 +513,31 @@ export class CompanyServiceClient {
510513
name: request.name ?? '',
511514
});
512515
this.initialize();
513-
return this.innerApiCalls.getCompany(request, options, callback);
516+
this._log.info('getCompany request %j', request);
517+
const wrappedCallback:
518+
| Callback<
519+
protos.google.ads.admanager.v1.ICompany,
520+
protos.google.ads.admanager.v1.IGetCompanyRequest | null | undefined,
521+
{} | null | undefined
522+
>
523+
| undefined = callback
524+
? (error, response, options, rawResponse) => {
525+
this._log.info('getCompany response %j', response);
526+
callback!(error, response, options, rawResponse); // We verified callback above.
527+
}
528+
: undefined;
529+
return this.innerApiCalls
530+
.getCompany(request, options, wrappedCallback)
531+
?.then(
532+
([response, options, rawResponse]: [
533+
protos.google.ads.admanager.v1.ICompany,
534+
protos.google.ads.admanager.v1.IGetCompanyRequest | undefined,
535+
{} | undefined,
536+
]) => {
537+
this._log.info('getCompany response %j', response);
538+
return [response, options, rawResponse];
539+
}
540+
);
514541
}
515542

516543
/**
@@ -620,7 +647,33 @@ export class CompanyServiceClient {
620647
parent: request.parent ?? '',
621648
});
622649
this.initialize();
623-
return this.innerApiCalls.listCompanies(request, options, callback);
650+
const wrappedCallback:
651+
| PaginationCallback<
652+
protos.google.ads.admanager.v1.IListCompaniesRequest,
653+
| protos.google.ads.admanager.v1.IListCompaniesResponse
654+
| null
655+
| undefined,
656+
protos.google.ads.admanager.v1.ICompany
657+
>
658+
| undefined = callback
659+
? (error, values, nextPageRequest, rawResponse) => {
660+
this._log.info('listCompanies values %j', values);
661+
callback!(error, values, nextPageRequest, rawResponse); // We verified callback above.
662+
}
663+
: undefined;
664+
this._log.info('listCompanies request %j', request);
665+
return this.innerApiCalls
666+
.listCompanies(request, options, wrappedCallback)
667+
?.then(
668+
([response, input, output]: [
669+
protos.google.ads.admanager.v1.ICompany[],
670+
protos.google.ads.admanager.v1.IListCompaniesRequest | null,
671+
protos.google.ads.admanager.v1.IListCompaniesResponse,
672+
]) => {
673+
this._log.info('listCompanies values %j', response);
674+
return [response, input, output];
675+
}
676+
);
624677
}
625678

626679
/**
@@ -677,6 +730,7 @@ export class CompanyServiceClient {
677730
const defaultCallSettings = this._defaults['listCompanies'];
678731
const callSettings = defaultCallSettings.merge(options);
679732
this.initialize();
733+
this._log.info('listCompanies stream %j', request);
680734
return this.descriptors.page.listCompanies.createStream(
681735
this.innerApiCalls.listCompanies as GaxCall,
682736
request,
@@ -741,6 +795,7 @@ export class CompanyServiceClient {
741795
const defaultCallSettings = this._defaults['listCompanies'];
742796
const callSettings = defaultCallSettings.merge(options);
743797
this.initialize();
798+
this._log.info('listCompanies iterate %j', request);
744799
return this.descriptors.page.listCompanies.asyncIterate(
745800
this.innerApiCalls['listCompanies'] as GaxCall,
746801
request as {},
@@ -1377,6 +1432,7 @@ export class CompanyServiceClient {
13771432
close(): Promise<void> {
13781433
if (this.companyServiceStub && !this._terminated) {
13791434
return this.companyServiceStub.then(stub => {
1435+
this._log.info('ending gRPC channel');
13801436
this._terminated = true;
13811437
stub.close();
13821438
});

0 commit comments

Comments
 (0)