このページは Cloud Translation API によって翻訳されました。

デベロッパーガイド: Python

Blogger Data API を使用すると、クライアントアプリケーションは Google Data API フィード形式で Blogger コンテンツを表示および更新できます。

クライアントアプリケーションは Blogger Data API を使用して、新しいブログ投稿の作成、既存のブログ投稿の編集または削除、特定の条件に一致するブログ投稿のクエリを実行できます。

このドキュメントでは、Blogger Data API の機能に関する背景情報に加えて、Python クライアントライブラリを使用した Data API の基本的な操作例を示します。ライブラリが使用する基盤となるプロトコルの詳細については、このデベロッパーガイドのプロトコルセクションをご覧ください。

オーディエンス

このドキュメントは、Blogger とやり取りできる Python クライアントアプリケーションを作成するプログラマを対象としています。

このドキュメントは、Google Data APIs プロトコルの基本的な考え方を理解していることを前提としています。

Blogger Data API の一般的なリファレンス情報については、プロトコルリファレンスガイドをご覧ください。

スタートガイド

クライアントライブラリの設定については、スタートガイドをご覧ください。

Python クライアントライブラリには Python 2.2 以降が必要です。クライアントライブラリをダウンロードしたら、ElementTree パッケージもダウンロードしてインストールする必要があります。

Blogger アカウントを作成する

テスト用に Blogger アカウントを登録することをおすすめします。Blogger は Google アカウントを使用しているため、すでに Google アカウントをお持ちの場合は、すぐにご利用いただけます。

サンプルコードの実行

このドキュメントに記載されているすべてのサンプルコードを含む、完全な動作サンプルクライアントは、gdata-python-client/samples/blogger/ ディレクトリの BloggerExample.py ファイルで入手できます。

サンプルクライアントは、指定されたブログに対していくつかのオペレーションを実行し、Blogger Data API の使用方法を示します。

サンプルは、次の引数で実行できます。

python BloggerExample.py --email [email_address] --password [password]

このドキュメントのサンプルを独自のコードで使用するには、次の import ステートメントが必要です。

from gdata import service
import gdata
import atom

Blogger サービスへの認証

Blogger Data API を使用すると、公開フィードと限定公開フィードの両方にアクセスできます。公開フィードには認証は必要ありませんが、読み取り専用です。ブログを変更する場合は、クライアントが限定公開フィードをリクエストする前に認証する必要があります。認証には、OAuth 認証、AuthSub プロキシ認証、ClientLogin ユーザー名/パスワード認証のいずれかを使用できます。

Google Data API での認証の詳細については、認証のドキュメントをご覧ください。

このドキュメントの以降のセクションのサンプルのほとんどは、認証済みの GDataService インスタンスがあることを前提としています。

OAuth 認証

Python GData ライブラリを使用した OAuth 認証については、Google Data Protocol クライアントライブラリの OAuth をご覧ください。

AuthSub プロキシ認証

AuthSub プロキシ認証は、Google アカウントのユーザーを認証する必要があるウェブアプリケーションで使用されます。ウェブサイト運営者とクライアントコードは、Blogger ユーザーのユーザー名とパスワードにアクセスできません。代わりに、クライアントは、特定のユーザーに代わってクライアントが操作できるようにする特別な AuthSub トークンを取得します。詳細については、AuthSub のドキュメントをご覧ください。

ユーザーが初めてアプリケーションにアクセスした時点では、認証は行われていません。この場合は、ブログへのアクセスリクエストの認証を行う Google ページにユーザーを誘導する情報とリンクを表示する必要があります。Python クライアントライブラリには、Google ページの URL を生成する関数があります。次のコードは、AuthSubRequest ページの URL を取得します。

def GetAuthSubUrl():
  next = 'http://www.example.com/welcome.pyc'
  scope = 'http://www.blogger.com/feeds/'
  secure = False
  session = True
  blogger_service = service.GDataService()
  return blogger_service.GenerateAuthSubURL(next, scope, secure, session);

authSubUrl = GetAuthSubUrl();
print '<a href="%s">Login to your Google account</a>' % authSubUrl

GenerateAuthSubURL メソッドは、AuthSubRequest ハンドラで使用されるクエリパラメータに対応する次のパラメータを受け取ります。

