@googleapis/merchantapi 1.1.0 → 4.1.0

package/products_v1beta.ts

@@ -269,9 +269,9 @@ export namespace merchantapi_products_v1beta {
      */
     googleProductCategory?: string | null;
     /**
-     * Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.
+     * Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs.
      */
-    gtin?: string | null;
+    gtin?: string[] | null;
     /**
      * Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided.
      */
@@ -469,7 +469,11 @@ export namespace merchantapi_products_v1beta {
      */
     subscriptionCost?: Schema$SubscriptionCost;
     /**
-     * The tax category of the product, used to configure detailed tax nexus in account-level tax settings.
+     * The list of sustainability incentive programs.
+     */
+    sustainabilityIncentives?: Schema$ProductSustainabilityIncentive[];
+    /**
+     * The tax category of the product.
      */
     taxCategory?: string | null;
     /**
@@ -739,6 +743,10 @@ export namespace merchantapi_products_v1beta {
      * The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. The label must be provided so that the system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
      */
     programLabel?: string | null;
+    /**
+     * The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier.
+     */
+    shippingLabel?: string | null;
     /**
      * The label of the tier within the loyalty program. Must match one of the labels within the program.
      */
@@ -786,7 +794,7 @@ export namespace merchantapi_products_v1beta {
      */
     feedLabel?: string | null;
     /**
-     * The name of the product. Format: `"{product.name=accounts/{account\}/products/{product\}\}"`
+     * The name of the product. Format: `"{product.name=accounts/{account\}/products/{product\}\}"` where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is "accounts/123/products/online~en~US~sku123"
      */
     name?: string | null;
     /**
@@ -807,19 +815,19 @@ export namespace merchantapi_products_v1beta {
    */
   export interface Schema$ProductChange {
     /**
-     * The new value of the changed resource or attribute.
+     * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
      */
     newValue?: string | null;
     /**
-     * The old value of the changed resource or attribute.
+     * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
      */
     oldValue?: string | null;
     /**
-     * Countries that have the change (if applicable)
+     * Countries that have the change (if applicable). Represented in the ISO 3166 format.
      */
     regionCode?: string | null;
     /**
-     * Reporting contexts that have the change (if applicable)
+     * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)
      */
     reportingContext?: string | null;
   }
@@ -854,7 +862,7 @@ export namespace merchantapi_products_v1beta {
     value?: number | null;
   }
   /**
-   * This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed product. Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the vertical spec with [some exceptions](https://support.google.com/merchants/answer/7052112).
+   * This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the vertical spec with [some exceptions](https://support.google.com/merchants/answer/7052112).
    */
   export interface Schema$ProductInput {
     /**
@@ -862,7 +870,7 @@ export namespace merchantapi_products_v1beta {
      */
     attributes?: Schema$Attributes;
     /**
-     * Required. Immutable. The [channel](https://support.google.com/merchants/answer/7361332) of the product.
+     * Immutable. The [channel](https://support.google.com/merchants/answer/7361332) of the product.
      */
     channel?: string | null;
     /**
@@ -878,7 +886,7 @@ export namespace merchantapi_products_v1beta {
      */
     feedLabel?: string | null;
     /**
-     * Identifier. The name of the product input. Format: `"{productinput.name=accounts/{account\}/productInputs/{productinput\}\}"`
+     * Identifier. The name of the product input. Format: `"{productinput.name=accounts/{account\}/productInputs/{productinput\}\}"` where the last section `productinput` consists of 4 parts: channel~content_language~feed_label~offer_id example for product input name is "accounts/123/productInputs/online~en~US~sku123"
      */
     name?: string | null;
     /**
@@ -935,12 +943,20 @@ export namespace merchantapi_products_v1beta {
      * A message to describe the change that happened to the product
      */
     changes?: Schema$ProductChange[];
+    /**
+     * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.
+     */
+    eventTime?: string | null;
+    /**
+     * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
+     */
+    expirationTime?: string | null;
     /**
      * The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id\}`
      */
     managingAccount?: string | null;
     /**
-     * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}`
+     * The product name. Format: `accounts/{account\}/products/{product\}`
      */
     resource?: string | null;
     /**
@@ -978,6 +994,23 @@ export namespace merchantapi_products_v1beta {
      */
     digitalSourceType?: string | null;
   }
+  /**
+   * Information regarding sustainability-related incentive programs such as rebates or tax relief.
+   */
+  export interface Schema$ProductSustainabilityIncentive {
+    /**
+     * The fixed amount of the incentive.
+     */
+    amount?: Schema$Price;
+    /**
+     * The percentage of the sale price that the incentive is applied to.
+     */
+    percentage?: number | null;
+    /**
+     * Sustainability incentive program.
+     */
+    type?: string | null;
+  }
   /**
    * The weight of the product.
    */
@@ -1330,6 +1363,94 @@ export namespace merchantapi_products_v1beta {
         return createAPIRequest<Schema$ProductInput>(parameters);
       }
     }
+
+    /**
+     * Updates the existing product input in your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
+     *
+     * @param params - Parameters for request
+     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+     * @param callback - Optional callback that handles the response.
+     * @returns A promise if used with async/await, or void if used with a callback.
+     */
+    patch(
+      params: Params$Resource$Accounts$Productinputs$Patch,
+      options: StreamMethodOptions
+    ): GaxiosPromise<Readable>;
+    patch(
+      params?: Params$Resource$Accounts$Productinputs$Patch,
+      options?: MethodOptions
+    ): GaxiosPromise<Schema$ProductInput>;
+    patch(
+      params: Params$Resource$Accounts$Productinputs$Patch,
+      options: StreamMethodOptions | BodyResponseCallback<Readable>,
+      callback: BodyResponseCallback<Readable>
+    ): void;
+    patch(
+      params: Params$Resource$Accounts$Productinputs$Patch,
+      options: MethodOptions | BodyResponseCallback<Schema$ProductInput>,
+      callback: BodyResponseCallback<Schema$ProductInput>
+    ): void;
+    patch(
+      params: Params$Resource$Accounts$Productinputs$Patch,
+      callback: BodyResponseCallback<Schema$ProductInput>
+    ): void;
+    patch(callback: BodyResponseCallback<Schema$ProductInput>): void;
+    patch(
+      paramsOrCallback?:
+        | Params$Resource$Accounts$Productinputs$Patch
+        | BodyResponseCallback<Schema$ProductInput>
+        | BodyResponseCallback<Readable>,
+      optionsOrCallback?:
+        | MethodOptions
+        | StreamMethodOptions
+        | BodyResponseCallback<Schema$ProductInput>
+        | BodyResponseCallback<Readable>,
+      callback?:
+        | BodyResponseCallback<Schema$ProductInput>
+        | BodyResponseCallback<Readable>
+    ): void | GaxiosPromise<Schema$ProductInput> | GaxiosPromise<Readable> {
+      let params = (paramsOrCallback ||
+        {}) as Params$Resource$Accounts$Productinputs$Patch;
+      let options = (optionsOrCallback || {}) as MethodOptions;
+
+      if (typeof paramsOrCallback === 'function') {
+        callback = paramsOrCallback;
+        params = {} as Params$Resource$Accounts$Productinputs$Patch;
+        options = {};
+      }
+
+      if (typeof optionsOrCallback === 'function') {
+        callback = optionsOrCallback;
+        options = {};
+      }
+
+      const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
+      const parameters = {
+        options: Object.assign(
+          {
+            url: (rootUrl + '/products/v1beta/{+name}').replace(
+              /([^:]\/)\/+/g,
+              '$1'
+            ),
+            method: 'PATCH',
+            apiVersion: '',
+          },
+          options
+        ),
+        params,
+        requiredParams: ['name'],
+        pathParams: ['name'],
+        context: this.context,
+      };
+      if (callback) {
+        createAPIRequest<Schema$ProductInput>(
+          parameters,
+          callback as BodyResponseCallback<unknown>
+        );
+      } else {
+        return createAPIRequest<Schema$ProductInput>(parameters);
+      }
+    }
   }
 
   export interface Params$Resource$Accounts$Productinputs$Delete
@@ -1339,14 +1460,14 @@ export namespace merchantapi_products_v1beta {
      */
     dataSource?: string;
     /**
-     * Required. The name of the product input resource to delete. Format: accounts/{account\}/productInputs/{product\}
+     * Required. The name of the product input resource to delete. Format: accounts/{account\}/productInputs/{product\} where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is "accounts/123/productInputs/online~en~US~sku123"
      */
     name?: string;
   }
   export interface Params$Resource$Accounts$Productinputs$Insert
     extends StandardParameters {
     /**
-     * Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. Format: `accounts/{account\}/dataSources/{datasource\}`.
+     * Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. Only API data sources are supported. Format: `accounts/{account\}/dataSources/{datasource\}`.
      */
     dataSource?: string;
     /**
@@ -1359,6 +1480,26 @@ export namespace merchantapi_products_v1beta {
      */
     requestBody?: Schema$ProductInput;
   }
+  export interface Params$Resource$Accounts$Productinputs$Patch
+    extends StandardParameters {
+    /**
+     * Required. The primary or supplemental product data source where `data_source` name identifies the product input to be updated. Only API data sources are supported. Format: `accounts/{account\}/dataSources/{datasource\}`.
+     */
+    dataSource?: string;
+    /**
+     * Identifier. The name of the product input. Format: `"{productinput.name=accounts/{account\}/productInputs/{productinput\}\}"` where the last section `productinput` consists of 4 parts: channel~content_language~feed_label~offer_id example for product input name is "accounts/123/productInputs/online~en~US~sku123"
+     */
+    name?: string;
+    /**
+     * Optional. The list of product attributes to be updated. If the update mask is omitted, then it is treated as implied field mask equivalent to all fields that are populated (have a non-empty value). Attributes specified in the update mask without a value specified in the body will be deleted from the product. Update mask can only be specified for top level fields in attributes and custom attributes. To specify the update mask for custom attributes you need to add the `custom_attribute.` prefix. Providing special "*" value for full product replacement is not supported.
+     */
+    updateMask?: string;
+
+    /**
+     * Request body metadata
+     */
+    requestBody?: Schema$ProductInput;
+  }
 
   export class Resource$Accounts$Products {
     context: APIRequestContext;
@@ -1551,14 +1692,14 @@ export namespace merchantapi_products_v1beta {
   export interface Params$Resource$Accounts$Products$Get
     extends StandardParameters {
     /**
-     * Required. The name of the product to retrieve. Format: `accounts/{account\}/products/{product\}`
+     * Required. The name of the product to retrieve. Format: `accounts/{account\}/products/{product\}` where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is "accounts/123/products/online~en~US~sku123"
      */
     name?: string;
   }
   export interface Params$Resource$Accounts$Products$List
     extends StandardParameters {
     /**
-     * The maximum number of products 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 products will be returned.
+     * The maximum number of products to return. The service may return fewer than this value. The maximum value is 250; values above 250 will be coerced to 250. If unspecified, the maximum number of products will be returned.
      */
     pageSize?: number;
     /**

package/promotions_v1beta.ts

@@ -377,19 +377,19 @@ export namespace merchantapi_promotions_v1beta {
    */
   export interface Schema$ProductChange {
     /**
-     * The new value of the changed resource or attribute.
+     * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
      */
     newValue?: string | null;
     /**
-     * The old value of the changed resource or attribute.
+     * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
      */
     oldValue?: string | null;
     /**
-     * Countries that have the change (if applicable)
+     * Countries that have the change (if applicable). Represented in the ISO 3166 format.
      */
     regionCode?: string | null;
     /**
-     * Reporting contexts that have the change (if applicable)
+     * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)
      */
     reportingContext?: string | null;
   }
@@ -409,12 +409,20 @@ export namespace merchantapi_promotions_v1beta {
      * A message to describe the change that happened to the product
      */
     changes?: Schema$ProductChange[];
+    /**
+     * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.
+     */
+    eventTime?: string | null;
+    /**
+     * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
+     */
+    expirationTime?: string | null;
     /**
      * The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id\}`
      */
     managingAccount?: string | null;
     /**
-     * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}`
+     * The product name. Format: `accounts/{account\}/products/{product\}`
      */
     resource?: string | null;
     /**
@@ -799,7 +807,7 @@ export namespace merchantapi_promotions_v1beta {
   export interface Params$Resource$Accounts$Promotions$List
     extends StandardParameters {
     /**
-     * Output only. The maximum number of promotions 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 promotions will be returned.
+     * Output only. The maximum number of promotions to return. The service may return fewer than this value. The maximum value is 250; values above 250 will be coerced to 250. If unspecified, the maximum number of promotions will be returned.
      */
     pageSize?: number;
     /**

package/quota_v1beta.ts

@@ -133,7 +133,7 @@ export namespace merchantapi_quota_v1beta {
      */
     nextPageToken?: string | null;
     /**
-     * The methods, current quota usage and limits per each group. The quota is shared between all methods in the group. The groups are sorted in descending order based on quotaUsage.
+     * The methods, current quota usage and limits per each group. The quota is shared between all methods in the group. The groups are sorted in descending order based on quota_usage.
      */
     quotaGroups?: Schema$QuotaGroup[];
   }
@@ -163,19 +163,19 @@ export namespace merchantapi_quota_v1beta {
    */
   export interface Schema$ProductChange {
     /**
-     * The new value of the changed resource or attribute.
+     * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
      */
     newValue?: string | null;
     /**
-     * The old value of the changed resource or attribute.
+     * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
      */
     oldValue?: string | null;
     /**
-     * Countries that have the change (if applicable)
+     * Countries that have the change (if applicable). Represented in the ISO 3166 format.
      */
     regionCode?: string | null;
     /**
-     * Reporting contexts that have the change (if applicable)
+     * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)
      */
     reportingContext?: string | null;
   }
@@ -195,12 +195,20 @@ export namespace merchantapi_quota_v1beta {
      * A message to describe the change that happened to the product
      */
     changes?: Schema$ProductChange[];
+    /**
+     * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.
+     */
+    eventTime?: string | null;
+    /**
+     * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
+     */
+    expirationTime?: string | null;
     /**
      * The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id\}`
      */
     managingAccount?: string | null;
     /**
-     * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}`
+     * The product name. Format: `accounts/{account\}/products/{product\}`
      */
     resource?: string | null;
     /**

package/reports_v1beta.ts

@@ -651,19 +651,19 @@ export namespace merchantapi_reports_v1beta {
    */
   export interface Schema$ProductChange {
     /**
-     * The new value of the changed resource or attribute.
+     * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
      */
     newValue?: string | null;
     /**
-     * The old value of the changed resource or attribute.
+     * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
      */
     oldValue?: string | null;
     /**
-     * Countries that have the change (if applicable)
+     * Countries that have the change (if applicable). Represented in the ISO 3166 format.
      */
     regionCode?: string | null;
     /**
-     * Reporting contexts that have the change (if applicable)
+     * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)
      */
     reportingContext?: string | null;
   }
@@ -800,12 +800,20 @@ export namespace merchantapi_reports_v1beta {
      * A message to describe the change that happened to the product
      */
     changes?: Schema$ProductChange[];
+    /**
+     * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.
+     */
+    eventTime?: string | null;
+    /**
+     * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
+     */
+    expirationTime?: string | null;
     /**
      * The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id\}`
      */
     managingAccount?: string | null;
     /**
-     * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}`
+     * The product name. Format: `accounts/{account\}/products/{product\}`
      */
     resource?: string | null;
     /**