Skip to content

logly/LiftSDK-Android

BranchesTags

Repository files navigation

logly lift Mobile SDK

Download License

概要

Version: 0.9.13

このlogly lift Mobile SDKは、iOS & Androidのモバイル・アプリケーション向けに、loglyのliftレコメンデーション・システムを使用するためのSDKです。

このSDKでliftレコメンデーション・システムを使用するためには、以下のように行います。（注：logly lift システムの登録ユーザーである必要があります。）

１. アプリへのSDK組み込み 　SDK内のシンプルなwidgetを使って簡単に作成する方法と、SDKからAPIを呼び出してその結果を独自に処理・表示する方法があります

２.ページデータをliftシステムへ登録 　liftシステムに、あらかじめページデータをシステムへ登録する必要があります。これにはAWS S3にjsonファイルをアップロードすることで行います。注：これはアプリ外での作業です（参照：「ページデータの登録」）

３. アプリからliftシステムへアクセスしてレコメンド結果を取得 　SDKのwidget（もしくはAPI）を使用して、ページに対するレコメンド結果をliftシステムから取得します

ページについて

liftシステムではページ単位でのレコメンドを行うので、モバイル・アプリ内で擬似的なページを作り、その内容に対するレコメンド結果を取得します。

ページの識別にはMDL（Mobile Deep Link)をキーにしたURIを使用してページを識別します。これは、擬似的なページ識別用のリンクで、アプリケーションはこのリンクを開けるようにしておく必要があります。もちろん、擬似的ではない、実際のページがweb上にある場合には、そのURLを使用することも可能です。(その場合にはブラウザ等でリンクを開く事も可能です。)

必要システム・ヴァージョン

  • iOS: 8.1 以上
  • Android: SDK 16 (Android 4.1)以上

インストール: iOS

iOS版のSDKのライブラリをインストールするには、cocoapodsを使います。https://cocoapods.org/ 組み込むアプリケーションのPodfileに、以下のuse_frameworks!とpod “LoglyLift”の行を追加してください。

use_frameworks!
...
target ...
  pod “LoglyLift”

そしてコンソールから以下のコマンドを実行してください

pod install

インストール: Android

Android版のSDKライブラリをインストールするには、GitHubPackagesのmavenリポジトリを使います。

組み込むアプリケーションのbuild.gradleのrepositoriesセクションに以下を追加し、GitHubPackagesをレポジトリとして追加してください。 ただし、USERNAME、TOKEN にはGitHubのアクセストークンとそのユーザー名を指定してください。アクセストークンの作成方法はこちらをご参考ください。

repositories {
    maven {
        name = "GitHubPackages"
        url = uri("https://maven.pkg.github.com/logly/LiftSDK-Android")
        credentials {
            username = "USERNAME"
            password = "TOKEN"
        }
    }
}

同様に組み込むアプリケーションのbuild.gradleのdependenciesセクションに以下を追加してください。

dependencies {
    implementation 'jp.co.logly:lift-sdk:0.9.13'
}

もしAndroidManifestにネットアクセスの設定がない場合には、app/AndroidManifest.xmlに以下を追加してください。

<uses-permission android:name="android.permission.INTERNET"></uses-permission>

SDKの内容:

このモバイルSDKには、低レベルなAPI Client 部分と、シンプルなレコメンド表示用widget(View)が入っています。このwidgetは内部でAPIを呼び出しその結果をwidget上に表示し、（正しい計測に必要な）ビーコン＆トラキングURLにアクセスします。

widgetを使用したサンプルアプリもSDKに入っています。SDKユーザーはこのサンプルアプリを参考に、組み込みを行うことができます。あるいは、SDKユーザーはAPI Client を使って、独自のwidgetを作ることもできます。

