広告収益情報の記録

Adjust SDKを使用して、サポートされているネットワークパートナーの広告収益を記録することができます。

ADJAdRevenueオブジェクトをインスタンス化する

- (nullable id)initWithSource:(nonnull NSString *)source;

Adjust SDKで広告収益情報を送信するには、ADJAdRevenueオブジェクトをインスタンス化する必要があります。このオブジェクトには、アプリで広告収益が記録されたときにAdjustに送信される変数が含まれます。

広告収益オブジェクトをインスタンス化するには、新しいADJAdRevenueインスタンスを作成して以下のパラメーターをパスしてください：

source （NSString）：広告収益のソース。利用可能なソースについては、以下の表を参照してください。

パラメーター	ソース
`ADJAdRevenueSourceAppLovinMAX`	AppLovin MAX
`ADJAdRevenueSourceMopub`	MoPub
`ADJAdRevenueSourceAdMob`	AdMob
`ADJAdRevenueSourceIronSource`	ironSource
`ADJAdRevenueSourceAdmost`	Admost
`ADJAdRevenueSourceUnity`	Unity
`ADJAdRevenueSourceHeliumChartboost`	Helium Chartboost
`ADJAdRevenueSourceADX`	Ad(X)
`ADJAdRevenueSourceTradplus`	TradPlus
`ADJAdRevenueSourceTopon`	TopOn
`ADJAdRevenueSourcePublisher`	汎用ソース

Swift
Objective-C

1
let adRevenue = ADJAdRevenue(source: source);
2
//...
3
Adjust.trackAdRevenue(adRevenue);

1
ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source];
2
//...
3
[Adjust trackAdRevenue:adRevenue];

広告収益を送信する

+ (void)trackAdRevenue:(nonnull NSString *)source payload:(nonnull NSData *)payload;

広告収益をAdjustに送信するには、広告収益のインスタンスを引数としてtrackAdRevenueメソッドを呼び出します。

Swift
Objective-C

1
let adRevenue = ADJAdRevenue(source: source);
2
Adjust.trackAdRevenue(adRevenue);

1
ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source];
2
///...
3
[Adjust trackAdRevenue:adRevenue];

広告収益額を記録する

- (void)setRevenue:(double)amount currency:(nonnull NSString *)currency;

広告収益額を送信するには、setRevenueメソッドを呼び出し、以下の引数をパスします：

revenue double）：収益額
currency （NSString）：レポート通貨の3桁のISO 4217コード

Swift
Objective-C

1
let adRevenue = ADJAdRevenue(source: source);
2
adRevenue.setRevenue(1.6, currency: "USD");
3
Adjust.trackAdRevenue(adRevenue);

1
ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source];
2
[adRevenue setRevenue:1.6 currency:@"USD"];
3
[Adjust trackAdRevenue:adRevenue];

広告キャンペーンの詳細を記録する

ADJAdRevenueクラスには、広告キャンペーンのレポート作成に使用できるプロパティが含まれています。

広告インプレッション数

- (void)setAdImpressionsCount:(int)adImpressionsCount;

記録された広告インプレッションを送信するには、setAdImpressionsCountメソッドを呼び出し、以下の引数をパスします：

adImpressionsCount （int）：広告インプレッションの数。

Swift
Objective-C

1
let adRevenue = ADJAdRevenue(source: source);
2
adRevenue?.adImpressionsCount = 1;
3
Adjust.trackAdRevenue(adRevenue);

1
ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source];
2
[adRevenue setAdImpressionsCount:1];
3
[Adjust trackAdRevenue:adRevenue];

広告収益ネットワーク

- (void)setAdRevenueNetwork:(nonnull NSString *)adRevenueNetwork;

広告収益ネットワークを送信するには、setAdRevenueNetworkメソッドを呼び出し、以下の引数をパスします：

adRevenueNetwork （NSString）：ネットワーク名

Swift
Objective-C

1
let adRevenue = ADJAdRevenue(source: source);
2
adRevenue?.adRevenueNetwork = "network1";
3
Adjust.trackAdRevenue(adRevenue);

1
ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source];
2
[adRevenue setAdRevenueNetwork:@"network1"];
3
[Adjust trackAdRevenue:adRevenue];

広告収益ユニット

- (void)setAdRevenueUnit:(nonnull NSString *)adRevenueUnit;

広告収益ユニットを送信するには、setAdRevenueUnitメソッドを呼び出し、以下の引数をパスします：

adRevenueUnit （NSString）：広告ユニット

Swift
Objective-C

1
let adRevenue = ADJAdRevenue(source: source);
2
adRevenue?.adRevenueUnit = "unit1";
3
Adjust.trackAdRevenue(adRevenue);

1
ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source];
2
[adRevenue setAdRevenueUnit:@"unit1"];
3
[Adjust trackAdRevenue:adRevenue];

広告収益の配置

