35
Copyright © 2016 NTT DOCOMO, Inc. All Rights Reserved. sp モード版 i チャネル コンテンツ作成ガイド おこのみチャネル編 1.3 平成 28 2 25 株式会社 NTT ドコモ

sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

  • Upload
    others

  • View
    0

  • Download
    0

Embed Size (px)

Citation preview

Page 1: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright © 2016 NTT DOCOMO, Inc. All Rights Reserved.

spモード版

iチャネル

コンテンツ作成ガイド

- おこのみチャネル編 -

1.3版

平成 28年 2月 25日

株式会社 NTT ドコモ

Page 2: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright © 2016 NTT DOCOMO, Inc. All Rights Reserved.

(目次)

1. サービス概要 .................................................................. 1

1.1. iチャネルとは ............................................................ 1 1.2. 対象ユーザについて ........................................................ 1 1.3. チャネルの種類(ベーシックチャネル/おこのみチャネル) .................... 2 1.4. 接続形態について .......................................................... 2

2. 技術仕様 ...................................................................... 3

2.1. ドコモ~コンテンツ提供者間のインタフェース仕様 ............................ 3 2.2. チャネル登録インタフェース仕様 ............................................ 4 2.2.1. チャネル登録 ............................................................ 4 2.2.2. チャネル削除 ........................................................... 8 2.2.3. チャネル登録におけるエラー ............................................. 8

2.3. チャネルコンテンツ配信インタフェース仕様 .................................. 9 2.3.1. 「チャネルコンテンツ」の構成要素 ........................................ 9 2.3.2. チャネルコンテンツ配信シーケンス ....................................... 11 2.3.3. login .................................................................. 12 2.3.4. getdata ................................................................ 14 2.3.5. logout ................................................................. 20 2.3.6. チャネルコンテンツ配信インタフェースにおけるエラーコード ............... 22

2.4. リトライ制御について ..................................................... 22 2.4.1. login処理のリトライ制御 ............................................... 22 2.4.2. getdata処理のリトライ制御 ............................................. 23 2.4.3. logout制御 ............................................................ 25

2.5. 詳細コンテンツ配信インタフェース仕様 ..................................... 26

3. おこのみチャネル提供時の注意点 ................................................ 27

付録 1.URL エンコード対象文字について .............................................. 28

付録 2.チャネル登録時のエラー内容 ................................................ 29

付録 3.チャネルコンテンツ配信インタフェースにおけるエラーコード ................... 30

付録 4.トピックテキストの表示上の注意点について ................................... 32

Page 3: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright © 2016 NTT DoCoMo, Inc. All Rights Reserved.

修正履歴

版 項目 種別 内容

1.0 - - 新規作成

1.1 2.2.1 追加 使用禁止文字の追記

2.3.1 追加

付録 3 修正

1.2 2.2.1 追加 使用禁止文字の詳細説明を追記

付録 1 追加

1.3 2.3.1 削除 画像ファイルの形式から GIF を削除

2.3.4 削除

- 商標について -

・「iモード」、「spモード」は NTT ドコモの登録商標です。

・その他、本書に記載された会社名、製品名等は該当する各社の商標または登録商標です。

Page 4: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright © 2016 NTT DoCoMo, Inc. All Rights Reserved.

1

はじめに

本資料は、株式会社 NTT ドコモ(以下ドコモ)が提供する sp モード向けiチャネルサービスにお

けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

ツの作成方法等について規定することを目的としています。

1. サービス概要

1.1. iチャネルとは

i チャネルは、画像データや文字データから構成されるチャネルという単位のコンテンツの配信

サービスです。i チャネルサービスには、ドコモが配信する「ベーシックチャネル」と、コンテ

ンツ提供者が配信する「おこのみチャネル」という 2種類のチャネルがあります。おこのみチャ

ネルで配信対象となるコンテンツは以下の 2種類となります。

<表 1-1:配信対象>

名称 説明

チャネルコンテンツ 比較的小さなサイズの、画像データとテキストデータで構成されるコンテ

ンツです。i チャネルアプリでの一覧表示、及び iチャネルアプリのウィ

ジェット機能での表示の対象となるコンテンツです。

詳細コンテンツ チャネルコンテンツの詳細情報の位置づけとなるコンテンツです。iチャ

ネルアプリから連携起動される Android標準のブラウザ(以下ブラウザ)

で表示される Webページのコンテンツです。

<図 1-1:チャネルコンテンツの表示イメージ>

1.2. 対象ユーザについて

iチャネルアプリ対応の端末を利用し、かつドコモヘ iチャネルへの利用申込み(有料)を行っ

た、sp モード契約のユーザが利用できます。

本書に規定するおこのみチャネルに対応する iチャネルアプリは、Android端末(AndroidOS 2.1

おこのみ

チャネル

HOME画面

(iチャネルウィジェット)

iチャネル一覧

(iチャネルアプリ)

詳細コンテンツ

(ブラウザ)

XXXXサイト

Page 5: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

2

以降)に対応します。

1.3. チャネルの種類(ベーシックチャネル/おこのみチャネル)

iチャネルサービスをご利用のユーザは、下記のチャネルを利用することができます

(1) ベーシックチャネル(ドコモが配信するチャネル)

(2) おこのみチャネル(コンテンツ提供者が配信するチャネル)

ベーシックチャネルとおこのみチャネルの差異について以下に示します。

<表 1-2:ベーシックチャネルとおこのみチャネルの差異>

ベーシックチャネル おこのみチャネル

定義

(配信元)

ドコモが配信するチャネル群を意味し

ます。

コンテンツ提供者より自由に配信でき

るチャネル群を意味します。

ユーザの

利用申込み

方法

ドコモへiチャネルの利用申込みを行う

と利用できます。spモード契約が必要と

なります。

左記に加え、チャネル登録を行うこと

で、登録したおこのみチャネルが利用で

きます。なお、おこのみチャネルは最大

で 5チャネルの登録ができます。

通信料金 チャネルコンテンツ取得に関する通信

料金はかかりません。(詳細コンテンツ

の取得には通信料金がかかります。)

チャネルコンテンツ取得時にも通常の

通信料金がかかります。

コンテンツ

料金

コンテンツ料金は iチャネルの利用料金

に含まれます。

コンテンツ提供者のサービス提供方針

により異なります。

チャネル

コンテンツ

更新頻度

1 日 10回(6時から 2時までの間で 2時

間に 1 度)、チャネルコンテンツが自動

取得されます。

指定の更新頻度(2 時間毎/3 時間毎/

1日毎/1 週間に 2 回)にてチャネルコ

ンテンツが自動取得されます。

1.4. 接続形態について

iチャネルは Wi-Fi接続にも対応します。

Page 6: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

3

2. 技術仕様

本章では、i チャネルサービスを実現するためのおこのみチャネルの技術仕様について説明しま

す。

2.1. ドコモ~コンテンツ提供者間のインタフェース仕様

