@googleapis/merchantapi 17.3.0 → 18.0.0

package/build/accounts_v1.d.ts

@@ -111,7 +111,7 @@ export declare namespace merchantapi_accounts_v1 {
         termsOfServiceAgreementState?: Schema$TermsOfServiceAgreementState;
     }
     /**
-     * The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on.
+     * The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on.
      */
     export interface Schema$Account {
         /**
@@ -119,7 +119,7 @@ export declare namespace merchantapi_accounts_v1 {
          */
         accountId?: string | null;
         /**
-         * Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information.
+         * Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information.
          */
         accountName?: string | null;
         /**
@@ -588,7 +588,7 @@ export declare namespace merchantapi_accounts_v1 {
          */
         effectiveUriSettings?: Schema$UriSettings;
         /**
-         * Optional. The destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) to which the checkout program applies, valid destination values are `SHOPPING_ADS`, `FREE_LISTINGS`
+         * Optional. Required for the create operation. The destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) to which the checkout program applies. Valid destination values are `SHOPPING_ADS` and `FREE_LISTINGS`.
          */
         eligibleDestinations?: string[] | null;
         /**
@@ -631,7 +631,7 @@ export declare namespace merchantapi_accounts_v1 {
          */
         account?: Schema$Account;
         /**
-         * Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation` and `accounts.createAndConfigure` method can be used to create a sub-account under an existing advanced account through this method. Additional `account_management` or `product_management` services may be provided.
+         * Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation` and `accounts.createAndConfigure` method can be used to create a sub-account under an existing advanced account through this method. Additional `account_management` or `products_management` services may be provided.
          */
         service?: Schema$AddAccountService[];
         /**
@@ -787,7 +787,7 @@ export declare namespace merchantapi_accounts_v1 {
          */
         gcpIds?: string[] | null;
         /**
-         * Identifier. The `name` (ID) of the developer registration. Generated by the Content API upon creation of a new `DeveloperRegistration`. The `account` represents the merchant ID of the merchant that owns the registration.
+         * Identifier. The `name` (ID) of the developer registration. Generated upon creation of a new `DeveloperRegistration`. The `account` represents the merchant ID of the merchant that owns the registration.
          */
         name?: string | null;
     }
