Content API v2 から v2.1 に移行する

2019 年 3 月に Content API for Shopping バージョン 2.1 を リリース し、2021 年 4 月に v2 のサポートを 2021 年 9 月 30 日に終了することを お知らせ しました。バージョン v2 のサポートは終了しました。早急に v2.1 に移行してください。

アプリケーションの移行

v2 から v2.1 への移行では、新しい v2.1 バージョンを呼び出すようにエンドポイント URL を更新し、v2.1 で導入された破壊的変更に対応するようにアプリケーションを変更する必要があります。

v2.1 エンドポイントを使用するように API 呼び出しを更新する

v2.1 を呼び出すには、新しい v2.1 エンドポイントを使用するようにリクエストを更新します。

たとえば、v2 で products.get メソッドを呼び出すには、次のようにします。

GET https://shoppingcontent.googleapis.com/content/v2/merchantId/products/productId

v2.1 の場合は、URL を次のように更新します。

GET https://shoppingcontent.googleapis.com/content/v2.1/merchantId/products/productId

v2.1 のサービスとエンドポイントの詳細については、 API リファレンスをご覧ください。

必要な変更を加える

API 呼び出しの URL を更新するだけでなく、v2.1 で導入されたいくつかの破壊的変更に対応するようにアプリケーションを更新する必要があります。 以下のセクションを確認し、必要に応じてアプリケーションを更新してください。

1. inventory サービスとの統合を更新する

v2 の inventory サービスは削除されました。同等の機能は、次の v2.1 機能で利用できます。

  • 商品の一部分を更新するには、新しい補助 フィードまたは products.update を使用します。変更可能なすべての 商品フィールドを更新できます。これには、 inventory.set で以前に更新されたすべてのフィールド（localinventory 専用のフィールドを除く）が含まれます。詳しくは、 補助 フィードに移行する をご覧ください。

  • ローカル商品の更新には、新しい localinventoryサービス を使用します。

2. accounts サービスへの呼び出しを更新する

  • v2.1 の accounts.update メソッドの呼び出しでは、 accounts リソースが完全に上書きされます。リクエストに含まれるフィールドのみを更新するのではなく、 accounts リソースのフィールドが削除されないようにするには、すべてのフィールドを含めるように呼び出しリクエストを更新します。

  • reviewsUrl が削除されました。

  • adsLinks、googleMyBusinessLink、youtubeChannelLinks のリンク ステータス inactive が削除されました。

3. products サービスへの呼び出しを更新する

  • カスタム属性にタイプと単位が含まれなくなりました。代わりに、単位を値に追加し、タイプを自動的に検出する必要があります。

  • 繰り返しフィールド productTypes が、productType と additionalProductTypes の両方に置き換わりました。

  • 繰り返しフィールド includedDestinations と excludedDestinations が、繰り返しフィールド destinations に置き換わりました。

  • AdWords 関連の次のフィールドの名前が変更されました。

    • adwordsGrouping -> adsGrouping
    • adwordsLabels -> adsLabels
    • adwordsRedirect -> adsRedirect

  • 次のフィールドが削除されました。

    • aspects
    • destinations
    • onlineOnly
    • validatedDestinations
    • warnings

  • includeInvalidInsertedItems パラメータが削除されました。v2.1 では、デフォルトですべての商品が返されます。

  • 挿入された商品を products.get または products.list で取得できるようになるまで、数分かかるようになりました。

  • 返される offerId が入力 offerId と同じであるとは限りません。v2.1 では、offerId の先頭と末尾の空白文字が削除され、複数の空白文字が 1 つにまとめられます。この変更は、推奨される offerId構文に準拠するofferId値には影響しません。

  • 価格は、商品を挿入する前に検証されるようになりました。値の文字列で使用できる文字は、+、-、.、数字（ 0～9）のみです。カンマは使用できなくなりました。

  • products.insert または products.update 呼び出しからのレスポンスには、次の属性のみが含まれます。

    • channel
    • contentLanguage
    • id
    • offerId
    • feedLabel

  • v2 オプション includeAttributes は非推奨になりました。代わりに、ProductId で products.get を使用して、商品の詳細情報を表示します。

4. productstatuses サービスへの呼び出しを更新する

  • product 属性が includeAttributes パラメータとともに削除されました。ステータスに対応する商品の属性を取得するには、products サービスを使用し、新しい productId フィールドの値を渡します。

  • includeInvalidInsertedItems パラメータが削除されました。商品が有効かどうかに関係なく、すべての商品の productId が返されるようになりました。

  • destinationStatuses の intention、approvalStatus、approvalPending フィールドが status に置き換わりました。status は、approved、disapproved、pending のいずれかの文字列です。

  • dataQualityIssues が itemLevelIssues に置き換わりました。