おこのみチャネルを提供するコンテンツ提供者は、最低限以下の 3つのインタフェースを用意す

る必要があります。それぞれの詳細については、2.2節以降で説明します。

(1)チャネル登録インタフェース(Webサーバ)

(2)チャネルコンテンツ配信インタフェース(Feed サーバ ※1)

(3)詳細コンテンツ配信インタフェース(Webサーバ)

※1:i チャネルサービスにおいて、チャネルコンテンツを配信するサーバを「Feed サーバ」と

呼びます。

<図 2-1:ドコモ-コンテンツ提供者間のシステム構成例>

ドコモ

コンテンツ提供者

ドコモ

パケット網 ドコモサーバ

インターネット

i チャネルシステム

Webサーバ

Feedサーバ

DB

チャネル コンテンツ

詳細 コンテンツ

登録 CGI

インターネット

(3G接続)

(WiFi接続)

端末

Page 7: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

4

2.2. チャネル登録インタフェース仕様

本節では、ユーザが特定のおこのみチャネルを受信するよう設定するための「チャネル登録イン

タフェース」について説明します。

2.2.1. チャネル登録

おこのみチャネルを登録する場合、ユーザはコンテンツ提供者のサイト上、もしくは iチャネ

ルアプリの「iチャネル設定」画面より、チャネル登録を行います。

チャネル登録インタフェースの処理フローイメージを以下に示します。

<図 2-2:チャネル登録インタフェースの処理フローイメージ>

次に、コンテンツ提供者のサイト上のおこのみチャネル登録用ページに用意するリンクの書式、

およびドコモサーバからコンテンツ提供サーバへ送信するチャネル登録リクエスト、 コンテ

ンツ提供サーバからドコモサーバへ返信するチャネル登録レスポンスについて説明します。

①コンテンツ提供者のサイト上にある、おこのみチ

ャネル登録用ページ(チャネル登録インタフェース

のリンクが記載)へアクセス

③リンクに埋め込まれ

た情報が送信される

④ドコモサーバが設

定された URLへチャネ

ル登録リクエストを

送信

⑤チャネル登録レス

ポンスを送信

⑥チャネル登録完了

ドコモサーバ 端末

ブラウザ iチャネルアプリ

②リンク押下によ

り連携起動

登録CG

I

コンテンツ提供サーバ

(Webサーバ)

※③と④の間で spモードパスワードの入力・確認が発生しますが、図では省略しています。

Page 8: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

5

(1)コンテンツ提供者のサイト上に用意するチャネル登録インタフェースのリンク書式

おこのみチャネル登録用ページに、i チャネルアプリを起動するためのリンク(もしくは

ボタン)を用意します。以下に示すスキームとホストを設定することで、ブラウザからの

起動が可能となります。

スキーム : ich

ホスト : ichannel.nttdocomo.co.jp

iチャネルアプリ連携時に引き渡すパラメータを以下に示します。

<表 2-1:パラメータの詳細>

名称 説明 必須

1 regurl(※7) 登録・削除 CGI の URL(※4)(※6)。192byte以内(※1)。 ○

2 feedserverurl(※7) Feedサーバの URL(※4)(※6)。192byte以内(※1)。 ○

3 detailtopurl 詳細コンテンツの URL (※4)。192byte 以内(※2)。 ○

4 chname

画面表示するチャネル名(※8)。14byte以内(※2)。文字コードは SJIS。

i モード絵文字は使用できません。マルチバイト文字の URL エンコードは

SJISで行なってください(※2)。

5 chid チャネル ID。1~32767(10 進表記。ただし、ドコモサーバ~コンテンツ提

供サーバ間では 16 進表記(0x1~0x7fff)となります)。 ○

6 interval

コンテンツ提供者が推薦する更新間隔として、以下のいずれかを設定。

“0120”:2時間毎

“0180”:3時間毎

“1440”:1日毎

“5040”:1週間に 2回

7 realm サイトドメイン情報(※4)(※5)(※6)。128Byte以内(※3)

登録 CGI と Feedサーバの URL と同一のホスト名を指定する。 ○

※1:サイズのチェックについては、パラメータ値をデコードした状態で行なわれます。

※2:サイズのチェックについては、パラメータ値をデコード後、再度 URL エンコードした状

態で行われます。その際、URL エンコードの対象となる文字については付録 1「URL エン

コード対象文字一覧(サイズチェック時)」を参照してください。

※3:サイズのチェックについては、パラメータ値をエンコードした状態で行なわれます。そ

の際にエンコードの対象となる文字については付録 1「URL エンコード対象文字一覧」を

参照してください。

※4:以下の URL形式である必要があります。

・URL として許容されていない文字を含まないこと。

使用可能文字は半角英数字及び、 URLエンコード対象文字一覧の図形文字 0x21~0x7E

であること。

