mixi Developer Center (ミクシィ デベロッパーセンター)

mixi Connect

mixi Connect » mixi Graph API » 技術仕様 » Page API

Page API

mixiページはいまmixiでもっとも注目度の高いサービスのひとつです。
このPage APIを使うことで、mixiページの情報の取得やコメント・イイネ!の投稿が一段と容易になります。
また、Page APIをつかって専用のmixiページクライアントを作成したり、オリジナルのアプリケーションに組み込んだりすることが可能になるので、mixiページ上でのコミュニケーションがより一層円滑で活発なものとなるでしょう。

 

事前に必要なもの

Page APIを利用するためには、以下の情報をすでに入手している必要があります。

  • "r_page"または"r_pagefollow"または"w_pagefeed"スコープおよびそのいずれか複数またはこれら全てについて認可されたアクセストークン

上記以外のスコープで認可されたアクセストークンを使用して、Page APIにアクセスすることはできません。
アクセストークンの入手方法については、認証認可手順のページをご覧ください。

Page APIで提供される機能とスコープ

Page APIでは様々な機能が提供されますが、それらは大きく「参照系」「投稿系」の2つに分類されます。
この分類は、そのままPage APIを利用するためのスコープに対応します。以下に、スコープと各機能の対応を示します。

分類 スコープ 機能
参照系 r_page ページの検索
話題のページ取得
ページ情報取得
あるページのフィード一覧取得
あるフィードの情報取得
あるフィードのコメント取得
あるフィードのイイネ情報を取得
管理しているページの一覧取得
参照系 r_pagefollow フォローしているページの一覧取得
フォローページのフィード一覧取得
投稿系 w_pagefeed あるフィードへのコメント投稿
あるフィードのコメント削除
あるフィードへのイイネ!投稿
あるフィードのイイネ!削除
フィードの投稿

コンテンツとは

Page APIの説明には、「コンテンツ」「contentUri」などの単語が含まれています。
「コンテンツ」はmixiページアプリが扱う情報を示しています。
例えばイラストを描くアプリなら、描いたイラストが「コンテンツ」になります。

Page APIの中には、「コンテンツ」のURI(=contentUri)に紐づけてコメント・イイネを登録するものがあります。

ステータスコード

ステータスコード 意味
200 (OK) リクエストは正常に処理された
201 (CREATED) コメントやイイネ!の"投稿"が正常に処理された
204 (NO_CONTENT) コメントやイイネ!の"削除"が正常に処理された
400 (BAD_REQUEST) ページング指定値が不正、認証情報が不正、取得対象IDが未指定 など
403 (FORBIDDEN) 対象のページや情報にアクセス権限がない など
404 (NOT_FOUND) 指定されたIDのページやフィードが見つからない など
500 (INTERNAL_SERVER_ERROR) mixi側の内部エラー

ページング

Page APIはページングをサポートします。
ページングで指定できるcountパラメータの初期値は10件です。また、最大値は100件です。

絵文字の扱いについて

Page APIは、主に携帯電話端末で利用される絵文字の絵文字コードのキャリアごとの自動変換には対応しておりません。
本APIを使用して取得した結果に絵文字が含まれる場合、「[m:XX]」のようなmixiの内部表現で返されます。
また、本APIを使用したクライアントプログラムから絵文字を投稿する際は「[m:XX]」の形式で投稿してください。

詳しくは 絵文字対応表 をご参照ください。

fieldsパラメータ

クライアントプログラムは、fieldsパラメータを使用することで、取得する情報の項目を制限することができます。
fieldsパラメータを指定した場合、指定した項目のみを取得することができます。
fieldsパラメータは、取得したい属性名をカンマ区切りで列挙したものをクエリパラメータに指定します。例えば以下のようになります。

GET https://api.mixi-platform.com/2/followingPages/[User-ID]/@self?fields=details

fieldsパラメータを省略した場合は、APIが返す全ての項目が結果に含まれます。
また、fieldsパラメータでの指定有無に関係なく、 必須フィールド は必ず結果に含まれます。
必須フィールドは、各APIの「エントリ詳細」に (必須フィールド) と記載がありますのでご確認ください。

mixiページの検索結果の取得

mixiページの検索結果を取得するためのURIは以下となります。

GET https://api.mixi-platform.com/2/pages/search?query=[Keyword]
パラメータ名 指定する値
query (必須) 検索キーワードをUTF-8形式でURLエンコードしたもの
複数キーワードで検索する場合は、各キーワードを半角スペースで区切り、キーワード全体をUTF-8形式でURLエンコードする
category ページのカテゴリ。指定は任意で、省略された場合は all(=すべて) のカテゴリとして扱われる。
カテゴリ詳細は下記対応表を参考のこと。
sortBy ソート方法。指定は任意。

・follower...フォロワー数順にソート
・created...作成順にソート

省略した場合は follower
sortOrder ソート順。指定は任意。

・ascending...昇順にソート
・descending...降順にソート

省略した場合は descending(降順)

カテゴリー

all すべて
celebrity 著名人・アーティスト
brand ブランド・製品
event イベント
entertainment エンタテインメント
media メディア
internet WEB・インターネット
local サービス・地域店舗・スポット
company 企業・団体
hobby 趣味・テーマ
life 日常・ライフスタイル
group サークル・グループ
other その他

本APIの制限事項

ページの検索APIは「1分間に10回」という使用制限があります。
それ以上のリクエストにはHTTPステータスコード403とともに以下のようなエラーレスポンスが返ります。

{
    "error":"limit_exceeded",
    "error_description":"Limit Exceeded",
}

正常に取得できた場合は、以下のようなJSONレスポンスとなります。

