Shopify APIのサポ、トされるバ、ジョンに、いて、影響のある関連情報をお知らせします。今回の記事では,2020年10月1日をもって一番古いサポ,トバ,ジョンとなる2020年1月(2020 - 01)の変更内容を振り返ります。
今後の変更のガイドとして,またブラックフライデー・サイバーマンデーに合わせたアプリの機能調整のために,この記事をぜひご活用ください。
変更に関する説明のラesc escブ動画も,以下でご確認いただけます。
バ,ジョニングのおさらい
変更内容の詳細を見る前に,Shopify APIのバ,ジョニングにいて復習しておきましょう。
1.四半期ごとに新しいバ,ジョンをリリ,スします
通常,リリ,スは年に4回、1月1日・4月1日・7月1日・10月1日におこなわれます。バ,ジョン名称は年月表記となっていますので(例:2020 - 01),安定バ,ジョンの把握や複数バ,ジョンのタ,ムラ,ン比較が簡単にできます。
2.アプリはリクエストURLで特定したバ,ジョンのAPIをリクエストします
Shopify APIは改良が続けられていますが,アプリを安定して機能させるために,安定バージョンを指定して構築することができます。ただし,特定のバ,ジョンを指定している場合,リクエストURLをアップデ,トしないかぎり,以降の新しい機能にはアクセスできないので注意が必要です。
3.マ,チャント向けの機能を定期的にリリ,スします
最新の安定バ,ジョンへの影響を避けるため,新機能を導入する際には候補バ,ジョンがリリ,スされます。このリリ,ス候補は単純に次のAPIバ,ジョンになりますが,年月表記でリクエスト指定が可能です。リリ,ス候補では,最新の機能セットを確かめることができます。ただ,改良がねに続けられているため,リリス候補をアプリの常態APIとして使用するのは避けてください。
安定性のメリットと最新機能へのアクセスを両立させるには,通常のリクエストは安定パージョンを使用し,特定の新機能を利用するときのみリリース候補にコールすることをお勧めします。
4.特定バ,ジョンをリクエストしない場合はもっとも古いサポ,トバ,ジョンが提供されます
これにより既存アプリは,新バ,ジョンのリリ,ス後にリクエストURLをアップデ,トすることなく機能し続けることができます。この原則は,サポ,トが終了しているバ,ジョンを指定している場合にも適用されます。
たとえば,サポ,トが終了している2019 - 10をアプリがリクエストしている場合,一番古いサポ,トバ,ジョンの2020 - 01が提供されます。
この仕組みによってバージョンスイッチ後のリクエストエラーを防ぐことができますが,新しいリリースバージョンを意図的に指定することを推奨しています。
5.各バ,ジョンは1年間サポ,トされます
バ,ジョンサポ,トの終了により,長期的にShopifyとマチャントにとってベストなサビスを提供できるようアジャルな体制を保ことができます。各バ,ジョンは1年間サポートされますが,これはつまり古い機能のサポート終了以前に新しい変更を採用して新機能を利用するまで,実質9ヶ月しかないことを意味します。
以上のサ电子邮箱クルを頭に入れたうえで,2020年10月の主要な情報を見ていきましょう。
10月1日の変更
2020年10月1日より,以下の変更がAPIに生じています。
・2020 - 10バ,ジョンが安定バ,ジョンとなり,一般利用可能に。
・2019 - 10バ,ジョンのサポ,トが終了。
・2020 - 01バ,ジョンの変更によって非推奨となったリクエストはアプリをフラグ付けします。マ,チャントへの影響を最小化するために,Shopifyはフラグ付けされたアプリをアプリストアのリスト掲載から外し,新規。また,マ,チャントに対して該当アプリがサポ,ト外であることを通知します。
その後,随時以下の対応となります。
・APIバ,ジョンの指定のないリクエストには2020 - 01バ,ジョンが提供されます。
・2019 - 10バ,ジョンへのリクエストは無効となり,代わりに2020 - 01バ,ジョンが提供されます。
・2019 - 10に設定されているWebhookでも同じ対応となります。
デフォルトとなる2020 - 01バ,ジョンでもっとも重要なのは,互換性のないAPI変更が含まれることです。2020 - 01で無効となるリクエストをアプリが実行している場合,2020年10月1日までにリクエスト切り替えのアクションを実施する必要があります。これが為されないと,リクエストが失敗してアプリが機能しなくなります。
それでは,2020 - 01で導入された重要な変更を個別に見ていきましょう。
気をいて
2020 - 01で導入された互換性のない変更が以下のとおりです。10月1日から,これがもっとも古いサポ,トバ,ジョンとなります。
1.收集APIから智能收集が削除されます
より効率的で性能のいいエンドポesc escント提供のために,コレクションAPIが再設計されています。この移行の一環として,收集APIから“智能收藏”が削除されました。これらのスマ,トコレクトは新しいコレクションAPIに移され,休息とGraphQLの両方で利用可能です。
ポ电子邮箱ント:コレクションに必要なすべてのケ,スで新しいコレクションAPIを使用してください。スマ,トコレクションを扱う際にはとくに重要になります。收集APIでスマ,トコレクションの情報を得ようとすると,不正確な結果または404エラ,が返ってきます。
開発者変更履歴に詳細があります。
2.GraphQLの@ @ンプットオブジェクトが250ア@ @テムに制限されます
すべてのコネクションにおいて、得られる結果の最大総数(第一:numか最后:numによる)はすでに250件に制限されています。これが@ @ンプットの引数にも適用されることになりました。
ポ电子邮箱ント:今後は無限に長い@ @ンプットをAPIに渡すことはできません。リクエストをより小さく管理しやすいサ@ @ズに分けましょう。
詳しい情報は,開発者変更履歴でご確認いただけます。
こらも参考にしてください:GraphQLで実現するShopifyメタフィ,ルドからの迅速なデ,タ取得
2020 - 10バ,ジョンへの対応
プラットフォームにおける変更が,開発者やパートナーのみなさんに対応努力を要求してしまうことは重々承知しています。バージョニングによって,このプロセスがいくらか予見しやすくなり,混乱をおさえることになればと願っています。次のリソ,スは,変更に対処するうえで参考になるかと思います。
・APIヘルスレポ,ト:パ,トナ,ダッシュボ,ドで見られるアプリごとのヘルスレポ,トで,あなたに影響のあるAPIの変更が正確にわかります。
・メル:保留中の変更について通知が受け取れるように,開発者向けコンタクトメールを最新のものにしておきましょう。
・弃用ヘッダ:アプリ内で,9ヶ月以内にサポ,トが終わる非推奨のリクエストには,X-Shopify-API-Deprecated-Reasonヘッダ,が付与されます。
・開発者変更履歴:Shopify APIや開発プロダクトに関する最新の変更情報が得られます。
または,Shopifyパ,トナ,と開発者向けのマンスリ,メ,ルを購読いただくことも可能です。
ブラックフラ2020 - 01以降のバ,ジョンにアップデ,トしておきましょう。
2020 - 10のリリ,スノ,トでは,新機能の全体にいて詳細を見ることができます。またはパ,トナ,ダッシュボ,ドで,あなたに影響のある変更をご確認ください。
Shopifyパ,トナ,プログラムでビジネスを成長させる
マーケティング,カスタマイズ,またはWebデザインや開発など提供するサービスに関係なく,Shopifyパートナープログラムはあなたを成功へと導きます。プログラムの参加は無料で,収益分配の機会が得られ,ビジネスを成長させる豊富なツールにアクセスできます。情熱的なコマスコミュニティに今すぐ参加しましょう!