・スキーム(http://)及びホストが付与されていること。

・スキームは http://であること。(https://などは不可)。

・ポート番号が付与されている場合は、数値で 1~65535の 範囲内であること。

※5:realmには先頭が”http://*.”で始まるワイルドカード表記の使用が可能です。

Page 9: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

6

ただし、ワイルドカード表記を使用する場合は、以下の(1)(2)のいずれかの条件を満た

した形式である必要があります。

(1)ホスト名を分割した際のドメイン数が 4 つ以上であること。

(2)ホスト名を分割した際のドメインが 3 つの場合、2 つ目のドメインが汎用的なセカン

ドレベルドメイン( ac,co,go,or,ad,ne,gr,ed,lg )でないこと。ホスト名を分割し、

ドメインが 2つ以下の場合は非許容となります。参照してください。

※6:regurl パラメータ、feedserverurl パラメータは realm パラメータと以下の相関チェッ

クを実施します。

(1)realm パラメータとホスト部分(スキーム以降の”//”から“:”又は“/”まで)が

完全一致していること。

ただし、ワイルドカード表記の場合は後方一致していること。

(2)realm パラメータとパス部分(ホスト部以降の最初の“/”から“?”まで)が前方一

致していること。

ただし realmパラメータにパスが存在しない場合は、本処理は実施しません。

(3)realmパラメータとポート部分(ホスト部で検出された “:”から最初の “/”まで)

が完全一致していること。ただし realm パラメータにポートが存在しない場合は、本処

理は実施しません。

※7:パラメータ値に指定する URL に、クエリパラメータを付加することはできません。

※8:以下の半角文字は使用できません。(URLエンコード値での記述も不可です。)

< > & " '

スキーム

http://www.example.com:8080/news/index.html?page=2&msg=yes

ホスト パス ポート

Page 10: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

7

チャネル登録インタフェースの記述例を以下に示します(例では、“intent:”を使用して i

チャネルアプリを連携起動する処理を想定しています)。

<図 2-3:チャネル登録インタフェース例>

(2)チャネル登録リクエスト

ドコモサーバからコンテンツ提供サーバへのチャネル登録リクエストの設定値について

以下に示します。

<表 2-2:チャネル登録リクエスト>

種別 名称 パラメータ

1 リクエスト ライン

POST -

2 ヘッダ Host -

3 Content-Type “application/x-www-form-urlencoded”【固定】

4 Content-Length ボディ部サイズ(byte) が設定されます。

5 ボディ DID デバイス ID。URLエンコードした OpenIDが設定されます。エンコー

ドの対象となる文字については、付録 1「URL エンコード対象文字

一覧(サイズチェック時)」を参照してください。

※なお、OpenID の取得はドコモサーバ内で全ての処理を行います。

Webサーバ(コンテンツ提供者)への通信は発生しません。

6 ChID チャネル ID。16進表記で設定されます。

7 act “reg1”:チャネル登録 【固定】

チャネル登録リクエスト例を以下に示します。

POST /xxx/xxx.cgi HTTP/1.1<CR><LF>

HOST: xxx.xxx.xxx<CR><LF>

Content-Type: application/x-www-form-urlencoded<CR><LF>

Content-Length: xx<CR><LF>

<CR><LF>

DID=xxxxxxxxxxxx&ChID=xxx&act=reg1

<図 2-4:チャネル登録リクエスト例>

(3)チャネル登録レスポンス

コンテンツ提供サーバからドコモサーバへのチャネル登録レスポンスの設定値について

以下に示します。

<body>

<a href="intent://ichannel.nttdocomo.co.jp/?regurl=http%3A%2F%2Fxxxxx.xx.co.jp%2Fnews%2

Freg.cgi&feedserverurl=http%3A%2F%2Fxxxxx.xx.co.jp%2Fnews%2Ffeed%2F&detailtopurl=http%3

A%2F%2Fxxxxx.xx.co.jp/news/detail.html&chname=%82%A8%82%B1%82%CC%82%DD%82%50&chid=12345

&interval=0180&realm=http%3A%2F%2F%2A.xx.co.jp%2Fnews%2F#Intent;scheme=ich;end">i チャネ

ル登録</a>

Page 11: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

8

<表 2-3:チャネル登録レスポンス>

種別 名称 パラメータ

1 ヘッダ Content-Type “text/plain”【固定】

2 Content-Length ボディ部サイズ(byte) が設定されます。

3 ボディ Result “OK”:認証 OK(登録する)

“NG”:認証 NG(登録しない)

チャネル登録レスポンス例を以下に示します。

HTTP/1.1 200 OK<CR><LF>

Content-Type: text/plain<CR><LF>

Content-Length: xx<CR><LF>

<CR><LF>

Result=OK<CR><LF>

<図 2-5:チャネル登録レスポンス例>

2.2.2. チャネル削除

チャネルの削除は iチャネルアプリ上よりユーザ操作で行ないます。

コンテンツ提供サーバへ削除の通知はされません。

2.2.3. チャネル登録におけるエラー

おこのみチャネルのチャネル登録におけるエラー内容については付録 2を参照下さい。

Page 12: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

9

2.3. チャネルコンテンツ配信インタフェース仕様

本節では、チャネルコンテンツの配信時のインタフェース仕様について説明します。

2.3.1. 「チャネルコンテンツ」の構成要素

チャネルコンテンツは、「アイコンムービー」、「トピックムービー」、「トピックテキスト」と

呼ばれるアイテムで構成されます。さらにトピックムービー、及びトピックテキストはそれぞ

れ A、Bのアイテムに分かれているため、合計で 5種類のアイテムが必要となります。

またチャネルコンテンツには、構成する各アイテムのサイズが異なる、Phone 型端末向けと

Tablet 型端末向け(※1)の 2種類があります(※2)。

※1:AndroidOS を搭載したタブレット型端末を「Tablet型端末」、それ以外の端末(AndroidOS

を搭載した携帯電話)を「Phone 型端末」として扱います。 なお、i チャネルにおける

Phone 型端末/Tablet 型端末の区別は、製品シリーズ上の区別と異なる場合があります。

それぞれの区別は、後述する X-Client-Typeヘッダから判断できます。

※2:Tablet型端末向けのチャネルコンテンツへの対応は任意です。

「Tablet型端末」で Tablet型端末向けのチャネルコンテンツを用意しない場合は、phone

型端末向けのチャネルコンテンツを拡大表示します。

<図 2-8:チャネルコンテンツ構成イメージ(iチャネル一覧での表示時:Phone 型)>

トピックムービーA

アイコンムービー

トピックテキスト B

チャネル

トピックテキスト A

トピックムービーB

は未使用

チャネル名(※登録時のパラメータ)

Page 13: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

10

<図 2-9:チャネルコンテンツ構成イメージ(iチャネル一覧での表示時:Tablet型)>

<図 2-10:チャネルコンテンツ構成イメージ(iチャネルウィジェットでの表示時:Phone型)>

<図 2-11:チャネルコンテンツ構成イメージ(iチャネルウィジェットでの表示時:Tablet型)>

トピックテキスト B

アイコンムービー チャネル名(※登録時のパラメータ)

トピックムービーB

トピックムービーA

トピックテキスト A

トピックムービーA/B トピックテキスト A/B

アイコンムービー

「トピックムービーA+トピックテキスト A」⇒「トピックムービーB+トピックテキスト B」の順で

切り替え表示

チャネル名(※登録時のパラメータ)

トピックテキスト B

アイコンムービー チャネル名(※登録時のパラメータ)

トピックムービーB トピックムービーA

チャネル

トピックムービーA トピックテキスト A

Page 14: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

11

チャネルコンテンツを構成する各アイテムの要件を以下に示します(1 チャネルコンテンツ単

位の要件)。

<表 2-6:アイテムの要件>

アイテム 説明 数 ファイル形式 サイズ

Phone 型 Tablet型

アイコン

ムービー

ジャンルを分

類するための

アイコンです。

1 画像ファイル

(JPEG/PNG)。

1) ベースライン JPEG

・ プログレッシブ JPEG

はサポートしません。

[縦横サイズ]

横 34dot

縦 30dot

[ファイルサイズ]

10kbytes

[縦横サイズ]

横 34dot

縦 30dot

[ファイルサイズ]

10kbytes

トピック

ムービー

A/B

コンテンツの

トピックを表

示する画像で

す。

2 1 ファイルあたり

[縦横サイズ]

横 90dot

縦 90dot

[ファイルサイズ]

100kbytes

1 ファイルあたり

[縦横サイズ]

横 170dot

縦 170dot

※1

[ファイルサイズ]

100kbytes

トピック

テキスト

A/B

コンテンツの

トピックを表

示するテキス

トです。

2 テキストファイル。

・ 文 字 コ ー ド は

Shift-JIS です。記述

された文字列がそのま

まトピックテキストと

して表示されます。タ

グ等の記述は不要で

す。

・ i モード絵文字の利用

も可能です。

・ 半角文字を記述するこ

とは禁止します。(URL

エンコード値での記述

も禁止します。)

・ 改行コード(<CR><LF>

もしくは<LF>)を記述

することは禁止しま

す。

・ 表示に関する注意点に

ついては付録 5 を参照

して下さい。

1 ファイルあたり

全角 20文字

(40bytes)

1 ファイルあたり

全角 40文字

(80bytes)

※1: i チャネル一覧での表示は、拡大して表示します。

2.3.2. チャネルコンテンツ配信シーケンス

おこのみチャネルコンテンツ配信シーケンスを以下に示します。

Page 15: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

12

<図 2-12:チャネルコンテンツ配信シーケンス>

2.3.3. login

(1)loginリクエスト

loginリクエストの設定値について以下に示します。

<表 2-7:login リクエスト>

種別 名称 パラメータ

1 リクエスト ライン

POST URL は Feedサーバの URLの末尾に“login”を付与したものとなり

ます。なお、Feedサーバの URL の末尾が“/”でない場合は、“/”

を補完した上で“login”を付与します。HTTP バージョンは 1.0 で

す。

2 ヘッダ User-Agent “Docomo-OPF-iCh-Client/1.0”【固定】

3 Accept-Language “ja, en-US;q=0.9, en;q=0.8”【固定】

4 Accept-Charset “EUC-JP, ISO-2022-JP;q=0.9, Shift_JIS;q=0.8, *;q=0.7”【固定】

5 Content-Type “application/x-www-form-urlencoded”【固定】

6 TE “trailers”【固定】

7 Host Feedサーバのホスト名が設定されます。

8 Content-Length ボディ部サイズ(byte) が設定されます。

9 Connection “keep-alive”【固定】

10 X-DCMRoaming 端末からのリクエストに X-DCMRoamingヘッダ(ローミングビット)

が付与されている場合、当該ヘッダの値が設定されます。

11 ボディ protoversion “1.5”【固定】

12 device “connector”【固定】

13 client “connector”【固定】

14 clientstate “1”【固定】

ドコモサーバ コンテンツ提供サーバ

(Feedサーバ)

TCP Connect

loginリクエスト

TCP Close

login

getdata

logout

loginレスポンス

getdataリクエスト

logoutリクエスト

logoutレスポンス

Page 16: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

13

種別 名称 パラメータ

15 deviceid デバイス ID。 URLエンコードした OpenIDが設定されます。エンコー

ドの対象となる文字については、付録 1「URL エンコード対象文字

一覧(サイズチェック時)」を参照してください。

loginリクエスト例を以下に示します。

POST<SP>/feedserver/login<SP>HTTP/1.0<CR><LF>

User-Agent:<SP> Docomo-OPF-iCh-Client/1.0<CR><LF>

Accept-Language:<SP>ja,<SP>en-US;q=0.9,<SP>en;q=0.8<CR><LF>

Accept-Charset:<SP>EUC-JP,<SP>ISO-2022-JP;q=0.9,<SP>Shift_JIS;q=0.8,<SP>*;q=0.7<CR><LF>

Content-Type:<SP>application/x-www-form-urlencoded<CR><LF>

TE:<SP>trailers<CR><LF>

Host:<SP>www.xxxxxx.co.jp<CR><LF>

Connection:<SP>keep-alive<CR><LF>

Content-Length:<SP>145<CR><LF>

<CR><LF>

protoversion=1.5&device=connector&client=connector&clientstate=1&deviceid=xxx・・・

<図 2-13:login リクエスト例>

(2)loginレスポンス

loginレスポンスの設定値について以下に示します。

なお、レスポンスのチャンクエンコーディングには対応していません。

<表 2-8:login レスポンス>

種別 名称 パラメータ 必須

1 ヘッダ Set-Cookie 例)“JSESSIONID=XXXX・・・” ※1 ○

