FAQにおけるディープリンク

カスタムURLスキームを使用して、アプリ内でのディープリンクに対応します

注意

SDKに含まれているすべてのパブリックAPIは、Helpshift installWithPlatformId APIを介してSDKを初期化した後に呼び出す必要があります

カスタムURLスキームを使用して、HelpshiftのFAQからアプリ内の特定のセクションへとユーザーを誘導します。これらのスキームを使用することで、よりシームレスな体験をユーザーに提供できるようになります。たとえば、あなたのiOSアプリ内に会員登録用の画面がある場合、FAQにある「登録」リンクをクリックすることでユーザーを直接その画面へと誘導することができます。

FAQにカスタムURLスキームを挿入する

FAQを編集する際に、テキストを選択してから「リンクを作成する」をクリックします。

ポップアップ表示されたダイアログにカスタムURLを入力し、FAQを保存します。

iOSアプリでディープリンクを扱う

ディープリンクとは、ユーザーがカスタムURLをクリックした際にそのURLが何を行うかを開発者が自由に決定できるカスタムリンクURLのことを指します。ディープリンクの使用例には、ユーザーをチャット画面からレビューページへとリダイレクトする必要がある場合や、チャット画面からFAQページまたはFAQセクションへとリダイレクトする必要がある場合のインスタンスなどが挙げられます。

ディープリンクでは、myscheme://example.comのようなカスタムURLスキームを設定することができます。 たとえば、URLmyscheme://FAQID（FAQIDはFAQの公開IDを指しています）では関連するFAQが会話画面内で開きます。開発者がmyschemeを扱う場合には、対応するFAQ IDを用いてshowSingleFAQAPIを呼び出す必要があります。

iOSアプリでカスタムURLを扱う場合には、アプリのInfo.plistがFAQで使用されるカスタムURLスキームをサポートしていることを最初にご確認ください。詳細情報

その後は、アプリのデリゲートにapplication:openURL:sourceApplication:annotation:を実装し、必要な処理を実行する必要があります。たとえば、以下のようになります:

Objective-C

- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation {

    // URL is myapp://discount-scheme/id304
    if ([url.scheme isEqualToString:@"myapp"]) {
        if ([url.relativePath isEqualToString:@"/id304"]) {
            // Handle deep link in app. Do something inside your app.
            [MyApp doSomething];
        }
    }

    return YES;
}

Swift

func application(_ application: UIApplication, open url: URL, sourceApplication: String?, annotation: Any) -> Bool {

    // URL is myapp://discount-scheme/id304
    if url.scheme == "myapp" {
        if url.relativePath == "/id304" {
            // Handle deep link in app. Do something inside your app.
            MyApp.doSomething()
        }
    }

    return true
}