2018年4月22日(日) 17:36 JST

TypePad JSON API 解説ページを和訳 (対訳)

おしらせ

TypePad JSON API
http://everything.typepad.jp/elt/2010/04/typepad-json-api.html

TypePad's JSON-based API provides an interface for client developers to interact with content stored on TypePad, and to build new applications on top of TypePad's infrastructure.

TypePadのJSONベースAPIはTypePad内のコンテンツに対応するインターフェイスをクライアント開発者に提供します。

Getting Started ¶
始める際に

    * Introduction: Some general information about how the API is structured and the conventions it uses.
    * Authentication: How to authenticate to the TypePad JSON API.
    * Rate Limiting: Information about the usage limits for the API.
    *紹介:APIがどのように構成されているか、どのように使うのかの情報です。
    *認証:TypePad JSON APIをどのように認証するかについて
    *使用制限:APIの使用制限についての情報

API Endpoints ¶
APIのエンドポイント

The following list describes each endpoint supported by the TypePad API, including a link to a page describing that endpoint, including which HTTP methods it supports, what request parameters it expects and what kind of object it returns.
以下にTypePad APIでサポートするエンドポイントを紹介する。以下の情報も含む。そのエンドポイントが述べてあるページへのリンク、また、どのHTTPメソッドをサポートし、どのリクエストパラメータを必要とし、どのオブジェクトを返すのか。

Api Keys ¶
APIキー

/api-keys/<id>
    Get basic information about the selected API key, including what application it belongs to.
    選択されたAPIキーがどのアプリケーションに属するかなどの基本情報を取得する。

Applications ¶
アプリケーション

/applications/<id>
    Get basic information about the selected application.
    選択されたアプリケーションについての基本情報を取得する
/applications/<id>/badges
    Get a list of badges defined by this application.
    このアプリケーションで定義されたバッジのリストを取得する
/applications/<id>/create-external-feed-subscription
    Subscribe the application to one or more external feeds.
    ひとつ以上の外部RSSフィードのアプリケーションを購読する
/applications/<id>/external-feed-subscriptions
    Get a list of the application's active external feed subscriptions.
    有効な外部RSS購読アプリケーションのリストを取得する
/applications/<id>/groups
    Get a list of groups in which a client using a app_full access auth token from this application can act.
    このアプリケーションのapp_fullアクセス認証トークン使用中のユーザーグループのリストを取得する

Assets ¶
情報

/assets
    Search for user-created content across the whole of TypePad.
    TypePad全体のユーザー作成コンテンツを検索する
/assets/<id>
    Get basic information about the selected asset.
    選択した情報に関する基本的な情報を取得する
/assets/<id>/add-category
    Send label argument to add a category to an asset
    情報にカテゴリを追加するラベル引数を送信する
/assets/<id>/categories
    Get a list of categories into which this asset has been placed within its blog. Currently supported only for Post assets that are posted within a blog.
    ブログの中でその情報が置かれたカテゴリのリストを取得。現在はひとつのブログの中でのPOST情報のみをサポート。
/assets/<id>/comment-tree
    Get a list of assets that were posted in response to the selected asset and their depth in the response tree
    選択された情報に対してpostされた別の情報とそのレスポンスツリーにおける深さのリストを取得
/assets/<id>/comments
    Get a list of assets that were posted in response to the selected asset.
    選択された情報に対してpostされた情報のリストを取得
/assets/<id>/extended-content
    Get the extended content for the asset, if any. Currently supported only for Post assets that are posted within a blog.
    ある情報の拡張コンテンツを取得。現在はあるブログ内でpostされたpost情報のみをサポートしている。
/assets/<id>/favorites
    Get a list of favorites that have been created for the selected asset.
    選択された情報に対して生成されたお気に入りのリストを取得
/assets/<id>/feedback-status
    Get the feedback status of the selected asset.
    選択された情報に対するfeedbackの状況を取得
/assets/<id>/make-comment-preview
    Send relevant data to get back a model of what the submitted comment will look like.
    投稿されたコメントがどのように見えるか、その形の関連データを送信
