@google-ads/admanager 0.5.0 → 0.6.0

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

@@ -140,46 +140,220 @@ export declare class ApplicationServiceClient {
     getApplication(request: protos.google.ads.admanager.v1.IGetApplicationRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IApplication, protos.google.ads.admanager.v1.IGetApplicationRequest | null | undefined, {} | null | undefined>): void;
     getApplication(request: protos.google.ads.admanager.v1.IGetApplicationRequest, callback: Callback<protos.google.ads.admanager.v1.IApplication, protos.google.ads.admanager.v1.IGetApplicationRequest | null | undefined, {} | null | undefined>): void;
     /**
-    * API to retrieve a list of `Application` objects.
-    *
-    * @param {Object} request
-    *   The request object that will be sent.
-    * @param {string} request.parent
-    *   Required. The parent, which owns this collection of Applications.
-    *   Format: `networks/{network_code}`
-    * @param {number} [request.pageSize]
-    *   Optional. The maximum number of `Applications` to return. The service may
-    *   return fewer than this value. If unspecified, at most 50 `Applications`
-    *   will be returned. The maximum value is 1000; values greater than 1000 will
-    *   be coerced to 1000.
-    * @param {string} [request.pageToken]
-    *   Optional. A page token, received from a previous `ListApplications` call.
-    *   Provide this to retrieve the subsequent page.
-    *
-    *   When paginating, all other parameters provided to `ListApplications` 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.Application|Application}.
-    *   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 `listApplicationsAsync()`
-    *   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 create a `Application` object.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent resource where this `Application` will be created.
+     *   Format: `networks/{network_code}`
+     * @param {google.ads.admanager.v1.Application} request.application
+     *   Required. The `Application` to create.
+     * @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 an object representing {@link protos.google.ads.admanager.v1.Application|Application}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/application_service.create_application.js</caption>
+     * region_tag:admanager_v1_generated_ApplicationService_CreateApplication_async
+     */
+    createApplication(request?: protos.google.ads.admanager.v1.ICreateApplicationRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.IApplication,
+        protos.google.ads.admanager.v1.ICreateApplicationRequest | undefined,
+        {} | undefined
+    ]>;
+    createApplication(request: protos.google.ads.admanager.v1.ICreateApplicationRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IApplication, protos.google.ads.admanager.v1.ICreateApplicationRequest | null | undefined, {} | null | undefined>): void;
+    createApplication(request: protos.google.ads.admanager.v1.ICreateApplicationRequest, callback: Callback<protos.google.ads.admanager.v1.IApplication, protos.google.ads.admanager.v1.ICreateApplicationRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * API to batch create `Application` objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent resource where `Applications` will be created.
+     *   Format: `networks/{network_code}`
+     *   The parent field in the CreateApplicationRequest must match this
+     *   field.
+     * @param {number[]} request.requests
+     *   Required. The `Application` objects to create.
+     * @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 an object representing {@link protos.google.ads.admanager.v1.BatchCreateApplicationsResponse|BatchCreateApplicationsResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/application_service.batch_create_applications.js</caption>
+     * region_tag:admanager_v1_generated_ApplicationService_BatchCreateApplications_async
+     */
+    batchCreateApplications(request?: protos.google.ads.admanager.v1.IBatchCreateApplicationsRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.IBatchCreateApplicationsResponse,
+        (protos.google.ads.admanager.v1.IBatchCreateApplicationsRequest | undefined),
+        {} | undefined
+    ]>;
+    batchCreateApplications(request: protos.google.ads.admanager.v1.IBatchCreateApplicationsRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchCreateApplicationsResponse, protos.google.ads.admanager.v1.IBatchCreateApplicationsRequest | null | undefined, {} | null | undefined>): void;
+    batchCreateApplications(request: protos.google.ads.admanager.v1.IBatchCreateApplicationsRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchCreateApplicationsResponse, protos.google.ads.admanager.v1.IBatchCreateApplicationsRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * API to update a `Application` object.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.ads.admanager.v1.Application} request.application
+     *   Required. The `Application` to update.
+     *
+     *   The `Application`'s `name` is used to identify the `Application` to update.
+     * @param {google.protobuf.FieldMask} [request.updateMask]
+     *   Optional. The list of fields to update.
+     * @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 an object representing {@link protos.google.ads.admanager.v1.Application|Application}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/application_service.update_application.js</caption>
+     * region_tag:admanager_v1_generated_ApplicationService_UpdateApplication_async
+     */
+    updateApplication(request?: protos.google.ads.admanager.v1.IUpdateApplicationRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.IApplication,
+        protos.google.ads.admanager.v1.IUpdateApplicationRequest | undefined,
+        {} | undefined
+    ]>;
+    updateApplication(request: protos.google.ads.admanager.v1.IUpdateApplicationRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IApplication, protos.google.ads.admanager.v1.IUpdateApplicationRequest | null | undefined, {} | null | undefined>): void;
+    updateApplication(request: protos.google.ads.admanager.v1.IUpdateApplicationRequest, callback: Callback<protos.google.ads.admanager.v1.IApplication, protos.google.ads.admanager.v1.IUpdateApplicationRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * API to batch update `Application` objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent resource where `Applications` will be updated.
+     *   Format: `networks/{network_code}`
+     *   The parent field in the UpdateApplicationRequest must match this
+     *   field.
+     * @param {number[]} request.requests
+     *   Required. The `Application` objects to update.
+     * @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 an object representing {@link protos.google.ads.admanager.v1.BatchUpdateApplicationsResponse|BatchUpdateApplicationsResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/application_service.batch_update_applications.js</caption>
+     * region_tag:admanager_v1_generated_ApplicationService_BatchUpdateApplications_async
+     */
+    batchUpdateApplications(request?: protos.google.ads.admanager.v1.IBatchUpdateApplicationsRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.IBatchUpdateApplicationsResponse,
+        (protos.google.ads.admanager.v1.IBatchUpdateApplicationsRequest | undefined),
+        {} | undefined
+    ]>;
+    batchUpdateApplications(request: protos.google.ads.admanager.v1.IBatchUpdateApplicationsRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchUpdateApplicationsResponse, protos.google.ads.admanager.v1.IBatchUpdateApplicationsRequest | null | undefined, {} | null | undefined>): void;
+    batchUpdateApplications(request: protos.google.ads.admanager.v1.IBatchUpdateApplicationsRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchUpdateApplicationsResponse, protos.google.ads.admanager.v1.IBatchUpdateApplicationsRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * / API to batch archive `Application` objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent resource shared by all `Applications` to archive.
+     *   Format: `networks/{network_code}`
+     * @param {string[]} request.names
+     *   Required. The `Application` objects to archive.
+     * @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 an object representing {@link protos.google.ads.admanager.v1.BatchArchiveApplicationsResponse|BatchArchiveApplicationsResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/application_service.batch_archive_applications.js</caption>
+     * region_tag:admanager_v1_generated_ApplicationService_BatchArchiveApplications_async
+     */
+    batchArchiveApplications(request?: protos.google.ads.admanager.v1.IBatchArchiveApplicationsRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.IBatchArchiveApplicationsResponse,
+        (protos.google.ads.admanager.v1.IBatchArchiveApplicationsRequest | undefined),
+        {} | undefined
+    ]>;
+    batchArchiveApplications(request: protos.google.ads.admanager.v1.IBatchArchiveApplicationsRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchArchiveApplicationsResponse, protos.google.ads.admanager.v1.IBatchArchiveApplicationsRequest | null | undefined, {} | null | undefined>): void;
+    batchArchiveApplications(request: protos.google.ads.admanager.v1.IBatchArchiveApplicationsRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchArchiveApplicationsResponse, protos.google.ads.admanager.v1.IBatchArchiveApplicationsRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * / API to batch unarchive `Application` objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent resource shared by all `Applications` to Unarchive.
+     *   Format: `networks/{network_code}`
+     * @param {string[]} request.names
+     *   Required. The `Application` objects to unarchive.
+     * @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 an object representing {@link protos.google.ads.admanager.v1.BatchUnarchiveApplicationsResponse|BatchUnarchiveApplicationsResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/application_service.batch_unarchive_applications.js</caption>
+     * region_tag:admanager_v1_generated_ApplicationService_BatchUnarchiveApplications_async
+     */
+    batchUnarchiveApplications(request?: protos.google.ads.admanager.v1.IBatchUnarchiveApplicationsRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.IBatchUnarchiveApplicationsResponse,
+        (protos.google.ads.admanager.v1.IBatchUnarchiveApplicationsRequest | undefined),
+        {} | undefined
+    ]>;
+    batchUnarchiveApplications(request: protos.google.ads.admanager.v1.IBatchUnarchiveApplicationsRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchUnarchiveApplicationsResponse, protos.google.ads.admanager.v1.IBatchUnarchiveApplicationsRequest | null | undefined, {} | null | undefined>): void;
+    batchUnarchiveApplications(request: protos.google.ads.admanager.v1.IBatchUnarchiveApplicationsRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchUnarchiveApplicationsResponse, protos.google.ads.admanager.v1.IBatchUnarchiveApplicationsRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * API to retrieve a list of `Application` objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent, which owns this collection of Applications.
+     *   Format: `networks/{network_code}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of `Applications` to return. The service may
+     *   return fewer than this value. If unspecified, at most 50 `Applications`
+     *   will be returned. The maximum value is 1000; values greater than 1000 will
+     *   be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListApplications` call.
+     *   Provide this to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided to `ListApplications` must
+     *   match the call that provided the page token.
+     * @param {string} [request.filter]
+     *   Optional. Expression to filter the response.
+     *    See syntax details at
+     *    https://developers.google.com/ad-manager/api/beta/filters
+     *
+     *   <b>Filterable fields:</b>
+     *   <ul style="list-style-type:none">
+     *     <li><code>appStoreId</code></li>
+     *     <li><code>appStores</code></li>
+     *     <li><code>applicationCode</code></li>
+     *     <li><code>approvalStatus</code></li>
+     *     <li><code>archived</code></li>
+     *     <li><code>displayName</code></li>
+     *     <li><code>name</code></li>
+     *     <li><code>platform</code></li>
+     *     <li><code>webviewClaimingStatus</code></li>
+     *   </ul>
+     * @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.Application|Application}.
+     *   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 `listApplicationsAsync()`
+     *   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.
+     */
     listApplications(request?: protos.google.ads.admanager.v1.IListApplicationsRequest, options?: CallOptions): Promise<[
         protos.google.ads.admanager.v1.IApplication[],
         protos.google.ads.admanager.v1.IListApplicationsRequest | null,
@@ -207,8 +381,21 @@ export declare class ApplicationServiceClient {
      *   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
+     *    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>appStoreId</code></li>
+     *     <li><code>appStores</code></li>
+     *     <li><code>applicationCode</code></li>
+     *     <li><code>approvalStatus</code></li>
+     *     <li><code>archived</code></li>
+     *     <li><code>displayName</code></li>
+     *     <li><code>name</code></li>
+     *     <li><code>platform</code></li>
+     *     <li><code>webviewClaimingStatus</code></li>
+     *   </ul>
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -249,8 +436,21 @@ export declare class ApplicationServiceClient {
      *   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
+     *    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>appStoreId</code></li>
+     *     <li><code>appStores</code></li>
+     *     <li><code>applicationCode</code></li>
+     *     <li><code>approvalStatus</code></li>
+     *     <li><code>archived</code></li>
+     *     <li><code>displayName</code></li>
+     *     <li><code>name</code></li>
+     *     <li><code>platform</code></li>
+     *     <li><code>webviewClaimingStatus</code></li>
+     *   </ul>
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -480,6 +680,30 @@ export declare class ApplicationServiceClient {
      * @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.
      *
@@ -888,6 +1112,54 @@ export declare class ApplicationServiceClient {
      * @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.
      *
@@ -1191,6 +1463,30 @@ export declare class ApplicationServiceClient {
      * @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.
      *