Attributionモジュール
使用方法
Attributionモジュールは、ユーザーによるリセットが可能なAdvertising Identifier(IDFA)を各トラッキングコールに追加し、オプションでApple Search Ads APIを実装してアトリビューション情報を収集します。Apple Search Adsの詳細については、こちらを参照してください。
このモジュールの使用はオプションです。この機能では追加の依存関係が発生するため、この機能の説明を読んで、必要かどうかを判断します。アプリを提出する際に、Appleに対してIDFAを使用している理由を説明する必要があります。IDFAの使用を表明しない場合は、Appleはアプリを却下します。IDFAの使用方法と却下の詳細については、こちらを参照してください。
以下のプラットフォームがサポートされています。
- iOS
要件
- UIKit
- AdSupport
- iAd
インストール
AttributionモジュールをCocoaPodsまたはCarthageによってインストールします。
CocoaPods
AttributionモジュールをCocoaPodsによってインストールするには、Podfileに以下のポッドを追加します。
pod 'tealium-swift/TealiumAttribution'
フレームワークは自動でインスタンス化され、TealiumCore
ポッドに依存しています。iOS向けCocoaPodsのインストールの詳細については、こちらを参照してください。
Carthage
AttributionモジュールをCarthageによってインストールするには、以下の手順に従います。
Xcodeで対象アプリの[General]構成ページに移動します。
以下のフレームワークを[Embedded Binaries]セクションに追加します。
TealiumAttribution.framework
フレームワークは自動でインスタンス化され、TealiumCore
に依存しています。追加のインポートステートメントは必要ありません。iOS向けCarthageのインストールの詳細については、こちらを参照してください。
データレイヤー
モジュールが有効な場合に、トラッキングコールのたびに以下の変数が送信されます。
変数名 | 説明 | 例 |
---|---|---|
ad_campaign_id |
対応する広告のキャンペーンID | 1234567890 |
ad_campaign_name |
対応する広告のキャンペーン名 | CampaignName |
ad_creativeset_id |
対応する広告が一部となっていたクリエイティブセットのID。 | 456093 |
ad_creativeset_name |
対応する広告が一部となっていたクリエイティブセットの名前。 | Beast Images |
ad_group_id |
対応する広告のキャンペーングループID | 1234567890 |
ad_group_name |
対応する広告のキャンペーングループ名 | AdGroupName |
ad_keyword |
対応する広告のクリックを導いた広告インプレッションを促したキーワード | Keyword |
ad_keyword_matchtype |
部分一致、完全一致、検索一致のいずれかです。 | Exact |
ad_org_id |
対応する広告のキャンペーン組織ID | OrgID |
ad_org_name |
対応する広告のキャンペーン組織名 | OrgName |
ad_purchase_date |
ユーザーがアプリを最初にダウンロードした日時。iadconversion-type = “Redownload” の場合、これは最初の購入日を表します。Apple Search Adに関連付けられている場合とそうでない場合があります。 |
2016-12-05T17:31:40Z |
ad_region |
このインストールのきっかけとなったキャンペーンに関連付けられた国または地域を識別します。 | US |
ad_user_clicked_ last_30_days |
アプリをダウンロードする前の30日以内にユーザーがSearch Adsインプレッションをクリックしたかどうかを示すブール値 | [true , false ] |
ad_user_conversion_type |
アプリの新規ダウンロードまたは再ダウンロードを識別します | Download |
ad_user_date_ clicked |
ユーザーが対応する広告をクリックした日時 | 2016-12-05T17:31:40Z |
ad_user_date_ converted |
ユーザーがアプリをダウンロードした日時 | 2016-12-05T17:31:40Z |
device_advertising_ enabled |
ユーザーが広告のトラッキングを許可しているかどうか示すブール値(false の場合、広告IDはゼロからなる文字列として表示されます) |
[true , false ] |
device_advertising_ id |
ユーザーによるリセットが可能なAdvertising Identifier(IDFA) | 6D92078A-8246... |
device_advertising_ vendor_id |
単一ベンダーの同じデバイス上にあるすべてのアプリで必ず同一になる一意のID(RDNSバンドルIDの最初の2つの部分が同じになるアプリ。例:com.tealiumやcom.acme) | 6D92078A-8246... |
Search AdsがTealiumConfigオブジェクトで明示的に有効にされている場合にのみ、プレフィックスad_
の付いた変数は有効になります。これらの変数はアプリの有効期間内にAppleのサーバーから1回だけ取得されますが、永続的な変数として保存されるため、以降アプリが起動されるときに利用できます。