@google-ads/admanager 0.3.0 → 0.4.1

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

@@ -112,7 +112,7 @@ export declare class AdUnitServiceClient {
      * in this service.
      * @returns {string[]} List of default scopes.
      */
-    static get scopes(): never[];
+    static get scopes(): string[];
     getProjectId(): Promise<string>;
     getProjectId(callback: Callback<string, undefined, undefined>): void;
     /**
@@ -140,46 +140,46 @@ export declare class AdUnitServiceClient {
     getAdUnit(request: protos.google.ads.admanager.v1.IGetAdUnitRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IAdUnit, protos.google.ads.admanager.v1.IGetAdUnitRequest | null | undefined, {} | null | undefined>): void;
     getAdUnit(request: protos.google.ads.admanager.v1.IGetAdUnitRequest, callback: Callback<protos.google.ads.admanager.v1.IAdUnit, protos.google.ads.admanager.v1.IGetAdUnitRequest | null | undefined, {} | null | undefined>): void;
     /**
-     * API to retrieve a list of AdUnit objects.
-     *
-     * @param {Object} request
-     *   The request object that will be sent.
-     * @param {string} request.parent
-     *   Required. The parent, which owns this collection of AdUnits.
-     *   Format: `networks/{network_code}`
-     * @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.
-     * @param {string} [request.pageToken]
-     *   Optional. A page token, received from a previous `ListAdUnits` call.
-     *   Provide this to retrieve the subsequent page.
-     *
-     *   When paginating, all other parameters provided to `ListAdUnits` 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
-     * @param {string} [request.orderBy]
-     *   Optional. Expression to specify sorting order.
-     *   See syntax details at
-     *   https://developers.google.com/ad-manager/api/beta/filters#order
-     * @param {number} [request.skip]
-     *   Optional. Number of individual resources to skip while paginating.
-     * @param {object} [options]
-     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
-     * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is Array of {@link protos.google.ads.admanager.v1.AdUnit|AdUnit}.
-     *   The client library will perform auto-pagination by default: it will call the API as many
-     *   times as needed and will merge results from all the pages into this array.
-     *   Note that it can affect your quota.
-     *   We recommend using `listAdUnitsAsync()`
-     *   method described below for async iteration which you can stop as needed.
-     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
-     *   for more details and examples.
-     */
+    * API to retrieve a list of AdUnit objects.
+    *
+    * @param {Object} request
+    *   The request object that will be sent.
+    * @param {string} request.parent
+    *   Required. The parent, which owns this collection of AdUnits.
+    *   Format: `networks/{network_code}`
+    * @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.
+    * @param {string} [request.pageToken]
+    *   Optional. A page token, received from a previous `ListAdUnits` call.
+    *   Provide this to retrieve the subsequent page.
+    *
+    *   When paginating, all other parameters provided to `ListAdUnits` 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
+    * @param {string} [request.orderBy]
+    *   Optional. Expression to specify sorting order.
+    *   See syntax details at
+    *   https://developers.google.com/ad-manager/api/beta/filters#order
+    * @param {number} [request.skip]
+    *   Optional. Number of individual resources to skip while paginating.
+    * @param {object} [options]
+    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+    * @returns {Promise} - The promise which resolves to an array.
+    *   The first element of the array is Array of {@link protos.google.ads.admanager.v1.AdUnit|AdUnit}.
+    *   The client library will perform auto-pagination by default: it will call the API as many
+    *   times as needed and will merge results from all the pages into this array.
+    *   Note that it can affect your quota.
+    *   We recommend using `listAdUnitsAsync()`
+    *   method described below for async iteration which you can stop as needed.
+    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+    *   for more details and examples.
+    */
     listAdUnits(request?: protos.google.ads.admanager.v1.IListAdUnitsRequest, options?: CallOptions): Promise<[
         protos.google.ads.admanager.v1.IAdUnit[],
         protos.google.ads.admanager.v1.IListAdUnitsRequest | null,
@@ -271,46 +271,46 @@ export declare class AdUnitServiceClient {
      */
     listAdUnitsAsync(request?: protos.google.ads.admanager.v1.IListAdUnitsRequest, options?: CallOptions): AsyncIterable<protos.google.ads.admanager.v1.IAdUnit>;
     /**
-     * API to retrieve a list of AdUnitSize objects.
-     *
-     * @param {Object} request
-     *   The request object that will be sent.
-     * @param {string} request.parent
-     *   Required. The parent, which owns this collection of AdUnitSizes.
-     *   Format: `networks/{network_code}`
-     * @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.
-     * @param {string} [request.pageToken]
-     *   Optional. A page token, received from a previous `ListAdUnitSizes` call.
-     *   Provide this to retrieve the subsequent page.
-     *
-     *   When paginating, all other parameters provided to `ListAdUnitSizes` 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
-     * @param {string} [request.orderBy]
-     *   Optional. Expression to specify sorting order.
-     *   See syntax details at
-     *   https://developers.google.com/ad-manager/api/beta/filters#order
-     * @param {number} [request.skip]
-     *   Optional. Number of individual resources to skip while paginating.
-     * @param {object} [options]
-     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
-     * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is Array of {@link protos.google.ads.admanager.v1.AdUnitSize|AdUnitSize}.
-     *   The client library will perform auto-pagination by default: it will call the API as many
-     *   times as needed and will merge results from all the pages into this array.
-     *   Note that it can affect your quota.
-     *   We recommend using `listAdUnitSizesAsync()`
-     *   method described below for async iteration which you can stop as needed.
-     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
-     *   for more details and examples.
-     */
+    * API to retrieve a list of AdUnitSize objects.
+    *
+    * @param {Object} request
+    *   The request object that will be sent.
+    * @param {string} request.parent
+    *   Required. The parent, which owns this collection of AdUnitSizes.
+    *   Format: `networks/{network_code}`
+    * @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.
+    * @param {string} [request.pageToken]
+    *   Optional. A page token, received from a previous `ListAdUnitSizes` call.
+    *   Provide this to retrieve the subsequent page.
+    *
+    *   When paginating, all other parameters provided to `ListAdUnitSizes` 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
+    * @param {string} [request.orderBy]
+    *   Optional. Expression to specify sorting order.
+    *   See syntax details at
+    *   https://developers.google.com/ad-manager/api/beta/filters#order
+    * @param {number} [request.skip]
+    *   Optional. Number of individual resources to skip while paginating.
+    * @param {object} [options]
+    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+    * @returns {Promise} - The promise which resolves to an array.
+    *   The first element of the array is Array of {@link protos.google.ads.admanager.v1.AdUnitSize|AdUnitSize}.
+    *   The client library will perform auto-pagination by default: it will call the API as many
+    *   times as needed and will merge results from all the pages into this array.
+    *   Note that it can affect your quota.
+    *   We recommend using `listAdUnitSizesAsync()`
+    *   method described below for async iteration which you can stop as needed.
+    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+    *   for more details and examples.
+    */
     listAdUnitSizes(request?: protos.google.ads.admanager.v1.IListAdUnitSizesRequest, options?: CallOptions): Promise<[
         protos.google.ads.admanager.v1.IAdUnitSize[],
         protos.google.ads.admanager.v1.IListAdUnitSizesRequest | null,
@@ -401,6 +401,39 @@ export declare class AdUnitServiceClient {
      * region_tag:admanager_v1_generated_AdUnitService_ListAdUnitSizes_async
      */
     listAdUnitSizesAsync(request?: protos.google.ads.admanager.v1.IListAdUnitSizesRequest, options?: CallOptions): AsyncIterable<protos.google.ads.admanager.v1.IAdUnitSize>;
+    /**
+     * Return a fully-qualified adBreak resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} asset_key
+     * @param {string} ad_break
+     * @returns {string} Resource name string.
+     */
+    adBreakPath(networkCode: string, assetKey: string, adBreak: string): string;
+    /**
+     * Parse the network_code from AdBreak resource.
+     *
+     * @param {string} adBreakName
+     *   A fully-qualified path representing AdBreak resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromAdBreakName(adBreakName: string): string | number;
+    /**
+     * Parse the asset_key from AdBreak resource.
+     *
+     * @param {string} adBreakName
+     *   A fully-qualified path representing AdBreak resource.
+     * @returns {string} A string representing the asset_key.
+     */
+    matchAssetKeyFromAdBreakName(adBreakName: string): string | number;
+    /**
+     * Parse the ad_break from AdBreak resource.
+     *
+     * @param {string} adBreakName
+     *   A fully-qualified path representing AdBreak resource.
+     * @returns {string} A string representing the ad_break.
+     */
+    matchAdBreakFromAdBreakName(adBreakName: string): string | number;
     /**
      * Return a fully-qualified adUnit resource name string.
      *
@@ -425,6 +458,30 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the ad_unit.
      */
     matchAdUnitFromAdUnitName(adUnitName: string): string | number;
+    /**
+     * Return a fully-qualified bandwidthGroup resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} bandwidth_group
+     * @returns {string} Resource name string.
+     */
+    bandwidthGroupPath(networkCode: string, bandwidthGroup: string): string;
+    /**
+     * Parse the network_code from BandwidthGroup resource.
+     *
+     * @param {string} bandwidthGroupName
+     *   A fully-qualified path representing BandwidthGroup resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromBandwidthGroupName(bandwidthGroupName: string): string | number;
+    /**
+     * Parse the bandwidth_group from BandwidthGroup resource.
+     *
+     * @param {string} bandwidthGroupName
+     *   A fully-qualified path representing BandwidthGroup resource.
+     * @returns {string} A string representing the bandwidth_group.
+     */
+    matchBandwidthGroupFromBandwidthGroupName(bandwidthGroupName: string): string | number;
     /**
      * Return a fully-qualified company resource name string.
      *
@@ -525,11 +582,10 @@ export declare class AdUnitServiceClient {
      * Return a fully-qualified customTargetingValue resource name string.
      *
      * @param {string} network_code
-     * @param {string} custom_targeting_key
      * @param {string} custom_targeting_value
      * @returns {string} Resource name string.
      */
-    customTargetingValuePath(networkCode: string, customTargetingKey: string, customTargetingValue: string): string;
+    customTargetingValuePath(networkCode: string, customTargetingValue: string): string;
     /**
      * Parse the network_code from CustomTargetingValue resource.
      *
@@ -538,14 +594,6 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the network_code.
      */
     matchNetworkCodeFromCustomTargetingValueName(customTargetingValueName: string): string | number;
-    /**
-     * Parse the custom_targeting_key from CustomTargetingValue resource.
-     *
-     * @param {string} customTargetingValueName
-     *   A fully-qualified path representing CustomTargetingValue resource.
-     * @returns {string} A string representing the custom_targeting_key.
-     */
-    matchCustomTargetingKeyFromCustomTargetingValueName(customTargetingValueName: string): string | number;
     /**
      * Parse the custom_targeting_value from CustomTargetingValue resource.
      *
@@ -554,6 +602,30 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the custom_targeting_value.
      */
     matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName: string): string | number;
+    /**
+     * Return a fully-qualified deviceCategory resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} device_category
+     * @returns {string} Resource name string.
+     */
+    deviceCategoryPath(networkCode: string, deviceCategory: string): string;
+    /**
+     * Parse the network_code from DeviceCategory resource.
+     *
+     * @param {string} deviceCategoryName
+     *   A fully-qualified path representing DeviceCategory resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromDeviceCategoryName(deviceCategoryName: string): string | number;
+    /**
+     * Parse the device_category from DeviceCategory resource.
+     *
+     * @param {string} deviceCategoryName
+     *   A fully-qualified path representing DeviceCategory resource.
+     * @returns {string} A string representing the device_category.
+     */
+    matchDeviceCategoryFromDeviceCategoryName(deviceCategoryName: string): string | number;
     /**
      * Return a fully-qualified entitySignalsMapping resource name string.
      *
@@ -578,6 +650,30 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the entity_signals_mapping.
      */
     matchEntitySignalsMappingFromEntitySignalsMappingName(entitySignalsMappingName: string): string | number;
+    /**
+     * Return a fully-qualified geoTarget resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} geo_target
+     * @returns {string} Resource name string.
+     */
+    geoTargetPath(networkCode: string, geoTarget: string): string;
+    /**
+     * Parse the network_code from GeoTarget resource.
+     *
+     * @param {string} geoTargetName
+     *   A fully-qualified path representing GeoTarget resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromGeoTargetName(geoTargetName: string): string | number;
+    /**
+     * Parse the geo_target from GeoTarget resource.
+     *
+     * @param {string} geoTargetName
+     *   A fully-qualified path representing GeoTarget resource.
+     * @returns {string} A string representing the geo_target.
+     */
+    matchGeoTargetFromGeoTargetName(geoTargetName: string): string | number;
     /**
      * Return a fully-qualified label resource name string.
      *
@@ -602,6 +698,30 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the label.
      */
     matchLabelFromLabelName(labelName: string): string | number;
+    /**
+     * Return a fully-qualified liveStreamEvent resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} live_stream_event
+     * @returns {string} Resource name string.
+     */
+    liveStreamEventPath(networkCode: string, liveStreamEvent: string): string;
+    /**
+     * Parse the network_code from LiveStreamEvent resource.
+     *
+     * @param {string} liveStreamEventName
+     *   A fully-qualified path representing LiveStreamEvent resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromLiveStreamEventName(liveStreamEventName: string): string | number;
+    /**
+     * Parse the live_stream_event from LiveStreamEvent resource.
+     *
+     * @param {string} liveStreamEventName
+     *   A fully-qualified path representing LiveStreamEvent resource.
+     * @returns {string} A string representing the live_stream_event.
+     */
+    matchLiveStreamEventFromLiveStreamEventName(liveStreamEventName: string): string | number;
     /**
      * Return a fully-qualified network resource name string.
      *
@@ -617,6 +737,54 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the network_code.
      */
     matchNetworkCodeFromNetworkName(networkName: string): string | number;
+    /**
+     * Return a fully-qualified operatingSystem resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} operating_system
+     * @returns {string} Resource name string.
+     */
+    operatingSystemPath(networkCode: string, operatingSystem: string): string;
+    /**
+     * Parse the network_code from OperatingSystem resource.
+     *
+     * @param {string} operatingSystemName
+     *   A fully-qualified path representing OperatingSystem resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromOperatingSystemName(operatingSystemName: string): string | number;
+    /**
+     * Parse the operating_system from OperatingSystem resource.
+     *
+     * @param {string} operatingSystemName
+     *   A fully-qualified path representing OperatingSystem resource.
+     * @returns {string} A string representing the operating_system.
+     */
+    matchOperatingSystemFromOperatingSystemName(operatingSystemName: string): string | number;
+    /**
+     * Return a fully-qualified operatingSystemVersion resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} operating_system_version
+     * @returns {string} Resource name string.
+     */
+    operatingSystemVersionPath(networkCode: string, operatingSystemVersion: string): string;
+    /**
+     * Parse the network_code from OperatingSystemVersion resource.
+     *
+     * @param {string} operatingSystemVersionName
+     *   A fully-qualified path representing OperatingSystemVersion resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromOperatingSystemVersionName(operatingSystemVersionName: string): string | number;
+    /**
+     * Parse the operating_system_version from OperatingSystemVersion resource.
+     *
+     * @param {string} operatingSystemVersionName
+     *   A fully-qualified path representing OperatingSystemVersion resource.
+     * @returns {string} A string representing the operating_system_version.
+     */
+    matchOperatingSystemVersionFromOperatingSystemVersionName(operatingSystemVersionName: string): string | number;
     /**
      * Return a fully-qualified order resource name string.
      *
@@ -665,6 +833,78 @@ export declare class AdUnitServiceClient {
      * @returns {string} A string representing the placement.
      */
     matchPlacementFromPlacementName(placementName: string): string | number;
+    /**
+     * Return a fully-qualified privateAuction resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} private_auction
+     * @returns {string} Resource name string.
+     */
+    privateAuctionPath(networkCode: string, privateAuction: string): string;
+    /**
+     * Parse the network_code from PrivateAuction resource.
+     *
+     * @param {string} privateAuctionName
+     *   A fully-qualified path representing PrivateAuction resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromPrivateAuctionName(privateAuctionName: string): string | number;
+    /**
+     * Parse the private_auction from PrivateAuction resource.
+     *
+     * @param {string} privateAuctionName
+     *   A fully-qualified path representing PrivateAuction resource.
+     * @returns {string} A string representing the private_auction.
+     */
+    matchPrivateAuctionFromPrivateAuctionName(privateAuctionName: string): string | number;
+    /**
+     * Return a fully-qualified privateAuctionDeal resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} private_auction_deal
+     * @returns {string} Resource name string.
+     */
+    privateAuctionDealPath(networkCode: string, privateAuctionDeal: string): string;
+    /**
+     * Parse the network_code from PrivateAuctionDeal resource.
+     *
+     * @param {string} privateAuctionDealName
+     *   A fully-qualified path representing PrivateAuctionDeal resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromPrivateAuctionDealName(privateAuctionDealName: string): string | number;
+    /**
+     * Parse the private_auction_deal from PrivateAuctionDeal resource.
+     *
+     * @param {string} privateAuctionDealName
+     *   A fully-qualified path representing PrivateAuctionDeal resource.
+     * @returns {string} A string representing the private_auction_deal.
+     */
+    matchPrivateAuctionDealFromPrivateAuctionDealName(privateAuctionDealName: string): string | number;
+    /**
+     * Return a fully-qualified programmaticBuyer resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} programmatic_buyer
+     * @returns {string} Resource name string.
+     */
+    programmaticBuyerPath(networkCode: string, programmaticBuyer: string): string;
+    /**
+     * Parse the network_code from ProgrammaticBuyer resource.
+     *
+     * @param {string} programmaticBuyerName
+     *   A fully-qualified path representing ProgrammaticBuyer resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromProgrammaticBuyerName(programmaticBuyerName: string): string | number;
+    /**
+     * Parse the programmatic_buyer from ProgrammaticBuyer resource.
+     *
+     * @param {string} programmaticBuyerName
+     *   A fully-qualified path representing ProgrammaticBuyer resource.
+     * @returns {string} A string representing the programmatic_buyer.
+     */
+    matchProgrammaticBuyerFromProgrammaticBuyerName(programmaticBuyerName: string): string | number;
     /**
      * Return a fully-qualified report resource name string.
      *