@@ -889,7 +889,7 @@ export declare namespace merchantapi_accounts_v1 {
         name?: string | null;
     }
     /**
-     * The current status of establishing of the service. (for example, pending approval or approved).
+     * The current status of establishing of the service. (for example, pending approval, approved, established).
      */
     export interface Schema$Handshake {
         /**
@@ -1644,7 +1644,7 @@ export declare namespace merchantapi_accounts_v1 {
         resourceType?: string | null;
     }
     /**
-     * Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`
+     * Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-affiliate` * `youtube-shopping-checkout`
      */
     export interface Schema$Program {
         /**
@@ -1732,7 +1732,7 @@ export declare namespace merchantapi_accounts_v1 {
         subtables?: Schema$Table[];
     }
     /**
-     * Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information.
+     * Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information.
      */
     export interface Schema$Region {
         /**
@@ -1769,7 +1769,7 @@ export declare namespace merchantapi_accounts_v1 {
      */
     export interface Schema$RegisterGcpRequest {
         /**
-         * Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have "API developer" access type and the email preference corresponding to that user will be updated to have the new "API notifications" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new "API notifications" preference. Make sure the email used is associated with a Google Account (Google Workspace account or Gmail account) and is not a service account as service accounts can't receive emails.
+         * Immutable. Optional field. Developer role can be also added by using `users.update` method. If the developer email provided is associated with a user in the provided merchant account, the user will be updated to have `API_DEVELOPER` `access_rights` and the email preference corresponding to that user will be updated to have the new API notifications preference. If the developer email provided is not associated with any user, it is added as a contact. The email preference corresponding to that contact will have the new API notifications preference. Make sure the email used is associated with a Google Account and is not a service account as service accounts can't receive emails.
          */
         developerEmail?: string | null;
     }
@@ -2387,6 +2387,86 @@ export declare namespace merchantapi_accounts_v1 {
         createAndConfigure(params: Params$Resource$Accounts$Createandconfigure, options: MethodOptions | BodyResponseCallback<Schema$Account>, callback: BodyResponseCallback<Schema$Account>): void;
         createAndConfigure(params: Params$Resource$Accounts$Createandconfigure, callback: BodyResponseCallback<Schema$Account>): void;
         createAndConfigure(callback: BodyResponseCallback<Schema$Account>): void;
+        /**
+         * Creates a Merchant Center test account. Test accounts are intended for development and testing purposes, such as validating API integrations or new feature behavior. Key characteristics and limitations of test accounts: - Immutable Type: A test account cannot be converted into a regular (live) Merchant Center account. Likewise, a regular account cannot be converted into a test account. - Non-Serving Products: Any products, offers, or data created within a test account will not be published or made visible to end-users on any Google surfaces. They are strictly for testing environments. - Separate Environment: Test accounts operate in a sandbox-like manner, isolated from live serving and real user traffic.
+         * @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('accounts_v1');
+         *
+         * 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.createTestAccount({
+         *     // Required. The account resource name to create the test account under. Format: accounts/{account\}
+         *     parent: 'accounts/my-account',
+         *
+         *     // Request body metadata
+         *     requestBody: {
+         *       // request body parameters
+         *       // {
+         *       //   "accountId": "my_accountId",
+         *       //   "accountName": "my_accountName",
+         *       //   "adultContent": false,
+         *       //   "languageCode": "my_languageCode",
+         *       //   "name": "my_name",
+         *       //   "testAccount": false,
+         *       //   "timeZone": {}
+         *       // }
+         *     },
+         *   });
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {
+         *   //   "accountId": "my_accountId",
+         *   //   "accountName": "my_accountName",
+         *   //   "adultContent": false,
+         *   //   "languageCode": "my_languageCode",
+         *   //   "name": "my_name",
+         *   //   "testAccount": false,
+         *   //   "timeZone": {}
+         *   // }
+         * }
+         *
+         * 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`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        createTestAccount(params: Params$Resource$Accounts$Createtestaccount, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        createTestAccount(params?: Params$Resource$Accounts$Createtestaccount, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Account>>;
+        createTestAccount(params: Params$Resource$Accounts$Createtestaccount, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        createTestAccount(params: Params$Resource$Accounts$Createtestaccount, options: MethodOptions | BodyResponseCallback<Schema$Account>, callback: BodyResponseCallback<Schema$Account>): void;
+        createTestAccount(params: Params$Resource$Accounts$Createtestaccount, callback: BodyResponseCallback<Schema$Account>): void;
+        createTestAccount(callback: BodyResponseCallback<Schema$Account>): void;
         /**
          * Deletes the specified account regardless of its type: standalone, advanced account or sub-account. Deleting an advanced account leads to the deletion of all of its sub-accounts. This also deletes the account's [developer registration entity](/merchant/api/reference/rest/accounts_v1/accounts.developerRegistration) and any associated GCP project to the account. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the `force` parameter to override this.
          * @example
@@ -2732,6 +2812,16 @@ export declare namespace merchantapi_accounts_v1 {
          */
         requestBody?: Schema$CreateAndConfigureAccountRequest;
     }
+    export interface Params$Resource$Accounts$Createtestaccount extends StandardParameters {
+        /**
+         * Required. The account resource name to create the test account under. Format: accounts/{account\}
+         */
+        parent?: string;
+        /**
+         * Request body metadata
+         */
+        requestBody?: Schema$Account;
+    }
     export interface Params$Resource$Accounts$Delete extends StandardParameters {
         /**
          * Optional. If set to `true`, the account is deleted even if it provides services to other accounts or has processed offers.
@@ -3586,7 +3676,7 @@ export declare namespace merchantapi_accounts_v1 {
         getDeveloperRegistration(params: Params$Resource$Accounts$Developerregistration$Getdeveloperregistration, callback: BodyResponseCallback<Schema$DeveloperRegistration>): void;
         getDeveloperRegistration(callback: BodyResponseCallback<Schema$DeveloperRegistration>): void;
         /**
-         * Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on.
+         * Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on. Restrictions: * The caller account must be authenticated and must not impersonate another account at registration time. Registering for subaccounts is not supported if the caller account is authenticated with the parent or the managing advanced account. * The caller account must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * [Test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts) are not eligible for registration.
          * @example
          * ```js
          * // Before running the sample:
@@ -3616,7 +3706,7 @@ export declare namespace merchantapi_accounts_v1 {
          *
          *   // Do the magic
          *   const res = await merchantapi.accounts.developerRegistration.registerGcp({
-         *     // Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration`
+         *     // Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration` The {account\} used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a [test account](https://developers.google.com/merchant/api/guides/accounts/test-accounts) ) and must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center.
          *     name: 'accounts/my-account/developerRegistration',
          *
          *     // Request body metadata
@@ -3729,7 +3819,7 @@ export declare namespace merchantapi_accounts_v1 {
     }
     export interface Params$Resource$Accounts$Developerregistration$Registergcp extends StandardParameters {
         /**
-         * Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration`
+         * Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration` The {account\} used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a [test account](https://developers.google.com/merchant/api/guides/accounts/test-accounts) ) and must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center.
          */
         name?: string;
         /**
@@ -7738,7 +7828,7 @@ export declare namespace merchantapi_accounts_v1 {
         create(params: Params$Resource$Accounts$Users$Create, callback: BodyResponseCallback<Schema$User>): void;
         create(callback: BodyResponseCallback<Schema$User>): void;
         /**
-         * Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager"
+         * Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account.
          * @example
          * ```js
          * // Before running the sample:

package/build/accounts_v1.js

@@ -120,6 +120,38 @@ var merchantapi_accounts_v1;
                 return (0, googleapis_common_1.createAPIRequest)(parameters);
             }
         }
+        createTestAccount(paramsOrCallback, optionsOrCallback, callback) {
+            let params = (paramsOrCallback ||
+                {});
+            let options = (optionsOrCallback || {});
+            if (typeof paramsOrCallback === 'function') {
+                callback = paramsOrCallback;
+                params = {};
+                options = {};
+            }
+            if (typeof optionsOrCallback === 'function') {
+                callback = optionsOrCallback;
+                options = {};
+            }
+            const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
+            const parameters = {
+                options: Object.assign({
+                    url: (rootUrl + '/accounts/v1/{+parent}:createTestAccount').replace(/([^:]\/)\/+/g, '$1'),
+                    method: 'POST',
+                    apiVersion: '',
+                }, options),
+                params,
+                requiredParams: ['parent'],
+                pathParams: ['parent'],
+                context: this.context,
+            };
+            if (callback) {
+                (0, googleapis_common_1.createAPIRequest)(parameters, callback);
+            }
+            else {
+                return (0, googleapis_common_1.createAPIRequest)(parameters);
+            }
+        }
         delete(paramsOrCallback, optionsOrCallback, callback) {
             let params = (paramsOrCallback || {});
             let options = (optionsOrCallback || {});