2 Content-Length ボディ部サイズ(byte) を設定します。 ○

3 Connection “keep-alive”【固定】 ※2

4 ボディ result

(処理結果コード)

“result=ok”

[意味]成功。

5 “result=fail-retry”

[意味]最後の操作は失敗した。

6 “result=fail-auth”

[意味]クライアントが認証を試行したが失敗した。

7 “result=fail-protoversion”

[意味]クライアントが認識していないバージョンのプロト

コルで、クライアントが通信しようとした。

8 “result=fail”

[意味]最後の操作が失敗した。

9 “result=fail-access”

[意味] “fail”と同様、アクセス権がないことが原因でエ

ラーとなる。

10 “result=(その他)”

11 session セッションを特定する一意の文字列(JSESSIONIDの値)を

設定します。

例)“session=XXXX・・・”

※3

12 logout logoutリクエストの送信先 URLを設定します。

例)“http://xxx.xxx.xxx.xxx:80/feedserver/logout”

※3

Page 17: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

14

種別 名称 パラメータ 必須

13 getData getdataリクエストの送信先 URLを設定します。

例)

“http://xxx.xxx.xxx.xxx:80/feedserver/getData”

※3

※ 1 JSESSIONIDは以後のリクエストでセッションを管理するために使用します。

※ 2 HTTPバージョン1.1の場合でも付加してください。

※ 3 “result=ok”の場合のみ必須です。

loginレスポンス例を以下に示します。

HTTP/1.1<SP>200<SP>OK<CR><LF>

Content-Length:<SP>532<CR><LF>

Set-Cookie:<SP>JSESSIONID=MQKvW1gDpqZlpQ11pWtH12y22HRGyYVCqYYn9yptqFj8tXd5WfVL!-1790409321;

<SP>path=/<CR><LF>

Connection:<SP>Keep-Alive<CR><LF>

<CR><LF>

result=ok&session=MQKvW1gDpqZlpQ11pWtH12y22HRGyYVCqYYn9yptqFj8tXd5WfVL%21-1790409321&logout

=http%3A%2F%2Ffcext1-o-m%3A8080%2Ffeedserver%2F%2Flogout&getData=http%3A%2F%2Ffcext1-o-m%3A

8080%2Ffeedserver%2F%2FgetData

<図 2-14:login レスポンス例>

2.3.4. getdata

(1)getdataリクエスト

getdata リクエストの設定値について以下に示します。

<表 2-9:getdataリクエスト>

種別 名称 パラメータ

1 リクエスト ライン

POST URL は login レスポンスボディ部の getData プロパティの指定値が

設定されます。HTTPバージョンは 1.0です。

2 ヘッダ User-Agent “Docomo-OPF-iCh-Client/1.0”【固定】

3 Accept-Language “ja, en-US;q=0.9, en;q=0.8”【固定】

4 Accept-Charset “EUC-JP, ISO-2022-JP;q=0.9, Shift_JIS;q=0.8, *;q=0.7”【固定】

5 Content-Type “application/x-www-form-urlencoded”【固定】

6 TE “trailers”【固定】

7 Host Feedサーバのホスト名が設定されます。

8 Content-Length ボディ部サイズ(byte) が設定されます。

9 Cookie login レスポンスヘッダ部の Set-Cookie ヘッダに指定された

