@google-ads/admanager 0.8.0 → 0.10.0

package/build/src/v1/company_service_client.js

@@ -28,7 +28,8 @@ const google_gax_1 = require("google-gax");
 const gapicConfig = require("./company_service_client_config.json");
 const version = require('../../../package.json').version;
 /**
- *  Provides methods for handling `Company` objects.
+ *  Provides methods for handling {@link protos.google.ads.admanager.v1.Company|Company}
+ *  objects.
  * @class
  * @memberof v1
  */
@@ -195,9 +196,12 @@ class CompanyServiceClient {
             creativePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/creatives/{creative}'),
             creativeSetPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/creativeSets/{creative_set}'),
             creativeTemplatePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/creativeTemplates/{creative_template}'),
+            creativeWrapperPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/creativeWrappers/{creative_wrapper}'),
             customFieldPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/customFields/{custom_field}'),
             customTargetingKeyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/customTargetingKeys/{custom_targeting_key}'),
             customTargetingValuePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/customTargetingValues/{custom_targeting_value}'),
+            daiAuthenticationKeyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/daiAuthenticationKeys/{dai_authentication_key}'),
+            daiEncodingProfilePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile}'),
             deviceCapabilityPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/deviceCapabilities/{device_capability}'),
             deviceCategoryPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/deviceCategories/{device_category}'),
             deviceManufacturerPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/deviceManufacturers/{device_manufacturer}'),
