@googleapis/merchantapi 6.0.1 → 8.0.0

package/datasources_v1beta.ts

@@ -453,7 +453,7 @@ export namespace merchantapi_datasources_v1beta {
      */
     eventTime?: string | null;
     /**
-     * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
+     * Optional. The product expiration time. This field will not be set if the notification is sent for a product deletion event.
      */
     expirationTime?: string | null;
     /**
@@ -559,6 +559,82 @@ export namespace merchantapi_datasources_v1beta {
 
     /**
      * Creates the new data source configuration for the given account. This method always creates a new data source.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.googleapis.com
+     * // - Login into gcloud by running:
+     * //   ```sh
+     * //   $ gcloud auth application-default login
+     * //   ```
+     * // - Install the npm module by running:
+     * //   ```sh
+     * //   $ npm install googleapis
+     * //   ```
+     *
+     * const {google} = require('googleapis');
+     * const merchantapi = google.merchantapi('datasources_v1beta');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: ['https://www.googleapis.com/auth/content'],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await merchantapi.accounts.dataSources.create({
+     *     // Required. The account where this data source will be created. Format: `accounts/{account\}`
+     *     parent: 'accounts/my-account',
+     *
+     *     // Request body metadata
+     *     requestBody: {
+     *       // request body parameters
+     *       // {
+     *       //   "dataSourceId": "my_dataSourceId",
+     *       //   "displayName": "my_displayName",
+     *       //   "fileInput": {},
+     *       //   "input": "my_input",
+     *       //   "localInventoryDataSource": {},
+     *       //   "merchantReviewDataSource": {},
+     *       //   "name": "my_name",
+     *       //   "primaryProductDataSource": {},
+     *       //   "productReviewDataSource": {},
+     *       //   "promotionDataSource": {},
+     *       //   "regionalInventoryDataSource": {},
+     *       //   "supplementalProductDataSource": {}
+     *       // }
+     *     },
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "dataSourceId": "my_dataSourceId",
+     *   //   "displayName": "my_displayName",
+     *   //   "fileInput": {},
+     *   //   "input": "my_input",
+     *   //   "localInventoryDataSource": {},
+     *   //   "merchantReviewDataSource": {},
+     *   //   "name": "my_name",
+     *   //   "primaryProductDataSource": {},
+     *   //   "productReviewDataSource": {},
+     *   //   "promotionDataSource": {},
+     *   //   "regionalInventoryDataSource": {},
+     *   //   "supplementalProductDataSource": {}
+     *   // }
+     * }
+     *
+     * main().catch(e => {
+     *   console.error(e);
+     *   throw e;
+     * });
+     *
+     * ```
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -649,6 +725,50 @@ export namespace merchantapi_datasources_v1beta {
 
     /**
      * Deletes a data source from your Merchant Center account.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.googleapis.com
+     * // - Login into gcloud by running:
+     * //   ```sh
+     * //   $ gcloud auth application-default login
+     * //   ```
+     * // - Install the npm module by running:
+     * //   ```sh
+     * //   $ npm install googleapis
+     * //   ```
+     *
+     * const {google} = require('googleapis');
+     * const merchantapi = google.merchantapi('datasources_v1beta');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: ['https://www.googleapis.com/auth/content'],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await merchantapi.accounts.dataSources.delete({
+     *     // Required. The name of the data source to delete. Format: `accounts/{account\}/dataSources/{datasource\}`
+     *     name: 'accounts/my-account/dataSources/my-dataSource',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {}
+     * }
+     *
+     * main().catch(e => {
+     *   console.error(e);
+     *   throw e;
+     * });
+     *
+     * ```
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -740,6 +860,56 @@ export namespace merchantapi_datasources_v1beta {
 
     /**
      * Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. If you need to call this method more than once per day, you should use the Products service to update your product data instead. This method only works on data sources with a file input set.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.googleapis.com
+     * // - Login into gcloud by running:
+     * //   ```sh
+     * //   $ gcloud auth application-default login
+     * //   ```
+     * // - Install the npm module by running:
+     * //   ```sh
+     * //   $ npm install googleapis
+     * //   ```
+     *
+     * const {google} = require('googleapis');
+     * const merchantapi = google.merchantapi('datasources_v1beta');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: ['https://www.googleapis.com/auth/content'],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await merchantapi.accounts.dataSources.fetch({
+     *     // Required. The name of the data source resource to fetch. Format: `accounts/{account\}/dataSources/{datasource\}`
+     *     name: 'accounts/my-account/dataSources/my-dataSource',
+     *
+     *     // Request body metadata
+     *     requestBody: {
+     *       // request body parameters
+     *       // {}
+     *     },
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {}
+     * }
+     *
+     * main().catch(e => {
+     *   console.error(e);
+     *   throw e;
+     * });
+     *
+     * ```
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -831,6 +1001,63 @@ export namespace merchantapi_datasources_v1beta {
 
     /**
      * Retrieves the data source configuration for the given account.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.googleapis.com
+     * // - Login into gcloud by running:
+     * //   ```sh
+     * //   $ gcloud auth application-default login
+     * //   ```
+     * // - Install the npm module by running:
+     * //   ```sh
+     * //   $ npm install googleapis
+     * //   ```
+     *
+     * const {google} = require('googleapis');
+     * const merchantapi = google.merchantapi('datasources_v1beta');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: ['https://www.googleapis.com/auth/content'],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await merchantapi.accounts.dataSources.get({
+     *     // Required. The name of the data source to retrieve. Format: `accounts/{account\}/dataSources/{datasource\}`
+     *     name: 'accounts/my-account/dataSources/my-dataSource',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "dataSourceId": "my_dataSourceId",
+     *   //   "displayName": "my_displayName",
+     *   //   "fileInput": {},
+     *   //   "input": "my_input",
+     *   //   "localInventoryDataSource": {},
+     *   //   "merchantReviewDataSource": {},
+     *   //   "name": "my_name",
+     *   //   "primaryProductDataSource": {},
+     *   //   "productReviewDataSource": {},
+     *   //   "promotionDataSource": {},
+     *   //   "regionalInventoryDataSource": {},
+     *   //   "supplementalProductDataSource": {}
+     *   // }
+     * }
+     *
+     * main().catch(e => {
+     *   console.error(e);
+     *   throw e;
+     * });
+     *
+     * ```
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -922,6 +1149,57 @@ export namespace merchantapi_datasources_v1beta {
 
     /**
      * Lists the configurations for data sources for the given account.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.googleapis.com
+     * // - Login into gcloud by running:
+     * //   ```sh
+     * //   $ gcloud auth application-default login
+     * //   ```
+     * // - Install the npm module by running:
+     * //   ```sh
+     * //   $ npm install googleapis
+     * //   ```
+     *
+     * const {google} = require('googleapis');
+     * const merchantapi = google.merchantapi('datasources_v1beta');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: ['https://www.googleapis.com/auth/content'],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await merchantapi.accounts.dataSources.list({
+     *     // Optional. The maximum number of data sources to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of data sources will be returned.
+     *     pageSize: 'placeholder-value',
+     *     // Optional. A page token, received from a previous `ListDataSources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSources` must match the call that provided the page token.
+     *     pageToken: 'placeholder-value',
+     *     // Required. The account to list data sources for. Format: `accounts/{account\}`
+     *     parent: 'accounts/my-account',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "dataSources": [],
+     *   //   "nextPageToken": "my_nextPageToken"
+     *   // }
+     * }
+     *
+     * main().catch(e => {
+     *   console.error(e);
+     *   throw e;
+     * });
+     *
+     * ```
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1014,6 +1292,84 @@ export namespace merchantapi_datasources_v1beta {
 
     /**
      * Updates the existing data source configuration. The fields that are set in the update mask but not provided in the resource will be deleted.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.googleapis.com
+     * // - Login into gcloud by running:
+     * //   ```sh
+     * //   $ gcloud auth application-default login
+     * //   ```
+     * // - Install the npm module by running:
+     * //   ```sh
+     * //   $ npm install googleapis
+     * //   ```
+     *
+     * const {google} = require('googleapis');
+     * const merchantapi = google.merchantapi('datasources_v1beta');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: ['https://www.googleapis.com/auth/content'],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await merchantapi.accounts.dataSources.patch({
+     *     // Required. Identifier. The name of the data source. Format: `accounts/{account\}/dataSources/{datasource\}`
+     *     name: 'accounts/my-account/dataSources/my-dataSource',
+     *     // Required. The list of data source fields to be updated. Fields specified in the update mask without a value specified in the body will be deleted from the data source. Providing special "*" value for full data source replacement is not supported. For example, If you insert `updateMask=displayName` in the request, it will only update the `displayName` leaving all other fields untouched.
+     *     updateMask: 'placeholder-value',
+     *
+     *     // Request body metadata
+     *     requestBody: {
+     *       // request body parameters
+     *       // {
+     *       //   "dataSourceId": "my_dataSourceId",
+     *       //   "displayName": "my_displayName",
+     *       //   "fileInput": {},
+     *       //   "input": "my_input",
+     *       //   "localInventoryDataSource": {},
+     *       //   "merchantReviewDataSource": {},
+     *       //   "name": "my_name",
+     *       //   "primaryProductDataSource": {},
+     *       //   "productReviewDataSource": {},
+     *       //   "promotionDataSource": {},
+     *       //   "regionalInventoryDataSource": {},
+     *       //   "supplementalProductDataSource": {}
+     *       // }
+     *     },
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "dataSourceId": "my_dataSourceId",
+     *   //   "displayName": "my_displayName",
+     *   //   "fileInput": {},
+     *   //   "input": "my_input",
+     *   //   "localInventoryDataSource": {},
+     *   //   "merchantReviewDataSource": {},
+     *   //   "name": "my_name",
+     *   //   "primaryProductDataSource": {},
+     *   //   "productReviewDataSource": {},
+     *   //   "promotionDataSource": {},
+     *   //   "regionalInventoryDataSource": {},
+     *   //   "supplementalProductDataSource": {}
+     *   // }
+     * }
+     *
+     * main().catch(e => {
+     *   console.error(e);
+     *   throw e;
+     * });
+     *
+     * ```
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1164,7 +1520,7 @@ export namespace merchantapi_datasources_v1beta {
      */
     name?: string;
     /**
-     * Required. The list of data source fields to be updated. Fields specified in the update mask without a value specified in the body will be deleted from the data source. Providing special "*" value for full data source replacement is not supported.
+     * Required. The list of data source fields to be updated. Fields specified in the update mask without a value specified in the body will be deleted from the data source. Providing special "*" value for full data source replacement is not supported. For example, If you insert `updateMask=displayName` in the request, it will only update the `displayName` leaving all other fields untouched.
      */
     updateMask?: string;
 
@@ -1182,6 +1538,59 @@ export namespace merchantapi_datasources_v1beta {
 
     /**
      * Gets the latest data source file upload. Only the `latest` alias is accepted for a file upload.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.googleapis.com
+     * // - Login into gcloud by running:
+     * //   ```sh
+     * //   $ gcloud auth application-default login
+     * //   ```
+     * // - Install the npm module by running:
+     * //   ```sh
+     * //   $ npm install googleapis
+     * //   ```
+     *
+     * const {google} = require('googleapis');
+     * const merchantapi = google.merchantapi('datasources_v1beta');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: ['https://www.googleapis.com/auth/content'],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await merchantapi.accounts.dataSources.fileUploads.get({
+     *     // Required. The name of the data source file upload to retrieve. Format: `accounts/{account\}/dataSources/{datasource\}/fileUploads/latest`
+     *     name: 'accounts/my-account/dataSources/my-dataSource/fileUploads/my-fileUpload',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "dataSourceId": "my_dataSourceId",
+     *   //   "issues": [],
+     *   //   "itemsCreated": "my_itemsCreated",
+     *   //   "itemsTotal": "my_itemsTotal",
+     *   //   "itemsUpdated": "my_itemsUpdated",
+     *   //   "name": "my_name",
+     *   //   "processingState": "my_processingState",
+     *   //   "uploadTime": "my_uploadTime"
+     *   // }
+     * }
+     *
+     * main().catch(e => {
+     *   console.error(e);
+     *   throw e;
+     * });
+     *
+     * ```
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.