【Shopify.dev和訳】API Examples/Marketing
この記事について
この記事は、APIs Examples/Marketingの記事を和訳したものです。
記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。
Shopify アプリのご紹介
Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。
Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。
マーケティングイベントとエンゲージメントの作成
このガイドでは、マーケティングイベントの作成と、そのイベントがアプリのマーケティング活動とどのように連動するかについて説明します。
例えば、マーケティングイベントは、E メールキャンペーン、アフィリエイトリンク、広告、その他の一般的なマーケティング戦術のために作成できます。
また、マーケティングイベントに対するお客様のインタラクションを表すエンゲージメントの作成についても説明しています。
広告キャンペーンでは、コメント、シェア、広告費などがエンゲージメントの例として挙げられます。
マーケティングイベントのプロパティの完全なリストは、MarketingEventリソースを参照してください。
マーケティングイベントについて
マーケティングイベントは、商品、コレクション、割引など、マーチャントのストアのアイテムを販売するために使用されます。
マーケティングイベントは、複数のユーザーを対象とし、トラフィックを促進することを目的としています。
マーチャントは、売上やトラフィックのアトリビューションを理解するのに役立つため、マーケティングイベントから価値を得ることができます。
あなたのアプリにマーケティングイベントを実装することは、Shopify がマーチャントに役立つ方法で Shopify 管理画面であなたのアプリを表示することができるので有益です。
マーケティングイベントの例としては、複数の潜在顧客を製品ページに誘導する広告キャンペーンや、割引コードを宣伝するメールマーケティングキャンペーンなどがあります。
始める前に
始める前に、自分のアプリがwrite_marketing_eventsのアクセススコープを持っていることを確認してください。
マーケティングイベントの作成
マーケティングイベントは、特定の時期をターゲットにした広告キャンペーンを追跡するために作成できます。
例として、2018 年のクリスマスに向けた Facebook 広告キャンペーンを追跡するために、マーケティングイベントを作成することができます。
マーケティングイベントを作成する際、リクエストの本文には、マーケティングイベントで提供されるリンクに含める必要のある UTM パラメータが含まれます。
また、各マーケティングイベントには、Shopify がアプリをランク付けし、Shopify admin 内で表面化させるのに役立つevent_typeとmarketing_channelのプロパティが含まれています。
以下の POST リクエストは、クリスマス 2018 をトラッキングするためのマーケティングイベントを作成します。
POST https://{shop}.myshopify.com/admin/api/2021-07/marketing_events.json
{
"marketing_event": {
"started_at": "2018-12-15",
"utm_campaign": "Christmas2018",
"utm_source": "facebook",
"utm_medium": "cpc",
"event_type": "ad",
"referring_domain": "facebook.com",
"marketing_channel": "social",
"paid": true
}
}
{
"marketing_event": {
"id": 9312272440,
"event_type": "ad",
"remote_id": null,
"started_at": "2018-12-14T19:00:00-05:00",
"ended_at": null,
"scheduled_to_end_at": null,
"budget": null,
"currency": null,
"manage_url": null,
"preview_url": null,
"utm_campaign": "Christmas2018",
"utm_source": "facebook",
"utm_medium": "cpc",
"budget_type": null,
"description": null,
"marketing_channel": "social",
"paid": true,
"referring_domain": "facebook.com",
"breadcrumb_id": null,
"marketing_activity_id": 147456056,
"admin_graphql_api_id": "gid://shopify/MarketingEvent/9312272440",
"marketed_resources": []
}
}
マーケティングイベントが Shopify で作成された後、Shopify へのトラフィックの誘導を開始することができます。
マーケティングイベントのリンクには、マーケティングイベントで定義されたものと同じ UTM パラメータが含まれていることを確認してください。
例えば、クリスマス 2018 広告キャンペーンのマーケティング活動では、以下の URL 規約を使用します。
https://storename.com/product?utm_source=facebook&utm_medium=cpc&utm_campaign=Christmas2018-12142018
エンゲージメントの創出
マーケティングイベントを作成した後は、ユーザーのインタラクションを追跡するためのエンゲージメントを作成することができます。
例えば、広告キャンペーンのエンゲージメントには、クリック、シェア、コメントなどが含まれます。
エンゲージメントの作成は任意であり、すべてのマーケティングイベントにエンゲージメントが含まれるわけではありません。
マーチャントが、潜在的な顧客がどのようにマーケティングイベントに参加しているかをより詳しく把握したい場合は、エンゲージメントの作成をお勧めします。
エンゲージメントを作成するには、以前に作成したマーケティングイベントのidを含む POST リクエストを送信します。
POST https://{shop}.myshopify.com/admin/api/2021-07/marketing_events/{marketing_event_id}/engagements.json
{
"engagements": [
{
"occurred_on": "2018-12-15",
"views_count": 0,
"clicks_count": 0,
"favorites_count": 0,
"ad_spend": 10,
"is_cumulative": true
},
{
"occurred_on": "2018-12-16",
"views_count": 100,
"clicks_count": 50,
"is_cumulative": true
},
{
"occurred_on": "2018-12-17",
"views_count": 200,
"clicks_count": 100,
"is_cumulative": true
}
]
}
レスポンスは以下です。公式がミスってます。
{
"engagements": [
{
"occurred_on": "2018-12-15",
"views_count": 0,
"clicks_count": 0,
"favorites_count": 0,
"ad_spend": 10,
"is_cumulative": true
},
{
"occurred_on": "2018-12-16",
"views_count": 100,
"clicks_count": 50,
"is_cumulative": true
},
{
"occurred_on": "2018-12-17",
"views_count": 200,
"clicks_count": 100,
"is_cumulative": true
}
]
}
Admin API による SEO データの管理
リソースの SEO データを更新することで、製品、ページ、コレクション、ブログ、記事の検索エンジンでの表示方法を変更することができます。リソースの SEO データを更新するには、リソースのメタフィールドを作成または更新します。
リソースの検索エンジンリストの更新
リソースの検索エンジンへの登録を変更するには、title_tag と description_tag という 2 つの異なるメタフィールドを更新します。
これらのメタフィールドは、global と呼ばれるネームスペースに存在します。
これらのメタフィールドの値を更新することで、リソースの検索エンジンリストのタイトルと説明を変更することができます。
JSON リクエストの例
以下のリクエスト例では、検索エンジンに掲載する製品の説明文を変更しています。
POST /admin/api/2021-07/products/#{id}/metafields.json
{
"metafield": {
"namespace": "global",
"key": "description_tag",
"value": "These matte black sunglasses are sure to impress.",
"type": "single_line_text_field"
}
}
検索エンジンやサイトマップからリソースを隠す
検索エンジンやサイトマップからリソースを隠したい場合は、メタフィールドを使用してリソースのページに noindex および nofollow メタタグを追加することができます。
リソースのページに noindex と nofollow のメタタグを追加するには、以下の属性を持つリソースの新しいメタフィールドを作成します。
- "namespace": "seo"
- "key": "hidden"
- "value": 1
- "type": "number_integer"
JSON リクエストの例
以下のリクエスト例では、検索エンジンやサイトマップから商品を非表示にします。
POST /admin/api/2021-07/products/#{id}/metafields.json
{
"metafield": {
"namespace": "seo",
"key": "hidden",
"value": 1,
"type": "number_integer"
}
}
Shopify アプリのご紹介
Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。
Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。
Discussion