{
    "entry" : [
        {
            "thumbnailUrls" : {
                "large" : "http://img.mixi.net/img/basic/common/noimage_logo180_001.gif",
                "small" : "http://img.mixi.net/img/basic/common/noimage_logo40_001.gif",
                "medium" : "http://img.mixi.net/img/basic/common/noimage_logo76_001.gif"
            },
            "options" : {
                "pcUrl" : "http://example.com/",
                "mobileUrl" : "http://example.com/m",
                "smartphoneUrl" : "http://example.com/sp",
                "birthday" : "1983-4-26"
            },
            "id" : "1234",
            "followerCount" : 123,
            "description" : "サンプル太郎の公式ページです。",
            "details" : "カリスマ美容師、サンプル太郎さんの公式mixiページがついに完成!",
            "displayName" : "サンプル太郎 公式ページ",
            "spots" : [
                {
                    "id": "S100",
                    "name": {
                        "formatted": "サンプル理容室"
                    },
                    "address": {
                        "formatted": "〒104-0061 東京都渋谷区身串1-2-3",
                        "latitude": "37.416343",
                        "longitude": "-122.153013",
                        "geohash" : "abc7h36zwv4g"
                    },
                    "categories": [ { "formatted": "サービス業" } ],
                    "description": "サンプル理容室 渋谷店"
                },
                ...
            ],
            "official" : true,
            "ageRating" : "G"
        },
        {
            "thumbnailUrls" : {
                "large" : "http://img.mixi.net/img/basic/common/noimage_logo180_001.gif",
                "small" : "http://img.mixi.net/img/basic/common/noimage_logo40_001.gif",
                "medium" : "http://img.mixi.net/img/basic/common/noimage_logo76_001.gif"
            },
            "options" : {
                "zipCode" : "123-4567",
                "pcUrl" : "http://some.company.jp/",
                "mobileUrl" : "http://some.company.jp/m",
                "smartphoneUrl" : "http://some.company.jp/sp",
                "address" : "東京都渋谷区渋谷1-2-3"
            },
            "id" : "1235",
            "followerCount" : 659,
            "details" : "ソーシャルネットワーク大手、サンプル興行ページ",
            "displayName" : "サンプル興行株式会社",
            "official" : true,
            "ageRating" : "G"
        }
    ],
    "startIndex" : 0,
    "itemsPerPage" : 10,
    "totalResults" : 2
}

個々のエントリに含まれる情報は、以下となります。

属性名 説明
id (必須フィールド) mixiページID
displayName (必須フィールド) mixiページの名前
thumbnailUrls.large mixiページのプロフィール画像(大)のURL
thumbnailUrls.medium mixiページのプロフィール画像(中)のURL
thumbnailUrls.small mixiページのプロフィール画像(小)のURL
description mixiページの説明
details mixiページの詳細
options.pcUrl ホームページURL PC
options. mobileUrl ホームページURL 携帯
options. smartphoneUrl ホームページURL スマートフォン
options.zipCode 郵便番号(カテゴリが「ブランド・製品」「イベント」「エンタテインメント」「メディア」「サービス・地域店舗・スポット」「企業・団体」の場合)
options.address 住所(カテゴリが「ブランド・製品」「イベント」「エンタテインメント」「メディア」「サービス・地域店舗・スポット」「企業・団体」の場合)
options.birthday 誕生日(カテゴリが「著名人・アーティスト」の場合)
followerCount mixiページのフォロワー数
spots ページ情報に紐付くスポット情報 ※スポット情報が存在しない場合は返されません
official オフィシャルページかどうかを真偽値で返します。
ageRating ページの年齢制限

"G" : 全年齢対応ページ
"R18" : 18歳未満はアクセスできないページ
"R20" : 20歳未満はアクセスできないページ

このAPIはページングをサポートします。

このAPIはfieldsパラメータをサポートします。

話題のmixiページの取得

話題のmixiページを取得するためのURIは以下となります。

GET https://api.mixi-platform.com/2/pages/hot

正常に取得できた場合は、以下のようなJSONレスポンスとなります。

{
   "entry" : [
      {
         "thumbnailUrls" : {
            "large" : "http://img.mixi.net/img/basic/common/noimage_logo180_001.gif",
            "small" : "http://img.mixi.net/img/basic/common/noimage_logo40_001.gif",
            "medium" : "http://img.mixi.net/img/basic/common/noimage_logo76_001.gif"
         },
         "options" : {
            "pcUrl" : "http://example.com/",
            "mobileUrl" : "http://example.com/m",
            "smartphoneUrl" : "http://example.com/sp",
            "birthday" : "1983-4-26"
         },
         "id" : "1234",
         "followerCount" : 1234,
         "description" : "サンプル太郎の公式ページです。",
         "details" : "カリスマ美容師、サンプル太郎さんの公式mixiページがついに完成!",
         "displayName" : "サンプル太郎 公式ページ",
         "spots" : [
              {
                  "id": "S100",
                  "name": {
                      "formatted": "サンプル理容室"
                  },
                  "address": {
                      "formatted": "〒104-0061 東京都渋谷区身串1-2-3",
                      "latitude": "37.416343",
                      "longitude": "-122.153013",
                      "geohash" : "abc7h36zwv4g"
                  },
                  "categories": [ { "formatted": "サービス業" } ],
                  "description": "サンプル理容室 渋谷店"
              },
              ...
          ],
          "official" : true,
          "ageRating" : "G"
      },
      {
         "thumbnailUrls" : {
            "large" : "http://img.mixi.net/img/basic/common/noimage_logo180_001.gif",
            "small" : "http://img.mixi.net/img/basic/common/noimage_logo40_001.gif",
            "medium" : "http://img.mixi.net/img/basic/common/noimage_logo76_001.gif"
         },
         "options" : {
            "zipCode" : "123-4567",
            "pcUrl" : "http://some.company.jp/",
            "mobileUrl" : "http://some.company.jp/m",
            "smartphoneUrl" : "http://some.company.jp/sp",
            "address" : "東京都渋谷区渋谷1-2-3"
         },
         "id" : "1235",
         "followerCount" : 659,
         "details" : "ソーシャルネットワーク大手、サンプル興行ページ",
         "displayName" : "サンプル興行株式会社",
         "official" : true,
         "ageRating" : "G"
      }
      ....
   ],
   "startIndex" : 0,
   "itemsPerPage" : 10,
   "totalResults" : 100
}

