Content API for Shopping からアカウント管理を移行する

このドキュメントでは、Content API v2.1 から Merchant API に移行する方法について説明します。

Content API v2.1 から Merchant API への変更の概要

Merchant API は、デベロッパーとビジネスのユーザビリティ、整合性、柔軟性を高めることを目的として、Content API v2.1 よりも大幅に改善されています。

きめ細かいリソース構造

Merchant API のリソースは、accountbusinessDetailsuserhomepageprogram などの単一のコンセプトを表します。関係を反映するように階層的に編成されます。たとえば、accountuser の親リソースです。

統合アカウント サービス

すべてのアカウント サービス(MCA とそのサブアカウントのアカウント集約、サードパーティ サービス プロバイダとアカウント間のアカウント集約など)は、統合された accountService リソースを介して管理されます。サービス プロバイダは、accountRelationship リソースを使用して関係を管理できます。

簡素化された URL 構造

URL で複数の ID ではなく、単一のアカウント ID(merchantapi.googleapis.com/accounts/v1beta/accounts/{accountId} など)が使用されるようになりました。URL パスは、詳細なリソース構造を反映しています。

その他の改良点

  • プログラムとユーザーの管理の強化: ショッピング広告や無料リスティングなどのプログラムが、単一の program リソースに統合されます。user リソースには、きめ細かいアクセス権を備えた包括的な管理機能が含まれています。
  • 構造化されたビジネス情報とビジネス ID: businessInfobusinessIdentity 専用のリソースがあります。リージョン固有のデータのフィールドによるコンプライアンス サポートが含まれています。韓国の法人登録番号など。
  • ホームページの登録の簡素化: ストアのホームページの URL は、専用の homepage リソースによって管理されます。claimunclaim などのメソッドは、API を介してウェブサイトの申し立てを直接処理します。
  • Google API ガイドラインへの準拠: Merchant API は、Google の API 改善案に準拠することを目指しています。

アカウント管理の移行

accounts リソースを使用して、販売者アカウントを作成、管理できます。詳細については、Merchant Accounts API の概要をご覧ください。

このページでは、アカウント管理を Content API から Merchant API に移行する方法について説明します。

リクエスト

Merchant Accounts API のリクエスト URL の形式は次のとおりです。

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

アカウントの作成と管理のリクエストについて、Content API for Shopping と Merchant Accounts API の比較例を次に示します。

  Content API for Shopping Merchant Accounts API
URL 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 には、アカウントデータを渡すための複数のリソースが用意されています。これらのリソースには、AccountUserBusinessInfoBusinessIdentity リソースが含まれます。

次の表に、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 email は nameaccounts/{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
- truePROMOTION_CONSENT_GIVEN を表します。
- falsePROMOTION_CONSENT_DENIED を表します。

Content API の AccountIdentityType リソースは、MerchantAPI の IdentityAttribute タイプとそのフィールド identityDeclaration で表されます。

Content API for Shopping Merchant Accounts API
self_identified identityDeclaration
- trueSELF_IDENTIFIES_AS を表します。
- falseDOES_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 サポートされていません。