Shopify API非推奨ポリシーの2020年度版最終版へようこそ、ここでは、サポートされているすべてのバージョンに適用予定の大きな変更に注目していきます。ブラックフライデー/サイバーマンデー2020に熱い視線が注がれる中、2021年1月1日にサポートされているShopify APIバージョン中で最も古い2020年4月リリースバージョンで実装された変更点を振り返ってみましょう。
Shopifyのマーチャントのためのアプリを構築する
Shopify App Store用のアプリを構築したい、カスタムアプリ開発サービスを提供したい、ユーザーベースを増やす方法を探しているなど、Shopifyパートナープログラムは成功のための支援を行います。無料で参加し、教育リソース、開発者プレビュー環境、定期的な収益共有の機会にアクセスしてください。
バージョニングについてのおさらい
変更の詳細に飛び込む前に、ShopifyのAPIバージョニングがどのようにプランニングされているか確認してみましょう。
- Shopifyは四半期ごとにバージョンをリリースしています。これらのリリースは通常、1月1日、4月1日、7月2日、10月1日頃実施されます。バージョン名は年月形式(例: 2021-01)で付けられているので、バージョンが安定した時期を常に容易に識別できるようにし、複数バージョンの時系列を比較することができます。
- アプリは、リクエストURLに特定のバージョンのAPIを指定してリクエストを行います。Shopify APIは継続的に進化していますが、アプリを安定したバージョンで構築することで、APIのコントラクトを一定に保つことができます。一方、ターゲットバージョン以降にリリースされた機能に関しては、リクエストURLを更新するまでアクセスできないことを覚えておいてください。
- 私たちはマーチャントに対し継続的に機能をリリースしています。安定している最新APIに影響を与えずに機能リリースするために、リリースキャンディデートを使用しています。リリースキャンディデートは端的に言えば次のAPIバージョンであり、同じ年月のフォーマットを使用してリクエストの対象とすることができます。リリースキャンディデートには、リリースされたばかりの機能の最新セットが含まれています。ただし、継続的に進化しているため、アプリの一般的な日常的なAPI利用にリリースキャンディデートを使用することは避けるべきです。安定性と最新機能へのアクセスの両方のメリットを得るには、アプリの日常的なリクエストを安定したバージョンに行い、新しくリリースされた機能を扱う特定の呼び出しのみをリリースキャンディデートに遷移させることをお勧めします。
- 特定のバージョンを要求しないアプリは、サポートされている最も古いバージョンと連携します。これにより、新しいバージョニングを出荷した際に、新URLにアップデートすることなく、既存アプリは機能を維持することができます。この概念は、サポートされなくなったバージョンを明示的に呼び出すアプリにも適用されます。すべてのアプリがバージョン切り替え後にすべてのリクエストがエラーになるのを防ぐこの仕組みの恩恵を受けることができますが、明示的に最新リリースをターゲットにすることをお勧めします。
- バージョンのサポート期間は1年間です。バージョンサポートを削除することで、私たちは機敏に対応し、長期的にマーチャントとShopifyプラットフォームに最高のサービスを提供するために必要な変更を行うことができます。バージョンは1年間サポートされていますが、これは、アプリがこの新しい変更を採用し、古い動作が利用できなくなる前に新しい機能を利用するために、実際には9ヶ月しかないことを意味します。
このおさらいを念頭に置き、2021年1月1日に備えて必要となる重要な情報を確認してみましょう。
1月1日のアップデート
2021年1月1日より、ShopifyのAPIに以下の変更が適用されます:
- 2021-01バージョンが安定し一般的に使用できるようになります。
- 2020-01バージョンはサポートされなくなります。
- 2020-04の変更により非推奨となったリクエストは、アプリにフラグが付きます。マーチャントへの影響を最小限に抑えるため、Shopifyはフラグが付いたアプリをShopify App Storeから削除し、新規インストールを制限します。さらに、私たちはアプリがサポートされなくなったことをマーチャントに通知する場合があります。
その他のShopifyの判断:
- API バージョンが指定されていないリクエストは、2020-04 バージョンで提供されます。
- 2019-10バージョンのリクエストは、そのバージョンを受け取らなくなります。代わりに、これらのリクエストは2020-04にフォワードされます。
- 2019-10 に設定されている Webhook も上記と同様の方法でフォワードされます。
今後予定される大きな変更点
1月1日よりShopifyがサポートするもっとも古いバージョンとなる、2020-04で導入される大きな変更点を以下に紹介します。
1. 値下げミューテーションの削除
2020-01では、値下げの一括修正を念頭に設計された2つのミューテーション、productBulkAddPriceReductionsとproductBulkRemovePriceReductionsをリリースしました。
検討した結果、これらはまだ広く使用するには不十分だと判断し、スキーマから削除することにしました。
ポイント：productBulkAddPriceReductionsとproductBulkRemovePriceReductionsのミューテーションが削除されました。
2. メディアオブジェクトの新しいエラーコード
メディア オブジェクトのエラーコードが追加がされ、より詳細なトラブルシューティングが可能になりました。 一方、enumに値を追加すると、アプリにとっては以前は想定していなかった新しい値として認識される可能性があるため、このアップデートを影響の大きなものとしてリストアップしています。
ポイント：メディアオブジェクトを扱う場合は、新しい値を処理するために構文解析ためにエラー解析を更新してください。
3. Storefront API 利用者向けの新しいエラーコード
これは上記と同じです。Storefront APIに顧客向けのエラーコードを追加しました。
ポイント:顧客に対応する際には、新しい値を処理するためにエラーパースをアップデートしてください。
2020年1月1日に備える
以下のリソースは、Shopifyプラットフォームの変更を常に把握しておくのに役立ちます :
- APIヘルスレポート。パートナーダッシュボード上でアプリ毎に用意されるヘルスレポートでは、 API の変更が与える影響を正確に表示します。
- eメール: 登録されているメールアドレスが最新であることを確認し、保留されているAPIの変更点を通知することができます。
- 非推奨ヘッダー。アプリ内で、X-Shopify-API-Deprecated-Reasonヘッダーを残すことで,非推奨となり,ヶ9月以内にサポートされなくなるリクエストに追加されます。
- 開発者チェンジログ。ShopifyのAPIやその他の開発者向け製品の最近のアップデートを確認できます。
- 非推奨のAPIコールエンドポイント：プライベートアプリは API ヘルスレポートにアクセスできないため、このデータを要求するための新しいエンドポイントを構築しました。
今年の1月には、2020-04以降に移行して、エラー処理の新機能を強化し、あなたのアプリが新しい年を迎える準備ができていることを確認してください。
新機能の包括的な情報については、2021-01リリースノートをご覧ください。また、どのアップデートがあなたに影響を与える可能性があるかについては、パートナーダッシュボードをご覧いただくか、以下のニュースレターの購読をおすすめします。
Shopifyパートナープログラムでビジネスを成長させる
マーケティング、カスタマイズ、またはWebデザインや開発など提供するサービスに関係なく、Shopifyパートナープログラムはあなたを成功へと導きます。プログラムの参加は無料で、収益分配の機会が得られ、ビジネスを成長させる豊富なツールにアクセスできます。情熱的なコマースコミュニティに今すぐ参加しましょう！