Cookie情報が設定されます。

10 Connection “keep-alive”【固定】

11 X-DCMRoaming 端末からのリクエストに X-DCMRoamingヘッダ(ローミングビット)

が付与されている場合、当該ヘッダの値が設定されます。

12 X-Client-Type 要求元の端末の種類が設定されます。 Tablet 型端末向けのチャネ

ルコンテンツの配信に対応する場合、getdata レスポンスに設定す

るチャネルコンテンツの種類を本ヘッダにより判断してください。

Phone 型:“0”

Tablet型:“1”

13 ボディ id ユーザが同期化を要求しているチャネル IDが設定されます。

“id=<channelid>”の形式となります。

Page 18: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

15

種別 名称 パラメータ

14 delta “false”【固定】 “delta=false”の形式となります。

getdata リクエスト例を以下に示します。

POST<SP>/xxxxxx/getData<SP>HTTP/1.0<CR><LF>

User-Agent:<SP> Docomo-OPF-iCh-Client/1.0<CR><LF>

Accept-Language:<SP>ja,<SP>en-US;q=0.9,<SP>en;q=0.8<CR><LF>

Accept-Charset:<SP>EUC-JP,<SP>ISO-2022-JP;q=0.9,<SP>Shift_JIS;q=0.8,<SP>*;q=0.7<CR><LF>

Content-Type:<SP>application/x-www-form-urlencoded<CR><LF>

TE:<SP>trailers<CR><LF>

Host:<SP>www.xxxxxxxx.co.jp<CR><LF>

Content-Length:<SP>16<CR><LF>

Cookie:<SP>JSESSIONID=MQKvW1gDpqZlpQ11pWtH12y22HRGyYVCqYYn9yptqFj8tXd5WfVL!-1790409321;<SP>

path=/<CR><LF>

Connection:<SP>keep-alive<CR><LF>

X-Client-Type:<SP>0<CR><LF>

<CR><LF>

id=a&delta=false

<図 2-15:getdataリクエスト例>

(2)getdataレスポンス

getdata レスポンスの設定値について以下に示します。

なお、レスポンスのチャンクエンコーディングには対応していません。

<表 2-10:getdataレスポンス>

種別 名称 パラメータ 必須

1 ヘッダ Content-Length ボディ部サイズ(byte) を設定します。 ○

2 Connection “keep-alive”【固定】 ※1

3 X-Client-Type チャネルコンテンツの種類を設定します。Tablet型端末の

端末向けのチャネルコンテンツに対応する場合、本ヘッダ

を付加する必要があります。

Phone 型:“0”

Tablet型:“1”

※2

4 ボディ result

(処理結果コード)

“result=fail-session”

[意味]最後の操作は期限切れのセッションで試行された。

※3

5 “result=fail-retry”

[意味]最後の操作は失敗した。

6 “result=fail-auth”

[意味]クライアントが認証を試行したが失敗した。

7 “result=fail-protoversion”

[意味]クライアントが認識していないバージョンのプロト

コルで、クライアントが通信しようとした。

8 “result=fail”

[意味]最後の操作が失敗した。

9 “result=fail-access”

[意味] “fail”と同様、アクセス権がないことが原因でエ

ラーとなる。

Page 19: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

16

種別 名称 パラメータ 必須

10 “result=(その他)”

11 Feed Item Collection

「(3)Feed Item Collection 」を参照してください。 ※4

※ 1 HTTPバージョン1.1の場合でも付加してください。

※ 2 X-Client-Typeヘッダを付加する場合、必ず設定した値と同じ型のチャネルコンテン

ツを配信してください。下記の組み合わせ以外のレスポンスである場合、エラーとなり

ます。

リクエスト レスポンス

備考 X-Client-Type

ヘッダ

X-Client-Type

ヘッダ

チャネル

コンテンツ

1 Phone型 Phone型 Phone型

2 ヘッダなし Phone型 Tablet型端末向けのチャネ

ルコンテンツの配信に対応

しない場合

3 Tablet型 Phone型 Phone型

4 Tablet型 Tablet型

5 ヘッダなし Phone型 Tablet型端末向けのチャネ

ルコンテンツの配信に対応

しない場合

※ 3 リクエスト失敗時は必須です。

※ 4 リクエスト成功時は必須です。

getdata レスポンス例を以下に示します。

HTTP/1.1<SP>200<SP>OK<CR><LF>

Date:<SP>Wed,<SP>16<SP>Feb<SP>2011<SP>10:07:15<SP>GMT<CR><LF>

Content-Length:<SP>7536<CR><LF>

X-Cache:<SP>MISS<SP>from<SP>fcmsn2-s-m<CR><LF>

Keep-Alive:<SP>timeout=15,<SP>max=99<CR><LF>

Connection:<SP>Keep-Alive<CR><LF>

X-Client-Type:<SP>0<CR><LF>

<CR><LF>

※ボディ部の設定内容は Feed Item Collectionを参照(バイナリデータ)

<図 2-16:getdataレスポンス例>

Page 20: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

17

(3) Feed Item Collection

Feed Item Collectionは、下記に示す 3種類のレコードで構成されます。

<表 2-11:Feed Item Collectionの構成>

レコード 概要

1 BeginFeedレコード Feed Item Collection の始まりを表します。

2 ItemData レコード Feed Itemの始まりを表し、文字列を指定します。

3 PropData レコード 単一プロパティデータで構成され、直前の ItemData レコー

ドが指定した Feed Itemに所属し、トピックムービーもしく

はアイコンムービーを指定します。

<図 2-17:Feed Item Collectionのイメージ>

Feed Item Collectionの各レコードの設定値について説明します。

各レコードについて、タイプ欄が整数となっている項目については、ネットワークバイト

オーダーで設定してください。文字列となっている項目については、とくに説明のない限

り ASCII コードで設定してください。

BeginFeedレコードの設定値について以下に示します。

Page 21: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

18

<表 2-12:BeginFeedレコード>

項目名 タイプ サイズ

(byte) 設定値

1 レコードヘッダ - -

2 レコードタイプ バイト 1 1 :BeginFeedレコード【固定】

3 レコード

レングス

整数 4 BeginFeedレコードのレコード長を設定します。

※項番 4 以降のサイズ(byte)の合計です。

4 ID サイズ 整数 2 値の長さを設定します。

値 文字列 可変長 チャネル ID を設定します。getdataリクエストの idプロパテ

ィの設定値をそのまま設定します。

5 SyncLevel

整数 4 コンテンツ提供サーバで保持している当該コンテンツの現在

の syncLevelを設定します。

有効範囲:0~4294967295

6 Delta バイト 1

<表 2-13:BeginFeedレコードの設定例>

項目名 設定値(16進イメージ:0x) 補足

1 レコードヘッダ -

2 レコードタイプ 01 BeginFeedレコード。

3 レコード

レングス

00 00 00 08 項番 4以降の合計が 8byte。

