Gcp/merchantapi
@swamp/gcp/merchantapiv2026.06.12.1
01README
Google Cloud merchantapi infrastructure models
02Release Notes
- Updated: accounts_products
03Models
@swamp/gcp/merchantapi/accountsv2026.06.08.1accounts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| accountId? | string | Output only. The ID of the account. |
| accountName? | string | Required. A human-readable name of the account. Don\ |
| adultContent? | boolean | Optional. Whether this account contains adult content. |
| languageCode? | string | Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`. |
| name? | string | Identifier. The resource name of the account. Format: `accounts/{account}` |
| testAccount? | boolean | Output only. Whether this is a test account. |
| timeZone? | object | Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). |
fn get(identifier: string)
Get a accounts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accounts |
fn update()
Update accounts attributes
fn delete(identifier: string)
Delete the accounts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accounts |
fn sync()
Sync accounts state from GCP
fn list(filter?: string, pageSize?: number, maxPages?: number)
List accounts resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax). |
| pageSize? | number | Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn create_and_configure(account?: any, service?: any, setAlias?: any, user?: any)
create and configure
| Argument | Type | Description |
|---|---|---|
| account? | any | |
| service? | any | |
| setAlias? | any | |
| user? | any |
fn create_test_account(accountId?: any, accountName?: any, adultContent?: any, languageCode?: any, name?: any, testAccount?: any, timeZone?: any)
create test account
| Argument | Type | Description |
|---|---|---|
| accountId? | any | |
| accountName? | any | |
| adultContent? | any | |
| languageCode? | any | |
| name? | any | |
| testAccount? | any | |
| timeZone? | any |
fn list_subaccounts()
list subaccounts
Resources
state(infinite)— The `Account` message represents a business's account within Merchant Center....
@swamp/gcp/merchantapi/accounts-aggregateproductstatusesv2026.06.08.1accounts_aggregateproductstatuses.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a aggregateProductStatuses
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the aggregateProductStatuses |
fn sync()
Sync aggregateProductStatuses state from GCP
fn list(filter?: string, pageSize?: number, maxPages?: number)
List aggregateProductStatuses resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter expression that filters the aggregate product statuses. Filtering is only supported by the `reporting_context` and `country` field. For example: `reporting_context = "SHOPPING_ADS" AND country = "US"`. |
| pageSize? | number | Optional. The maximum number of aggregate product statuses to return. The service may return fewer than this value. If unspecified, at most 25 aggregate product statuses are returned. The maximum value is 250; values above 250 are coerced to 250. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Aggregate product statuses for a given reporting context and country.
@swamp/gcp/merchantapi/accounts-conversionsourcesv2026.06.08.1accounts_conversionsources.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| googleAnalyticsLink? | object | "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. |
| merchantCenterDestination? | object | "Merchant Center Destination" sources can be used to send conversion events from an online store using a Google tag directly to a Merchant Center account where the source is created. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create(waitForReady?: boolean)
Create a conversionSources
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a conversionSources
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversionSources |
fn update(waitForReady?: boolean)
Update conversionSources attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the conversionSources
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversionSources |
fn sync()
Sync conversionSources state from GCP
fn list(pageSize?: number, showDeleted?: boolean, maxPages?: number)
List conversionSources resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of conversion sources to return in a page. If no `page_size` is specified, `100` is used as the default value. The maximum value is `200`. Values above `200` will be coerced to `200`. Regardless of pagination, at most `200` conversion sources are returned in total. |
| showDeleted? | boolean | Optional. Show deleted (archived) conversion sources. By default, deleted conversion sources are not returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn undelete()
undelete
Resources
state(infinite)— Represents a conversion source owned by a Merchant account. A merchant accoun...
@swamp/gcp/merchantapi/accounts-datasourcesv2026.06.08.1accounts_datasources.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| displayName? | string | Required. The displayed data source name in the Merchant Center UI. |
| fileInput? | object | The data specific for file data sources. This field is empty for other data source inputs. |
| localInventoryDataSource? | object | The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. |
| merchantReviewDataSource? | object | The merchant review data source. |
| name? | string | Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}` |
| primaryProductDataSource? | object | The primary data source for local and online products. |
| productReviewDataSource? | object | The product review data source. |
| promotionDataSource? | object | The promotion data source. |
| regionalInventoryDataSource? | object | |
| supplementalProductDataSource? | object | The [supplemental data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#link-supplemental-data-source) for local and online products. After creation,you should make sure to link the supplemental product data source into one or more primary product data sources. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a dataSources
fn get(identifier: string)
Get a dataSources
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataSources |
fn update()
Update dataSources attributes
fn delete(identifier: string)
Delete the dataSources
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataSources |
fn sync()
Sync dataSources state from GCP
fn list(pageSize?: number, maxPages?: number)
List dataSources resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | 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. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn fetch()
fetch
Resources
state(infinite)— The [data source](/merchant/api/guides/data-sources/overview) for the Merchan...
@swamp/gcp/merchantapi/accounts-datasources-fileuploadsv2026.06.08.1accounts_datasources_fileuploads.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a fileUploads
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the fileUploads |
fn sync()
Sync fileUploads state from GCP
Resources
state(infinite)— The file upload of a specific data source, that is, the result of the retriev...
@swamp/gcp/merchantapi/accounts-gbpaccountsv2026.06.08.1accounts_gbpaccounts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a gbpAccounts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the gbpAccounts |
fn sync()
Sync gbpAccounts state from GCP
fn list(pageSize?: number, maxPages?: number)
List gbpAccounts resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of `GbpAccount` resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the `pageSize`. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn link_gbp_account(gbpEmail?: any)
link gbp account
| Argument | Type | Description |
|---|---|---|
| gbpEmail? | any |
Resources
state(infinite)— Collection of information related to a Google Business Profile (GBP) account.
@swamp/gcp/merchantapi/accounts-issuesv2026.06.08.1accounts_issues.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a issues
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the issues |
fn sync()
Sync issues state from GCP
fn list(languageCode?: string, pageSize?: number, timeZone?: string, maxPages?: number)
List issues resources
| Argument | Type | Description |
|---|---|---|
| languageCode? | string | Optional. The issues in the response will have human-readable fields in the given language. The format is [BCP-47](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`. If not value is provided, `en-US` will be used. |
| pageSize? | number | Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50 issues will be returned. The maximum value is 100; values above 100 will be coerced to 100 |
| timeZone? | string | Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in human-readable fields. For example 'America/Los_Angeles'. If not set, 'America/Los_Angeles' will be used. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Issues with your Merchant Center account that can impact all your products. F...
@swamp/gcp/merchantapi/accounts-lfpmerchantstatesv2026.06.08.1accounts_lfpmerchantstates.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a lfpMerchantStates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the lfpMerchantStates |
fn sync()
Sync lfpMerchantStates state from GCP
Resources
state(infinite)— The LFP state of a merchant.
@swamp/gcp/merchantapi/accounts-lfpstoresv2026.06.08.1accounts_lfpstores.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| gcidCategory? | array | Optional. [Google My Business category id](https://support.google.com/business/answer/7249669). |
| phoneNumber? | string | Optional. The store phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. Example: `+15556767888` |
| placeId? | string | Optional. The [Google Place Id](https://developers.google.com/maps/documentation/places/web-service/place-id#id-overview) of the store location. |
| storeAddress? | string | Required. The street address of the store. Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA. |
| storeCode? | string | Required. Immutable. A store identifier that is unique for the target merchant. |
| storeName? | string | Optional. The merchant or store name. |
| targetAccount? | string | Required. The Merchant Center id of the merchant to submit the store for. |
| websiteUri? | string | Optional. The website URL for the store or merchant. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a lfpStores
fn get(identifier: string)
Get a lfpStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the lfpStores |
fn delete(identifier: string)
Delete the lfpStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the lfpStores |
fn sync()
Sync lfpStores state from GCP
fn list(pageSize?: number, targetAccount?: string, maxPages?: number)
List lfpStores resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of `LfpStore` resources for the given account to return. The service returns fewer than this value if the number of stores for the given account is less than the `pageSize`. The default value is 250. The maximum value is 1000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum. |
| targetAccount? | string | Required. The Merchant Center id of the merchant to list stores for. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A store for the merchant. This will be used to match to a store under the Goo...
@swamp/gcp/merchantapi/accounts-limitsv2026.06.08.1accounts_limits.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a limits
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the limits |
fn sync()
Sync limits state from GCP
fn list(filter?: string, pageSize?: number, maxPages?: number)
List limits resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Required. A filter on the limit `type` is required, for example, `type = "products"`. |
| pageSize? | number | Optional. The maximum number of limits to return. The service may return fewer than this value. If unspecified, at most 100 limits will be returned. The maximum value is 100; values above 100 will be coerced to 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A limit of a certain type that is applied to an account.
@swamp/gcp/merchantapi/accounts-merchantreviewsv2026.06.08.1accounts_merchantreviews.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| customAttributes? | array | Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per produc |
| merchantReviewAttributes? | object | Attributes. |
| merchantReviewId? | string | Required. The user provided merchant review ID to uniquely identify the merchant review. |
| merchantReviewStatus? | object | The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. |
| name? | string | Identifier. The name of the merchant review. Format: `"{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"` |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a merchantReviews
fn get(identifier: string)
Get a merchantReviews
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the merchantReviews |
fn delete(identifier: string)
Delete the merchantReviews
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the merchantReviews |
fn sync()
Sync merchantReviews state from GCP
fn list(pageSize?: number, maxPages?: number)
List merchantReviews resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of merchant reviews to return. The service can return fewer than this value. The maximum value is 1000; values above 1000 are coerced to 1000. If unspecified, the maximum number of reviews is returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A review for a merchant. For more information, see [Introduction to Merchant ...
@swamp/gcp/merchantapi/accounts-notificationsubscriptionsv2026.06.08.1accounts_notificationsubscriptions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| allManagedAccounts? | boolean | If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. |
| callBackUri? | string | URL to be used to push the notification to the merchant. |
| registeredEvent? | enum | The event that the merchant wants to be notified about. |
| targetAccount? | string | The `name` of the account you want to receive notifications for. Format: `accounts/{account}` |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a notificationsubscriptions
fn get(identifier: string)
Get a notificationsubscriptions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the notificationsubscriptions |
fn update()
Update notificationsubscriptions attributes
fn delete(identifier: string)
Delete the notificationsubscriptions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the notificationsubscriptions |
fn sync()
Sync notificationsubscriptions state from GCP
fn list(pageSize?: number, maxPages?: number)
List notificationsubscriptions resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Represents a notification subscription owned by a Merchant account. See [Deco...
@swamp/gcp/merchantapi/accounts-omnichannelsettingsv2026.06.08.1accounts_omnichannelsettings.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| about? | object | Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). |
| inStock? | object | Collection of information related to InStock. |
| inventoryVerification? | object | Collection of information related to [inventory verification](https://support.google.com/merchants/answer/14684499?ref_topic=15145634&sjid=6892280366904591178-NC). |
| lfpLink? | object | Collection of information related to the LFP link. |
| lsfType? | enum | Required. The Local Store Front type for this country. |
| name? | string | Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}` |
| odo? | object | Collection of information related to the on display to order ([ODO](https://support.google.com/merchants/answer/14615056?ref_topic=15145747&sjid=6892280366904591178-NC)). |
| pickup? | object | Collection of information related to Pickup. |
| regionCode? | string | Required. Immutable. Region code defined by [CLDR](https://cldr.unicode.org/). Must be provided in the Create method, and is immutable. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a omnichannelSettings
fn get(identifier: string)
Get a omnichannelSettings
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the omnichannelSettings |
fn update()
Update omnichannelSettings attributes
fn sync()
Sync omnichannelSettings state from GCP
fn list(pageSize?: number, maxPages?: number)
List omnichannelSettings resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of omnichannel settings to return. The service may return fewer than this value. If unspecified, at most 50 omnichannel settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn request_inventory_verification()
request inventory verification
Resources
state(infinite)— Collection of information related to the omnichannel settings of a merchant.
@swamp/gcp/merchantapi/accounts-onlinereturnpoliciesv2026.06.08.1accounts_onlinereturnpolicies.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| acceptDefectiveOnly? | boolean | Optional. This field specifies if business only accepts defective products for returns. |
| acceptExchange? | boolean | Optional. This field specifies if business allows customers to exchange products. |
| countries? | array | Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code. |
| itemConditions? | array | Optional. The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'. |
| label? | string | Optional. Immutable. This field represents the unique user-defined label of the return policy for the given country. It is important to note that the same label cannot be used in different return policies for the same country. If not given, policies will be automatically treated as the 'default' for the country. When using label, you are creating an exception policy in that country to assign a custom return policy to certain product groups, follow the instructions provided in the [Return policy |
| name? | string | Identifier. The name of the `OnlineReturnPolicy` resource. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}` |
| policy? | object | The available policies. |
| processRefundDays? | number | Optional. The field specifies the number of days it takes for business to process refunds. |
| restockingFee? | object | The restocking fee. This can be a flat fee or a micro percent. |
| returnLabelSource? | enum | Optional. The field specifies the return label source. |
| returnMethods? | array | Optional. The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns. |
| returnPolicyUri? | string | Required. The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL. |
| returnShippingFee? | object | The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost. |
| seasonalOverrides? | array | Optional. Overrides to the general policy for orders placed during a specific set of time intervals. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a onlineReturnPolicies
fn get(identifier: string)
Get a onlineReturnPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the onlineReturnPolicies |
fn delete(identifier: string)
Delete the onlineReturnPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the onlineReturnPolicies |
fn sync()
Sync onlineReturnPolicies state from GCP
fn list(pageSize?: number, maxPages?: number)
List onlineReturnPolicies resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of `OnlineReturnPolicy` resources to return. The service returns fewer than this value if the number of return policies for the given business is less that than the `pageSize`. The default value is 10. The maximum value is 100; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— [Online return policy](https://support.google.com/merchants/answer/10220642) ...
@swamp/gcp/merchantapi/accounts-productreviewsv2026.06.08.1accounts_productreviews.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| customAttributes? | array | Optional. A list of custom (merchant-provided) attributes. |
| name? | string | Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"` |
| productReviewAttributes? | object | Attributes. |
| productReviewId? | string | Required. The permanent, unique identifier for the product review in the publisher’s system. |
| productReviewStatus? | object | Product review status. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a productReviews
fn get(identifier: string)
Get a productReviews
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the productReviews |
fn delete(identifier: string)
Delete the productReviews
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the productReviews |
fn sync()
Sync productReviews state from GCP
fn list(pageSize?: number, maxPages?: number)
List productReviews resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of products to return. The service may return fewer than this value. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A review for a product. For more information, see [Introduction to Product Re...
@swamp/gcp/merchantapi/accounts-productsv2026.06.12.1accounts_products.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a products
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the products |
fn sync()
Sync products state from GCP
fn list(pageSize?: number, maxPages?: number)
List products resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | 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 default page size of 25 products will be returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— The processed product, built from multiple product inputs after applying rule...
@swamp/gcp/merchantapi/accounts-products-localinventoriesv2026.06.08.1accounts_products_localinventories.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| localInventoryAttributes? | object | Local inventory attributes. |
| storeCode? | string | Required. Immutable. Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a localInventories
fn get(identifier: string)
Get a localInventories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the localInventories |
fn delete(identifier: string)
Delete the localInventories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the localInventories |
fn sync()
Sync localInventories state from GCP
fn list(pageSize?: number, maxPages?: number)
List localInventories resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of `LocalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 25000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Local inventory information for the product. Represents in-store information ...
@swamp/gcp/merchantapi/accounts-products-regionalinventoriesv2026.06.08.1accounts_products_regionalinventories.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| region? | string | Required. Immutable. ID of the region for this `RegionalInventory` resource. See the [Regional availability and pricing](https://support.google.com/merchants/answer/9698880) for more details. |
| regionalInventoryAttributes? | object | Regional inventory attributes. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a regionalInventories
fn get(identifier: string)
Get a regionalInventories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the regionalInventories |
fn delete(identifier: string)
Delete the regionalInventories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the regionalInventories |
fn sync()
Sync regionalInventories state from GCP
fn list(pageSize?: number, maxPages?: number)
List regionalInventories resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of `RegionalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Regional inventory information for the product. Represents specific informati...
@swamp/gcp/merchantapi/accounts-programsv2026.06.08.1accounts_programs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a programs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the programs |
fn sync()
Sync programs state from GCP
fn list(pageSize?: number, maxPages?: number)
List programs resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn disable()
disable
fn enable()
enable
Resources
state(infinite)— Defines participation in a given program for the specified account. Programs ...
@swamp/gcp/merchantapi/accounts-promotionsv2026.06.08.1accounts_promotions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| dataSource? | string | Required. The data source of the [promotion](https://support.google.com/merchants/answer/6396268?sjid=5155774230887277618-NC) Format: `accounts/{account}/dataSources/{datasource}`. |
| promotion? | object | Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a promotions
fn get(identifier: string)
Get a promotions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the promotions |
fn sync()
Sync promotions state from GCP
fn list(pageSize?: number, maxPages?: number)
List promotions resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. 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. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Represents a promotion. See the following articles for more details. Required...
@swamp/gcp/merchantapi/accounts-quotasv2026.06.08.1accounts_quotas.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a quotas
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the quotas |
fn sync()
Sync quotas state from GCP
fn list(pageSize?: number, maxPages?: number)
List quotas resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of quotas to return in the response, used for paging. Defaults to 500; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— The group information for methods in the Merchant API. The quota is shared be...
@swamp/gcp/merchantapi/accounts-relationshipsv2026.06.08.1accounts_relationships.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| accountIdAlias? | string | Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use `account_id_alias` to assign a friendly name to this relationship for easier identification in your systems. |
| name? | string | Identifier. The resource name of the account relationship. Format: `accounts/{account}/relationships/{relationship}`. For example, `accounts/123456/relationships/567890`. |
| provider? | string | Immutable. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). |
| providerDisplayName? | string | Output only. The human-readable display name of the provider account. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a relationships
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the relationships |
fn update()
Update relationships attributes
fn sync()
Sync relationships state from GCP
fn list(pageSize?: number, maxPages?: number)
List relationships resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of elements to return in the response. Use for paging. If no `page_size` is specified, `100` is used as the default value. The maximum allowed value is `1000`. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— The `AccountRelationship` message defines a formal connection between a merch...
@swamp/gcp/merchantapi/accounts-servicesv2026.06.08.1accounts_services.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a services
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the services |
fn sync()
Sync services state from GCP
fn list(pageSize?: number, maxPages?: number)
List services resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of elements to return in the response. Use for paging. If no `page_size` is specified, `100` is used as the default value. The maximum allowed value is `1000`. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn approve()
approve
fn propose(accountService?: any, provider?: any)
propose
| Argument | Type | Description |
|---|---|---|
| accountService? | any | |
| provider? | any |
fn reject()
reject
Resources
state(infinite)— The `AccountService` message represents a specific service that a provider ac...
@swamp/gcp/merchantapi/accounts-termsofserviceagreementstatesv2026.06.08.1accounts_termsofserviceagreementstates.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a termsOfServiceAgreementStates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the termsOfServiceAgreementStates |
fn sync()
Sync termsOfServiceAgreementStates state from GCP
fn retrieve_for_application()
retrieve for application
Resources
state(infinite)— This resource represents the agreement state for a given account and terms of...
@swamp/gcp/merchantapi/accounts-usersv2026.06.08.1accounts_users.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| accessRights? | array | Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. |
| name? | string | Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. |
| userId? | string | Required. The email address of the user (for example, `john.doe@gmail.com`). |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a users
fn get(identifier: string)
Get a users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
fn update()
Update users attributes
fn delete(identifier: string)
Delete the users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
fn sync()
Sync users state from GCP
fn list(pageSize?: number, maxPages?: number)
List users resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100 |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— The `User` resource represents a user associated with a Merchant Center accou...
@swamp/gcp/merchantapi/termsofservicev2026.06.08.1termsofservice.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a termsOfService
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the termsOfService |
fn sync()
Sync termsOfService state from GCP
fn accept()
accept
fn retrieve_latest()
retrieve latest
Resources
state(infinite)— The `TermsOfService` message represents a specific version of the terms of se...
04Previous Versions
2026.06.08.2Jun 8, 2026
- Updated: accounts, accounts_gbpaccounts, accounts_issues, accounts_omnichannelsettings, accounts_onlinereturnpolicies, accounts_programs, accounts_relationships, accounts_services, accounts_termsofserviceagreementstates, accounts_users, termsofservice, accounts_conversionsources, accounts_datasources, accounts_datasources_fileuploads, accounts_products_localinventories, accounts_products_regionalinventories, accounts_aggregateproductstatuses, accounts_lfpmerchantstates, accounts_lfpstores, accounts_notificationsubscriptions, accounts_products, accounts_promotions, accounts_limits, accounts_quotas, accounts_merchantreviews, accounts_productreviews
2026.06.07.1Jun 7, 2026
- Updated: accounts, accounts_gbpaccounts, accounts_issues, accounts_omnichannelsettings, accounts_onlinereturnpolicies, accounts_programs, accounts_relationships, accounts_services, accounts_termsofserviceagreementstates, accounts_users, termsofservice, accounts_conversionsources, accounts_datasources, accounts_datasources_fileuploads, accounts_products_localinventories, accounts_products_regionalinventories, accounts_aggregateproductstatuses, accounts_lfpmerchantstates, accounts_lfpstores, accounts_notificationsubscriptions, accounts_products, accounts_promotions, accounts_limits, accounts_quotas, accounts_merchantreviews, accounts_productreviews
2026.06.05.1Jun 5, 2026
- Added: accounts, accounts_gbpaccounts, accounts_issues, accounts_omnichannelsettings, accounts_onlinereturnpolicies, accounts_programs, accounts_relationships, accounts_services, accounts_termsofserviceagreementstates, accounts_users, termsofservice, accounts_conversionsources, accounts_datasources, accounts_datasources_fileuploads, accounts_products_localinventories, accounts_products_regionalinventories, accounts_aggregateproductstatuses, accounts_lfpmerchantstates, accounts_lfpstores, accounts_notificationsubscriptions, accounts_products, accounts_promotions, accounts_limits, accounts_quotas
Added 24 models
2026.05.27.1May 27, 2026
- Updated: accounts_merchantreviews, accounts_productreviews
2026.05.25.1May 25, 2026
- Updated: accounts_merchantreviews, accounts_productreviews
Modified 2 models
2026.05.24.1May 24, 2026
- Updated: accounts_merchantreviews, accounts_productreviews
2026.05.21.2May 21, 2026
- Updated: accounts_merchantreviews, accounts_productreviews
2026.05.21.1May 21, 2026
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.04.23.1Apr 23, 2026
2026.04.03.3Apr 3, 2026
- Updated: accounts_merchantreviews, accounts_productreviews
2026.04.03.1Apr 3, 2026
- Updated: accounts_merchantreviews, accounts_productreviews
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: accounts_merchantreviews, accounts_productreviews
05Stats
A
100 / 100
Downloads
0
Archive size
243.4 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels