Shopify API の非推奨ポリシー：2021-04版

この記事はShopify API の非推奨ポリシー情報の最新版です。2020年7月のAPIリリースでリリースされた変更点を振り返りながら、プライベートアプリの開発者にとって重要かつ有益な情報をおさらいします。

 この記事はShopify API の非推奨ポリシー情報の最新版です。2020年7月のAPIリリースでリリースされた変更点を振り返りながら、プライベートアプリの開発者にとって重要かつ有益な情報をおさらいします。

プライベートアプリについての重要情報

COVID-19が始まったとき、私たちはプライベートアプリのAPIバージョン廃止を延期することを決定しました。ソリューションのカスタマイズ性や、技術担当者へのコンタクトの難しさもあり、マーチャントにとってパンデミックの中で新しい販売方法に適応しながら、アプリの移行も管理することは、大きな負担になると私たちは考えたからです。

しかし、現在のニューノーマルへの適応を考えるにあたり、私たちはすべてのアプリに対して同じバージョン管理タイムラインを適用すべきと考えています。古いバージョンを完全に廃止することで、古いコードパスを削除することができ、すべての人にとってよりパフォーマンスの高いプラットフォーム体験が提供できるようになります。

2021年4月1日には、プライベートアプリもサポートされていないバージョンのAPIにアクセスできなくなります（例：2019-04、2019-07、2019-10、2020-01、2020-04）またサポートされないリクエストに対してはパブリックアプリと同じ動作が適用されます。

プライベートアプリの重要な変更点について

もしプライベートアプリの開発をされている場合、以下の記事を参照することで、いくつかの主要なポリシー変更や、その対処法についての詳細を確認できます:

ShopifyのAPIのバージョンと廃止について

Shopify API 2020-10バージョンの廃止情報

Shopify API の非推奨ポリシー：2021-01版

また、アップデートに備えてアプリ修正が必要な場合は、開発者向けドキュメント内のプライベートアプリ情報ページのチェックをお勧めします。

確認する

バージョン管理のおさらい

今回の変更点に焦点を合わせる前に、Shopify   API のバージョニングのルールについて再確認しましょう。

四半期ごとにバージョンをリリースしています。これらのリリースは通常、1月1日、4月1日、7月2日、10月1日前後に行われます。バージョン名は年月形式（例：2021-01）で付けられており、各バージョンの安定時期の確認やタイムラインの比較を容易にしています。

アプリはリクエストURL中で特定のバージョンのAPIを指定し、リクエストを行います。Shopify APIは継続的にアップデートされていますが、アプリを安定したバージョンのAPIと構築することで、APIコントラクトを保つことができます。これは一方で、ターゲットバージョン以降にリリースされた機能は、リクエストURLを更新するまでアクセスできないことを意味します。

最新の安定したAPIに影響を与えることなく機能を追加するために、Shopifyはリリース候補というコンセプトを用いています。このリリース候補はシンプルにいえば次のAPIバージョンのことで、同じ年月形式のフォーマットを使用し、リクエストの対象となることができます。この中には、リリースされたばかりの最新の機能セットがあります。リリース候補は継続的に進化しているため、アプリが日常的にコールするAPIとしては使用しないでください。

特定のバージョンをリクエストしないアプリは、サポートされている内で最も古いバージョンが提供されます。これにより、新しいバージョンリリースの際に、URLをアップデートせずとも、既存のアプリが機能を継続することができます。このルールは、サポートされなくなったバージョンを明示的に呼び出すアプリにも適用されます。この仕組みにより、バージョン切り替え後にすべてのリクエストがエラーになるのを防ぐことができますが、明示的により新しいバージョンをターゲットにすることをお勧めします。

各バージョンのサポート期間は1年間です。バージョンサポートを取り除くことで、きめ細かな対応や、マーチャントおよびShopifyプラットフォームに最高のサービスを提供するた上で必要な修正を行うことができます。各バージョンは1年間サポートされていますが、アプリで新しい変更を採用し、オブソリートになるまで、実際には9ヶ月しかないことを意味しています。

しっかり振り返れたところで、2021年4月1日に備えて必要となる重要な情報を確認しましょう。

4月1日の変更点

2021年4月1日、パブリックおよびプライベートアプリのAPIに以下の変更が適用されます。:

2021-04年版は一般的に安定して使用できるようになります。

2020-04年版がサポート対象外となります。

非推奨(Depreciation)となったリクエストは、アプリにフラグが立てられます。マーチャントへの影響を最小限に抑えるため、Shopifyはフラグが付いたアプリを

Shopify App Storeから削除し、新規のインストールを制限します。またアプリがサポートされなくなったことをマーチャントに通知する場合があります。

変更後の動作:

APIのバージョンが指定されていないリクエストには、2020-07バージョンが提供されます。

2020-04 バージョンのリクエストは指定のバージョンでの受け取りができません。代わりに、これらのリクエストは 2020-07バージョンのリクエストに転送されます。

2020-04 に設定されたWebhookの場合も同様に動作します。

最も重要なことは、上の条件でデフォルトになる 2020-07 API バージョンには、いくつかの大きなAPI の仕様変更が含まれていることです。2020-07 バージョンでリクエストの不具合がアプリに発生している場合、2021年4月1日までに必要な修正を行い、それらのリクエストを移行する必要があります。これを怠るとリクエストが失敗してアプリが機能しなくなります。

”2020-07 バージョンでリクエストの不具合がアプリに発生している場合、2021年4月1日までに必要な修正を行い、それらのリクエストを移行する必要があります。これを怠るとリクエストが失敗してアプリが機能しなくなります"

それでは、2020-07バージョンに導入される重要な変更について確認しましょう。

重要な変更点について

以下、来たる4月1日にもっとも古い対応バージョンとなる2020-07バージョンで導入された変更点を紹介します。

1. ディスカウントの割り当て方法

ディスカウントに関して、target_selection 属性がexplicitに設定されている場合に取り得る値について修正しました。以前は、これらの割引は単一のライン項目に適用され、値はoneでした。2020-07の変更によって、割り当て方法がeach と across に置き換えられました。

この変更は、構文をシンプルするために行ったもので、機能的にはoneも across も最終価格を設定した金額だけ割引します。

ポイント：以前はoneが表示されていた場所に acrossというallocation methodの値が表示されることがあります。(oneが廃止） 

2.ProductVariantの画像リソースを削除しました

GraphQL Admin APIにおいて、ProductVariantオブジェクトの "images"フィールドは、より適切な名前の "image"フィールドに置き換えられたため、非推奨とされていました。今回の変更により、このフィールドは完全に削除されました。

ポイント：GraphQLでProductVariantの画像をクエリするときは、代わりに "image "フィールドを使用してください。

2021年4月1日に備える

以下のリソースは、Shopifyプラットフォームの変更への対応に役立ちます:

APIヘルスレポート： パートナーダッシュボードで見られるアプリごとのヘルスレポートで、あなたに影響のあるAPIの変更が正確にわかります。

メール： 保留中の変更について通知が受け取れるように、開発者向けコンタクトメールを最新のものにしておきましょう。

Deprecationヘッダー：アプリ内で、9ヶ月以内にサポートが終わる非推奨のリクエストには、X-Shopify-API-Deprecated-Reasonヘッダーが付与されます。

開発者変更履歴：Shopify APIや開発プロダクトに関する最新の変更情報が得られます。

Deprecated API calls endpoint　プライベートアプリは、このエンドポイントを介してAPIのヘルス情報にアクセスできます。

 

新機能の包括的な情報については2021-04リリースノートをチェックください。

 

原文：Alex Bradley 翻訳：阿部 敏朗