個々のエントリに含まれる情報は、以下となります。

属性名 説明
id (必須フィールド) mixiページID
displayName (必須フィールド) mixiページの名前
thumbnailUrls.large mixiページのプロフィール画像(大)のURL
thumbnailUrls.medium mixiページのプロフィール画像(中)のURL
thumbnailUrls.small mixiページのプロフィール画像(小)のURL
description mixiページの説明
details mixiページの詳細
options.pcUrl ホームページURL PC
options. mobileUrl ホームページURL 携帯
options. smartphoneUrl ホームページURL スマートフォン
options.zipCode 郵便番号(カテゴリが「ブランド・製品」「イベント」「エンタテインメント」「メディア」「サービス・地域店舗・スポット」「企業・団体」の場合)
options.address 住所(カテゴリが「ブランド・製品」「イベント」「エンタテインメント」「メディア」「サービス・地域店舗・スポット」「企業・団体」の場合)
options.birthday 誕生日(カテゴリが「著名人・アーティスト」の場合)
followerCount mixiページのフォロワー数
spots ページ情報に紐付くスポット情報 ※スポット情報が存在しない場合は返されません
official オフィシャルページかどうかを真偽値で返します。
ageRating ページの年齢制限

"G" : 全年齢対応ページ
"R18" : 18歳未満はアクセスできないページ
"R20" : 20歳未満はアクセスできないページ

このAPIはページングをサポートします。

このAPIはfieldsパラメータをサポートします。

あるmixiページの情報を取得

あるmixiページの情報を取得するためのURIは以下となります。

GET https://api.mixi-platform.com/2/pages/[Page-ID]
パラメータ名 指定する値
Page-ID mixiページのID

正常に取得できた場合は、以下のようなJSONレスポンスとなります。

{
    "entry" : {
        "id" : "12345678901234567890",
        "displayName" : "mixiページ名",
        "thumbnailUrls" : {
            "large" : "http://img.mixi.jp/img/basic/common/noimage_w180_001.gif",
            "medium" : "http://img.mixi.jp/img/basic/common/noimage_w76_001.gif",
            "small" : "http://img.mixi.jp/img/basic/common/noimage_w40_001.gif"
        },
        "details" : "mixiページの説明文",
        "description" : "サンプル太郎の公式ページです。",
        "options" : {
            "zipCode" : "150-0002",
            "address" : "東京都渋谷区渋谷3-3-5 NBF渋谷イースト5F"
        },
        "followerCount" : 1000,
        "spots" : [
            {
                "id": "S100",
                "name": {
                    "formatted": "サンプル理容室"
                },
                "address": {
                    "formatted": "〒104-0061 東京都渋谷区身串1-2-3",
                    "latitude": "37.416343",
                    "longitude": "-122.153013",
                    "geohash" : "abc7h36zwv4g"
                },
                "categories": [ { "formatted": "サービス業" } ],
                "description": "サンプル理容室 渋谷店"
            },
            ...
        ],
        "official" : true,
        "ageRating" : "G"
    }
}

個々のエントリに含まれる情報は、以下となります。

属性名 説明
id (必須フィールド) mixiページID
displayName (必須フィールド) mixiページの名前
thumbnailUrls.large mixiページのプロフィール画像(大)のURL
thumbnailUrls.medium mixiページのプロフィール画像(中)のURL
thumbnailUrls.small mixiページのプロフィール画像(小)のURL
description mixiページの説明
details mixiページの詳細
options.pcUrl ホームページURL PC
options. mobileUrl ホームページURL 携帯
options. smartphoneUrl ホームページURL スマートフォン
options.zipCode 郵便番号(カテゴリが「ブランド・製品」「イベント」「エンタテインメント」「メディア」「サービス・地域店舗・スポット」「企業・団体」の場合)
options.address 住所(カテゴリが「ブランド・製品」「イベント」「エンタテインメント」「メディア」「サービス・地域店舗・スポット」「企業・団体」の場合)
options.birthday 誕生日(カテゴリが「著名人・アーティスト」の場合)
followerCount mixiページのフォロワー数
spots ページ情報に紐付くスポット情報 ※スポット情報が存在しない場合は返されません
official オフィシャルページかどうかを真偽値で返します。
ageRating ページの年齢制限

"G" : 全年齢対応ページ
"R18" : 18歳未満はアクセスできないページ
"R20" : 20歳未満はアクセスできないページ

このAPIはfieldsパラメータをサポートします。

フォローしているmixiページの一覧を取得

フォローしているmixiページの一覧を取得するためのURIは以下となります。

GET https://api.mixi-platform.com/2/followingPages/[User-ID]/@self
パラメータ名 指定する値
User-ID 取得したいユーザのID、または"@me"

正常に取得できた場合は、以下のようなJSONレスポンスとなります。