- (void)setAdRevenuePlacement:(nonnull NSString *)adRevenuePlacement;

広告収益の配置を送信するには、setAdRevenuePlacementメソッドを呼び出し、以下の引数をパスします：

adRevenuePlacement （NSString）：広告配置

Swift
Objective-C

1
let adRevenue = ADJAdRevenue(source: source);
2
adRevenue?.adRevenuePlacement = "banner";
3
Adjust.trackAdRevenue(adRevenue);

1
ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source];
2
[adRevenue setAdRevenuePlacement:@"banner"];
3
[Adjust trackAdRevenue:adRevenue];

コールバックパラメーターを追加する

- (void)addCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value;

AdjustダッシュボードでコールバックURLを登録した場合、SDKがイベントを記録する際にコールバックURLにGETリクエストを送信します。

コールバックパラメーターをサーバーに設定できます。イベントにパラメーターを設定すると、SDKはそれらをコールバックURLに追加します。この情報を使用して、自社のBIシステムでユーザーのアプリ内行動を分析することが可能です。

イベントにコールバックパラメーターを追加するには、NSString key-value引数を指定してaddCallbackParameterメソッドを呼び出してください。このメソッドを複回呼び出すことで、複数のパラメーターを追加することができます。

Adjust SDKはイベントを計測し、コールバックパラメーターが追加されたURLにリクエストを送信します。例えば、URL https://www.mydomain.com/callbackが登録されている場合、コールバックは以下のようになります：

https://www.mydomain.com/callback?key=value&foo=bar

CSVレポートを使用している場合、CSVの定義欄にパラメーターを追加するようにしてください。

Adjustでは、SDKからURLに情報をパスするための様々なプレースホルダーをサポートしています。例えば、iOSの{idfa}プレースホルダーやAndroidの{gps_adid}プレースホルダーなどです。{publisher_parameter}プレースホルダーは、単一の文字列での全てのコールバックパラメーターを表示します。

Swift
Objective-C

1
let adRevenue = ADJAdRevenue(source: source);
2
adRevenue.addCallbackParameter(key, value: value);
3
Adjust.trackAdRevenue(adRevenue);

1
ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source];
2
[adRevenue addCallbackParameter:key value:value];
3
[Adjust trackAdRevenue:adRevenue];

パートナーパラメーターを追加する

- (void)addPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value;

パートナーパラメーターを追加することで、ネットワークパートナーに追加情報を送信することができます。

Adjustは、設定した外部パートナーにパートナーパラメーターを送信します。この情報は、より詳細な分析やリターゲティング施策にご利用いただけます。パートナー用にパラメーターの設定が完了し、機能が有効化されると、Adjustのサーバーはデータ転送を開始します。

イベントにパートナーパラメーターを追加するには、NSString key-value引数を指定してaddPartnerParameterメソッドを呼び出してください。このメソッドを複回呼び出すことで、複数のパラメーターを追加することができます。

Swift
Objective-C

1
let adRevenue = ADJAdRevenue(source: source);
2
adRevenue.addPartnerParameter(key, value: value);
3
Adjust.trackAdRevenue(adRevenue);

1
ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source];
2
[adRevenue addPartnerParameter:key value:value];
3
[Adjust trackAdRevenue:adRevenue];

例

この例では、以下のプロパティを含む広告収益オブジェクトを設定し、記録する方法を示しています：

収益ソースをAppLovin MAXとする
収益額を1 Euroとする
10広告インプレッション数
広告収益ネットワークを "network1" とする
広告収益ユニットを "unit1" とする
広告収益の配置を "banner" とする
コールバックパラメーター： "key1" = "value1"
パートナーパラメーター： "key2" = "value2"

Swift
Objective-C

1
let adRevenue = ADJAdRevenue(source: ADJAdRevenueSourceAppLovinMAX);
2
adRevenue.setRevenue(1, currency: "EUR");
3
adRevenue.setAdImpressionsCount(10);
4
adRevenue?.adRevenueNetwork = "network1"
5
adRevenue?.adRevenueUnit = "unit1"
6
adRevenue?.adRevenuePlacement = "banner"
7
adRevenue.addCallbackParameter("key1", value: "value1")
8
adRevenue.addPartnerParameter("key2", value: "value2")
9
Adjust.trackAdRevenue(adRevenue);

1
ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:ADJAdRevenueSourceAppLovinMAX];
2
[adRevenue setRevenue:1 currency:@"EUR"];
3
[adRevenue setAdImpressionsCount:10];
4
[adRevenue setAdRevenueNetwork:@"network1"];
5
[adRevenue setAdRevenueUnit:@"unit1"];
6
[adRevenue setAdRevenuePlacement:@"banner"];
7
[adRevenue addCallbackParameter:key1 value:@"value1"];
8
[adRevenue addPartnerParameter:key2 value:"@value2"];
9
[Adjust trackAdRevenue:adRevenue];