@@ -215,6 +219,7 @@ class CompanyServiceClient {
             operatingSystemPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/operatingSystems/{operating_system}'),
             operatingSystemVersionPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/operatingSystemVersions/{operating_system_version}'),
             orderPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/orders/{order}'),
+            partnerPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/partners/{partner}'),
             placementPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/placements/{placement}'),
             privateAuctionPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/privateAuctions/{private_auction}'),
             privateAuctionDealPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/privateAuctionDeals/{private_auction_deal}'),
@@ -230,6 +235,7 @@ class CompanyServiceClient {
             teamPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/teams/{team}'),
             thirdPartyCompanyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/thirdPartyCompanies/{third_party_company}'),
             userPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/users/{user}'),
+            viewabilityProviderPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/viewabilityProviders/{viewability_provider}'),
             webPropertyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/webProperties/{web_property}'),
         };
         // Some of the methods on this service return "paged" results,
@@ -271,7 +277,14 @@ class CompanyServiceClient {
                 this._protos.google.ads.admanager.v1.CompanyService, this._opts, this._providedCustomServicePath);
         // Iterate over each of the methods that the service provides
         // and create an API call method for each.
-        const companyServiceStubMethods = ['getCompany', 'listCompanies'];
+        const companyServiceStubMethods = [
+            'getCompany',
+            'listCompanies',
+            'createCompany',
+            'batchCreateCompanies',
+            'updateCompany',
+            'batchUpdateCompanies',
+        ];
         for (const methodName of companyServiceStubMethods) {
             const callPromise = this.companyServiceStub.then((stub) => (...args) => {
                 if (this._terminated) {
@@ -394,6 +407,178 @@ class CompanyServiceClient {
             throw error;
         });
     }
+    createCompany(request, optionsOrCallback, callback) {
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                parent: request.parent ?? '',
+            });
+        this.initialize().catch((err) => {
+            throw err;
+        });
+        this._log.info('createCompany request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('createCompany response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .createCompany(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('createCompany response %j', response);
+            return [response, options, rawResponse];
+        })
+            .catch((error) => {
+            if (error &&
+                'statusDetails' in error &&
+                error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
+        });
+    }
+    batchCreateCompanies(request, optionsOrCallback, callback) {
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                parent: request.parent ?? '',
+            });
+        this.initialize().catch((err) => {
+            throw err;
+        });
+        this._log.info('batchCreateCompanies request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('batchCreateCompanies response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .batchCreateCompanies(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('batchCreateCompanies response %j', response);
+            return [response, options, rawResponse];
+        })
+            .catch((error) => {
+            if (error &&
+                'statusDetails' in error &&
+                error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
+        });
+    }
+    updateCompany(request, optionsOrCallback, callback) {
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                'company.name': request.company.name ?? '',
+            });
+        this.initialize().catch((err) => {
+            throw err;
+        });
+        this._log.info('updateCompany request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('updateCompany response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .updateCompany(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('updateCompany response %j', response);
+            return [response, options, rawResponse];
+        })
+            .catch((error) => {
+            if (error &&
+                'statusDetails' in error &&
+                error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
+        });
+    }
+    batchUpdateCompanies(request, optionsOrCallback, callback) {
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                parent: request.parent ?? '',
+            });
+        this.initialize().catch((err) => {
+            throw err;
+        });
+        this._log.info('batchUpdateCompanies request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('batchUpdateCompanies response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .batchUpdateCompanies(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('batchUpdateCompanies response %j', response);
+            return [response, options, rawResponse];
+        })
+            .catch((error) => {
+            if (error &&
+                'statusDetails' in error &&
+                error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
+        });
+    }
     listCompanies(request, optionsOrCallback, callback) {
         request = request || {};
         let options;
@@ -433,40 +618,39 @@ class CompanyServiceClient {
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.parent
-     *   Required. The parent, which owns this collection of Companies.
+     *   Required. The parent, which owns this collection of {@link protos.|Companies}.
      *   Format: `networks/{network_code}`
      * @param {number} [request.pageSize]
-     *   Optional. The maximum number of `Companies` to return. The service may
-     *   return fewer than this value. If unspecified, at most 50 `Companies` will
+     *   Optional. The maximum number of {@link protos.|Companies} to return. The service may
+     *   return fewer than this value. If unspecified, at most 50 {@link protos.|Companies} will
      *   be returned. The maximum value is 1000; values greater than 1000 will be
      *   coerced to 1000.
      * @param {string} [request.pageToken]
-     *   Optional. A page token, received from a previous `ListCompanies` call.
+     *   Optional. A page token, received from a previous {@link protos.|ListCompanies} call.
      *   Provide this to retrieve the subsequent page.
      *
-     *   When paginating, all other parameters provided to `ListCompanies` must
+     *   When paginating, all other parameters provided to {@link protos.|ListCompanies} must
      *   match the call that provided the page token.
      * @param {string} [request.filter]
      *   Optional. Expression to filter the response.
      *    See syntax details at
      *    https://developers.google.com/ad-manager/api/beta/filters
      *
-     *   <b>Filterable fields:</b>
-     *   <ul style="list-style-type:none">
-     *     <li><code>address</code></li>
-     *     <li><code>comment</code></li>
-     *     <li><code>companyId</code></li>
-     *     <li><code>creditStatus</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>email</code></li>
-     *     <li><code>externalId</code></li>
-     *     <li><code>fax</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>phone</code></li>
-     *     <li><code>thirdPartyCompanyId</code></li>
-     *     <li><code>type</code></li>
-     *     <li><code>updateTime</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `address`
+     *   * `comment`
+     *   * `companyId`
+     *   * `creditStatus`
+     *   * `displayName`
+     *   * `email`
+     *   * `externalId`
+     *   * `fax`
+     *   * `name`
+     *   * `phone`
+     *   * `thirdPartyCompanyId`
+     *   * `type`
+     *   * `updateTime`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -508,40 +692,39 @@ class CompanyServiceClient {
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.parent
-     *   Required. The parent, which owns this collection of Companies.
+     *   Required. The parent, which owns this collection of {@link protos.|Companies}.
      *   Format: `networks/{network_code}`
      * @param {number} [request.pageSize]
-     *   Optional. The maximum number of `Companies` to return. The service may
-     *   return fewer than this value. If unspecified, at most 50 `Companies` will
+     *   Optional. The maximum number of {@link protos.|Companies} to return. The service may
+     *   return fewer than this value. If unspecified, at most 50 {@link protos.|Companies} will
      *   be returned. The maximum value is 1000; values greater than 1000 will be
      *   coerced to 1000.
      * @param {string} [request.pageToken]
-     *   Optional. A page token, received from a previous `ListCompanies` call.
+     *   Optional. A page token, received from a previous {@link protos.|ListCompanies} call.
      *   Provide this to retrieve the subsequent page.
      *
-     *   When paginating, all other parameters provided to `ListCompanies` must
+     *   When paginating, all other parameters provided to {@link protos.|ListCompanies} must
      *   match the call that provided the page token.
      * @param {string} [request.filter]
      *   Optional. Expression to filter the response.
      *    See syntax details at
      *    https://developers.google.com/ad-manager/api/beta/filters
      *
-     *   <b>Filterable fields:</b>
-     *   <ul style="list-style-type:none">
-     *     <li><code>address</code></li>
-     *     <li><code>comment</code></li>
-     *     <li><code>companyId</code></li>
-     *     <li><code>creditStatus</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>email</code></li>
-     *     <li><code>externalId</code></li>
-     *     <li><code>fax</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>phone</code></li>
-     *     <li><code>thirdPartyCompanyId</code></li>
-     *     <li><code>type</code></li>
-     *     <li><code>updateTime</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `address`
+     *   * `comment`
+     *   * `companyId`
+     *   * `creditStatus`
+     *   * `displayName`
+     *   * `email`
+     *   * `externalId`
+     *   * `fax`
+     *   * `name`
+     *   * `phone`
+     *   * `thirdPartyCompanyId`
+     *   * `type`
+     *   * `updateTime`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -1346,6 +1529,39 @@ class CompanyServiceClient {
     matchCreativeTemplateFromCreativeTemplateName(creativeTemplateName) {
         return this.pathTemplates.creativeTemplatePathTemplate.match(creativeTemplateName).creative_template;
     }
+    /**
+     * Return a fully-qualified creativeWrapper resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} creative_wrapper
+     * @returns {string} Resource name string.
+     */
+    creativeWrapperPath(networkCode, creativeWrapper) {
+        return this.pathTemplates.creativeWrapperPathTemplate.render({
+            network_code: networkCode,
+            creative_wrapper: creativeWrapper,
+        });
+    }
+    /**
+     * Parse the network_code from CreativeWrapper resource.
+     *
+     * @param {string} creativeWrapperName
+     *   A fully-qualified path representing CreativeWrapper resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromCreativeWrapperName(creativeWrapperName) {
+        return this.pathTemplates.creativeWrapperPathTemplate.match(creativeWrapperName).network_code;
+    }
+    /**
+     * Parse the creative_wrapper from CreativeWrapper resource.
+     *
+     * @param {string} creativeWrapperName
+     *   A fully-qualified path representing CreativeWrapper resource.
+     * @returns {string} A string representing the creative_wrapper.
+     */
+    matchCreativeWrapperFromCreativeWrapperName(creativeWrapperName) {
+        return this.pathTemplates.creativeWrapperPathTemplate.match(creativeWrapperName).creative_wrapper;
+    }
     /**
      * Return a fully-qualified customField resource name string.
      *
@@ -1447,6 +1663,72 @@ class CompanyServiceClient {
     matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName) {
         return this.pathTemplates.customTargetingValuePathTemplate.match(customTargetingValueName).custom_targeting_value;
     }
+    /**
+     * Return a fully-qualified daiAuthenticationKey resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} dai_authentication_key
+     * @returns {string} Resource name string.
+     */
+    daiAuthenticationKeyPath(networkCode, daiAuthenticationKey) {
+        return this.pathTemplates.daiAuthenticationKeyPathTemplate.render({
+            network_code: networkCode,
+            dai_authentication_key: daiAuthenticationKey,
+        });
+    }
+    /**
+     * Parse the network_code from DaiAuthenticationKey resource.
+     *
+     * @param {string} daiAuthenticationKeyName
+     *   A fully-qualified path representing DaiAuthenticationKey resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromDaiAuthenticationKeyName(daiAuthenticationKeyName) {
+        return this.pathTemplates.daiAuthenticationKeyPathTemplate.match(daiAuthenticationKeyName).network_code;
+    }
+    /**
+     * Parse the dai_authentication_key from DaiAuthenticationKey resource.
+     *
+     * @param {string} daiAuthenticationKeyName
+     *   A fully-qualified path representing DaiAuthenticationKey resource.
+     * @returns {string} A string representing the dai_authentication_key.
+     */
+    matchDaiAuthenticationKeyFromDaiAuthenticationKeyName(daiAuthenticationKeyName) {
+        return this.pathTemplates.daiAuthenticationKeyPathTemplate.match(daiAuthenticationKeyName).dai_authentication_key;
+    }
+    /**
+     * Return a fully-qualified daiEncodingProfile resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} dai_encoding_profile
+     * @returns {string} Resource name string.
+     */
+    daiEncodingProfilePath(networkCode, daiEncodingProfile) {
+        return this.pathTemplates.daiEncodingProfilePathTemplate.render({
+            network_code: networkCode,
+            dai_encoding_profile: daiEncodingProfile,
+        });
+    }
+    /**
+     * Parse the network_code from DaiEncodingProfile resource.
+     *
+     * @param {string} daiEncodingProfileName
+     *   A fully-qualified path representing DaiEncodingProfile resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromDaiEncodingProfileName(daiEncodingProfileName) {
+        return this.pathTemplates.daiEncodingProfilePathTemplate.match(daiEncodingProfileName).network_code;
+    }
+    /**
+     * Parse the dai_encoding_profile from DaiEncodingProfile resource.
+     *
+     * @param {string} daiEncodingProfileName
+     *   A fully-qualified path representing DaiEncodingProfile resource.
+     * @returns {string} A string representing the dai_encoding_profile.
+     */
+    matchDaiEncodingProfileFromDaiEncodingProfileName(daiEncodingProfileName) {
+        return this.pathTemplates.daiEncodingProfilePathTemplate.match(daiEncodingProfileName).dai_encoding_profile;
+    }
     /**
      * Return a fully-qualified deviceCapability resource name string.
      *
@@ -2009,6 +2291,40 @@ class CompanyServiceClient {
     matchOrderFromOrderName(orderName) {
         return this.pathTemplates.orderPathTemplate.match(orderName).order;
     }
+    /**
+     * Return a fully-qualified partner resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} partner
+     * @returns {string} Resource name string.
+     */
+    partnerPath(networkCode, partner) {
+        return this.pathTemplates.partnerPathTemplate.render({
+            network_code: networkCode,
+            partner: partner,
+        });
+    }
+    /**
+     * Parse the network_code from Partner resource.
+     *
+     * @param {string} partnerName
+     *   A fully-qualified path representing Partner resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromPartnerName(partnerName) {
+        return this.pathTemplates.partnerPathTemplate.match(partnerName)
+            .network_code;
+    }
+    /**
+     * Parse the partner from Partner resource.
+     *
+     * @param {string} partnerName
+     *   A fully-qualified path representing Partner resource.
+     * @returns {string} A string representing the partner.
+     */
+    matchPartnerFromPartnerName(partnerName) {
+        return this.pathTemplates.partnerPathTemplate.match(partnerName).partner;
+    }
     /**
      * Return a fully-qualified placement resource name string.
      *
@@ -2506,6 +2822,39 @@ class CompanyServiceClient {
     matchUserFromUserName(userName) {
         return this.pathTemplates.userPathTemplate.match(userName).user;
     }
+    /**
+     * Return a fully-qualified viewabilityProvider resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} viewability_provider
+     * @returns {string} Resource name string.
+     */
+    viewabilityProviderPath(networkCode, viewabilityProvider) {
+        return this.pathTemplates.viewabilityProviderPathTemplate.render({
+            network_code: networkCode,
+            viewability_provider: viewabilityProvider,
+        });
+    }
+    /**
+     * Parse the network_code from ViewabilityProvider resource.
+     *
+     * @param {string} viewabilityProviderName
+     *   A fully-qualified path representing ViewabilityProvider resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromViewabilityProviderName(viewabilityProviderName) {
+        return this.pathTemplates.viewabilityProviderPathTemplate.match(viewabilityProviderName).network_code;
+    }
+    /**
+     * Parse the viewability_provider from ViewabilityProvider resource.
+     *
+     * @param {string} viewabilityProviderName
+     *   A fully-qualified path representing ViewabilityProvider resource.
+     * @returns {string} A string representing the viewability_provider.
+     */
+    matchViewabilityProviderFromViewabilityProviderName(viewabilityProviderName) {
+        return this.pathTemplates.viewabilityProviderPathTemplate.match(viewabilityProviderName).viewability_provider;
+    }
     /**
      * Return a fully-qualified webProperty resource name string.
      *