Retail is being renamed to Vertex AI Search for retail. We are in the process of updating content to reflect the new branding.

REST Resource: projects.locations.catalogs.merchantCenterAccountLinks

Resource: MerchantCenterAccountLink

Represents a link between a Merchant Center account and a branch. After a link is established, products from the linked Merchant Center account are streamed to the linked branch.

JSON representation

JSON representation
{ "name": string, "id": string, "merchantCenterAccountId": string, "branchId": string, "feedLabel": string, "languageCode": string, "feedFilters": [ { object (`MerchantCenterFeedFilter`) } ], "state": enum (`State`), "projectId": string, "source": string }

{
  "name": string,
  "id": string,
  "merchantCenterAccountId": string,
  "branchId": string,
  "feedLabel": string,
  "languageCode": string,
  "feedFilters": [
    {
      object (MerchantCenterFeedFilter)
    }
  ],
  "state": enum (State),
  "projectId": string,
  "source": string
}

Fields
`name`	`string` Output only. Immutable. Full resource name of the Merchant Center Account Link, such as `projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLinks/merchantCenterAccountLink`.
`id`	`string` Output only. Immutable. `MerchantCenterAccountLink` identifier, which is the final component of `name`. This field is auto generated and follows the convention: `BranchId_MerchantCenterAccountId`. `projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLinks/id_1`.
`merchantCenterAccountId`	`string (int64 format)` Required. The linked Merchant center account id. The account must be a standalone account or a sub-account of a MCA.
`branchId`	`string` Required. The branch ID (e.g. 0/1/2) within the catalog that products from merchantCenterAccountId are streamed to. When updating this field, an empty value will use the currently configured default branch. However, changing the default branch later on won't change the linked branch here. A single branch ID can only have one linked Merchant Center account ID.
`feedLabel`	`string` The FeedLabel used to perform filtering. Note: this replaces region_id. Example value: `US`. Example value: `FeedLabel1`.
`languageCode`	`string` Language of the title/description and other string attributes. Use language tags defined by BCP 47. ISO 639-1. This specifies the language of offers in Merchant Center that will be accepted. If empty, no language filtering will be performed. Example value: `en`.
`feedFilters[]`	`object (MerchantCenterFeedFilter)` Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.
`state`	`enum (State)` Output only. Represents the state of the link.
`projectId`	`string` Output only. Google Cloud project ID.
`source`	`string` Optional. An optional arbitrary string that could be used as a tag for tracking link source.

MerchantCenterFeedFilter

Merchant Center Feed filter criterion.

JSON representation
{ "primaryFeedId": string, "primaryFeedName": string }

Fields

Fields
`primaryFeedId`	`string (int64 format)` Merchant Center primary feed ID.
`primaryFeedName`	`string` Merchant Center primary feed name. The name is used for the display purposes only.

primaryFeedId

string (int64 format)

Merchant Center primary feed ID.

primaryFeedName

string

Merchant Center primary feed name. The name is used for the display purposes only.

State

The state of the link.

Enums
`STATE_UNSPECIFIED`	Default value.
`PENDING`	Link is created and LRO is not complete.
`ACTIVE`	Link is active.
`FAILED`	Link creation failed.

Methods
`create`	Creates a `MerchantCenterAccountLink`.
`delete`	Deletes a `MerchantCenterAccountLink`.
`list`	Lists all `MerchantCenterAccountLink`s under the specified parent `Catalog`.

REST Resource: projects.locations.catalogs.merchantCenterAccountLinks

Resource: MerchantCenterAccountLink

MerchantCenterFeedFilter

State

Methods

`create`

`delete`

`list`