次へ: 認証後にユーザーをリダイレクトするページの URL。
スコープ: Blogger フィードにアクセスするためのトークンをアプリがリクエストしていることを示します。使用するスコープ文字列は http://www.blogger.com/feeds/ です（もちろん URL エンコードされています）。
安全: クライアントがセキュアトークンをリクエストしているかどうかを示します。
セッション: 返されたトークンを複数回使用（セッション）トークンと交換できるかどうかを示します。

上記の例は、安全なトークンをリクエストしない呼び出しを示しています（secure の値は False です）。結果として生成されるリクエスト URL は次のようになります。

https://www.google.com/accounts/AuthSubRequest?scope=http%3A%2F%2Fwww.blogger.com%2Ffeeds%2F&session=1&secure=0&next=http%3A%2F%2Fwww.example.com%2Fwelcome.pyc

ユーザーはリンクから Google のサイトにアクセスし、Google アカウントで認証します。

ユーザーが認証されると、AuthSub システムは AuthSubRequest URL の next クエリパラメータで指定した URL にユーザーをリダイレクトします。AuthSub システムは、token クエリパラメータの値として、その URL に認証トークンを追加します。次に例を示します。

http://www.example.com/welcome.pyc?token=yourAuthToken

URL からトークン値を取得する方法はいくつかあります。次に例を示します。

import cgi

parameters = cgi.FieldStorage()
authsub_token = parameters['token']

このトークン値は、1 回限りの AuthSub トークンを表します。この例では、session = True が指定されているため、このトークンは UpgradeToSessionToken メソッドを使用して AuthSub セッショントークンと交換できます。このメソッドは AuthSubSessionToken サービスを呼び出します。

blogger_service = service.GDataService()
blogger_service.auth_token = authsub_token
blogger_service.UpgradeToSessionToken()

つまり、1 回限りのトークンを UpgradeToSessionToken メソッドに渡すと、AuthSub インターフェースがセッショントークンを返します。

その後、アプリケーションは、Blogger との以降のやり取りでセッショントークン値を使用できます。クライアントライブラリは、リクエストとともにトークンを自動的に送信します。

ClientLogin ユーザー名/パスワード認証

クライアントがスタンドアロンのシングルユーザーの「インストール済み」クライアント（デスクトップアプリケーションなど）の場合は、ClientLogin 認証を使用します。GDataService インスタンスで ProgrammaticLogin() メソッドを呼び出すだけで、Blogger とのその後のすべての操作が認証されます。

blogger_service = service.GDataService('user@example.com', 'secretPassword')
blogger_service.source = 'exampleCo-exampleApp-1.0'
blogger_service.service = 'blogger'
blogger_service.account_type = 'GOOGLE'
blogger_service.server = 'www.blogger.com'
blogger_service.ProgrammaticLogin()

上のスニペットでは、GDataService インスタンスに 3 つのプロパティを設定しています。1 つ目は、companyName-applicationName-versionID 形式のアプリケーションの名前です。2 つ目は、操作するサービスの名前です。3 つ目は、サーバーのアドレスです。

account_type が明示的に GOOGLE に設定されていることに注意してください。このパラメータを設定しないと、G Suite ユーザーは Blogger API を正常に使用できません。

リクエストとレスポンスのサンプルなど、ClientLogin 認証の詳細については、インストール済みアプリケーションの認証のドキュメントをご覧ください。

注: 特定のセッション内のすべてのリクエストに同じトークンを使用します。Blogger リクエストごとに新しいトークンを取得しないでください。

注: ClientLogin のドキュメントに記載されているように、認証リクエストが失敗し、CAPTCHA チャレンジがリクエストされる場合があります。Google に CAPTCHA チャレンジの発行と処理を任せる場合は、ユーザーを https://www.google.com/accounts/DisplayUnlockCaptcha?service=blogger にリダイレクトします（ClientLogin のドキュメントに記載されている CAPTCHA 処理 URL ではなく）。

ブログのリストを取得する

Blogger Data API は、特定のユーザーのブログを一覧表示するフィードを提供します。このフィードは「メタフィード」と呼ばれます。

次のサンプルコードでは、認証済みの GDataService インスタンスを使用してメタフィードを取得し、各ブログのタイトルを出力します。

def PrintUserBlogTitles(blogger_service):
  query = service.Query()
  query.feed = '/feeds/default/blogs'
  feed = blogger_service.Get(query.ToUri())

  print feed.title.text
  for entry in feed.entry:
    print "\t" + entry.title.text