5. datafeeds サービスへの呼び出しを更新する

  • 次のターゲット フィールドが置き換わりました。

    • contentLanguage -> language
    • targetCountry -> country
    • intendedDestinations -> includedDestinations、excludedDestinations

  • contentType = "product inventory update" のデータフィードが削除されました。

6. orders サービスと TestOrders サービスへの呼び出しを更新する

  • v2.1 では、税金データは自動的に計算されるため、呼び出しに税金データを含めないでください。市場公正法（MFA）または同様の法律が適用される州で注文が履行される場合、税金データを含む呼び出しは失敗します。MFA が適用されない州で注文が履行される場合、税金は Merchant Center で構成された設定に基づいて計算されます。構成されていない場合、計算される税金は 0 です。

  • InStoreRefundLineItem フィールドと ReturnRefundLineItem フィールドの amountPretax と amountTax が、それぞれ priceAmount と taxAmount に置き換わりました。priceAmount は、注文の場所に応じて税抜きまたは税込みになります。

  • リクエストの ShipLineItem フィールド carrier、shipmentId、trackingId が shipmentInfos に移動しました。

  • billingAddress と predefinedBillingAddress が、それぞれ orders と TestOrder の最上位フィールドになりました。

  • customer.explicitMarketingPreference が customer.marketingRightsInfo に置き換わりました。

  • netAmount フィールドが netPriceAmount と netTaxAmount に分割されました。

  • shippingOption が lineItems[].shippingDetails に置き換わりました。

  • リクエストの CancelLineItem フィールド amount、amountPretax、amountTax が削除されました。払い戻し額が自動的に計算されるようになりました。

  • CustomBatch が削除されました。

  • Refund が削除されました。代わりに refundOrder または refundItem を使用してください。

  • paymentMethod フィールドが削除されました。

  • v2 メソッド orders.returnlineitem と orders.refund が、orderreturns.creatOrderReturn と orderreturns.process に置き換わりました。

  • customer.email、channelType、lineItem.product.channel フィールドが削除されました。

  • promotions フィールドが TestOrder サービスから削除され、その 形式が Order で変更されました。

7. orderinvoice サービスへの呼び出しを更新する

  • amountPretax フィールドと amountTax フィールドが、それぞれ priceAmount と taxAmount に置き換わりました。priceAmount フィールドは、注文の場所に応じて税抜きまたは税込みになります。

  • invoiceSummary の残高（販売者、購入者、Google）とプロモーション料金関連フィールドが削除されました。

8. v2.1 に含まれていない機能を削除する

v2.1 では、Content API から他の機能もいくつか削除されています。次のリストを確認し、必要に応じてアプリケーションを更新してください。

  • XML はサポートされなくなりました。JSON への切り替えについて詳しくは、 Content API for Shopping での XML サポートの終了をご覧ください。

  • dryRun パラメータが削除されました。この変更は、すべての API 呼び出しに適用されます。

  • すべての HTTP BATCH メソッドが削除されました。代わりに customBatch を使用してください。

  • 次のサービスから patch メソッドが削除されました。

    • accounts
    • accounttax
    • datafeeds
    • liasettings
    • shippingsettings

  • orderpayments サービスが削除されました。

移行をテストする

v2.1 に移行した後、アプリケーションの変更をテストする方法について詳しくは、Content API for Shopping の使用をテストするをご覧ください。更新のテスト中に問題が発生した場合は、お問い合わせください。

v2.1 のその他の変更

v2.1 では、更新が必要な変更に加えて、いくつかの新機能と非破壊的変更も導入されています。

  • 新しいサービス:

    • 新しい localinventory サービス を使用すると、ローカル商品の更新（v2 の inventory サービス の代わり）を行うことができます。

    • 新しい orderreturns サービスを使用すると、 orders サービスを使用せずに返品を処理できるため、Google で購入（以前のショッピング アクション）の管理が 容易になります。

  • 補助フィード を使用すると、商品の部分的な更新を行うことができます。

  • products サービスのその他の変更:

    • products.insert リクエストで、致命的でない警告やエラーが報告されなくなりました。 これにより、商品を挿入し、後で更新して、Content API の外部で管理されているフィードと同じように、Merchant Center のフィードのルールを使用して問題を解決できます。

    • products.update が追加され、選択した商品フィールドを更新できるようになりました。使用方法について詳しくは、 ガイドをご覧ください。

    • 次の属性の無効な値は、挿入 エラーを引き起こさなくなり、itemLevelIssues の一部として productstatus サービスによって返されるようになりました。

      • ageGroup
      • availability
      • condition
      • energyEfficiencyClass
      • gender
      • maxEnergyEfficiencyClass
      • minEnergyEfficiencyClass
      • sizeSystem
      • sizeType

    • カスタム属性が再帰的になり、カスタム グループが不要になりました。

    • カスタム属性に、元の value フィールドに加えて groupValues フィールドが追加されました。フィールドのいずれか 1 つを設定する必要があります。