4 ID 00 01 61 チャネル ID=10(16 進数表記で

“a”)(サイズ=1)。

5 SyncLevel 2d f0 23 13

6 Delta 00 完全更新。

ItemData レコードの設定値について以下に示します。

<表 2-14:ItemDataレコード>

項目名 タイプ サイズ

(byte) 設定値

1 レコードヘッダ - -

2 レコードタイプ バイト 1 2 :ItemDataレコード【固定】

3 レコード

レングス

整数 4 ItemData レコードのレコード長を設定します。

※項番 4 以降のサイズ(byte)の合計です。

4 最終更新日

(lastModified)

タイム

スタン

4 アイテムの最終更新日時を設定します。

1970年 1月 1日 00時 00分 00秒から起算した秒数を設定しま

す。

5 IsDelete 整数 4 0 【固定】

6 タイプ サイズ 整数 2 3 【固定】

値 文字列 3 “000”【固定】

7 ID サイズ 整数 2 値の長さを設定します。

値 文字列 可変長 アイテム名を設定します。

“tpctxa”:トピックテキスト A

“tpctxb”:トピックテキスト B

“tpcma”:トピックムービーA

“tpcmb”:トピックムービーB

“icona”:アイコンムービー

Page 22: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

19

項目名 タイプ サイズ

(byte) 設定値

8 プロパティ

レングス

整数 4 プロパティ(プロパティ名+プロパティ値)の文字列長を設定

します。

9 プロパテ

ィ名

サイズ 整数 2 値の長さを設定します。

値 文字列 可変長 設定するアイテムにあわせて以下のいずれかを設定します。

“tpctxa”:トピックテキスト A

“tpctxb”:トピックテキスト B

10 プロパテ

ィ値

サイズ 整数 2 値の長さを設定します。

値 文字列 可変長 トピックテキストの実データ(文字コードは Shift-JIS)を設

定します。

<表 2-15:ItemDataレコードの設定例(トピックテキスト)>

項目名 設定値(16進イメージ:0x) 補足

1 レコードヘッダ -

2 レコードタイプ 02 ItemData レコード。

3 レコード

レングス

00 00 00 33 項番 4以降の合計が 51byte。

4 最終更新日

(lastModified)

4b e7 e1 2d 設定値は、

2010/05/10 12:37:21。

5 IsDelete 00 00 00 00

6 タイプ 00 03 30 30 30

7 ID 00 06 74 70 63 74 78 61 アイテム名は“tpctxa” (サイ

ズ=6)。

8 プロパティ

レングス

00 00 00 1A プロパティ名とプロパティ値の

合計が 26byte。

9 プロパティ名 00 06 74 70 63 74 78 61 プロパティ名は“tpctxa” (サ

イズ=6)。

10 プロパティ値 00 10 82 a8 82 b1 82 cc 82 dd 83 60 83 83

83 6c 83 8b

プロパティ値は“おこのみチャネ

ル”(サイズ=16)。

<表 2-16:ItemDataレコードの設定例(アイコンムービー)>

項目名 設定値(16進イメージ:0x) 補足

1 レコードヘッダ -

2 レコードタイプ 02 ItemData レコード。

3 レコード

レングス

00 00 00 18 項番 4以降の合計が 24byte。

4 最終更新日

(lastModified)

4b e7 e1 2d 設定値は、

2010/05/10 12:37:21。

5 IsDelete 00 00 00 00

6 タイプ 00 03 30 30 30

7 ID 00 05 69 63 6f 6e 61 アイテム名は“icona” (サイズ

=5)。

8 プロパティ

レングス

00 00 00 00 プロパティが未設定のため、

0byte。

9 プロパティ名 - (未設定)

10 プロパティ値 - (未設定)

PropData レコードの設定値について以下に示します。なお、トピックテキストの場合、

Page 23: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

20

ItemDataレコードにてアイテムを設定するため、PropDataレコードは設定しません。

<表 2-17:PropDataレコード>

項目名 タイプ サイズ

(byte) 設定値

1 レコードヘッダ - -

2 レコードタイプ バイト 1 3 :PropDataレコード【固定】

3 レコード

レングス

整数 4 PropData レコードのレコード長を設定します。

※項番 4 以降のサイズ(byte)の合計です。

4 プロパテ

ィ名

サイズ 整数 2 値の長さを設定します。

値 文字列 可変長 設定するアイテムにあわせて以下のいずれかを設定します。

“tpcma”:トピックムービーA

“tpcmb”:トピックムービーB

“icona”:アイコンムービー

5 タイプ サイズ 整数 2 値の長さを設定します。

値 文字列 可変長 使用する画像フォーマットにあわせて以下のいずれかを設定

します。

“image/jpeg”:JPEG

“image/png”:PNG

6 データ サイズ 整数 4 値の長さを設定します。

値 バイト

可変長 トピックムービーA/B、もしくはアイコンムービーの画像フ

ァイルの実データを設定します。

<表 2-18:PropDataレコードの設定例>

項目名 設定値(16進イメージ:0x) 補足

1 レコードヘッダ -

2 レコード

タイプ

03 PropData レコード。

3 レコード

レングス

00 00 04 11 項番 4以降の合計が 1041byte。

4 プロパティ名 00 05 69 63 6f 6e 61 プロパティ名は“icona”(サイ

ズ=5)。

5 タイプ 00 0a 69 6d 61 67 65 2f 6a 70 65 67 “image/jpeg”(サイズ=10)。

6 データ 00 00 03 fa ・・・(以後、略) 画像ファイルの実データ(サイ

ズ=1018)。

2.3.5. logout

(1)logoutリクエスト

logout リクエストの設定値について以下に示します。

<表 2-19:logoutリクエスト>

種別 名称 パラメータ

1 リクエスト ライン

POST URLは login実行時に取得したレスポンスボディ部の logoutプロパ

ティの指定値が設定されます。

2 ヘッダ User-Agent “Docomo-OPF-iCh-Client/1.0”【固定】

3 Accept-Language “ja, en-US;q=0.9, en;q=0.8”【固定】

4 Accept-Charset “EUC-JP, ISO-2022-JP;q=0.9, Shift_JIS;q=0.8, *;q=0.7”【固定】

Page 24: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

21

種別 名称 パラメータ

5 Content-Type “application/x-www-form-urlencoded”【固定】

6 TE “trailers”【固定】

7 Host Feedサーバのホスト名が設定されます。

8 Content-Length 0 【固定】

Cookie loginレスポンスヘッダ部の Set-Cookieに指定された Cookie情報

が設定されます。

9 Connection “keep-alive”【固定】

10 X-DCMRoaming 端末からのリクエストに X-DCMRoamingヘッダ(ローミングビット)

が付与されている場合、当該ヘッダの値が設定されます。

11 ボディ - ボディ部は設定されません。

logout リクエスト例を以下に示します。

POST<SP>/feedserver/logout<SP>HTTP/1.0<CR><LF>