Get メソッドで使用されている URL をメモします。これはデフォルトのメタフィード URL で、現在認証されているユーザーのブログのリストを返します。別のユーザーのフィードにアクセスするには、メタフィード URL の default の代わりにユーザー ID を指定します。ユーザーの ID は、ユーザーのプロフィール URL の末尾にある数字の文字列です。

以下のコードスニペットは、フィードからブログ ID を抽出する方法を示しています。投稿とコメントの作成、更新、削除を行うには、ブログ ID が必要です。以下のスニペットは、ユーザーに対して取得された最初のブログを選択します。

blog_id = feed.entry[0].GetSelfLink().href.split("/")[-1]

BloggerExample.py サンプルでは、BloggerExample クラスが作成され、後で簡単にアクセスできるようにコンストラクタでブログ ID が設定されています。このドキュメントの以降の例のほとんどでは、blog_id は変数として渡されます。

投稿の作成

Blogger Data API を使用すると、新しいブログ投稿を作成して公開したり、投稿の下書きを作成したりできます。

注: 現在のところ、投稿のカスタム作成者は設定できません。新しい投稿はすべて、現在認証されているユーザーによって作成されたものとして表示されます。

ブログ投稿の公開

Python クライアントライブラリを使用して、新しいブログ投稿を公開できます。

まず、ブログ投稿を表す GDataEntry インスタンスを作成します。次に、ブログ投稿のタイトル、コンテンツなどの属性を設定します。最後に、GDataService インスタンスを使用して投稿を挿入します。新しいブログ投稿を公開する方法の例を次に示します。

def CreatePublicPost(blogger_service, blog_id, title, content):
  entry = gdata.GDataEntry()
  entry.title = atom.Title('xhtml', title)
  entry.content = atom.Content(content_type='html', text=content)
  return blogger_service.Post(entry, '/feeds/%s/posts/default' % blog_id)

blogEntry = CreatePublicPost(blogger_service, blog_id,
    title='I have the answer', content='Eureka! It is 42!')

ブログ投稿の下書きを作成する

下書き投稿は公開投稿と同じ方法で作成されますが、GDataEntry インスタンスで draft 拡張要素を設定する必要があります。上記のブログ投稿は、ハイライト表示された行を追加することで下書きとして作成できます。

def CreateDraftPost(blogger_service, blog_id, title, content):
  entry = gdata.GDataEntry()
  entry.title = atom.Title('xhtml', title)
  entry.content = atom.Content(content_type='html', text=content)

  control = atom.Control()
  control.draft = atom.Draft(text='yes')
  entry.control = control

  return blogger_service.Post(entry, '/feeds/%s/posts/default' % blog_id)

draftEntry = CreateDraftPost(blogger_service, blog_id,
    title='I have the question',
    content='What do you get if you multiply six by nine?')

既存の下書きのブログ投稿を公開済み投稿にするには、下書き投稿を取得し、下書き属性を no に設定してから、投稿を更新します。投稿の取得と更新については、次の 2 つのセクションで説明します。

投稿の取得

以降のセクションでは、クエリパラメータありとなしの場合の、ブログ投稿のリストを取得する方法について説明します。

Blogger の公開フィードを認証なしでクエリできます。したがって、公開ブログから投稿を取得する前に、認証情報を設定したり、AuthSub 認証を行う必要はありません。

すべてのブログ投稿を取得する

ユーザーの投稿を取得するには、ブログ投稿フィードの URL を指定して GetFeed メソッドを呼び出します。

def PrintAllPosts(blogger_service, blog_id):
  feed = blogger_service.GetFeed('/feeds/' + blog_id + '/posts/default')

  print feed.title.text
  for entry in feed.entry:
    print "\t" + entry.title.text
    print "\t" + entry.content.text
    print "\t" + entry.updated.text
  print

クエリパラメータを使用して投稿を取得する

Blogger Data API を使用すると、指定した条件に一致するエントリセットをリクエストできます。たとえば、特定の日付範囲に公開または更新されたブログ投稿をリクエストできます。これを行うには、Query インスタンスを作成してから、Get() メソッドを呼び出します。

たとえば、期間クエリを送信するには、Query インスタンスの published_min プロパティと published_min プロパティを設定します。次のコードスニペットは、指定された開始時間と終了時間の間に公開された各ブログ投稿のタイトルとコンテンツを出力します。

