Merchant API 使用入门

本页介绍了如何使用 Merchant API 创建 Merchant Center 账号并上传示例商品。

准备工作

在 Google Cloud 项目中启用 Merchant API。

如果 API 集成在 AppScript 中使用 Shopping Content Service,它会创建一个默认 Google Cloud 项目并自动启用 Merchant API 服务。不过,您仍需先完成一次性开发者注册,然后才能使用 Merchant API。如需了解详情,请参阅在 Apps 脚本中使用 Merchant API 服务

前往 Google Cloud

创建账号

如需使用 Merchant API,您必须拥有 Merchant Center 账号。如需创建 Merchant Center 账号,请参阅 Merchant Center 使用入门

前往 Merchant Center

注册为开发者

如需使用 Merchant API,您必须使用开发者注册方法关联您的 Merchant Center 账号和 Google Cloud 项目,具体操作如下:

  1. 关联 Merchant Center 和您的 Google Cloud 项目:由于调用者拥有来自 Google Cloud 项目的有效访问令牌或 API 密钥,并且是 Merchant Center 账号的授权用户,因此系统会自动批准关联。

  2. 向 Merchant Center 账号添加 API 开发者用户:注册 API 会向 Merchant Center 账号添加 API 开发者用户。如果用户已存在,系统会向其授予新的访问权限类型。如果是新用户,他们会收到 Merchant Center 电子邮件邀请。

我们建议您使用 accounts.users.create 方法添加其他或备用 API 开发者,以确保在相关人员离开组织或被删除的情况下,您仍然可以拥有有效的开发者注册。

注册后,您可以使用 GetDeveloperRegistration 查看注册状态,也可以使用 UnregisterGCP 取消注册。

注册调用为

POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/{ACCOUNT_ID}/developerRegistration:registerGcp

{
  developer_email:"example-email@example.com"
}

请求成功运行后,您会收到以下响应:

{
  "developerRegistration": {
    "name": "accounts/ACCOUNT_ID/developerRegistration",
    "gcpIds": ["GOOGLE_CLOUD_PROJECT_ID"]
  }
}

注册 API 开发者后,您可以使用 accounts.users.patch 方法向其授予其他角色,例如 STANDARDADMIN

获取您的账号 ID

您可以使用 accounts.list 方法获取账号 ID。

您可以使用 Google APIs Explorer 运行 Merchant API 请求。API Explorer 使用 Google OAuth 2.0 进行身份验证。在运行请求之前,请确保已勾选 Google OAuth 2.0 复选框。

如需使用 OAuth 2.0 进行身份验证,您需要登录自己的 Google 账号,然后登录 API Explorer。您还需要允许 API Explorer 管理您的商品详情和账号。

以下请求展示了如何检索您的账号 ID:

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/{ACCOUNT_ID}

请求成功运行后,您会看到以下响应:

{
  "accounts": [
    {
      "name": "{ACCOUNT_NAME}",
      "accountId": "{ACCOUNT_ID}",
      "accountName": "{ACCOUNT_DISPLAY_NAME}",
      "timeZone": {
        "id": "America/Los_Angeles"
      },
      "languageCode": "en-US"
    }
  ]
}

复制 {ACCOUNT_ID},因为您需要使用它来运行其他请求。

创建主要商品数据源

如需插入商品,您需要一个主要商品数据源。以下请求展示了如何创建可用于向您的账号中插入商品的数据源:

POST https://merchantapi.googleapis.com/datasources/v1beta/accounts/{ACCOUNT_ID}/dataSources HTTP/1.1

{
  "primaryProductDataSource": {
    "channel": "ONLINE_PRODUCTS",
    "contentLanguage": "en",
    "countries": [
      "US"
    ],
    "feedLabel": "US"
  },
  "name": "primary-data-source",
  "displayName": "Primary Products Data Source"
}

{ACCOUNT_ID} 替换为您创建的 Merchant Center 账号的 ID。

此请求成功运行后,您会看到以下响应:

{
  "name": "accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}",
  "dataSourceId": "{DATASOURCE_ID}",
  "displayName": "Primary Products Data Source",
  "primaryProductDataSource": {
    "channel": "ONLINE_PRODUCTS",
    "feedLabel": "US",
    "contentLanguage": "en",
    "countries": [
      "US"
    ],
    "defaultRule": {
      "takeFromDataSources": [
        {
          "self": true
        }
      ]
    }
  },
  "input": "API"
}

复制 name 字段的值,因为您需要使用它来插入商品。

创建的数据源需要几分钟时间才能用于插入商品。

您可以在 Merchant Center 界面中查看此数据源。如需了解详情,请参阅如何找到“数据源”标签页

插入产品

如需向您的账号插入示例商品,请运行以下请求:

POST https://merchantapi.googleapis.com/products/v1beta/accounts/{ACCOUNT_ID}/productInputs:insert?dataSource={DATASOURCE_NAME} HTTP/1.1

{
  "channel": "ONLINE",
  "contentLanguage": "en",
  "feedLabel": "US",
  "name": "Red T-shirt",
  "attributes": {
    "gender": "Male",
    "brand": "New brand"
  },
  "offerId": "tshirt-123"
}

{DATASOURCE_NAME} 替换为您之前复制的值。

此请求成功运行后,您会看到以下响应:

{
  "name": "accounts/{ACCOUNT_ID}/productInputs/online~en~US~tshirt-123",
  "product": "accounts/{ACCOUNT_ID}/products/online~en~US~tshirt-123",
  "channel": "ONLINE",
  "offerId": "tshirt-123",
  "contentLanguage": "en",
  "feedLabel": "US",
  "attributes": {
    "brand": "New brand",
    "gender": "Male"
  }
}

新创建的商品的商品 ID 为 online~en~US~tshirt-123。您可以使用 accounts.products.get 方法检索有关此商品的详细信息。您还可以使用 Merchant Center 界面查看此商品