Skip to content

Commit

Permalink
Merge pull request #80 from czwuwei/20170317_4.1.2_doc
Browse files Browse the repository at this point in the history
[4.1.2] Update doc about deferred deep link and trackingCompletionHandler
  • Loading branch information
czwuwei authored Mar 17, 2017
2 parents 10e9225 + 63c0387 commit f2db8e5
Show file tree
Hide file tree
Showing 4 changed files with 75 additions and 4 deletions.
37 changes: 36 additions & 1 deletion lang/ja/doc/deferred_deeplink/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#### Properties
|Property|Type|Detail|
|:---|:---|:---|
|deferredDeeplinkHandler|Block|ディファードディープリンクを取得した際のコールバック。|
|deferredDeeplinkHandler|Block|ディファードディープリンクを取得した際のコールバック。コールバックはバックグラウンドスレッドで実行されます。|
|durationSinceClick|NSTimeInterval|ディファードディープリンクをサーバに問い合わせる際に、対象となるラストクリックの対象期間(秒)(どれだけ遡るかを秒数で指定)。設定しない時、デフォルト24時間となります。|

* `deferredDeeplinkHandler`の詳細
Expand Down Expand Up @@ -62,5 +62,40 @@ foxTrackOption.deferredDeeplinkHandler = { deeplinkInfo in
CYZFox.trackInstall(with: foxTrackOption)
```

<div id="with_thirdparty"></div>
### 他社ツールのディファードディープリンクを利用する

#### Facebook SDKの場合

以下の例では、F.O.X SDK のインストール計測完了のコールバック内で`FacebookSDK`のディファードディープリンク処理を記述しています。Cookie計測時のブラウザ立ち上げが完了した後にディファードディープリンクによる遷移が行われ、Cookie計測が正常に行われます。

![Language](http://img.shields.io/badge/language-Objective–C-blue.svg?style=flat)
```objc
-(BOOL) application:(UIApplication *) application didFinishLaunchingWithOptions:(NSDictionary *) launchOptions {
// after activate
CYZFoxTrackOption* option = [CYZFoxTrackOption new];
option.trackingCompletionHandler = ^ {
// Facebook SDK でのディファードディープリンク処理を実行
}
[CYZFox trackInstallWithOption:option];
// ...
return YES; // openURL:メソッドをコールさせるため必ずYESを返してください
}
```

![Language](https://img.shields.io/badge/language-Swift-orange.svg?style=flat)
```Swift
func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
let option: CYZFoxTrackOption = CYZFoxTrackOption()
option.trackingCompletionHandler = {
// Facebook SDK でのディファードディープリンク処理を実行
}
CYZFox.trackInstallWithOption(option)
return true; // openURL:メソッドをコールさせるため必ずYESを返してください
}
```

> Facebook SDKの実装に関しては[公式ドキュメント](https://developers.facebook.com/docs/app-ads/deep-linking#deferred-deep-linking)を参照ください。
---
[トップ](../../README.md)
2 changes: 1 addition & 1 deletion lang/ja/doc/track_install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ func application(application: UIApplication, didFinishLaunchingWithOptions launc
}
```

> 上記のサンプルコードでは、リダイレクト先・BUID・オプトアウトの有無・計測完了のコールバックを受け取る処理の実装例となっています。<br>`trackingCompletionHandler`をセットした上で計測処理が完了すると`Block`が呼ばれますので、インストール計測完了直後に実行したい処理はこちらに実装してください。
> 上記のサンプルコードでは、リダイレクト先・BUID・オプトアウトの有無・計測完了のコールバックを受け取る処理の実装例となっています。<br>`trackingCompletionHandler`をセットした上で計測処理が完了すると`Block`が呼ばれますので、インストール計測完了直後に実行したい処理はこちらに実装してください。`Block`がmainスレッドで実行されます。
> オプトアウトを有効にした場合、その後そのユーザーを広告の配信対象から外すことが可能です。<br>
尚、オプトアウトはユーザーに対しオプトアウトの意思表示を選択させるような機能をアプリ内で実装している場合に有効です。
Expand Down
38 changes: 37 additions & 1 deletion lang/zh-cn/doc/deferred_deeplink/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
#### Properties
|Property|Type|Detail|
|:---|:---|:---|
|deferredDeeplinkHandler|Block|取得Defferred Deeplink时调用的Callback方法。|
|deferredDeeplinkHandler|Block|取得Defferred Deeplink时调用的Callback方法。Callback将在后台线程中被执行。|
|durationSinceClick|NSTimeInterval|使用Defferred Deeplink访问服务器的时候,作为对象的Last Click的期间(秒)(按秒数来指定追溯到多久以前)。不设定的话,默认为24小时。|

* `deferredDeeplinkHandler`的详细
Expand Down Expand Up @@ -60,5 +60,41 @@ foxTrackOption.deferredDeeplinkHandler = { deeplinkInfo in
CYZFox.trackInstall(with: foxTrackOption)
```

<div id="with_thirdparty"></div>
### 关于其他第三方SDK的deferred deeplink的使用

#### Facebook SDK

下面是关于在F.O.X SDK安装检测完成之后执行`FacebookSDK`的deferred deeplink处理的例子。如果Cookie监测设置为有效的话,浏览器跳转动作完成之后才会调用deferred deeplink的处理。

![Language](http://img.shields.io/badge/language-Objective–C-blue.svg?style=flat)
```objc
-(BOOL) application:(UIApplication *) application didFinishLaunchingWithOptions:(NSDictionary *) launchOptions {
// after activate
CYZFoxTrackOption* option = [CYZFoxTrackOption new];
option.trackingCompletionHandler = ^ {
// Facebook SDK 的 deferred deeplink处理
}
[CYZFox trackInstallWithOption:option];
// ...
return YES; // 固定为YES,为了调用openURL:方法。
}
```

![Language](https://img.shields.io/badge/language-Swift-orange.svg?style=flat)
```Swift
func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
let option: CYZFoxTrackOption = CYZFoxTrackOption()
option.trackingCompletionHandler = {
// Facebook SDK 的 deferred deeplink处理
}
CYZFox.trackInstallWithOption(option)
return true // 固定为true,为了调用openURL:方法。
}
```

> Facebook SDK的详细内容请参照[官方说明](https://developers.facebook.com/docs/app-ads/deep-linking#deferred-deep-linking)

---
[Top](../../README.md)
2 changes: 1 addition & 1 deletion lang/zh-cn/doc/track_install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ func application(application: UIApplication, didFinishLaunchingWithOptions launc
}
```

> 上述示例代码为,redirect位置・BUID・有无optout・计测完成的callback受理的执行案例。<br>`trackingCompletionHandler`设置后完成计测时会呼出`Block`,请在Install计测完成后在此执行操作。
> 上述示例代码为,redirect位置・BUID・有无optout・计测完成的callback受理的执行案例。<br>`trackingCompletionHandler`设置后完成计测时会呼出`Block`,请在Install计测完成后在此执行操作。`Block`的处理将会在主线程中被执行。
> optout为有效时,可以将用户从广告投放对象中移除。<br>
另外,optout仅在APP中编码安装了类似用户可选optout功能的情况下有效。
Expand Down

0 comments on commit f2db8e5

Please sign in to comment.