{
    "entry" : [
        {
            "thumbnailUrls" : {
                "large" : "http://img.mixi.net/img/basic/common/noimage_logo180_001.gif",
                "small" : "http://img.mixi.net/img/basic/common/noimage_logo40_001.gif",
                "medium" : "http://img.mixi.net/img/basic/common/noimage_logo76_001.gif"
            },
            "options" : {
                "pcUrl" : "http://example.com/",
                "mobileUrl" : "http://example.com/m",
                "smartphoneUrl" : "http://example.com/sp",
                "birthday" : "1983-4-26"
            },
            "id" : "1234",
            "followerCount" : 123,
            "description" : "サンプル太郎の公式ページです。",
            "details" : "カリスマ美容師、サンプル太郎さんの公式mixiページがついに完成!",
            "displayName" : "サンプル太郎 公式ページ",
            "spots" : [
                {
                    "id": "S100",
                    "name": {
                        "formatted": "サンプル理容室"
                    },
                    "address": {
                        "formatted": "〒104-0061 東京都渋谷区身串1-2-3",
                        "latitude": "37.416343",
                        "longitude": "-122.153013",
                        "geohash" : "abc7h36zwv4g"
                    },
                    "categories": [ { "formatted": "サービス業" } ],
                    "description": "サンプル理容室 渋谷店"
                },
                ...
            ],
            "official" : true,
            "ageRating" : "G"
        },
        {
            "thumbnailUrls" : {
                "large" : "http://img.mixi.net/img/basic/common/noimage_logo180_001.gif",
                "small" : "http://img.mixi.net/img/basic/common/noimage_logo40_001.gif",
                "medium" : "http://img.mixi.net/img/basic/common/noimage_logo76_001.gif"
            },
            "options" : {
                "zipCode" : "123-4567",
                "pcUrl" : "http://some.company.jp/",
                "mobileUrl" : "http://some.company.jp/m",
                "smartphoneUrl" : "http://some.company.jp/sp",
                "address" : "東京都渋谷区渋谷1-2-3"
            },
            "id" : "1235",
            "followerCount" : 659,
            "details" : "ソーシャルネットワーク大手、サンプル興行ページ",
            "displayName" : "サンプル興行株式会社",
            "official" : true,
            "ageRating" : "G"
        }
    ],
    "startIndex" : 0,
    "itemsPerPage" : 10,
    "totalResults" : 2
}

個々のエントリに含まれる情報は、以下となります。

属性名 説明
id (必須フィールド) mixiページID
displayName (必須フィールド) mixiページの名前
thumbnailUrls.large mixiページのプロフィール画像(大)のURL
thumbnailUrls.medium mixiページのプロフィール画像(中)のURL
thumbnailUrls.small mixiページのプロフィール画像(小)のURL
description mixiページの説明
details mixiページの詳細
options.pcUrl ホームページURL PC
options. mobileUrl ホームページURL 携帯
options. smartphoneUrl ホームページURL スマートフォン
options.zipCode 郵便番号(カテゴリが「ブランド・製品」「イベント」「エンタテインメント」「メディア」「サービス・地域店舗・スポット」「企業・団体」の場合)
options.address 住所(カテゴリが「ブランド・製品」「イベント」「エンタテインメント」「メディア」「サービス・地域店舗・スポット」「企業・団体」の場合)
options.birthday 誕生日(カテゴリが「著名人・アーティスト」の場合)
followerCount mixiページのフォロワー数
spots ページ情報に紐付くスポット情報 ※スポット情報が存在しない場合は返されません
official オフィシャルページかどうかを真偽値で返します。
ageRating ページの年齢制限

"G" : 全年齢対応ページ
"R18" : 18歳未満はアクセスできないページ
"R20" : 20歳未満はアクセスできないページ

このAPIはページングをサポートします。

このAPIはfieldsパラメータをサポートします。

あるmixiページのフィード一覧を取得

あるmixiページのフィード一覧を取得するためのURIは以下となります。

GET https://api.mixi-platform.com/2/pages/[Page-ID]/feeds
パラメータ名 指定する値
Page-ID mixiページのID
type フィードの投稿者。省略可。

・owner...ページの管理者
・user...通常のユーザ

省略した場合は、管理者・ユーザ両方のフィードを取得する。

正常に取得できた場合は、以下のようなJSONレスポンスとなります。

{
    "entry" : [
        {
            "contentUri" : "http://www.application.com/id=12345",
            "title" : "タイトル",
            "body" : "本文",
            "urls" : {
                "pcUrl" : "http://mixi.jp/run_page_appli.pl?page_id=0&module_id=0&appParams=%7B%22uid%22%3A%221569%22%7D",
                "mobileUrl" : "",
                "smartphoneUrl" : ""
            },
            "images" : [
                {
                    "large" : "http://img.mixi.jp/img/basic/common/noimage_w180_001.gif",
                    "medium" : "http://img.mixi.jp/img/basic/common/noimage_w76_001.gif",
                    "small" : "http://img.mixi.jp/img/basic/common/noimage_w40_001.gif"
                }
            ],
            "user" : {
                "id" : "qgjw86yg5djw",
                "displayName" : "ニックネーム",
                "thumbnailUrl" : "http://img.mixi.jp/img/basic/common/noimage_member180.gif"
            },
            "favoriteCount" : 4632,
            "commentCount" : 274,
            "sourceName" : "メニュー名",
            "created" : "2010-11-02T10:42:57+09:00",
            "isOwnerPosted" : true
        },
        ....
    ],
    "startIndex" : 0,
    "itemsPerPage" : 10,
    "totalResults" : 24
}

個々のエントリに含まれる情報は、以下となります。

