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

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 の設定に accounts.update（空の URL を設定することで申請を解除）、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
リソース アクセス用のアカウント ID パス内の merchantId（アドバンス アカウント）と accountId（サブアカウント） account（name フィールドの一部、例: accounts/{account_id}/homepage）
ホームページのリソース ID 該当なし（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 リソースの output_only ブール値フィールド） uri が申請され、確認されているかどうかを示します。このステータスは、関連するすべての Merchant API メソッドから返される Homepage リソースで直接確認できます。
なし UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage リクエスト本文パラメータ） homepage.update のオプションのフィールド マスク。Homepage リソースのどのフィールド（uri など）を更新するかを指定します。
前へ
Migrate user and access management
次へ
Migrate region management