/assets/<id>/media-assets
    Get a list of media assets that are embedded in the content of the selected asset.
    選択された情報コンテンツに埋め込まれたメディア情報のリストを取得
/assets/<id>/publication-status
    Get the publication status of the selected asset.
    選択された情報の公開状況を取得
/assets/<id>/reblogs
    Get a list of posts that were posted as reblogs of the selected asset.
    選択された情報がリブログされたpostのリストを取得
/assets/<id>/remove-category
    Send label argument to remove a category from an asset
    ある情報がカテゴリから外されたラベル引数を送信
/assets/<id>/update-publication-status
    Adjust publication status of an asset
    ある情報の公開状況を調整

Auth Tokens ¶
認証トークン

/auth-tokens/<id>
    Get basic information about the selected auth token, including what object it grants access to.
    選択された認証トークンがどのオブジェクトへのアクセスを許可されたのか他の基本的な情報を取得。
    
Badges ¶
バッジ
/badges/<id>
    Get basic information about the selected badge.
    選択されたバッジの基本的な情報を取得
Batch Processor ¶
バッチプロセッサ
/batch-processor
    Submit a selection of API requests to be performed as a batch job.
    バッチジョブとして実行されることを選択されたAPIリクエストを送信
Blogs ¶
ブログ
/blogs/<id>
    Get basic information about the selected blog.
    選択されたブログについての基本的な情報を取得
/blogs/<id>/add-category
    Send label argument to remove a category from the blog
    ブログから削除するカテゴリのラベル引数を送信
    (訳者注:add-categoryなので追加するカテゴリと思われるが説明文にはremove=削除とある。書き間違えの可能性)
/blogs/<id>/categories
    Get a list of categories which are defined for the selected blog.
    選択されたブログに定義されたカテゴリのリストを取得
/blogs/<id>/commenting-settings
    Get the commenting-related settings for this blog.
    このブログのコメント関連の設定を取得
/blogs/<id>/comments/@published
    Return a pageable list of published comments associated with the selected blog
    選択されたブログの公開済みのコメントのHTML化されたリストを返す
/blogs/<id>/comments/@published/@recent
    Return the fifty most recent published comments associated with the selected blog
    選択されたブログの最新50個の公開済みコメントを返す
/blogs/<id>/crosspost-accounts
    Get a list of accounts that can be used for crossposting with this blog.
    このブログにクロスポスト出来るアカウントのリストを取得
/blogs/<id>/discover-external-post-asset
    If the selected blog is a connected blog, create or retrieve the external post stub for the given permalink.
    参照;http://www.movabletype.jp/documentation/typepadconnect/connect_a_blog_mt.html
    選択されたブログが登録されたブログの場合、そのパーマリンクに対する外部postスタブを生成または拾い出す
/blogs/<id>/media-assets
    Add a new media asset to the account that owns this blog.
    このブログを所有するアカウントに新たなメディア情報を追加する
/blogs/<id>/page-assets
    Get a list of pages associated with the selected blog.
    選択されたブログ内にあるページのリストを取得
/blogs/<id>/post-assets
    Get a list of posts associated with the selected blog.
    選択されたブログ内にある投稿のリストを取得
/blogs/<id>/post-assets/@by-category/<id>
    Get all visibile posts in the selected blog that have been assigned to the given category.
    選択されたブログで所与のカテゴリに所属する閲覧可能な全ての投稿を取得
/blogs/<id>/post-assets/@by-month/<id>
    Get all visible posts in the selected blog that have a publication date within the selected month, specified as a string of the form "YYYY-MM".
    選択されたブログの全ての閲覧可能な投稿のうち特定の月のものを取得。"YYYY-MM"の文字列で指定。
/blogs/<id>/post-assets/@published/@by-category/<id>
    Get the published posts in the selected blog that have been assigned to the given category.
    選択されたブログの中で所与のカテゴリに割り当てられた公開済み投稿を取得
/blogs/<id>/post-assets/@published/@by-month/<id>
    Get the posts that were published within the selected month (YYYY-MM) from the selected blog.
    選択されたブログから特定の月の公開済み投稿を取得