属性名 説明
contentUri (必須フィールド) コンテンツのURI
body (必須フィールド) フィードの本文
title フィードのタイトル
urls.pcUrl 投稿元へ遷移するパーマネントURL(PC用)
urls.mobileUrl 投稿元へ遷移するパーマネントURL(モバイル用)
urls.smartphoneUrl 投稿元へ遷移するパーマネントURL(スマートフォン用)
images.large フィードの添付画像(大)のURL
images.medium フィードの添付画像(中)のURL
images.small フィードの添付画像(小)のURL
user.id フィード投稿者のID
user.displayName フィード投稿者のニックネーム
user.thumbnailUrl フィード投稿者のプロフィール画像のURL
favoriteCount コンテンツのイイネ!の数
commentCount コンテンツのコメントの数
sourceName フィード投稿元のアプリ名称
created フィードの作成日時。書式はW3C-DTF形式
isOwnerPosted ページのオーナーによるポストか否か。形式は boolean (true / false)

このAPIはページングをサポートします。

このAPIはfieldsパラメータをサポートします。

あるmixiページの特定のフィード情報を取得

あるmixiページの特定のフィード情報を取得するためのURIは以下となります。

GET https://api.mixi-platform.com/2/pages/[Page-ID]/feeds?contentUri=[ContentURI]
パラメータ名 指定する値
Page-ID mixiページのID
contentUri フィードのコンテンツを示すURIを、UTF-8でURLエンコードして指定

正常に取得できた場合は、以下のようなJSONレスポンスとなります。

{
    "entry" : {
        "contentUri" : "http://www.application.com/id=12345",
        "title" : "タイトル",
        "body" : "本文",
        "urls" : {
            "pcUrl" : "http://mixi.jp/run_page_appli.pl?page_id=0&module_id=0&appParams=%7B%22uid%22%3A%221569%22%7D",
            "mobileUrl" : "",
            "smartphoneUrl" : ""
        },
        "images" : [
            {
                "large" : "http://img.mixi.jp/img/basic/common/noimage_w180_001.gif",
                "medium" : "http://img.mixi.jp/img/basic/common/noimage_w76_001.gif",
                "small" : "http://img.mixi.jp/img/basic/common/noimage_w40_001.gif"
            }
        ],
        "user" : {
            "id" : "qgjw86yg5djw",
            "displayName" : "ニックネーム",
            "thumbnailUrl" : "http://img.mixi.jp/img/basic/common/noimage_member180.gif"
        },
        "favoriteCount" : 4632,
        "commentCount" : 274,
        "sourceName" : "メニュー名",
        "created" : "2010-11-02T10:42:57+09:00",
        "isOwnerPosted" : true
    }
}

個々のエントリに含まれる情報は、以下となります。

属性名 説明
contentUri (必須フィールド) コンテンツのURI
body (必須フィールド) フィードの本文
title フィードのタイトル
urls.pcUrl 投稿元へ遷移するパーマネントURL(PC用)
urls.mobileUrl 投稿元へ遷移するパーマネントURL(モバイル用)
urls.smartphoneUrl 投稿元へ遷移するパーマネントURL(スマートフォン用)
images.large フィードの添付画像(大)のURL
images.medium フィードの添付画像(中)のURL
images.small フィードの添付画像(小)のURL
user.id フィード投稿者のID
user.displayName フィード投稿者のニックネーム
user.thumbnailUrl フィード投稿者のプロフィール画像のURL
favoriteCount コンテンツのイイネ!の数
commentCount コンテンツのコメントの数
sourceName フィード投稿元のアプリ名称
created フィードの作成日時。書式はW3C-DTF形式
isOwnerPosted ページのオーナーによるポストか否か。形式は boolean (true / false)

このAPIはfieldsパラメータをサポートします。

フォローしているmixiページのフィード一覧の取得

フォローしているmixiページのフィード一覧を取得するためのURIは以下となります。

GET https://api.mixi-platform.com/2/followingPages/@me/@self/feeds

正常に取得できた場合は、以下のようなJSONレスポンスとなります。

{
    "entry" : [
        {
            "contentUri" : "http://www.application.com/id=12345",
            "title" : "タイトル",
            "body" : "本文",
            "urls" : {
                "pcUrl" : "http://mixi.jp/run_page_appli.pl?page_id=0&module_id=0&appParams=%7B%22uid%22%3A%221569%22%7D",
                "mobileUrl" : "",
                "smartphoneUrl" : ""
            },
            "images" : [
                {
                    "large" : "http://img.mixi.jp/img/basic/common/noimage_w180_001.gif",
                    "medium" : "http://img.mixi.jp/img/basic/common/noimage_w76_001.gif",
                    "small" : "http://img.mixi.jp/img/basic/common/noimage_w40_001.gif"
                }
            ],
            "user" : {
                "id" : "qgjw86yg5djw",
                "displayName" : "ニックネーム",
                "thumbnailUrl" : "http://img.mixi.jp/img/basic/common/noimage_member180.gif"
            },
            "page" : {
                "id" : "1234",
                "displayName" : "mixiページ名"
            },
            "favoriteCount" : 4632,
            "commentCount" : 274,
            "sourceName" : "メニュー名",
            "created" : "2010-11-02T10:42:57+09:00",
            "isOwnerPosted" : true
        },
        ....
    ],
    "startIndex" : 0,
    "itemsPerPage" : 10,
    "totalResults" : 24
}

個々のエントリに含まれる情報は、以下となります。

