ホームページの設定を移行する

Merchant API に専用の Homepage リソースが導入されました。このリソースには、ホームページの申請を管理するための新しいメソッドが用意されており、従来の Content API for Shopping よりも多くの機能を提供します。

オンライン ショップの機能にアクセスするには、まず所有権を確認し、次にアカウントにサイトを申請する 2 つの手順が必要です。最後の手順を完了するには、 次を使用します accounts.homepage.claim。

主な違い

Merchant API では、Content API for Shopping と比較して、ホームページ関連の変更がいくつか行われています。

• 専用リソース: Merchant API では、個別の Homepage リソース （accounts.homepage） が、ホームページ関連のすべてのオペレーションに対して提供されます。（Content API for Shopping では、申請アクションを実行するために accounts.claimwebsite を使用し、ホームページの URL (website_url) は Account リソースの一部であり、申請ステータス (website_claimed) は AccountStatus リソースの一部でした）。
• 詳細なメソッド: Merchant API には、次の操作を行うための特定のメソッドが用意されています。
  • ホームページの詳細を取得する: accounts.homepage.getHomepage
  • ホームページの URI を更新する: accounts.homepage.updateHomepage
  • ホームページを申請する: accounts.homepage.claim
  • ホームページの申請を取り消す: accounts.homepage.unclaim Content API for Shopping では、申請アクションに accounts.claimwebsite、URL の設定（空の URL を設定して申請を取り消す）に accounts.update、URL と 申請ステータスの取得に accounts.get/accountstatuses.get が使用されていました。
• 情報の一元化: Merchant API の Homepage リソースには、 uri（ホームページの URL）と claimed ステータスの両方が直接含まれています。Homepage リソースを操作するすべてのメソッドは、このリソースを返して、現在の状態に関するフィードバックを即座に提供します。Content API for Shopping では、accounts.claimwebsite は更新されたステータスを返さなかったため、個別の呼び出しが必要でした。
• 明示的な申請取り消し: Content API for Shopping では、通常、Account.website_url を空の文字列に更新することで申請を取り消していました。Merchant API には、専用の homepage.unclaim メソッドが用意されています。
• 申請の上書き: どちらの API も、 申請プロセス中に overwrite パラメータをサポートしています。所有権を 確認できる場合は、別のアカウントからの申請を引き継ぐことができます。

リクエスト

Merchant API では、ホームページのさまざまな側面を管理するために、個別の RESTful エンドポイントを使用します。

リクエストの説明	Content API for Shopping	Merchant API
ホームページの詳細を取得する	accounts.get（Account.website_url を読み取る）、accountstatuses.get（AccountStatus.website_claimed を読み取る）	GET /accounts/v1/accounts/{account}/homepage
ホームページの URI を更新する	accounts.update（Account.website_url を設定）	PATCH /accounts/v1/accounts/{account}/homepage
ホームページを申請または再確認する	POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite（accounts.update を使用して設定された Account.website_url に対して実行）	POST /accounts/v1/accounts/{account}/homepage:claim
ホームページの申請を取り消す	accounts.update（Account.website_url を空の文字列に設定）	POST /accounts/v1/accounts/{account}/homepage:unclaim

識別子

Merchant API では、リソースの識別が合理化されています。

識別子の説明	Content API for Shopping	Merchant API
リソース アクセスのアカウント識別子	パス内の merchantId（アドバンス アカウント）と accountId（サブアカウント）	account（name フィールドの一部。例: accounts/{account_id}/homepage）
ホームページ リソース識別子	該当なし（Account リソースに暗黙的に含まれる）	name: accounts/{account_id}/homepage（Homepage サブリソースを識別）

メソッド

Content API for Shopping の accounts.claimwebsite メソッドは、申請アクションに重点を置いていましたが、Merchant API の Homepage リソース内の幅広い機能の一部になりました。

Content API for Shopping のメソッド	Merchant API のメソッド	提供状況と注意事項
accounts.claimwebsite	accounts.homepage.claim	ウェブサイトの申請を直接開始または再確認します。homepage.update を使用して以前に設定した uri に対して動作します。overwrite パラメータが含まれています。現在の uri と claimed ステータスを含む Homepage リソースを返します。
accounts.get（Account.website_url を読み取る）、accountstatuses.get（AccountStatus.website_claimed を読み取る）	accounts.homepage.getHomepage	現在のホームページの uri とその claimed ステータスを 1 回の呼び出しで取得するための新しい専用メソッド。
accounts.update（Account.website_url を設定）	accounts.homepage.updateHomepage	ホームページの uri を設定または変更するための新しい専用メソッド。
accounts.update（申請を解除するための回避策として Account.website_url を空の文字列に設定）	accounts.homepage.unclaim	ホームページの申請を明示的に解除するための新しい専用メソッド。

フィールドの詳細な変更点

ホームページ情報の構造とアクセス方法が大幅に変更され、Merchant API の明示的な Homepage リソースに移行しました。

Content API for Shopping	Merchant API	説明
merchantId（accounts.claimwebsite のパスパラメータ）	name（Homepage メソッドのパスパラメータ、形式: accounts/{account}/homepage）	Merchant API の name 文字列の account 部分は、Content API for Shopping の accountId に対応します。
accountId（accounts.claimwebsite のパスパラメータ）	name（Homepage メソッドのパスパラメータ、形式: accounts/{account}/homepage）	ホームページが管理されている特定のアカウントの識別子。
overwrite（ContentAccountsClaimwebsiteRequest 本文と AccountsCustomBatchRequestEntry のブール値）	ClaimHomepageRequest.overwrite（homepage.claim リクエスト本文のブール値）	省略可。true の場合、ウェブサイトの申請を試みます。リクエスト元のアカウントが所有権を確認できる場合は、別のアカウントからの既存の申請が削除される可能性があります。
Account.website_url（Account リソースのフィールド、accounts.update を使用して設定、accounts.get を使用して読み取り）	Homepage.uri（Homepage リソースのフィールド）	ストアのホームページの URI（URL）。Merchant API では、これは Homepage リソース内の明示的なフィールドです。accounts.homepage.updateHomepage を使用して設定され、すべての Homepage メソッドによって返されます。
AccountStatus.website_claimed（AccountStatus リソースのフィールド、accountstatuses.get を使用して読み取り）	Homepage.claimed（Homepage リソースの出力専用のブール値フィールド）	uri が申請され、確認されているかどうかを示します。このステータスは、関連するすべての Merchant API メソッドによって返される Homepage リソースで直接確認できます。
なし	UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage リクエスト本文パラメータ）	Homepage リソースのどのフィールド（uri など）が更新されているかを指定する、homepage.update の省略可能なフィールド マスク。