非推奨となった手法の削除と、is_externalのクエリ能力の追加

非推奨となったタクティクスの削除とis_externalクエリの追加

ShopifyのExternal Marketing APIをより使いやすくするため、2024年4月から非推奨となった古い値を削除し、is_externalの値を公開します。

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

これまで、follow_up、receipt、display、search、seo、directといったマーケティングタクティクスがAPIバージョン2024-04で使用可能でした。しかし、これらの値は非推奨となっており、新たなマーケティングタクティクスへの移行が求められています。

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

上記の非推奨となったタクティクスは削除され、代わりに使用すべきタクティクスはMarketingTactic documentationで確認できます。また、is_external属性をMarketingActivitiesクエリで取得できるようになり、アクティビティが外部プラットフォームで作成・管理されているかどうかを知ることができます。

実装手順とコード例

新たに使用すべきタクティクスをAPIバージョン2024-04にて実装するには、以下の手順を守ることが求められます。

まず、非推奨となった値の削除を行います。次に、新たなマーケティングタクティクスをMarketingTactic documentationを参照して選択・実装します。以下に、MarketingActivitiesクエリでis_external属性を取得するコード例を示します。

{
  marketingActivities {
    edges {
      node {
        id
        is_external
      }
    }
  }
}

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

この更新により、非推奨となったタクティクスを使用しないことでAPIのパフォーマンスが向上します。また、is_external属性を取得できるようになることで、外部プラットフォームで作成・管理されたマーケティングアクティビティを効率的に把握することが可能になります。

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

新たなタクティクスの実装にあたり、MarketingTactic documentationをよく読み、適切なタクティクスを選択することが重要です。また、コードの可読性を保つため、非推奨となったタクティクスの削除は一括で行うことをお勧めします。

次のステップ・発展案

今後はAPIの新バージョンがリリースされるたびに、非推奨となったタクティクスの削除と新たなタクティクスの導入を行うことで、システムを最新の状態に保つことが求められます。

参考記事: Removal of deprecated tactics and add ability to query is_external