属性名 説明
contentUri (必須フィールド) コンテンツのURI
body (必須フィールド) フィードの本文
title フィードのタイトル
urls.pcUrl 投稿元へ遷移するパーマネントURL(PC用)
urls.mobileUrl 投稿元へ遷移するパーマネントURL(モバイル用)
urls.smartphoneUrl 投稿元へ遷移するパーマネントURL(スマートフォン用)
images.large フィードの添付画像(大)のURL
images.medium フィードの添付画像(中)のURL
images.small フィードの添付画像(小)のURL
user.id フィード投稿者のID
user.displayName フィード投稿者のニックネーム
user.thumbnailUrl フィード投稿者のプロフィール画像のURL
page.id このフィードの投稿元mixiページ
page.displayName このフィードの投稿元mixiページ名
favoriteCount コンテンツのイイネ!の数
commentCount コンテンツのコメントの数
sourceName フィード投稿元のアプリ名称
created フィードの作成日時。書式はW3C-DTF形式
isOwnerPosted ページのオーナーによるポストか否か。形式は boolean (true / false)

このAPIはページングをサポートします。

このAPIはfieldsパラメータをサポートします。

あるフィードのコメントを取得

あるフィードのコメントを取得するためのURIは以下となります。

GET https://api.mixi-platform.com/2/pages/[Page-ID]/comments/[Comment-ID]?contentUri=[ContentURI]
パラメータ名 指定する値
Page-ID mixiページのID
contentUri コンテンツのURI
Comment-ID コメントを特定するID。(省略可)
指定された場合はそのコメント 単体 を、省略した場合はコメントの 一覧 を取得します。

正常に取得できた場合は、以下のようなJSONレスポンスとなります。

コメント単体取得時

{
    "entry" : {
        "id" : "1FZ3P4ACUWBBC-20090520180336",
        "comment" : "コメント本文",
        "user" : {
            "id" : "qgjw87yg3djw",
            "displayName" : "ニックネーム",
            "thumbnailUrl" : "http://img.mixi.jp/img/basic/common/noimage_member180.gif"
        },
        "created" : "2010-11-02T10:42:57+09:00",
        "isOwnerPosted" : true
    }
}

コメント一覧取得時

{
    "entry" : [
        {
            "id" : "1FZ3P4ACUWBBC-20090520180336",
            "comment" : "コメント本文",
            "user" : {
                "id" : "qgjw87yg3djw",
                "displayName" : "ニックネーム",
                "thumbnailUrl" : "http://img.mixi.jp/img/basic/common/noimage_member180.gif"
            },
            "created" : "2010-11-02T10:42:57+09:00",
            "isOwnerPosted" : true
        },
        ....
    ],
    "startIndex" : 0,
    "itemsPerPage" : 10,
    "totalResults" : 24
}

個々のエントリに含まれる情報は、以下となります。

属性名 説明
id (必須フィールド) コメントID (Comment-ID)
comment (必須フィールド) コメント本文
user.id コメント投稿者のユーザのID
user.displayName コメント投稿者のニックネーム
user.thumbnailUrl コメント投稿者のプロフィール画像のURL
created コメントの作成日時。書式はW3C-DTF形式
isOwnerPosted ページのオーナーによるポストか否か。形式は boolean (true / false)

このAPIはページングをサポートします。

このAPIはfieldsパラメータをサポートします。

備考

Comment-ID に対応するコメントが見つからなかった場合、HTTPステータスコード404と共に、以下の様なJSONレスポンスが返却されます。

{
    "error" : "not_found",
    "error_description" : "The comment isn't found."
}

あるフィードへコメントを投稿

あるフィードへコメントを投稿するためのURIは以下となります。

POST https://api.mixi-platform.com/2/pages/[Page-ID]/comments?contentUri=[ContentURI]
パラメータ名 指定する値
Page-ID コメントを残すmixiページのID
contentUri フィードのコンテンツを示すURIを、UTF-8でURLエンコードして指定

コメント本文は、application/json形式でリクエストボディに指定します。 指定する内容は、以下のようになります。

{
    "comment" : "コメント本文"
}

コメント本文に指定する文字列の文字コードはUTF-8とし、それをURIエンコードした結果を指定します。

コメントの投稿に成功した場合は、HTTPステータスコード201および以下の内容を含むJSONがレスポンスボディとして返却されます。

{
    "id" : "1FZ3P4ACUWBBC-20090520180336"
}

個々のエントリに含まれる情報は、以下となります。

属性名 説明
id コメントを特定するためのComment-ID

あるフィードのコメントを削除

あるフィードのコメントを削除するためのURIは以下となります。

DELETE https://api.mixi-platform.com/2/pages/[Page-ID]/comments/[Comment-ID]?contentUri=[ContentURI]
パラメータ名 指定する値
Page-ID コメントを残すmixiページのID
Comment-ID 削除したいコメントを特定するためのID
contentUri フィードのコンテンツを示すURIを、UTF-8でURLエンコードして指定

コメント削除に成功した場合は、HTTPステータスコード204が返却されます。

あるフィードのイイネ情報を取得

あるフィードのイイネ情報を取得するためのURIは以下となります。

GET https://api.mixi-platform.com/2/pages/[Page-ID]/favorites?contentUri=[ContentURI]
Page-ID mixiページのID
contentUri フィードのコンテンツを示すURIを、UTF-8でURLエンコードして指定

正常に取得できた場合は、以下のようなJSONレスポンスとなります。

{
    "count" : 1234,
    "favorited" : true,
    "favoriteId" : "t7mn5bas374kc"
}

個々のエントリに含まれる情報は、以下となります。

属性名 説明
count コンテンツに紐づくイイネ数
favorited 自分が対象のコンテンツにイイネしたかどうかをbooleanで返す。
favoriteId イイネしていた場合、そのFavorite IDを返す。