○　シンプル widgetの使い方 : iOS

  1. storybord / xib (あるいはコード）等で、UIViewのサブクラスとしてLGLiftWidgetを画面に配置
  2. その画面のViewController#viewDidLoad()などから、そのLGLiftWidgetにリクエストをrequestByURL()でスタートさせます。実際のアクセスは別スレッド等で行われ、このメソッドはすぐに戻ります。
  3. レコメンドの表示数はwidgetの大きさで決まります。一つのレコメンドセルの大きさは300x72（マージンは2。余った幅は均等に配分されます）、ヘッダ・フッタの高さは34でマージンは2。なので、これを基準に変更すると良いでしょう。（注：最大数は、Liftコンソールの側でも設定できます）

objective-c

[self.liftWidget requestByURL:detail[@"url"]
                     adspotId:@(3777016)
                     widgetId:@(1684)
                          ref:@"http://blog.logly.co.jp/"];

swift

liftWidget.requestByURL( detail["url"],
                         adspotId:NSNumber(longLong: 3777016),
                         widgetId:NSNumber(int: 1684),
                         ref:"http://blog.logly.co.jp/")

○　シンプル widgetの使い方 : Android

  1. layoutリソースや、コード上で、jp.co.logly.Lift.WidgetViewを画面上に配置
  2. その画面のActivity/FragmentのonCreateView()などから、WidgetViewにリクエストをrequestByURL()でスタートさせます。実際のアクセスは別スレッド等で行われ、このメソッドはすぐに戻ります。
  3. レコメンドの表示数はwidgetの大きさで決まります。一つのレコメンドセルの大きさは300x72なので、それを単位に変更すると良いでしょう。（注：最大数は、Liftコンソールの側でも設定できます）
liftWidget.requestByURL(mItem.url, 3777016, 1684, "http://blog.logly.co.jp/", 1);

requestByURLのパラメータ

  • url: キーとなる、ページURL(MDL)
  • adspotID: Loglyが発行したadspotID
  • widgetID: Loglyが発行したwidgetID
  • ref: リファラーURL(通常、モバイル版では必要なし)

Clickコールバック : iOS

  • swift
liftWidget.onWigetItemClickCallback = {(widget, url, item) -> Bool in
    // do something useful.
    return true; // we handled click. do not need to open in browser.
}
  • Objective-C
self.liftWidget.onWigetItemClickCallback = ^(LGLiftWidget *widget, NSString *url, LGInlineResponse200Items *item) {
    // do something useful.
    return YES; // we handled click. do not need to open in browser.
};

このonWigetItemClickCallbackにコールバックを登録しておくと、レコメンドのアイテムがクリックされた時に、このコールバックが呼ばれます。このコールバック関数の戻り値としてtrueを返すと、widgetはその先の処理をやめます。（ブラウザでURLをオープンしない）

Clickコールバック : Android

liftWidget.mOnWigetItemClickListener = new WidgetView.OnWigetItemClickListener() {
                @Override
                public boolean onItemClick(WidgetView widget, String url, InlineResponse200Items item) {
                    /* do something useful. */
                    return true; /* we handled click. do not need to open in browser. */
                }
            };

このmOnWigetItemClickListenerにコールバックのListnerを登録しておくと、レコメンドのアイテムがクリックされた時に、このListnerが呼ばれます。このListnerの戻り値としてtrueを返すと、widgetはその先の処理をやめます。（ブラウザでURLをオープンしない）

○　サンプルアプリについて

iOS (Swift or Objective-C)版サンプルアプリの実行方法

cd examples/LiftSample-{swift,objc}
pod install
open LiftSample-{swift,objc}.xcworkspace
  • Xcodeが開くので、Run.

Android版サンプルアプリの実行方法

  • Android StudioでSDKのディレクトリを開く
  • Run

○　SDK: API client

SDKのAPI clientを使用して直接lift APIへアクセスし、レコメンド結果を取得することで、独自のビューなどで表示することなどもできます。 シンプルwidgetの内部でもこのAPI clientを使用しています。SDKのソースコードも公開していますので、widgetのコードも参考にしてください。 API clientの仕様については、別ファイルのAPIドキュメントAPI.htmlを参照してください。

注：API clientを使用する場合には計測のために、ビューが見えた時にbeaconUrlを、クリックされた時にUrlを呼ぶ必要があるので注意してください。

ページデータの登録

liftシステムでは、あらかじめページデータをシステムへ登録し、そのページデータに基づいたレコメンド（中間）結果をシステム上で計算します。登録は、Amazon AWS S3へ登録用データのJSONファイルをアップロードすることで、自動的に処理されます。

注：アップロードしたJSONファイルは定期的に処理され、エラーなく登録された場合には、すぐに消去されます。ある程度の時間がたった後にファイルがなくなっていた場合には、正常に処理されたと考えられます。逆にファイルが残っていた場合には、何らかのエラーが起こったと考えられます。その際にはアップロードされたデータは全く、登録されません。修正したファイルをアップロードするか、loglyのサポートまでご連絡ください。

前準備：loglyからあらかじめ、Amazon AWS S3にアクセスするときの認証情報、アップロードすべきbucket名とフォルダ名を取得してください。

JSONファイル・フォーマット

ファイル名：“任意の名前.json”

サンプル：

{
  "user": "user1",
  "items": [{
    "url": "logly-liftmobilesdk-sample://jp.co.logly.liftmobilesdk.sample/page/1",
    "title": "NYタイムズがソーシャル・インフルエンサーを活用、ブランドコンテンツのクリエイティブのためにマーケティング会社を買収",
    "text": "NYタイムズは今月上旬から、外部のメディアサイトのネイティブ広告を利用し始めています。同社は年初からネイティブ広告の提供を開始していたので、ネイティブ広告メディアとして今後の展開に注目していました。そのNYタイムズが立場を変えて、「広告主」として他サイトのネイティブ広告にコンテンツを出稿したのです。そこで、どのようなコンテンツを配信しているかを見ていきましょう。　NYタイムズが利用したネイティブ広告提供メディアは「Mashable」です。Mashableはインターネット分野をカバーしたオンライン・ニュー",
    "image_size": "128x128",
    "image_url": "http://blog.logly.co.jp/system/attachments/images/000/016/896/large_thumb/1.png",
    "pubdate": "2015-11-10T02:00:00Z",
    "category": "blog"
  }]
}

内容(topレベル)：

  • user : loglyからあらかじめお知らせしたユーザーIDを入れてください。
  • items : ページデーターの配列

内容(ページデータ):

  • url : (required) キーとなるMDL。実際にweb上にページがある場合にはURLでも良い。
  • title : (required) タイトル
  • summary : (optional) サマリー
  • text : (required) 本文テキスト
  • image_size : (required) サムネイル・イメージのサイズ。例：100x200
  • image_url : (required) サムネイル・イメージのURL。iOS9でのATSに抵触する可能性がある場合にはHTTPS上にイメージを置いてください。
  • pubdate : (optional)ページ投稿日時。ISO 8601 フォーマット。例："2015-11-10T03:00:00Z"

アップデート＆削除方法

登録と同様の方法で、同じページのアップデートや削除も行えます。 アップデートの時には、同じMDLを”url”フィールドに使い、新しい内容の他のデータを記述すればその内容にアップデートされます。 削除の場合には、同じMDLを”url”フィールドに使い、他のすべての項目に空データを入れておけば削除されます。（現状、判定にはtitleとtextを使っています。両方が空の場合に削除されます）

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

16 watching

Forks

1 fork
Report repository

Releases 5

v0.9.12.2 Latest
Dec 18, 2018
+ 4 releases

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •  

Languages