/blogs/<id>/post-assets/@published/@recent
    Get the most recent 50 published posts in the selected blog.
    選択されたブログから最新50の公開済み投稿を取得
/blogs/<id>/post-assets/@recent
    Get the most recent 50 posts in the selected blog, including draft and scheduled posts.
    選択されたブログの最新50の投稿(ドラフト投稿と予約投稿含む)を取得。
/blogs/<id>/post-by-email-settings/@by-user/<id>
    Get the selected user's post-by-email address
    選択されたユーザーのメール投稿アドレスを取得
/blogs/<id>/remove-category
    Send label argument to remove a category from the blog
    ブログから削除するカテゴリのラベル引数を送信
/blogs/<id>/stats
    Get data about the pageviews for the selected blog.
    選択されたブログのページビューに関するデータを取得

Browser Upload ¶
ブラウザアップロード
/browser-upload
    Submit an asset to a particular URL in the form of a multipart/form-data message with a file attachment.
    特定のURLにmultipart/form-data形式でファイルを添付して情報を投稿する

Client Library Helpers ¶
クライアント・ライブラリ・ヘルパー
/client-library-helpers/<id>
    Retrieve some data intended to be used for code generation in client libraries.
    クライアント・ライブラリでのコード生成に使うための幾つかのデータを抽出。
Events ¶
イベント
/events/<id>
    Get basic information about the selected event.
    選択されたイベントに関する基本的な情報をを取得
External Feed Subscriptions ¶
外部フィードの購読
/external-feed-subscriptions/<id>
    Get basic information about the selected subscription.
    選択された購読に関する基本的な情報を取得
/external-feed-subscriptions/<id>/add-feeds
    Add one or more feed identifiers to the subscription.
    購読に1つ以上のIDを付与する
/external-feed-subscriptions/<id>/feeds
    Get a list of strings containing the identifiers of the feeds to which this subscription is subscribed.
    購読されているフィードのIDを含む文字列を取得。
/external-feed-subscriptions/<id>/remove-feeds
    Remove one or more feed identifiers from the subscription.
    購読対象から1つ以上のフィードIDを削除
/external-feed-subscriptions/<id>/update-filters
    Change the filtering rules for the subscription.
    購読フィードのフィルタリング・ルールを変更する
/external-feed-subscriptions/<id>/update-notification-settings
    Change the callback URL and/or secret for the subscription.
    コールバックURLの変更、または同時に購読フィードの秘密
    (secretはselectの誤記の可能性。→コールバックURLの変更、または同時に購読フィードの変更)
/external-feed-subscriptions/<id>/update-user
    Change the "post as" user for a subscription owned by a group.
    管理者の承認なしで記事を公開するユーザーをグループが所有するフィード購読に変更する

Favorites ¶
お気に入り
/favorites/<id>
    Get basic information about the selected favorite, including its owner and the target asset.
    選択されたお気に入りに関する基本的な情報、所有者とその対象情報などを取得。
Groups ¶
グループ
/groups/<id>
    Get basic information about the selected group.
    選択されたグループに関する基本的な情報をを取得
/groups/<id>/add-member
    Add a given user as a member of the selected group.
    そのユーザーを選択されたグループのメンバーにする
/groups/<id>/audio-assets
    Create a new Audio asset within the selected group.
    選択されたグループ内に新しくオーディオ情報を生成する
/groups/<id>/block-user
    Block the given user from joining the selected group, removing that user as a member in the process.
    あるユーザーが特定のグループに入れないようにする。そのユーザーを除外する。
/groups/<id>/create-external-feed-subscription
    Subscribe the group to one or more external feeds.
    1つ以上の外部フィードにグループを購読させる。
/groups/<id>/events
    Get a list of events describing actions performed in the selected group.
    選択されたグループ内に記述されているイベントのリストを取得
/groups/<id>/external-feed-subscriptions
    Get a list of the group's active external feed subscriptions.
    そのグループの有効な外部購読フィードのリストを取得
/groups/<id>/link-assets
    Create a new Link asset within the selected group.
    選択されたグループ内にリンク情報を新たに生成する
/groups/<id>/memberships
    Get a list of relationships between users and the selected group.
    選択されたグループとユーザー間の関係のリストを取得