あるフィードへイイネ!を投稿

あるフィードへイイネ!を投稿するためのURIは以下となります。

POST https://api.mixi-platform.com/2/pages/[Page-ID]/favorites?contentUri=[ContentURI]
パラメータ名 指定する値
Page-ID イイネ!を投稿するmixiページのID
contentUri フィードのコンテンツを示すURIを、UTF-8でURLエンコードして指定

イイネ!の投稿に成功した場合は、HTTPステータスコード201および以下の内容を含むJSONがレスポンスボディとして返却されます。

{
    "id" : "t7mn5bas374kc"
}

個々のエントリに含まれる情報は、以下となります。

属性名 説明
id イイネ!を特定するためのFavorite-ID

あるフィードのイイネ!を削除

あるフィードのイイネ!を削除するためのURIは以下となります。

DELETE https://api.mixi-platform.com/2/pages/[Page-ID]/favorites/[Favorite-ID]?contentUri=[ContentURI]
パラメータ名 指定する値
Page-ID イイネ!を削除するmixiページのID
Favorite-ID 削除したいイイネ!を特定するためのFavorite-ID
contentUri フィードのコンテンツを示すURIを、UTF-8でURLエンコードして指定

イイネ!の削除に成功した場合は、HTTPステータスコード204が返却されます。

管理しているmixiページの一覧を取得

自分が管理しているmixiページの一覧を取得するURIは以下となります。

GET https://api.mixi-platform.com/2/managingPages/@me/@self

正常に取得できた場合は、以下のようなJSONレスポンスとなります。

{
    "entry" : [
        {
            "thumbnailUrls" : {
                "large" : "http://img.mixi.net/img/basic/common/noimage_logo180_001.gif",
                "small" : "http://img.mixi.net/img/basic/common/noimage_logo40_001.gif",
                "medium" : "http://img.mixi.net/img/basic/common/noimage_logo76_001.gif"
            },
            "options" : {
                "pcUrl" : "http://example.com/",
                "mobileUrl" : "http://example.com/m",
                "smartphoneUrl" : "http://example.com/sp",
                "birthday" : "1983-4-26"
            },
            "id" : "1234",
            "followerCount" : 123,
            "description" : "サンプル太郎の公式ページです。",
            "details" : "カリスマ美容師、サンプル太郎さんの公式mixiページがついに完成!",
            "displayName" : "サンプル太郎 公式ページ",
            "spots" : [
                {
                    "id": "S100",
                    "name": {
                        "formatted": "サンプル理容室"
                    },
                    "address": {
                        "formatted": "〒104-0061 東京都渋谷区身串1-2-3",
                        "latitude": "37.416343",
                        "longitude": "-122.153013",
                        "geohash" : "abc7h36zwv4g"
                    },
                    "categories": [ { "formatted": "サービス業" } ],
                    "description": "サンプル理容室 渋谷店"
                },
                ...
            ],
            "official" : true,
            "ageRating" : "G"
        },
        {
            "thumbnailUrls" : {
                "large" : "http://img.mixi.net/img/basic/common/noimage_logo180_001.gif",
                "small" : "http://img.mixi.net/img/basic/common/noimage_logo40_001.gif",
                "medium" : "http://img.mixi.net/img/basic/common/noimage_logo76_001.gif"
            },
            "options" : {
                "zipCode" : "123-4567",
                "pcUrl" : "http://some.company.jp/",
                "mobileUrl" : "http://some.company.jp/m",
                "smartphoneUrl" : "http://some.company.jp/sp",
                "address" : "東京都渋谷区渋谷1-2-3"
            },
            "id" : "1235",
            "followerCount" : 659,
            "details" : "ソーシャルネットワーク大手、サンプル興行ページ",
            "displayName" : "サンプル興行株式会社",
            "official" : true,
            "ageRating" : "G"
        }
    ],
    "startIndex" : 0,
    "itemsPerPage" : 10,
    "totalResults" : 2
}

個々のエントリに含まれる情報は、以下となります。

属性名 説明
id (必須フィールド) mixiページID
displayName (必須フィールド) mixiページの名前
thumbnailUrls.large mixiページのプロフィール画像(大)のURL
thumbnailUrls.medium mixiページのプロフィール画像(中)のURL
thumbnailUrls.small mixiページのプロフィール画像(小)のURL
description mixiページの説明
details mixiページの詳細
options.pcUrl ホームページURL PC
options. mobileUrl ホームページURL 携帯
options. smartphoneUrl ホームページURL スマートフォン
options.zipCode 郵便番号(カテゴリが「ブランド・製品」「イベント」「エンタテインメント」「メディア」「サービス・地域店舗・スポット」「企業・団体」の場合)
options.address 住所(カテゴリが「ブランド・製品」「イベント」「エンタテインメント」「メディア」「サービス・地域店舗・スポット」「企業・団体」の場合)
options.birthday 誕生日(カテゴリが「著名人・アーティスト」の場合)
followerCount mixiページのフォロワー数
spots ページ情報に紐付くスポット情報 ※スポット情報が存在しない場合は返されません
official オフィシャルページかどうかを真偽値で返します。
ageRating ページの年齢制限

"G" : 全年齢対応ページ
"R18" : 18歳未満はアクセスできないページ
"R20" : 20歳未満はアクセスできないページ

このAPIはページングをサポートします。

このAPIはfieldsパラメータをサポートします。

フィードの投稿

本APIの制限事項

本APIはページの管理者・副管理者が、自身の管理するページに対してしか利用することができません。
それ以外の場合は HTTP 403 Forbidden が返ります。

