SDKの記述

SDKとは?
SDK (Software Development Kit)ソフトウェア開発ツールです。(JSとはJavaスクリプトとのこと)

ApesterのSDKは単純なJSファイルです。ウェブサイトにコピーすると、その次に続くコードを有効にします。ApesterのSDKはインターアクションに関係する機能のライブラリーのようなものです。


SDKを使うとどんなことができますか?

●  新たなhtmlタグを定義:

●  より安定した拡張可能で、高速の経験

●  ダイナミックな埋め込み機能と埋め込みのサイズ変更

●  おすすめコンテンツ・エンジンの新しいビルド:速く、賢く、ユーザに合ったもの

●  マネタイズできる機能はSDKでしか作成できません。

 

SDKはどのように使うのでしょうか?
こちらのリンクをご参照ください。

  1. タグの前に一度だけJS SDKを加える。
    コードはこのようになります。:
    <script type="text/javascript" src="//static.apester.com/js/sdk/v2.0/apester-sdk.min.js"></script>

  2. 記事の中にアイテムを埋め込むためには、次の埋め込みコードを使用してください。:

    <interaction>id</interaction>

    idは新規のアイテム毎に自動でデータベースにより生成されるIDです。それぞれにユニークです。idの例は562f76ebbece044e14637dbf

 

どのように動くのですか?

SDKのフローは次の通りです。:

  1. まず、基本的なJSの構成数値を確認します。

  2. "document loaded""postMessage"と特定のApesterイベントのリスナーを複数加えます。(外部コードからSDKを再起動出来るように)

  3. Document Loadedイベントはそれぞれのタグを関連するiframeタグで置き換えます。これにより、async iframe が呼び出され、<iframe>タグそのものを設定するのと同じことです。

  4. iframeがロードされると、postMessageが送信されます。これはSDKリスナーにキャッチされます。これにより2つのアクションが起こります。Iframeの高さがインターアクションのサイズに合わせて変更され、ページからメタデータ情報が集められ、postMessageでiframeへと送られます。

安全のために:

  1. HTMLのHEADではDOMの操作は行いません。操作するのはタグのみです。

  2. 全てのコードはイベントによりトリガーされます。非同時性、非ブロックのコードとなっています。

  3. 何よりも、お客様のコードの一部となるSDKがページのローディングを遮るようなエラーを起こしてはならないということです。そのために、全てのコードを "try catch"ブロックでラッピングしました。これにより、SDKのエラーは全てここでキャッチされ、お客様のウェブサイトに影響を及ぼすことはありません。(インターアクションが表示されないという可能性はあります)

他にご質問がございましたら、リクエストを送信してください

0 コメント

ログインしてコメントを残してください。