Shopify API：2020年7月のリリース情報

 2020年7月のAPIの新機能をまとめてご紹介します。最新バージョンのAPIリリースにおける変更箇所を理解して、アプリの品質と開発体験の向上に役立ててください。

今月は、Admin APIの改良にフォーカスし、さらに国際的なマーチャント体験の向上に役立つ機能も追加しています。2020-07バージョンのリリースにともない、2019-04と2019-07のバージョン削除も同時におこなわれるため、APIヘルスレポートをチェックして互換性を確認することもお忘れなく。

それでは2020-07バージョンがShopify APIにもたらす改善点を見ていきましょう。

2020-07のリリース情報

以下の機能が2020-07リリースに含まれています。

1 AWS EventBridgeのサポート

ショップからのwebhookイベントを受け取るためにAmazon EventBridgeを利用できるようになりました。Shopifyから直接webhookのトラフィックを受け入れるようにスケーリングすることは、とくに大型ショップがフラッシュセール中にあなたのアプリを使用している場合などに、困難なことがあります。EventBridgeとの統合により、イベントデータを直接AWSに送ることができ、処理のためにSQSやLambdaに転送可能です。

ShopifyのEventBridge統合は、高度なスケーリングと柔軟な解決策を提供します。複雑なキューイングシステムを管理する必要なく、多くのwebhookトラフィックを確実に受け取れます。

以下の動画で、ShopifyのAWS EventBridge統合をセットアップする方法をご確認ください。

 

開発者ドキュメントに、AWS EventBridgeでShopifyのwebhook管理を始めるための詳細が載っています。

2 GraphQL Billing APIで年払い請求が可能に

今まで、Billing APIで年払いを提供するにはいろいろな対策が必要でした。通常、アプリは「1回限り」の請求をおこない、一年ごとに作成されてマーチャントの承認が必要です。このアプローチにはいくつも欠点があり、とくにアップグレードや請求の再承認において問題がありました。

2020-07バージョンからBilling APIは年払いはサポートし、分割アップグレードや自動更新に対応します。appSubscriptionCreateのミューテーションを使用し、interval: ANNUALを指定すると、Shopifyが年払い請求を実行します。

下記は、年払い請求を作成するミューテーションの例です。

 

既存の年額サブスクリプションの切り替えなど、年払い請求についてのより詳しい情報は、こちらのドキュメントで参照可能です。

3 ローカライズの拡張機能

国や地域によっては、行政規則に準拠した追加情報がチェックアウト時に必要になることがあります。Shopifyはこの情報エントリをサポートし、関連する内容をOrder APIを介して表示します。

たとえば、この拡張機能をサポートする最初の地域であるブラジルの例を見てみましょう。適切な行政の請求書には、有効なCPF番号がチェックアウト時に要求されます。今まで、創意あるストアオーナーが「会社情報」のフィールドでCPF番号を収集するケースがありましたが、今後はCPFを取得するための専用フィールドが利用できます。

このフィールドに入力された情報は、以下に示すとおり、注文に紐づけられたlocalizationExtensionsを通じて取得できます。 

この拡張機能により、今後ほかの地域で必要となるかもしれない地域特有の追加フィールドが利用可能となります。

この機能を使ってtax IDを取得する方法の詳細は、こちらのドキュメントでご確認いただけます。

4 GraphQLアクセスエラーの改善

GraphQLのアクセスエラーがより記述的になり、「アクセスが拒否されました」という表示だけではなく、リクエストが失敗した理由について情報を返します。レスポンスにはextensionsが含まれ、エラーコード、関連するドキュメントのリンク、必要なアクセススコープの名称などで構成されます。

ビフォー：

アフター：

 

2019-04と2019-07のバージョン削除について

以前、新型コロナウイルスへの対応に関するブログでスケジュールの変更についてお伝えしたとおり、2020-07のリリースにあわせて2019-04と2019-07バージョンが終了します。

未解決になっている互換性の問題を解消するために、パートナーダッシュボードのアプリ管理ページでAPIヘルスレポートを忘れずにご確認ください。アプリの移行に関するサポートを得るには、コミュニティフォーラムでほかのパートナーやShopifyスタッフからの支援を受けることができます。

最新の情報をご確認ください

Shopifyプラットフォームに関するすべての変更内容は開発者Changelogで参照いただけます。新プロダクトのローンチ情報などが集約されています。チェンジログで最新の情報をチェックし、2020-10のリリース候補が公開されたらすぐに新機能を採用できるように準備しておきましょう。