@google-ads/admanager 0.5.0 → 0.6.0

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

@@ -231,63 +231,70 @@ export declare class AdReviewCenterAdServiceClient {
      */
     checkBatchBlockAdReviewCenterAdsProgress(name: string): Promise<LROperation<protos.google.ads.admanager.v1.BatchBlockAdReviewCenterAdsResponse, protos.google.ads.admanager.v1.BatchAdReviewCenterAdsOperationMetadata>>;
     /**
-    * API to search for AdReviewCenterAds.
-    *
-    * @param {Object} request
-    *   The request object that will be sent.
-    * @param {string} request.parent
-    *   Required. The parent, which owns this collection of AdReviewCenterAds.
-    *   Format: networks/{network_code}/webProperties/{web_property_code}
-    *
-    *   Since a network can only have a single web property of each
-    *   `ExchangeSyndicationProduct`, you can use the
-    *   `ExchangeSyndicationProduct` as an alias for the web property code:
-    *
-    *   `networks/{network_code}/webProperties/display`
-    *
-    *   `networks/{network_code}/webProperties/videoAndAudio`
-    *
-    *   `networks/{network_code}/webProperties/mobileApp`
-    *
-    *   `networks/{network_code}/webProperties/games`
-    * @param {number} [request.pageSize]
-    *   Optional. The maximum number of AdReviewCenterAds to return. The service
-    *   may return fewer than this value. If unspecified, at most 50
-    *   AdReviewCenterAds will be returned. The maximum value is 1000; values
-    *   greater than 1000 will be coerced to 1000.
-    * @param {string} [request.pageToken]
-    *   Optional. The page token to fetch the next page of AdReviewCenterAds. This
-    *   is the value returned from a previous Search request, or empty.
-    * @param {google.ads.admanager.v1.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus} request.status
-    *   Required. Only return ads with the given status.
-    * @param {string[]} [request.adReviewCenterAdId]
-    *   Optional. If provided, only return ads with the given AdReviewCenterAd IDs.
-    * @param {google.type.Interval} [request.dateTimeRange]
-    *   Optional. If provided, only return ads that served within the given date
-    *   range (inclusive). The  date range must be within the last 30 days. If not
-    *   provided, the date range will be the last 30 days.
-    * @param {string[]} [request.searchText]
-    *   Optional. If provided, restrict the search to AdReviewCenterAds associated
-    *   with the text (including any text on the ad or in the destination URL). If
-    *   more than one value is provided, the search will combine them in a logical
-    *   AND. For example, ['car', 'blue'] will match ads that contain both "car"
-    *   and "blue", but not an ad that only contains "car".
-    * @param {number[]} [request.buyerAccountId]
-    *   Optional. If provided, restrict the search to creatives belonging to one of
-    *   the given Adx buyer account IDs. Only applicable to RTB creatives. Adx
-    *   buyer account IDs can be found via the ProgrammaticBuyerService.
-    * @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.AdReviewCenterAd|AdReviewCenterAd}.
-    *   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 `searchAdReviewCenterAdsAsync()`
-    *   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 search for AdReviewCenterAds.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.ads.admanager.v1.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus} [request.status]
+     *   Optional. Only return ads with the given status.
+     * @param {google.ads.admanager.v1.ManualAdReviewCenterAdStatusEnum.ManualAdReviewCenterAdStatus} [request.manualReviewStatus]
+     *   Optional. Only return ads with the given manual review status. Only
+     *   available for networks with Manual Creative Review enabled. For more
+     *   information, see
+     *   https://support.google.com/admanager/answer/2586531#manual-creative-review.
+     * @param {string} request.parent
+     *   Required. The parent, which owns this collection of AdReviewCenterAds.
+     *   Format: networks/{network_code}/webProperties/{web_property_code}
+     *
+     *   Since a network can only have a single web property of each
+     *   `ExchangeSyndicationProduct`, you can use the
+     *   `ExchangeSyndicationProduct` as an alias for the web property code:
+     *
+     *   `networks/{network_code}/webProperties/display`
+     *
+     *   `networks/{network_code}/webProperties/videoAndAudio`
+     *
+     *   `networks/{network_code}/webProperties/mobileApp`
+     *
+     *   `networks/{network_code}/webProperties/games`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of AdReviewCenterAds to return. The service
+     *   may return fewer than this value. If unspecified, at most 50
+     *   AdReviewCenterAds will be returned. The maximum value is 1000; values
+     *   greater than 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. The page token to fetch the next page of AdReviewCenterAds. This
+     *   is the value returned from a previous Search request, or empty.
+     * @param {string[]} [request.adReviewCenterAdId]
+     *   Optional. Only return ads with the given AdReviewCenterAd IDs. If provided,
+     *   no other filter can be set (other than page size and page token).
+     * @param {google.type.Interval} [request.dateTimeRange]
+     *   Optional. If provided, only return ads that served within the given date
+     *   range (inclusive). The  date range must be within the last 30 days. If not
+     *   provided, the date range will be the last 30 days. This filter does not
+     *   apply to the PENDING manual review status.
+     * @param {string[]} [request.searchText]
+     *   Optional. If provided, restrict the search to AdReviewCenterAds associated
+     *   with the text (including any text on the ad or in the destination URL). If
+     *   more than one value is provided, the search will combine them in a logical
+     *   AND. For example, ['car', 'blue'] will match ads that contain both "car"
+     *   and "blue", but not an ad that only contains "car".
+     * @param {number[]} [request.buyerAccountId]
+     *   Optional. If provided, restrict the search to creatives belonging to one of
+     *   the given Adx buyer account IDs. Only applicable to RTB creatives. Adx
+     *   buyer account IDs can be found using the `ProgrammaticBuyerService`.
+     * @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.AdReviewCenterAd|AdReviewCenterAd}.
+     *   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 `searchAdReviewCenterAdsAsync()`
+     *   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.
+     */
     searchAdReviewCenterAds(request?: protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsRequest, options?: CallOptions): Promise<[
         protos.google.ads.admanager.v1.IAdReviewCenterAd[],
         protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsRequest | null,
@@ -299,6 +306,13 @@ export declare class AdReviewCenterAdServiceClient {
      * Equivalent to `searchAdReviewCenterAds`, but returns a NodeJS Stream object.
      * @param {Object} request
      *   The request object that will be sent.
+     * @param {google.ads.admanager.v1.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus} [request.status]
+     *   Optional. Only return ads with the given status.
+     * @param {google.ads.admanager.v1.ManualAdReviewCenterAdStatusEnum.ManualAdReviewCenterAdStatus} [request.manualReviewStatus]
+     *   Optional. Only return ads with the given manual review status. Only
+     *   available for networks with Manual Creative Review enabled. For more
+     *   information, see
+     *   https://support.google.com/admanager/answer/2586531#manual-creative-review.
      * @param {string} request.parent
      *   Required. The parent, which owns this collection of AdReviewCenterAds.
      *   Format: networks/{network_code}/webProperties/{web_property_code}
@@ -322,14 +336,14 @@ export declare class AdReviewCenterAdServiceClient {
      * @param {string} [request.pageToken]
      *   Optional. The page token to fetch the next page of AdReviewCenterAds. This
      *   is the value returned from a previous Search request, or empty.
-     * @param {google.ads.admanager.v1.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus} request.status
-     *   Required. Only return ads with the given status.
      * @param {string[]} [request.adReviewCenterAdId]
-     *   Optional. If provided, only return ads with the given AdReviewCenterAd IDs.
+     *   Optional. Only return ads with the given AdReviewCenterAd IDs. If provided,
+     *   no other filter can be set (other than page size and page token).
      * @param {google.type.Interval} [request.dateTimeRange]
      *   Optional. If provided, only return ads that served within the given date
      *   range (inclusive). The  date range must be within the last 30 days. If not
-     *   provided, the date range will be the last 30 days.
+     *   provided, the date range will be the last 30 days. This filter does not
+     *   apply to the PENDING manual review status.
      * @param {string[]} [request.searchText]
      *   Optional. If provided, restrict the search to AdReviewCenterAds associated
      *   with the text (including any text on the ad or in the destination URL). If
@@ -339,7 +353,7 @@ export declare class AdReviewCenterAdServiceClient {
      * @param {number[]} [request.buyerAccountId]
      *   Optional. If provided, restrict the search to creatives belonging to one of
      *   the given Adx buyer account IDs. Only applicable to RTB creatives. Adx
-     *   buyer account IDs can be found via the ProgrammaticBuyerService.
+     *   buyer account IDs can be found using the `ProgrammaticBuyerService`.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -358,6 +372,13 @@ export declare class AdReviewCenterAdServiceClient {
      * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
      * @param {Object} request
      *   The request object that will be sent.
+     * @param {google.ads.admanager.v1.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus} [request.status]
+     *   Optional. Only return ads with the given status.
+     * @param {google.ads.admanager.v1.ManualAdReviewCenterAdStatusEnum.ManualAdReviewCenterAdStatus} [request.manualReviewStatus]
+     *   Optional. Only return ads with the given manual review status. Only
+     *   available for networks with Manual Creative Review enabled. For more
+     *   information, see
+     *   https://support.google.com/admanager/answer/2586531#manual-creative-review.
      * @param {string} request.parent
      *   Required. The parent, which owns this collection of AdReviewCenterAds.
      *   Format: networks/{network_code}/webProperties/{web_property_code}
@@ -381,14 +402,14 @@ export declare class AdReviewCenterAdServiceClient {
      * @param {string} [request.pageToken]
      *   Optional. The page token to fetch the next page of AdReviewCenterAds. This
      *   is the value returned from a previous Search request, or empty.
-     * @param {google.ads.admanager.v1.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus} request.status
-     *   Required. Only return ads with the given status.
      * @param {string[]} [request.adReviewCenterAdId]
-     *   Optional. If provided, only return ads with the given AdReviewCenterAd IDs.
+     *   Optional. Only return ads with the given AdReviewCenterAd IDs. If provided,
+     *   no other filter can be set (other than page size and page token).
      * @param {google.type.Interval} [request.dateTimeRange]
      *   Optional. If provided, only return ads that served within the given date
      *   range (inclusive). The  date range must be within the last 30 days. If not
-     *   provided, the date range will be the last 30 days.
+     *   provided, the date range will be the last 30 days. This filter does not
+     *   apply to the PENDING manual review status.
      * @param {string[]} [request.searchText]
      *   Optional. If provided, restrict the search to AdReviewCenterAds associated
      *   with the text (including any text on the ad or in the destination URL). If
@@ -398,7 +419,7 @@ export declare class AdReviewCenterAdServiceClient {
      * @param {number[]} [request.buyerAccountId]
      *   Optional. If provided, restrict the search to creatives belonging to one of
      *   the given Adx buyer account IDs. Only applicable to RTB creatives. Adx
-     *   buyer account IDs can be found via the ProgrammaticBuyerService.
+     *   buyer account IDs can be found using the `ProgrammaticBuyerService`.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
@@ -413,35 +434,35 @@ export declare class AdReviewCenterAdServiceClient {
      */
     searchAdReviewCenterAdsAsync(request?: protos.google.ads.admanager.v1.ISearchAdReviewCenterAdsRequest, options?: CallOptions): AsyncIterable<protos.google.ads.admanager.v1.IAdReviewCenterAd>;
     /**
-       * Gets the latest state of a long-running operation.  Clients can use this
-       * method to poll the operation result at intervals as recommended by the API
-       * service.
-       *
-       * @param {Object} request - The request object that will be sent.
-       * @param {string} request.name - The name of the operation resource.
-       * @param {Object=} options
-       *   Optional parameters. You can override the default settings for this call,
-       *   e.g, timeout, retries, paginations, etc. See {@link
-       *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
-       *   for the details.
-       * @param {function(?Error, ?Object)=} callback
-       *   The function which will be called with the result of the API call.
-       *
-       *   The second parameter to the callback is an object representing
-       *   {@link google.longrunning.Operation | google.longrunning.Operation}.
-       * @return {Promise} - The promise which resolves to an array.
-       *   The first element of the array is an object representing
-       * {@link google.longrunning.Operation | google.longrunning.Operation}.
-       * The promise has a method named "cancel" which cancels the ongoing API call.
-       *
-       * @example
-       * ```
-       * const client = longrunning.operationsClient();
-       * const name = '';
-       * const [response] = await client.getOperation({name});
-       * // doThingsWith(response)
-       * ```
-       */
+     * Gets the latest state of a long-running operation.  Clients can use this
+     * method to poll the operation result at intervals as recommended by the API
+     * service.
+     *
+     * @param {Object} request - The request object that will be sent.
+     * @param {string} request.name - The name of the operation resource.
+     * @param {Object=} options
+     *   Optional parameters. You can override the default settings for this call,
+     *   e.g, timeout, retries, paginations, etc. See {@link
+     *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
+     *   for the details.
+     * @param {function(?Error, ?Object)=} callback
+     *   The function which will be called with the result of the API call.
+     *
+     *   The second parameter to the callback is an object representing
+     *   {@link google.longrunning.Operation | google.longrunning.Operation}.
+     * @return {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing
+     * {@link google.longrunning.Operation | google.longrunning.Operation}.
+     * The promise has a method named "cancel" which cancels the ongoing API call.
+     *
+     * @example
+     * ```
+     * const client = longrunning.operationsClient();
+     * const name = '';
+     * const [response] = await client.getOperation({name});
+     * // doThingsWith(response)
+     * ```
+     */
     getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
     /**
      * Lists operations that match the specified filter in the request. If the
@@ -742,6 +763,30 @@ export declare class AdReviewCenterAdServiceClient {
      * @returns {string} A string representing the browser_language.
      */
     matchBrowserLanguageFromBrowserLanguageName(browserLanguageName: string): string | number;
+    /**
+     * Return a fully-qualified childPublisher resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} child_publisher
+     * @returns {string} Resource name string.
+     */
+    childPublisherPath(networkCode: string, childPublisher: string): string;
+    /**
+     * Parse the network_code from ChildPublisher resource.
+     *
+     * @param {string} childPublisherName
+     *   A fully-qualified path representing ChildPublisher resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromChildPublisherName(childPublisherName: string): string | number;
+    /**
+     * Parse the child_publisher from ChildPublisher resource.
+     *
+     * @param {string} childPublisherName
+     *   A fully-qualified path representing ChildPublisher resource.
+     * @returns {string} A string representing the child_publisher.
+     */
+    matchChildPublisherFromChildPublisherName(childPublisherName: string): string | number;
     /**
      * Return a fully-qualified cmsMetadataKey resource name string.
      *
@@ -1150,6 +1195,54 @@ export declare class AdReviewCenterAdServiceClient {
      * @returns {string} A string representing the label.
      */
     matchLabelFromLabelName(labelName: string): string | number;
+    /**
+     * Return a fully-qualified lineItem resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} line_item
+     * @returns {string} Resource name string.
+     */
+    lineItemPath(networkCode: string, lineItem: string): string;
+    /**
+     * Parse the network_code from LineItem resource.
+     *
+     * @param {string} lineItemName
+     *   A fully-qualified path representing LineItem resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromLineItemName(lineItemName: string): string | number;
+    /**
+     * Parse the line_item from LineItem resource.
+     *
+     * @param {string} lineItemName
+     *   A fully-qualified path representing LineItem resource.
+     * @returns {string} A string representing the line_item.
+     */
+    matchLineItemFromLineItemName(lineItemName: string): string | number;
+    /**
+     * Return a fully-qualified linkedDevice resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} linked_device
+     * @returns {string} Resource name string.
+     */
+    linkedDevicePath(networkCode: string, linkedDevice: string): string;
+    /**
+     * Parse the network_code from LinkedDevice resource.
+     *
+     * @param {string} linkedDeviceName
+     *   A fully-qualified path representing LinkedDevice resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromLinkedDeviceName(linkedDeviceName: string): string | number;
+    /**
+     * Parse the linked_device from LinkedDevice resource.
+     *
+     * @param {string} linkedDeviceName
+     *   A fully-qualified path representing LinkedDevice resource.
+     * @returns {string} A string representing the linked_device.
+     */
+    matchLinkedDeviceFromLinkedDeviceName(linkedDeviceName: string): string | number;
     /**
      * Return a fully-qualified liveStreamEvent resource name string.
      *
@@ -1453,6 +1546,30 @@ export declare class AdReviewCenterAdServiceClient {
      * @returns {string} A string representing the report.
      */
     matchReportFromReportName(reportName: string): string | number;
+    /**
+     * Return a fully-qualified richMediaAdsCompany resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} rich_media_ads_company
+     * @returns {string} Resource name string.
+     */
+    richMediaAdsCompanyPath(networkCode: string, richMediaAdsCompany: string): string;
+    /**
+     * Parse the network_code from RichMediaAdsCompany resource.
+     *
+     * @param {string} richMediaAdsCompanyName
+     *   A fully-qualified path representing RichMediaAdsCompany resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromRichMediaAdsCompanyName(richMediaAdsCompanyName: string): string | number;
+    /**
+     * Parse the rich_media_ads_company from RichMediaAdsCompany resource.
+     *
+     * @param {string} richMediaAdsCompanyName
+     *   A fully-qualified path representing RichMediaAdsCompany resource.
+     * @returns {string} A string representing the rich_media_ads_company.
+     */
+    matchRichMediaAdsCompanyFromRichMediaAdsCompanyName(richMediaAdsCompanyName: string): string | number;
     /**
      * Return a fully-qualified role resource name string.
      *