User-Agent:<SP> Docomo-OPF-iCh-Client/1.0<CR><LF>

Accept-Language:<SP>ja,<SP>en-US;q=0.9,<SP>en;q=0.8<CR><LF>

Accept-Charset:<SP>EUC-JP,<SP>ISO-2022-JP;q=0.9,<SP>Shift_JIS;q=0.8,<SP>*;q=0.7<CR><LF>

Content-Type: <SP>application/x-www-form-urlencoded<CR><LF>

TE:<SP>trailers<CR><LF>

Host:<SP>www.xxxxxxx.co.jp<CR><LF>

Content-Length:<SP>0<CR><LF>

Cookie:<SP>JSESSIONID=MQKvW1gDpqZlpQ11pWtH12y22HRGyYVCqYYn9yptqFj8tXd5WfVL!-1790409321;<SP

>path=/<CR><LF>

Connection:<SP>keep-alive<CR><LF>

<CR><LF>

<図 2-18:logoutリクエスト例>

(2)logoutレスポンス

logout レスポンスの設定値について以下に示します。

なお、レスポンスのチャンクエンコーディングには対応していません。

<表 2-20:logoutレスポンス>

種別 名称 パラメータ 必須 1 ヘッダ Content-Length ボディ部サイズ(byte) を設定します。 ○

2 ボディ result

(処理結果コード)

“result=ok”

[意味]成功。

3 “result=fail-retry”

[意味]最後の操作は失敗した。

4 “result=fail-auth”

[意味]クライアントが認証を試行したが失敗した。

5 “result=fail-protoversion”

[意味]クライアントが認識していないバージョンのプロト

コルで、クライアントが通信しようとした。

6 “result=fail”

[意味]最後の操作が失敗した。

7 “result=fail-access”

[意味] “fail”と同様、アクセス権がないことが原因でエ

ラーとなる。

8 “result=(その他)”

Page 25: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

22

logout レスポンス例を以下に示します。

HTTP/1.1<SP>200<SP>OK<CR><LF>

Content-Length:<SP>9<CR><LF>

<CR><LF>

result=ok

<図 2-19:logoutレスポンス例>

ドコモサーバでは getdataでコンテンツを正しく取得できている場合、logoutのエラーの

有無に関わらず、コンテンツを端末に返却する処理を行います。

2.3.6. チャネルコンテンツ配信インタフェースにおけるエラーコード

おこのみチャネルコンテンツの配信インタフェースにおけるエラーコードについては、付録 3

を参照ください。

2.4. リトライ制御について

ドコモサーバーから IPサーバ(Feed サーバ)に HTTP リクエスト送信し、HTTP レスポンスを

受信するまでのリトライ制御について説明します。ドコモサーバは以下に示すリトライシー

ケンスに従い、各種リクエストを再送する場合があるので、IPサーバ(Feed サーバ)側では

リクエストが再送された場合でも正常動作するようにしてください。

2.4.1. login処理のリトライ制御

login処理におけるリトライシーケンスを以下に示します。

Page 26: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

23

<図 2-20:login 処理におけるリトライシーケンス>

2.4.2. getdata 処理のリトライ制御

getdata 処理におけるリトライシーケンスを以下に示します。

TCP Connect

TCP Connect エラー、または接続タイムアウト

接続完了?

login リクエスト YES

終了

ドコモサーバ コンテンツ提供サーバ

(Feedサーバ)

NO

getdata制御へ

タイムアウト

または受信エラー

リトライ要?

login レスポンス

NO

TCP切断

規定間隔

YES

タイムアウト

または送信エラー

リトライ要?

NO

YES

Page 27: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

24

<図 2-21:getdata処理におけるリトライシーケンス>

getdata 処理にて処理結果コードが“fail-session”の場合、ドコモサーバではセッション保

持時間を経過したと判断し、セッションを破棄して login からリトライすることにご注意くだ

さい。

getdata リクエスト

ドコモサーバ コンテンツ提供サーバ

(Feedサーバ)

logout制御へ

タイムアウト

または送信エラー

リトライ要?

getdata レスポンス NO

TCP切断

規定間隔

YES

TCP再接続

セッション ID保持

タイムアウト

または受信エラー

リトライ要?

NO

YES

“result=fail-session”?

NO

login制御へ

規定間隔

TCP切断

YES

Page 28: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

25

2.4.3. logout制御

logout 処理におけるリトライシーケンスを以下に示します。

<図 2-22:logout処理におけるリトライシーケンス>

logout リクエスト

ドコモサーバ コンテンツ提供サーバ

(Feedサーバ)

タイムアウト

または受信エラー

リトライ要?

logout レスポンス

NO

TCP再接続

セッション ID保持

YES

タイムアウト

または送信エラー

リトライ要?

NO

YES

TCP切断

規定間隔

TCP Close

終了

Page 29: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

26

2.5. 詳細コンテンツ配信インタフェース仕様

詳細コンテンツは iチャネルアプリから連携起動されるブラウザ上での表示となります。従いま

して、詳細コンテンツの作成方法や制限事項はブラウザに依存します。

Page 30: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

27

3. おこのみチャネル提供時の注意点

(1) iチャネルサービスにおけるドコモサーバの IPアドレス帯域は、以下の通りです。

① チャネル登録、チャネルコンテンツ取得時 → 210.136.160.0/25

② 詳細コンテンツ取得時 → 接続形態に依存

(2) iチャネルサービスに対してもアクセス制限サービスが適用されます。

(3) 公開済みのチャネル登録インタフェースはチャネル提供終了まで変更できません。別チャ

ネルとして提供する必要があります。同一ユーザが同一チャネルの再登録を行おうとした

際に、チャネル登録インタフェースの情報と登録済みのチャネル情報の不一致により、「こ

のチャネルはメンテナンス中です」とエラーが返却されます。チャネル名や詳細コンテン

ツ URL など、公開済みのチャネル登録インタフェースの各種情報を変更したい場合は、

「regurl」、「chid」のパラメータを変更して、別チャネルとして提供する必要があります。

(4) ユーザが国際ローミング中の場合、チャネルコンテンツ配信時にはローミングビット

(X-DCMRoaming ヘッダ)によりローミング状態が通知されますが、詳細コンテンツ配信時には

ローミングビットは付加されません。

Page 31: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

28

付録 1.URL エンコード対象文字について

チャネル登録インタフェースにおいて、URLエンコード対象文字の一覧を下記に示します

【URLエンコード対象文字一覧】

ASCII

コード 文字種 対象

エンコード

後の値

ASCII

コード 文字種 対象

エンコード

後の値

0x20 (スペース) ○ %20 0x3B ; ○ %3b

0x21 ! ○ %21 0x3C < ○

*1 %3c

0x22 " ○

*1 %22 0x3D = ○ %3d

0x23 # ○ %23 0x3E > ○

*1 %3e

0x24 $ ○ %24 0x3F ? ○ %3f