/groups/<id>/memberships/@admin
    Get a list of relationships that have the Admin type between users and the selected group.
    選択されたグループとユーザー間のadminタイプの関係のリストを取得
/groups/<id>/memberships/@blocked
    Get a list of relationships that have the Blocked type between users and the selected groups. (Restricted to group admin.)
    選択されたグループとユーザー間のブロックされた(blocked type)関係のリストを取得(グループ    admin限定)    
/groups/<id>/memberships/@member
    Get a list of relationships that have the Member type between users and the selected group.
    選択されたグループとユーザー間のメンバータイプの関係のリストを取得
/groups/<id>/photo-assets
    Create a new Photo asset within the selected group.
    選択されたグループ内に写真情報を新たに生成する
/groups/<id>/post-assets
    Create a new Post asset within the selected group.
    選択されたグループ内に投稿情報を新たに生成する
/groups/<id>/remove-member
    Remove a given user as a member of the selected group.
    あるユーザーを選択されたグループのメンバーから除外する
/groups/<id>/unblock-user
    Remove the block preventing the given user from joining the selected group.
    選択されたグループへの加入をブロックされていたメンバーを、その対象から除外する(メンバー加入できるようにする)
/groups/<id>/video-assets
    Create a new Video asset within the selected group.
    選択されたグループ内にビデオ情報を新たに生成する

Nouns ¶

/nouns
    Get information about all of the nouns in the API, along with their sub-resources and filters.
    API内の全てのnuonに関する情報を取得。そのサブリソースとフィルターも取得。
/nouns/<id>
    Get information about the selected noun, its sub-resources and their filters.
    選択されたnounとそのサブリソースとフィルターに関する情報を取得。

Object Types ¶
オブジェクトタイプ
/object-types
    Get information about all of the object types in the API, including the names and types of their properties.
    API内の全てのオブジェクトタイプに関する情報、プロパティの名前やタイプなどを取得
/object-types/<id>
    Get information about the selected object type and its properties.
    選択されたオブジェクトのタイプとプロパティに関する情報を取得

Relationships ¶
関係性
/relationships/<id>
    Get basic information about the selected relationship.
    選択された関係に関する基本的な情報を取得
/relationships/<id>/status
    Get the status information for the selected relationship, including its types.
    選択された関係の状況情報、そのタイプなどを取得。

Users ¶
ユーザー
/users/<id>
    Get basic information about the selected user.
    選択されたユーザーに関する基本的な情報を取得
/users/<id>/badges
    Get a list of badges that the selected user has won.
    選択されたユーザーが保有するバッジのリストを取得
/users/<id>/blogs
    Get a list of blogs that the selected user has access to.
    選択されたユーザーがアクセスしたブログのリストを取得
/users/<id>/elsewhere-accounts
    Get a list of elsewhere accounts for the selected user.
    選択されたユーザーの「他のサービス」一覧を取得
/users/<id>/events
    Get a list of events describing actions that the selected user performed.
    選択されたユーザーが行ったイベントのリストを取得
/users/<id>/events/@by-group/<id>
    Get a list of events describing actions that the selected user performed in a particular group.
    特定のグループのユーザーが行ったイベントのリストを取得
/users/<id>/favorites
    Get a list of favorites that were listed by the selected user.
    選択されたユーザーのお気に入りのリストを取得
/users/<id>/memberships
    Get a list of relationships that the selected user has with groups.
    選択されたユーザーと各グループとの関係のリストを取得
/users/<id>/memberships/@admin
    Get a list of relationships that have an Admin type that the selected user has with groups.
    選択されたユーザーと各グループとのadminタイプの関係のリストを取得
/users/<id>/memberships/@by-group/<id>
    Get a list containing only the relationship between the selected user and a particular group, or an empty list if the user has no relationship with the group.
    選択されたユーザーと特定のループとの間の関係のみのリストを取得、そのグループとの関係が無い場合は空のリストを取得。
/users/<id>/memberships/@member
    Get a list of relationships that have a Member type that the selected user has with groups.
    選択されたユーザーと各グループとのmemberタイプの関係のリストを取得
