本文档介绍了如何从 Content API v2.1 迁移到 Merchant API。
从 Content API v2.1 迁移到 Merchant API 的变更概览
与 Content API v2.1 相比，Merchant API 进行了重大改进，旨在为开发者和商家提升易用性、一致性和灵活性。
精细的资源结构
Merchant API 中的资源代表单个概念，例如 account、businessDetails、user、homepage 和 program。它们采用分层结构进行整理，以反映它们之间的关系。例如，account 是 user 的父级资源。
统一账号服务
所有账号服务（例如，MCA 及其子账号的账号汇总，或第三方服务提供商与账号之间的账号汇总）均通过统一的 accountService 资源进行管理。服务提供方可以使用 accountRelationship 资源管理其关系。
简化了网址结构
网址现在使用单个账号 ID（例如 merchantapi.googleapis.com/accounts/v1beta/accounts/{accountId}），而不是多个 ID。网址路径反映了精细的资源结构。
其他改进
- 增强的计划和用户管理功能：购物广告和非付费商品详情等计划整合到单个
program资源下。user资源包含具有精细访问权限的全面管理功能。 - 结构化商家信息和商家身份：
businessInfo和businessIdentity有专门的资源。这些版本包含合规性支持，并包含用于特定区域数据的字段。例如，韩国企业注册号。 - 简化了首页声明流程：专用
homepage资源可管理商店的首页网址。claim和unclaim等方法可直接通过 API 处理网站声明。 - 遵守 Google API 准则：Merchant API 旨在与 Google 的 API 改进建议保持一致。
账号管理迁移
您可以使用 accounts 资源创建和管理商家账号。如需了解详情，请参阅 商家账号 API 概览。
本页介绍了如何将账号管理从 Content API 迁移到 Merchant API。
请求
请使用以下请求网址格式访问 Merchant Accounts API：
https://merchantapi.googleapis.com/accounts/v1beta/{accountId}/accounts
下面的示例比较了 Content API for Shopping 和 Merchant Accounts API 在账号创建和管理请求方面的差异：
| Content API for Shopping | Merchant Accounts API | |
|---|---|---|
| 网址 | https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/accounts/{accountId}/ |
https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*} |
| 标识符 | merchantId,accountId |
``name |
资源
账号数据是使用 Content API for Shopping 中的 Account 资源传递的。Merchant Accounts API 提供了多个资源来传递账号数据。这些资源包括 Account、User、BusinessInfo 和 BusinessIdentity 资源。
下表比较了 Content API for Shopping 中的 Account 资源与 Merchant Accounts API 中的 Account 资源。
| Content API for Shopping | Merchant Accounts API |
|---|---|
id |
name |
name |
accountName |
kind |
不可用 |
websiteUrl |
Homepage 资源中的 uri 字段 |
adultContent |
adultContent |
sellerId |
AccountRelationship 资源中的 accountIdAlias 字段 |
users |
在 User 资源中 |
youtubeChannelLinks |
尚未提供 |
googleMyBusinessLink |
尚未提供 |
businessInformation |
在 businessInfo 资源中 |
businessIdentity |
在 businessIdentity 资源中 |
automaticImprovements |
尚未提供 |
adsLinks |
AccountService 资源中的 campaignsManagement 字段 |
cssId |
仅在 CSS API 中提供 |
labelIds |
仅在 CSS API 中提供 |
accountManagement |
AccountService 资源中的 accountManagement 字段 |
automaticLabelIds |
仅在 CSS API 中提供 |
conversionSettings |
尚未提供 |
下表比较了 Content API for Shopping 中的 AccountUser 资源与 Merchant Accounts API 中的 User 资源。
| Content API for Shopping | Merchant Accounts API |
|---|---|
emailAddress
|
电子邮件地址属于 name (accounts/{account}/users/{email})。 |
admin |
user#accessRights.ADMIN |
orderManager |
不可用 |
paymentsManager |
不支持 |
paymentsAnalyst |
不可用 |
reportingManager |
user#accessRights.PERFORMANCE_REPORTING |
下表比较了 Content API for Shopping 中的 AccountBusinessInformation 资源及其在 Merchant Accounts API 中的等效资源 businessInfo。
| Content API for Shopping | Merchant Accounts API |
|---|---|
address |
address |
phoneNumber |
phone |
phoneVerificationStatus |
phoneVerificationState |
customerService |
customerService |
koreanBusinessRegistrationNumber |
koreanBusinessRegistrationNumber |
下表比较了 Content API for Shopping 中的 AccountBusinessIdentity 资源与 Merchant Accounts API 中的 businessIdentity 资源。
| Content API for Shopping | Merchant Accounts API |
|---|---|
blackOwned |
blackOwned |
womenOwned |
womenOwned |
veteranOwned |
veteranOwned |
latinoOwned |
latinoOwned |
smallBusiness |
smallBusiness |
includeForPromotions |
promotionsConsent |
- true 表示 PROMOTION_CONSENT_GIVEN |
|
- false 表示 PROMOTION_CONSENT_DENIED |
Content API 中的 AccountIdentityType 资源由 MerchantAPI 中的 IdentityAttribute 类型及其字段 identityDeclaration 表示。
| Content API for Shopping | Merchant Accounts API |
|---|---|
self_identified |
identityDeclaration |
- true 表示 SELF_IDENTIFIES_AS |
|
- false 表示 DOES_NOT_SELF_IDENTIFY_AS |
方法
Merchant Accounts API 中引入了以下方法：
| Content API for Shopping | Merchant Accounts API |
|---|---|
accounts.authinfo |
不使用过滤条件的 GET https://merchantapi.googleapis.com/accounts/v1beta/accounts |
accounts.claimwebsite |
POST https://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}/homepage:claim 如需了解详情，请参阅方法：accounts.v1beta.accounts.homepage.claim |
accounts.custombatch |
不可用。Merchant API 不支持自定义批处理。 |
accounts.delete |
DELETE https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*} |
accounts.get |
GET https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*}` |
accounts.insert |
POST https://merchantapi.googleapis.com/accounts/v1beta/accounts:createAndConfigure 如需了解详情，请参阅创建和配置商家账号 |
accounts.link |
AccountService 资源 |
accounts.list |
GET https://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}:listSubaccounts |
accounts.listlinks |
GET https://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}/services |
accounts.requestphoneverification |
不受支持。 |
accounts.update |
与定义必填字段或一组必填字段的资源的更新请求相对应。 |
accounts.updatelabels |
仅在 CSS API 中提供 |
accounts.verifyphonenumber |
不受支持。 |