@google-ads/admanager 0.8.0 → 0.10.0

package/build/src/v1/creative_template_service_client.d.ts

@@ -163,18 +163,17 @@ export declare class CreativeTemplateServiceClient {
      *    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>description</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>interstitial</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>nativeEligible</code></li>
-     *     <li><code>nativeVideoEligible</code></li>
-     *     <li><code>safeFrameCompatible</code></li>
-     *     <li><code>status</code></li>
-     *     <li><code>type</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `description`
+     *   * `displayName`
+     *   * `interstitial`
+     *   * `name`
+     *   * `nativeEligible`
+     *   * `nativeVideoEligible`
+     *   * `safeFrameCompatible`
+     *   * `status`
+     *   * `type`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -223,18 +222,17 @@ export declare class CreativeTemplateServiceClient {
      *    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>description</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>interstitial</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>nativeEligible</code></li>
-     *     <li><code>nativeVideoEligible</code></li>
-     *     <li><code>safeFrameCompatible</code></li>
-     *     <li><code>status</code></li>
-     *     <li><code>type</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `description`
+     *   * `displayName`
+     *   * `interstitial`
+     *   * `name`
+     *   * `nativeEligible`
+     *   * `nativeVideoEligible`
+     *   * `safeFrameCompatible`
+     *   * `status`
+     *   * `type`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -278,18 +276,17 @@ export declare class CreativeTemplateServiceClient {
      *    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>description</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>interstitial</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>nativeEligible</code></li>
-     *     <li><code>nativeVideoEligible</code></li>
-     *     <li><code>safeFrameCompatible</code></li>
-     *     <li><code>status</code></li>
-     *     <li><code>type</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `description`
+     *   * `displayName`
+     *   * `interstitial`
+     *   * `name`
+     *   * `nativeEligible`
+     *   * `nativeVideoEligible`
+     *   * `safeFrameCompatible`
+     *   * `status`
+     *   * `type`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -855,6 +852,30 @@ export declare class CreativeTemplateServiceClient {
      * @returns {string} A string representing the creative_template.
      */
     matchCreativeTemplateFromCreativeTemplateName(creativeTemplateName: string): string | number;
+    /**
+     * Return a fully-qualified creativeWrapper resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} creative_wrapper
+     * @returns {string} Resource name string.
+     */
+    creativeWrapperPath(networkCode: string, creativeWrapper: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
     /**
      * Return a fully-qualified customField resource name string.
      *
@@ -927,6 +948,54 @@ export declare class CreativeTemplateServiceClient {
      * @returns {string} A string representing the custom_targeting_value.
      */
     matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName: string): string | number;
+    /**
+     * Return a fully-qualified daiAuthenticationKey resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} dai_authentication_key
+     * @returns {string} Resource name string.
+     */
+    daiAuthenticationKeyPath(networkCode: string, daiAuthenticationKey: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * Return a fully-qualified daiEncodingProfile resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} dai_encoding_profile
+     * @returns {string} Resource name string.
+     */
+    daiEncodingProfilePath(networkCode: string, daiEncodingProfile: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
     /**
      * Return a fully-qualified deviceCapability resource name string.
      *
@@ -1326,6 +1395,30 @@ export declare class CreativeTemplateServiceClient {
      * @returns {string} A string representing the order.
      */
     matchOrderFromOrderName(orderName: string): string | number;
+    /**
+     * Return a fully-qualified partner resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} partner
+     * @returns {string} Resource name string.
+     */
+    partnerPath(networkCode: string, partner: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
     /**
      * Return a fully-qualified placement resource name string.
      *
@@ -1686,6 +1779,30 @@ export declare class CreativeTemplateServiceClient {
      * @returns {string} A string representing the user.
      */
     matchUserFromUserName(userName: string): string | number;
+    /**
+     * Return a fully-qualified viewabilityProvider resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} viewability_provider
+     * @returns {string} Resource name string.
+     */
+    viewabilityProviderPath(networkCode: string, viewabilityProvider: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
     /**
      * Return a fully-qualified webProperty resource name string.
      *

package/build/src/v1/creative_template_service_client.js

@@ -196,9 +196,12 @@ class CreativeTemplateServiceClient {
             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}'),
@@ -216,6 +219,7 @@ class CreativeTemplateServiceClient {
             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}'),
@@ -231,6 +235,7 @@ class CreativeTemplateServiceClient {
             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,
@@ -455,18 +460,17 @@ class CreativeTemplateServiceClient {
      *    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>description</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>interstitial</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>nativeEligible</code></li>
-     *     <li><code>nativeVideoEligible</code></li>
-     *     <li><code>safeFrameCompatible</code></li>
-     *     <li><code>status</code></li>
-     *     <li><code>type</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `description`
+     *   * `displayName`
+     *   * `interstitial`
+     *   * `name`
+     *   * `nativeEligible`
+     *   * `nativeVideoEligible`
+     *   * `safeFrameCompatible`
+     *   * `status`
+     *   * `type`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -526,18 +530,17 @@ class CreativeTemplateServiceClient {
      *    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>description</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>interstitial</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>nativeEligible</code></li>
-     *     <li><code>nativeVideoEligible</code></li>
-     *     <li><code>safeFrameCompatible</code></li>
-     *     <li><code>status</code></li>
-     *     <li><code>type</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `description`
+     *   * `displayName`
+     *   * `interstitial`
+     *   * `name`
+     *   * `nativeEligible`
+     *   * `nativeVideoEligible`
+     *   * `safeFrameCompatible`
+     *   * `status`
+     *   * `type`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -1342,6 +1345,39 @@ class CreativeTemplateServiceClient {
     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.
      *
@@ -1443,6 +1479,72 @@ class CreativeTemplateServiceClient {
     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.
      *
@@ -2005,6 +2107,40 @@ class CreativeTemplateServiceClient {
     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.
      *
@@ -2502,6 +2638,39 @@ class CreativeTemplateServiceClient {
     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.
      *