0x25 % ○ %25 0x40 @ ○ %40

0x26 & ○

*1 %26 0x41~0x5A A~Z ×

0x27 ' ○

*1 %27 0x5B [ ○ %5b

0x28 ( ○ %28 0x5C \ ○ %5c

0x29 ) ○ %29 0x5D ] ○ %5d

0x2A * ○ %2a 0x5E ^ ○ %5e

0x2B + ○ %2b 0x5F _ ×

0x2C , ○ %2c 0x60 ` ○ %60

0x2D - × 0x61~0x7A a~z ×

0x2E . × 0x7B { ○ %7b

0x2F / ○ %2f 0x7C | ○ %7c

0x30~

0x39 0~9 × 0x7D } ○ %7d

0x3A : ○ %3a 0x7E ~ ×

※○:URLエンコードの対象、×:URL エンコードの対象外

*1chname では使用不可

【URLエンコード対象文字一覧(サイズチェック時)】

半角文字 URLエンコード後

(スペース) %20

“ %22

# %23

% %25

& %26

* %2a

+ %2b

: %3a

< %3c

> %3e

? %3f

Page 32: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

29

付録 2.チャネル登録時のエラー内容

チャネル登録時のエラーメッセージ内容について以下に示します。

メッセージ 詳細内容

登録できるおこのみチャネルは 5

件までです

おこのみチャネルの登録数が既に 5 件登録している場合

設定できませんでした。再度おため

しください。

バックグラウンドでチャネルコンテンツ取得中の場合

i チャネル未契約です ・iチャネルサービス未契約の場合

・i チャネルおためしサービス契約中のユーザが海外からアク

セスした場合

正常に接続できませんでした パラメータが存在しない、またはサイズが想定外の場合

おためしサービス中は、おためし

サービスの終了(自動更新停止設

定)以外の設定はご利用いただけま

せん

おためしサービス契約中の場合

このチャネルは登録できません ・レスポンス形式が不正の場合

・レスポンスのステータスコードが 200 OK以外の場合

・レスポンスのボディ部に“result=NG”が設定されている場合

・realmパラメータが不正の場合

パスワードが間違っています パスワード認証でエラーが発生した場合

アクセス制限機能によりこのチャ

ネルは登録できません

spモードフィルタ契約ユーザが登録 URLの可否判定でエラーと

なった場合

既に登録されています 登録済みのおこのみチャネルを登録しようとした場合

ご指定のおこのみチャネルは現在、

削除処理中です。しばらくしてから

もう一度ご登録ください。

削除準備中状態のおこのみチャネルを登録しようとした場合

このチャネルはメンテナンス中で

チャネル登録インタフェースと登録済みのチャネル情報に不一

致がある場合

接続できません。しばらくおまちく

ださい

・OpenID取得時に輻輳が発生した又は、システムが規制中だっ

た場合

・アクセス制限問合せ時にドコモサーバが計画停止中の場合

指定サイトにつながりません ・コンテンツ提供者サイトに Connectできない

・DNSに IPアドレスが登録されていない

・Connectしたが、TCPリクエストの送信ができない

指定サイトから時間内に応答があ

りません。しばらくたってからもう

一度ご利用ください。

・Internet上の DNSに問い合わせしたが応答がない。

・一定時間以内に全てのレスポンスが返ってこない

Page 33: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

30

付録 3.チャネルコンテンツ配信インタフェースにおけるエラーコード

チャネルコンテンツ取得時にエラーが発生した場合、トピックテキストにエラーメッセージとエ

ラーコードが表示されます。各エラーコードの詳細を以下に示します。

エラー

コード エラー起因 エラー発生理由例

1111 取得コンテンツ コンテンツサイズの上限値を超過した場合

1112 取得コンテンツ 半角文字を記述した場合

1113 login レスポンスライン 存在しない場合

1114 login レスポンスライン 「200 OK」以外の場合

1115 login レスポンスヘッダ Set-Cookieがない場合

1116 login レスポンスヘッダ Content-Length がない場合

1117 login レスポンスボディ Resultがない場合

1118 login レスポンスボディ sessionがない場合

1119 login レスポンスボディ logoutがない場合

1120 login レスポンスボディ getdataがない場合

1121 login 処理結果コード result=fail-entry

1122 login 処理結果コード fail-auth

1123 login 処理結果コード fail-protoversion

1124 login 処理結果コード result=fail

1125 login 処理結果コード result=fail-access

1126 getdataレスポンスライン 存在しない場合

1127 getdataレスポンスライン 「200 OK」以外の場合

1128 getdataレスポンスヘッダ Content-Length がない場合

1129 getdataレスポンスボディ データが不正の場合

1130 getdata処理結果コード result=fail-entry

1131 getdata処理結果コード result=fail-auth

1132 getdata処理結果コード result=fail-protoversion

1133 getdata処理結果コード result=fail

1134 getdata処理結果コード result=fail-access

1135 getdata処理結果コード result=fail-session

1136 DNS DNSにホスト未存在の場合

1137 DNS DNSタイムアウト

1138 DNS DNS復旧不可エラー

1139 送信エラー、接続エラー login リクエスト送信エラー

1140 送信エラー、接続エラー getdataリクエスト送信エラー

1141 受信エラー、レスポンス解析エラー login レスポンス受信エラー

1142 受信エラー、レスポンス解析エラー getdataレスポンス受信エラー

1143 送信タイムアウト login リクエスト送信タイムアウト

1144 送信タイムアウト getdataリクエスト送信タイムアウト

1145 受信タイムアウト login レスポンス受信タイムアウト

1146 受信タイムアウト getdataレスポンス受信タイムアウト

1147 送信エラー、接続エラー コネクションエラー

1148 getdataレスポンスボディ バッファオーバー

1149 取得コンテンツ コンテンツサイズが 0byteの場合

1150 login 処理結果コード result=その他

1151 getdata処理結果コード result=その他

1152 DNS DNSに IP アドレスが未存在の場合

1153 接続処理 処理許容時間オーバー 接続処理にて処理許容時間を超過

1154 login 処理 処理許容時間オーバー login 処理にて処理許容時間を超過

Page 34: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

31

エラー

コード エラー起因 エラー発生理由例

1155 getdata 処理 リトライ時 処理許容

時間オーバー

getdata処理のリトライ時にて処理許容時間を超

1156 IP 輻輳対象

1157 相関チェック対象アイテム重複

1159 X-Client-Typeヘッダ不正

Page 35: sp モード版 - NTT Docomo...NTTドコモ(以下ドコモ)が提供するspモード向けiチャネルサービスにお けるおこのみチャネルについて、コンテンツ提供者とドコモ間の接続インタフェース及びコンテン

Copyright ©2016 NTT DOCOMO, Inc. All Rights Reserved.

32

付録 4.トピックテキストの表示上の注意点について

【i チャネル一覧の場合】

・ 端末の解像度により、行末が“・・・”(3点リーダー)により省略される場合があります。