Kii PhotoColle SDK の導入

このページではあなたのアプリケーションに Kii PhotoColle SDK を導入する手順を紹介します。

  • Android アプリに SDK を導入する方法は こちら をご覧ください。
  • iOS アプリに SDK を導入する方法は こちら をご覧ください。

Android でのプロジェクトの設定

Kii PhotoColle SDK は Android 2.3 プラットフォーム(API レベル: 9)以降の環境に対応しています。使用する SDK のバージョン等を確認してください。

下記の手順に従って、Kii PhotoColle SDK をアプリケーションのプロジェクトに追加してください。

  1. Kii PhotoColle SDK の追加

    まず始めに Kii PhotoColle SDK ライブラリーをプロジェクトに追加する必要があります。

    ライブラリーは 2 通りの方法で追加可能です。

    1. Maven リポジトリからのダウンロード

      ビルド対象のモジュール配下にある "build.gradle"(デフォルトでは app ディレクトリの直下)に、以下の dependencies を追加します。

      追加する内容は Android Studio のバージョンによって異なります。

      • dependencies {
            implementation 'com.kii.photocolle:photocolle:XX.YY.ZZ'
        }
        
      • dependencies {
            compile 'com.kii.photocolle:photocolle:XX.YY.ZZ'
        }
        

      com.kii.photocolle:photocolle:XX.YY.ZZ のバージョン部分 XX.YY.ZZ は、ダウンロードしたいファイルのバージョンに合わせて書き換えてください。最新版のバージョン番号は、このドキュメントサイトの最も上にある "SDK" のリンクより確認できます(開発者ポータルにログインした状態で開いてください)。

    2. 手動ダウンロード

      まずはライブラリーをダウンロードします。開発者ポータル(https://developer.kii.com)にログインし、"ダウンロード" ページで SDK のリンクをクリックするとライブラリーがダウンロードされます。

      ダウンロード後、下記の手順に従ってライブラリーをアプリケーションのプロジェクトに追加してください。

      1. Kii PhotoColle SDK(android-photocolle-sdk-vXX.YY.ZZ.aar)をライブラリパス(デフォルトでは "app/libs" )にコピーします。

        XX.YY.ZZ はダウンロードしたファイルのバージョンに合わせて書き換えてください。

      2. ビルド対象のモジュール直下(デフォルトでは app ディレクトリの直下)にある build.gradle に以下を追加します。

        repositories {
            flatDir {
                dirs 'libs'
            }
        }
        
        dependencies {
            compile 'com.example.library:android-photocolle-sdk-vXX.YY.ZZ@aar'
        }
        

    リモートに設置された Kii PhotoColle SDK ライブラリーを自動的にダウンロードする Maven 方式の利用を推奨しますが、開発者ポータルより手動で AAR パッケージファイルをダウンロードすることもできます。

  2. SDK 内で使用している Activity を利用可能にするために AndroidManifest.xml の application タグ配下に以下内容を追加します。

    <activity
        android:name="com.kii.sdk.photocolle.AuthHiddenActivity"
        android:label="@string/app_name" />
    
  3. SDK では通信を行うため、ネットワークアクセスのパーミッションが必要です。AndroidManifest.xml の manifest タグ配下に以下の内容を追加します。すでに存在する場合は再度追加する必要はありません。

    <uses-permission android:name="android.permission.INTERNET"/>
    
  4. Kii PhotoColle SDK を導入するクラスに com.kii.cloud.storage.photocolle.* をインポートして PhotoColleSocialConnect.initialize() を呼び出します。PhotoColleSocialConnect.initialize() を呼び出す前に、Kii.initialize() の呼び出しと Kii.SocialNetwork() からの PhotoColleSocialConnect インスタンスの取得が必要です。

    以下にサンプルを記載します。

    import com.kii.cloud.storage.*;
    import com.kii.cloud.storage.photocolle.*;
    
    public class MyClass {
        static {
            // Kii PhotoColle SDK を初期化します。
            Kii.initialize(getApplicationContext(),
            "___APPID___", "___APPKEY___", Site.JP);
    
            // PhotoColleSocialConnect インスタンスを作成します。
            PhotoColleSocialConnect connect =
                (PhotoColleSocialConnect)Kii.socialConnect(
                    SocialNetwork.PHOTOCOLLE);
    
            // PhotoColleSocialConnect インスタンスを初期化します。
            connect.initialize(
                    "___CLIENTID___",
                    "___CLIENTSECRET___",
                    "___REDIRECTURI___",
                    EnumSet.of(
                        Scope.PHOTO_GET_CONTENTS_LIST,
                        Scope.PHOTO_GET_CONTENT,
                        Scope.PHOTO_UPLOAD_CONTENT,
                        Scope.PHOTO_GET_VACANT_SIZE,
                        Scope.PHOTO_GET_VACANT_SIZE,
                        Scope.PHOTO_UPDATE_TRASH_INFO,
                        Scope.PHOTO_GET_GROUP_INFO),
                    null);
        }
    }
    

    CLIENTIDCLIENTSECRETREDIRECTURI と スコープ には docomo Developer support で登録/取得した Client ID、Client Secret 、 Redirect Uri とスコープを指定してください。また Kii.initialize() に設定する Site は Site.JP のみ利用可能です。

iOS でのプロジェクトの設定

Kii PhotoColle SDK は iOS 8.0 以降の環境に対応しています。使用する SDK のバージョン等を確認してください。Kii PhotoColle SDK は Standard architecture (includes 64-bit) の選択が可能となっています。

下記の手順に従って、Kii PhotoColle SDK をアプリケーションのプロジェクトに追加してください。

なお、GitHub の README では CocoaPods または Carthage を使ってビルドする方法も紹介しています。

  1. SDK の組み込み

    ダウンロードした SDK の ZIP ファイルを Xcode のプロジェクト配下のディレクトリに展開します。

    展開後、Xcode のプロジェクトエディターでターゲットを選択した後に "General" タブをクリックします。

    Embedded Binaries までスクロールダウンした後、追加ボタン (+) をクリックします。

    "Add Other" ボタンを選択した後に、ZIP ファイル展開先の PhotoColleSDK.framework ディレクトリを選択してください。

    次に、Linked Frameworks and Libraries までスクロールダウンした後、追加ボタン (+) をクリックします。

    "Add Other" ボタンを選択した後に、ZIP ファイル展開先の PhotoColleSDK.framework ディレクトリを選択してください。

  2. 以下のフレームワークとライブラリをプロジェクトに追加します。

    • Accounts.framework
    • ImageIO.framework
    • MobileCoreServices.framework
    • Security.framework
    • Social.framework
    • SystemConfiguration.framework
    • UIKit.framework
    • libsqlite3.dylib
  3. Kii PhotoColle SDK を使用するすべてのファイルに、下記のヘッダを追加します。

    #import <PhotoColleSDK/DCPhotoColleSDK.h>
    
  4. AppDelegateapplication:didFinishLaunchingWithOptions メソッド内で KiiPhotoColleSocialConnectsetupNetworkWithClientId:clientSecret:redirectUri:scopes:accessibility: を呼び出してください。なお KiiPhotoColleSocialConnectsetupNetworkWithClientId:clientSecret:redirectUri:scopes:accessibility: を呼び出す前には必ず KiibeginWithID:andKey:andSite を呼び出してください。

    // アプリの起動後
    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
      // Kii PhotoColle SDK を初期化します。
      [Kii beginWithID:@"___APPID___"
                andKey:@"___APPKEY___"
               andSite:kiiSiteJP];
    
      // スコープを設定します。
      NSArray *scopes = @[
              [DCScope photoUploadContent],
              [DCScope photoGetContentsList]];
    
      // PhotoColleSocialConnect インスタンスを初期化します。
      [KiiPhotoColleSocialConnect setupNetworkWithClientId:@"__DOCOMO_CONSUMER_KEY__"
                                        clientSecret:@"__DOCOMO_CONSUMER_SECRET__"
                                         redirectUri:@"___REDIRECT_URL___"
                                              scopes:scopes
                                       accessibility:kSecAttrAccessibleWhenUnlocked];
    
      return TRUE;
    }
    

    CLIENTIDCLIENTSECRETREDIRECTURI と スコープには docomo Developer support で登録/取得した Client ID、Client Secret 、 Redirect Uri とスコープを指定してください。また Kii の beginWithID:andKey:andSite に設定する KiiSite enum は kiiSiteJP のみ利用可能です。