フィードを投稿するためのURIは以下となります。

POST http://api.mixi-platform.com/2/pages/[Page-ID]/feeds
パラメータ名 指定する値
Page-ID mixiページのID

画像なしフィードの投稿

フィード本文は、application/json形式でリクエストボディに指定します。
指定する内容は、以下のようになります。

{
    "contentUri" : "http://www.application.com/id=12345",
    "title" : "タイトル",
    "body" : "本文",
        "urls" : {
            "pcUrl" : "http://mixi.jp/run_page_appli.pl?page_id=0&module_id=0&appParams=%7B%22uid%22%3A%221569%22%7D",
            "mobileUrl" : "",
            "smartphoneUrl" : ""
        },
    "sourceId" : "3"
}

指定する内容は、以下のようになります。

属性名 説明
contentUri コンテンツのURI
title フィードのタイトル
body フィードの本文
urls.pcUrl 投稿元へ遷移するパーマネントURL(PC用)
urls.mobileUrl 投稿元へ遷移するパーマネントURL(モバイル用)
urls.smartphoneUrl 投稿元へ遷移するパーマネントURL(スマートフォン用)
sourceId モジュールID (Module-ID)

「contentUri」を省略すると、mixiページのフィード詳細画面のURLが割り当てられます。 フィードを投稿するアプリなど、アプリでコンテンツを持たない場合は「contentUri」を省略してご利用ください。

「sourceId」は、フィード投稿に使われたアプリの名称を決めるための項目です。 現在はモジュールIDのみ指定することができ、モジュールIDを指定すると「メニューに表示する名称」、省略すると「アプリそのものの名称」となります。

※現在、mixiページ上では、投稿対象ページのページ管理者の投稿しか反映されませんのでご注意ください。

画像付きフィードの投稿

フィードを投稿する際に、そのフィードに関する画像も同時に投稿することができます。その方法は2種類提供されています。

  • 画像のURLを指定したフィードの投稿 (application/json形式)
  • 画像を直接添付したフィードの投稿 (multipart/form-data形式)

フィード本文は、application/json形式でリクエストボディに指定します。 指定する内容は、以下のようになります。

{
    "contentUri" : "http://www.application.com/id=12345",
    "title" : "タイトル",
    "body" : "本文",
    "urls" : {
        "pcUrl" : "http://mixi.jp/run_page_appli.pl?page_id=0&module_id=0&appParams=%7B%22uid%22%3A%221569%22%7D",
        "mobileUrl" : "",
        "smartphoneUrl" : ""
    },
    "sourceId" : "3",
    "imageUrls" : [
        "http://www.imageurl.com/image/photo1.jpeg"
    ]
}

指定する内容は、以下のようになります。

属性名 説明
contentUri コンテンツのURI
title フィードのタイトル
body フィードの本文
urls.pcUrl 投稿元へ遷移するパーマネントURL(PC用)
urls.mobileUrl 投稿元へ遷移するパーマネントURL(モバイル用)
urls.smartphoneUrl 投稿元へ遷移するパーマネントURL(スマートフォン用)
sourceId モジュールID (Module-ID)
imageUrls 添付したい画像のURL。1枚のみ指定できます。

添付画像の対応フォーマットはjpeg, pngです。

画像を直接添付したフィードの投稿 (multipart/form-data形式)

画像付きのフィード投稿する方法として、上述の imageUrl を利用する方法とは別に、画像を直接添付してフィードを投稿することができます。

フィードを投稿するためのURIは、通常のフィード投稿時と同様の形式です。 Content-Typeリクエストヘッダには"multipart/form-data"を指定し、リクエストボディには以下のようにフィード情報と画像を指定します。 フィード情報はJSON形式で指定し、画像はバイナリデータを指定します。 指定する内容は、以下のようになります。

boundary文字列
Content-Disposition: form-data; name="request"
{
    "contentUri" : "http://www.application.com/id=12345",
    "title" : "タイトル",
    "body" : "本文",
    "urls" : {
        "pcUrl" : "http://mixi.jp/run_page_appli.pl?page_id=0&module_id=0&appParams=%7B%22uid%22%3A%221569%22%7D",
        "mobileUrl" : "",
        "smartphoneUrl" : ""
    },
    "sourceId" : "3"
}
boundary文字列
Content-Disposition: form-data; name="image1"; filename="添付画像1.jpg"
Content-Type: image/jpeg
.......添付画像のバイナリデータ

指定する内容は、以下のようになります。

属性名 説明
contentUri コンテンツのURI
title フィードのタイトル
body フィードの本文
urls.pcUrl 投稿元へ遷移するパーマネントURL(PC用)
urls.mobileUrl 投稿元へ遷移するパーマネントURL(モバイル用)
urls.smartphoneUrl 投稿元へ遷移するパーマネントURL(スマートフォン用)
sourceId モジュールID (Module-ID)

boundary文字列で区切った各要素は、フィード情報はname="request"を、画像はimage1を指定してください。 画像は1枚まで指定可能です。 添付画像の対応フォーマットはjpeg, pngです。

フィードの投稿に成功した場合は、HTTPステータスコード201および以下の内容を含むJSONがレスポンスボディとして返却されます。

{
    "contentUri" : [ContentURI]
}

エラー情報

重複する contentUri

フィードはページの一意なコンテンツ(contentUri)に紐付くので、新しいフィード投稿時に、すでに対象のcontentUriに紐付くフィードが存在する場合、以下のようなエラーが返されます。

# HTTPステータスコード 400
# application/json
 
{
    "error" : "parameter_invalid",
    "error_description" : "The contentUri has already found."
}

このページの上部へ