@google-ads/admanager 0.4.0 → 0.5.0

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

@@ -150,8 +150,8 @@ export declare class AdUnitServiceClient {
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of AdUnits to return. The service may return
     *   fewer than this value. If unspecified, at most 50 ad units will be
-    *   returned. The maximum value is 1000; values above 1000 will be coerced to
-    *   1000.
+    *   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 `ListAdUnits` call.
     *   Provide this to retrieve the subsequent page.
@@ -197,8 +197,8 @@ export declare class AdUnitServiceClient {
      * @param {number} [request.pageSize]
      *   Optional. The maximum number of AdUnits to return. The service may return
      *   fewer than this value. If unspecified, at most 50 ad units will be
-     *   returned. The maximum value is 1000; values above 1000 will be coerced to
-     *   1000.
+     *   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 `ListAdUnits` call.
      *   Provide this to retrieve the subsequent page.
@@ -239,8 +239,8 @@ export declare class AdUnitServiceClient {
      * @param {number} [request.pageSize]
      *   Optional. The maximum number of AdUnits to return. The service may return
      *   fewer than this value. If unspecified, at most 50 ad units will be
-     *   returned. The maximum value is 1000; values above 1000 will be coerced to
-     *   1000.
+     *   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 `ListAdUnits` call.
      *   Provide this to retrieve the subsequent page.
@@ -281,8 +281,8 @@ export declare class AdUnitServiceClient {
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of AdUnitSizes to return. The service may
     *   return fewer than this value. If unspecified, at most 50 ad unit sizes will
-    *   be returned. The maximum value is 1000; values above 1000 will be coerced
-    *   to 1000.
+    *   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 `ListAdUnitSizes` call.
     *   Provide this to retrieve the subsequent page.
@@ -328,8 +328,8 @@ export declare class AdUnitServiceClient {
      * @param {number} [request.pageSize]
      *   Optional. The maximum number of AdUnitSizes to return. The service may
      *   return fewer than this value. If unspecified, at most 50 ad unit sizes will
-     *   be returned. The maximum value is 1000; values above 1000 will be coerced
-     *   to 1000.
+     *   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 `ListAdUnitSizes` call.
      *   Provide this to retrieve the subsequent page.
@@ -370,8 +370,8 @@ export declare class AdUnitServiceClient {
      * @param {number} [request.pageSize]
      *   Optional. The maximum number of AdUnitSizes to return. The service may
      *   return fewer than this value. If unspecified, at most 50 ad unit sizes will
-     *   be returned. The maximum value is 1000; values above 1000 will be coerced
-     *   to 1000.
+     *   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 `ListAdUnitSizes` call.
      *   Provide this to retrieve the subsequent page.
@@ -434,6 +434,39 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the ad_break.
      */
     matchAdBreakFromAdBreakName(adBreakName: string): string | number;
+    /**
+     * Return a fully-qualified adReviewCenterAd resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} web_property_code
+     * @param {string} ad_review_center_ad
+     * @returns {string} Resource name string.
+     */
+    adReviewCenterAdPath(networkCode: string, webPropertyCode: string, adReviewCenterAd: string): string;
+    /**
+     * Parse the network_code from AdReviewCenterAd resource.
+     *
+     * @param {string} adReviewCenterAdName
+     *   A fully-qualified path representing AdReviewCenterAd resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromAdReviewCenterAdName(adReviewCenterAdName: string): string | number;
+    /**
+     * Parse the web_property_code from AdReviewCenterAd resource.
+     *
+     * @param {string} adReviewCenterAdName
+     *   A fully-qualified path representing AdReviewCenterAd resource.
+     * @returns {string} A string representing the web_property_code.
+     */
+    matchWebPropertyCodeFromAdReviewCenterAdName(adReviewCenterAdName: string): string | number;
+    /**
+     * Parse the ad_review_center_ad from AdReviewCenterAd resource.
+     *
+     * @param {string} adReviewCenterAdName
+     *   A fully-qualified path representing AdReviewCenterAd resource.
+     * @returns {string} A string representing the ad_review_center_ad.
+     */
+    matchAdReviewCenterAdFromAdReviewCenterAdName(adReviewCenterAdName: string): string | number;
     /**
      * Return a fully-qualified adUnit resource name string.
      *
@@ -458,6 +491,54 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the ad_unit.
      */
     matchAdUnitFromAdUnitName(adUnitName: string): string | number;
+    /**
+     * Return a fully-qualified application resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} application
+     * @returns {string} Resource name string.
+     */
+    applicationPath(networkCode: string, application: string): string;
+    /**
+     * Parse the network_code from Application resource.
+     *
+     * @param {string} applicationName
+     *   A fully-qualified path representing Application resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromApplicationName(applicationName: string): string | number;
+    /**
+     * Parse the application from Application resource.
+     *
+     * @param {string} applicationName
+     *   A fully-qualified path representing Application resource.
+     * @returns {string} A string representing the application.
+     */
+    matchApplicationFromApplicationName(applicationName: string): string | number;
+    /**
+     * Return a fully-qualified audienceSegment resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} audience_segment
+     * @returns {string} Resource name string.
+     */
+    audienceSegmentPath(networkCode: string, audienceSegment: string): string;
+    /**
+     * Parse the network_code from AudienceSegment resource.
+     *
+     * @param {string} audienceSegmentName
+     *   A fully-qualified path representing AudienceSegment resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromAudienceSegmentName(audienceSegmentName: string): string | number;
+    /**
+     * Parse the audience_segment from AudienceSegment resource.
+     *
+     * @param {string} audienceSegmentName
+     *   A fully-qualified path representing AudienceSegment resource.
+     * @returns {string} A string representing the audience_segment.
+     */
+    matchAudienceSegmentFromAudienceSegmentName(audienceSegmentName: string): string | number;
     /**
      * Return a fully-qualified bandwidthGroup resource name string.
      *
@@ -482,6 +563,102 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the bandwidth_group.
      */
     matchBandwidthGroupFromBandwidthGroupName(bandwidthGroupName: string): string | number;
+    /**
+     * Return a fully-qualified browser resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} browser
+     * @returns {string} Resource name string.
+     */
+    browserPath(networkCode: string, browser: string): string;
+    /**
+     * Parse the network_code from Browser resource.
+     *
+     * @param {string} browserName
+     *   A fully-qualified path representing Browser resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromBrowserName(browserName: string): string | number;
+    /**
+     * Parse the browser from Browser resource.
+     *
+     * @param {string} browserName
+     *   A fully-qualified path representing Browser resource.
+     * @returns {string} A string representing the browser.
+     */
+    matchBrowserFromBrowserName(browserName: string): string | number;
+    /**
+     * Return a fully-qualified browserLanguage resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} browser_language
+     * @returns {string} Resource name string.
+     */
+    browserLanguagePath(networkCode: string, browserLanguage: string): string;
+    /**
+     * Parse the network_code from BrowserLanguage resource.
+     *
+     * @param {string} browserLanguageName
+     *   A fully-qualified path representing BrowserLanguage resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromBrowserLanguageName(browserLanguageName: string): string | number;
+    /**
+     * Parse the browser_language from BrowserLanguage resource.
+     *
+     * @param {string} browserLanguageName
+     *   A fully-qualified path representing BrowserLanguage resource.
+     * @returns {string} A string representing the browser_language.
+     */
+    matchBrowserLanguageFromBrowserLanguageName(browserLanguageName: string): string | number;
+    /**
+     * Return a fully-qualified cmsMetadataKey resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} cms_metadata_key
+     * @returns {string} Resource name string.
+     */
+    cmsMetadataKeyPath(networkCode: string, cmsMetadataKey: string): string;
+    /**
+     * Parse the network_code from CmsMetadataKey resource.
+     *
+     * @param {string} cmsMetadataKeyName
+     *   A fully-qualified path representing CmsMetadataKey resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromCmsMetadataKeyName(cmsMetadataKeyName: string): string | number;
+    /**
+     * Parse the cms_metadata_key from CmsMetadataKey resource.
+     *
+     * @param {string} cmsMetadataKeyName
+     *   A fully-qualified path representing CmsMetadataKey resource.
+     * @returns {string} A string representing the cms_metadata_key.
+     */
+    matchCmsMetadataKeyFromCmsMetadataKeyName(cmsMetadataKeyName: string): string | number;
+    /**
+     * Return a fully-qualified cmsMetadataValue resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} cms_metadata_value
+     * @returns {string} Resource name string.
+     */
+    cmsMetadataValuePath(networkCode: string, cmsMetadataValue: string): string;
+    /**
+     * Parse the network_code from CmsMetadataValue resource.
+     *
+     * @param {string} cmsMetadataValueName
+     *   A fully-qualified path representing CmsMetadataValue resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromCmsMetadataValueName(cmsMetadataValueName: string): string | number;
+    /**
+     * Parse the cms_metadata_value from CmsMetadataValue resource.
+     *
+     * @param {string} cmsMetadataValueName
+     *   A fully-qualified path representing CmsMetadataValue resource.
+     * @returns {string} A string representing the cms_metadata_value.
+     */
+    matchCmsMetadataValueFromCmsMetadataValueName(cmsMetadataValueName: string): string | number;
     /**
      * Return a fully-qualified company resource name string.
      *
@@ -530,6 +707,102 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the contact.
      */
     matchContactFromContactName(contactName: string): string | number;
+    /**
+     * Return a fully-qualified content resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} content
+     * @returns {string} Resource name string.
+     */
+    contentPath(networkCode: string, content: string): string;
+    /**
+     * Parse the network_code from Content resource.
+     *
+     * @param {string} contentName
+     *   A fully-qualified path representing Content resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromContentName(contentName: string): string | number;
+    /**
+     * Parse the content from Content resource.
+     *
+     * @param {string} contentName
+     *   A fully-qualified path representing Content resource.
+     * @returns {string} A string representing the content.
+     */
+    matchContentFromContentName(contentName: string): string | number;
+    /**
+     * Return a fully-qualified contentBundle resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} content_bundle
+     * @returns {string} Resource name string.
+     */
+    contentBundlePath(networkCode: string, contentBundle: string): string;
+    /**
+     * Parse the network_code from ContentBundle resource.
+     *
+     * @param {string} contentBundleName
+     *   A fully-qualified path representing ContentBundle resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromContentBundleName(contentBundleName: string): string | number;
+    /**
+     * Parse the content_bundle from ContentBundle resource.
+     *
+     * @param {string} contentBundleName
+     *   A fully-qualified path representing ContentBundle resource.
+     * @returns {string} A string representing the content_bundle.
+     */
+    matchContentBundleFromContentBundleName(contentBundleName: string): string | number;
+    /**
+     * Return a fully-qualified contentLabel resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} content_label
+     * @returns {string} Resource name string.
+     */
+    contentLabelPath(networkCode: string, contentLabel: string): string;
+    /**
+     * Parse the network_code from ContentLabel resource.
+     *
+     * @param {string} contentLabelName
+     *   A fully-qualified path representing ContentLabel resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromContentLabelName(contentLabelName: string): string | number;
+    /**
+     * Parse the content_label from ContentLabel resource.
+     *
+     * @param {string} contentLabelName
+     *   A fully-qualified path representing ContentLabel resource.
+     * @returns {string} A string representing the content_label.
+     */
+    matchContentLabelFromContentLabelName(contentLabelName: string): string | number;
+    /**
+     * Return a fully-qualified creativeTemplate resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} creative_template
+     * @returns {string} Resource name string.
+     */
+    creativeTemplatePath(networkCode: string, creativeTemplate: string): string;
+    /**
+     * Parse the network_code from CreativeTemplate resource.
+     *
+     * @param {string} creativeTemplateName
+     *   A fully-qualified path representing CreativeTemplate resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromCreativeTemplateName(creativeTemplateName: string): string | number;
+    /**
+     * Parse the creative_template from CreativeTemplate resource.
+     *
+     * @param {string} creativeTemplateName
+     *   A fully-qualified path representing CreativeTemplate resource.
+     * @returns {string} A string representing the creative_template.
+     */
+    matchCreativeTemplateFromCreativeTemplateName(creativeTemplateName: string): string | number;
     /**
      * Return a fully-qualified customField resource name string.
      *
@@ -602,6 +875,30 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the custom_targeting_value.
      */
     matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName: string): string | number;
+    /**
+     * Return a fully-qualified deviceCapability resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} device_capability
+     * @returns {string} Resource name string.
+     */
+    deviceCapabilityPath(networkCode: string, deviceCapability: string): string;
+    /**
+     * Parse the network_code from DeviceCapability resource.
+     *
+     * @param {string} deviceCapabilityName
+     *   A fully-qualified path representing DeviceCapability resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromDeviceCapabilityName(deviceCapabilityName: string): string | number;
+    /**
+     * Parse the device_capability from DeviceCapability resource.
+     *
+     * @param {string} deviceCapabilityName
+     *   A fully-qualified path representing DeviceCapability resource.
+     * @returns {string} A string representing the device_capability.
+     */
+    matchDeviceCapabilityFromDeviceCapabilityName(deviceCapabilityName: string): string | number;
     /**
      * Return a fully-qualified deviceCategory resource name string.
      *
@@ -626,6 +923,30 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the device_category.
      */
     matchDeviceCategoryFromDeviceCategoryName(deviceCategoryName: string): string | number;
+    /**
+     * Return a fully-qualified deviceManufacturer resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} device_manufacturer
+     * @returns {string} Resource name string.
+     */
+    deviceManufacturerPath(networkCode: string, deviceManufacturer: string): string;
+    /**
+     * Parse the network_code from DeviceManufacturer resource.
+     *
+     * @param {string} deviceManufacturerName
+     *   A fully-qualified path representing DeviceManufacturer resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromDeviceManufacturerName(deviceManufacturerName: string): string | number;
+    /**
+     * Parse the device_manufacturer from DeviceManufacturer resource.
+     *
+     * @param {string} deviceManufacturerName
+     *   A fully-qualified path representing DeviceManufacturer resource.
+     * @returns {string} A string representing the device_manufacturer.
+     */
+    matchDeviceManufacturerFromDeviceManufacturerName(deviceManufacturerName: string): string | number;
     /**
      * Return a fully-qualified entitySignalsMapping resource name string.
      *
@@ -722,6 +1043,78 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the live_stream_event.
      */
     matchLiveStreamEventFromLiveStreamEventName(liveStreamEventName: string): string | number;
+    /**
+     * Return a fully-qualified mobileCarrier resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} mobile_carrier
+     * @returns {string} Resource name string.
+     */
+    mobileCarrierPath(networkCode: string, mobileCarrier: string): string;
+    /**
+     * Parse the network_code from MobileCarrier resource.
+     *
+     * @param {string} mobileCarrierName
+     *   A fully-qualified path representing MobileCarrier resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromMobileCarrierName(mobileCarrierName: string): string | number;
+    /**
+     * Parse the mobile_carrier from MobileCarrier resource.
+     *
+     * @param {string} mobileCarrierName
+     *   A fully-qualified path representing MobileCarrier resource.
+     * @returns {string} A string representing the mobile_carrier.
+     */
+    matchMobileCarrierFromMobileCarrierName(mobileCarrierName: string): string | number;
+    /**
+     * Return a fully-qualified mobileDevice resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} mobile_device
+     * @returns {string} Resource name string.
+     */
+    mobileDevicePath(networkCode: string, mobileDevice: string): string;
+    /**
+     * Parse the network_code from MobileDevice resource.
+     *
+     * @param {string} mobileDeviceName
+     *   A fully-qualified path representing MobileDevice resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromMobileDeviceName(mobileDeviceName: string): string | number;
+    /**
+     * Parse the mobile_device from MobileDevice resource.
+     *
+     * @param {string} mobileDeviceName
+     *   A fully-qualified path representing MobileDevice resource.
+     * @returns {string} A string representing the mobile_device.
+     */
+    matchMobileDeviceFromMobileDeviceName(mobileDeviceName: string): string | number;
+    /**
+     * Return a fully-qualified mobileDeviceSubmodel resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} mobile_device_submodel
+     * @returns {string} Resource name string.
+     */
+    mobileDeviceSubmodelPath(networkCode: string, mobileDeviceSubmodel: string): string;
+    /**
+     * Parse the network_code from MobileDeviceSubmodel resource.
+     *
+     * @param {string} mobileDeviceSubmodelName
+     *   A fully-qualified path representing MobileDeviceSubmodel resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromMobileDeviceSubmodelName(mobileDeviceSubmodelName: string): string | number;
+    /**
+     * Parse the mobile_device_submodel from MobileDeviceSubmodel resource.
+     *
+     * @param {string} mobileDeviceSubmodelName
+     *   A fully-qualified path representing MobileDeviceSubmodel resource.
+     * @returns {string} A string representing the mobile_device_submodel.
+     */
+    matchMobileDeviceSubmodelFromMobileDeviceSubmodelName(mobileDeviceSubmodelName: string): string | number;
     /**
      * Return a fully-qualified network resource name string.
      *
@@ -953,6 +1346,30 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the role.
      */
     matchRoleFromRoleName(roleName: string): string | number;
+    /**
+     * Return a fully-qualified site resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} site
+     * @returns {string} Resource name string.
+     */
+    sitePath(networkCode: string, site: string): string;
+    /**
+     * Parse the network_code from Site resource.
+     *
+     * @param {string} siteName
+     *   A fully-qualified path representing Site resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromSiteName(siteName: string): string | number;
+    /**
+     * Parse the site from Site resource.
+     *
+     * @param {string} siteName
+     *   A fully-qualified path representing Site resource.
+     * @returns {string} A string representing the site.
+     */
+    matchSiteFromSiteName(siteName: string): string | number;
     /**
      * Return a fully-qualified taxonomyCategory resource name string.
      *
@@ -1025,6 +1442,30 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the user.
      */
     matchUserFromUserName(userName: string): string | number;
+    /**
+     * Return a fully-qualified webProperty resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} web_property
+     * @returns {string} Resource name string.
+     */
+    webPropertyPath(networkCode: string, webProperty: string): string;
+    /**
+     * Parse the network_code from WebProperty resource.
+     *
+     * @param {string} webPropertyName
+     *   A fully-qualified path representing WebProperty resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromWebPropertyName(webPropertyName: string): string | number;
+    /**
+     * Parse the web_property from WebProperty resource.
+     *
+     * @param {string} webPropertyName
+     *   A fully-qualified path representing WebProperty resource.
+     * @returns {string} A string representing the web_property.
+     */
+    matchWebPropertyFromWebPropertyName(webPropertyName: string): string | number;
     /**
      * Terminate the gRPC channel and close the client.
      *