def PrintPostsInDateRange(blogger_service, blog_id, start_time='2007-04-01', end_time='2007-04-25'):
  query = service.Query()
  query.feed = '/feeds/' + blog_id + '/posts/default'
  query.published_min = start_time
  query.published_max = end_time
  feed = blogger_service.Get(query.ToUri())

  print feed.title.text + " posts between " + start_time + " and " + end_time
  for entry in feed.entry:
    print "\t" + entry.title.text
    print "\t" + entry.content.text
    print "\t" + entry.updated.text
  print

Query オブジェクトは、投稿の取得に使用された投稿フィード URL を使用して作成されています。

Blogger Data API は、次の Query プロパティをサポートしています。

categories: フィード結果をフィルタするカテゴリ（ラベル）を指定します。たとえば、http://www.blogger.com/feeds/blogID/posts/default/-/Fritz/Laurie は、ラベル Fritz と Laurie の両方を含むエントリを返します。Python クライアントライブラリでそのカテゴリクエリを指定するには、query.categories = ['Fritz','Laurie',] を使用します。
max_results: 返されるエントリの最大数。
published_min、published_max: エントリの公開日の範囲。
start_index: 取得される最初の結果のインデックス（1 から始まる）（ページング用）。
updated_min、updated_max: エントリの更新日の上限と下限。これらのクエリパラメータは、orderby パラメータが updated に設定されていない限り無視されます。

クエリパラメータの詳細については、Blogger Data API リファレンスガイドと Google Data APIs リファレンスガイドをご覧ください。

投稿の更新

既存のブログ投稿を更新するには、まず更新するエントリを取得し、変更してから、Put メソッドを使用して Blogger に送信します。次のコードスニペットは、エントリがすでにサーバーから取得されていることを前提として、ブログ投稿のタイトルを変更します。

def UpdatePostTitle(blogger_service, entry_to_update, new_title='The REAL answer'):
  entry_to_update.title = atom.Title('xhtml', new_title)
  return blogger_service.Put(entry_to_update, entry_to_update.GetEditLink().href)

上記のコードは、新しく更新された投稿全体を含む GDataEntry を返します。他のプロパティを更新するには、Put を呼び出す前に GDataEntry インスタンスで設定します。

注: 投稿に関連付けられた作成者データを変更することは現在サポートされていません。

投稿の削除

投稿を削除するには、投稿の編集 URL を GDataService オブジェクトの Delete メソッドに渡します。次に例を示します。

def DeletePost(blogger_service, edit_link_href):
  blogger_service.Delete(edit_link_href)

Blogger Data API を使用すると、コメントの作成、取得、削除を行うことができます。コメントの更新はサポートされていません（ウェブインターフェースでも利用できません）。

コメントの作成

コメントを投稿するには、GDataEntry オブジェクトを作成し、次のように挿入します。

def CreateComment(blogger_service, blog_id, post_id, comment_text='Mostly harmless'):
  feed_uri = '/feeds/' + blog_id + '/' + post_id + '/comments/default'

  entry = gdata.GDataEntry()
  entry.content = atom.Content(content_type='xhtml', text=comment_text)
  return blogger_service.Post(entry, feed_uri)

注: 現在、コメントを投稿できるのは、認証済みユーザーが所有するブログに限られます。

注: 現在のところ、コメントのカスタム作成者を設定することはできません。新しいコメントはすべて、現在認証されているユーザーによって作成されたものとして表示されます。

コメントの取得

特定の投稿のコメントは、その投稿のコメントフィード URL から取得できます。

def PrintAllComments(blogger_service, blog_id, post_id):
  feed_url = '/feeds/' + blog_id + '/' + post_id + '/comments/default'
  feed = blogger_service.Get(feed_url)

  print feed.title.text
  for entry in feed.entry:
    print "\t" + entry.title.text
    print "\t" + entry.updated.text
  print

または、ブログのコメントフィード URL を使用して、すべての投稿のコメントを取得することもできます。

http://www.blogger.com/feeds/blogID/comments/default

コメントの削除

コメントを削除するには、次のように、コメントの編集 URL を GDataService オブジェクトの Delete メソッドに渡します。

def DeleteComment(blogger_service, post_id, comment_id):
  feed_url = '/feeds/' + post_id + '/comments/default/' + comment_id
  blogger_service.Delete(feed_url)

トップへ戻る

デベロッパー ガイド: Python

目次