Admin GraphQL/StorefrontのExternalVideo URLフィールドが更新されました

Shopify Admin GraphQLとStorefrontのExternalVideo URLフィールドが更新されました

ShopifyのAdmin GraphQLとStorefront APIにおけるExternalVideoタイプのURL表現が、2022-04 APIリリースの一環として改善されました。今回の改善により、外部ビデオのURL表現がより明確になり、開発者がより効率的にURLを取り扱うことが可能となります。

技術的課題の定義と現状分析

従来のAPIでは、外部ビデオのホストプラットフォーム（VimeoやYouTube）へのURLを取得するためにembeddedUrlフィールドを使用していました。しかし、このフィールド名は実際の用途に対して直感的でなく、混乱を招く可能性がありました。

具体的な技術的ソリューションの提案

新APIでは、より直感的なフィールド名が導入されました。

• embeddedUrlはoriginUrlに置き換えられました。このoriginUrlは、以前のembeddedUrlと同様に、ビデオのホストプラットフォームへのURLを返します。
• 新しいフィールドembedUrlが追加され、iframe内にビデオを埋め込むために必要なURLを返します。

実装手順とコード例

新しいフィールドに移行するには、以下のようにGraphQLクエリを更新します：

{
  shop {
    productByHandle(handle: "your-product-handle") {
      media {
        ... on ExternalVideo {
          originUrl
          embedUrl
        }
      }
    }
  }
}

パフォーマンス・コスト分析

この変更によるパフォーマンスやコストへの影響はほぼありません。ただし、フィールド名が直感的になったことで、開発者がコードを読み書きする速度が向上し、間違いを減らすことができます。

実装時の注意点・ベストプラクティス

旧embeddedUrlフィールドは非推奨となりましたが、互換性のために一定期間保持されます。ただし、新しいフィールドを可能な限り早く取り入れ、旧フィールドへの依存を減らすことをお勧めします。

次のステップ・発展案

これらの新しいフィールドを活用して、サイト内のビデオ体験をよりスムーズにし、ユーザーエンゲージメントを高めることが可能です。

参考記事: Updated Admin GraphQL/Storefront ExternalVideo URL fields