/users/<id>/notifications
    Get a list of events describing actions by users that the selected user is following.
    選択されたユーザーがフォローしているユーザーによるイベントのリストを取得
/users/<id>/notifications/@by-group/<id>
    Get a list of events describing actions in a particular group by users that the selected user is following.
    選択されたユーザーがフォローしているユーザーが所属する特定のグループのイベントのリストを取得
/users/<id>/profile
    Get a more extensive set of user properties that can be used to build a user profile page.
    ユーザーのプロフィールページのための詳細なプロパティの取得
/users/<id>/relationships
    Get a list of relationships that the selected user has with other users, and that other users have with the selected user.
    選択されたユーザーと他のユーザーとの関係、他のユーザーとそのユーザーとの関係リストを取得。
/users/<id>/relationships/@by-group/<id>
    Get a list of relationships that the selected user has with other users, and that other users have with the selected user, constrained to members of a particular group.
    選択されたユーザーと他のユーザーとの関係、他のユーザーとそのユーザーとの関係で、特定のグループのメンバーに強制されているもののリストを取得。
/users/<id>/relationships/@by-user/<id>
    Get a list of relationships that the selected user has with a single other user.
    選択されたユーザーと他の特定の一人のユーザーとの関係のリストを取得
    /users/<id>/relationships/@follower
    Get a list of relationships that have the Contact type that the selected user has with other users.
    選択されたユーザーが他のユーザーと持っている関係でcontactタイプのもののリストを取得
/users/<id>/relationships/@follower/@by-group/<id>
    Get a list of relationships that have the Contact type that the selected user has with other users, constrained to members of a particular group.
    選択されたユーザーが他のユーザーと持っている関係でcontactタイプのもののリストで特定のグループに矯正されているもののリストを取得。
/users/<id>/relationships/@following
    Get a list of relationships that have the Contact type that other users have with the selected user.
    他のユーザーが選択されたユーザーと持っている関係でcontactタイプのもののリストを取得
/users/<id>/relationships/@following/@by-group/<id>
    Get a list of relationships that have the Contact type that other users have with the selected user, constrained to members of a particular group.
    他のユーザーが選択されたユーザーと持っている関係でcontactタイプのもので、特定のグループのメンバーにするに強制されているもののリストを取得。

Object Types ¶
オブジェクトタイプ
The following pages provide a reference for the different types of object that are used in the TypePad API. Developers may wish to represent each of these as a class in their application.
次に示すのはTypePad APIで使われるオブジェクトのリファレンスです。開発者の方はアプリケーション開発においてこれらをclassに置き換えて使うことになる筈です。

It is recommended that client libraries use the type and property names defined here -- possibly with some adjustment for local language conventions -- so that users of such libraries can refer to this documentation.
クライアントライブラリーでは、ここに定義されているプロパティ名を使うことを推奨します。各国語で使う場合に少々の調整が必要かもしれません。そのためにもこのドキュメントを活用ください。

    * Account
    * ApiKey
    * Application
    * Asset
    * AssetExtendedContent
    * AssetRef
    * AssetSource
    * Audio
    * AudioLink
    * AuthToken
    * Badge
    * Base
    * Blog
    * BlogCommentingSettings
    * BlogStats
    * Comment
    * CommentTreeItem
    * ContainerRef
    * Endpoint
    * Entity
    * Event
    * ExternalFeedSubscription
    * Favorite
    * FeedbackStatus
    * Group
    * ImageLink
    * Link
    * ObjectProperty
    * ObjectType
    * Page
    * Photo
    * Post
    * PostByEmailAddress
    * PublicationStatus
    * Relationship
    * RelationshipStatus
    * User
    * UserBadge
    * UserProfile
    * Video
    * VideoLink

Advanced Topics ¶
追加情報
    * Batch Processing: Perform multiple API operations in a single request.
    *バッチプロセス:一回のリクエストで複数のAPIを動作させること
    * Uploading Files from the Browser: Upload files directly from the browser to TypePad in web-based applications.
    *ブラウザでのファイルアップロード:ブラウザからウェブアプリケーションでファイルを直接TypePadにアップロードすること