用python的django框架编写从googleadsense中获得报表的应用

我完成了更新我们在 neutron的实时收入统计。在我花了一周的时间完成并且更新了我们的php脚本之后,我最终认决定开始使用python进行抓取,这是值得我去花费我的时间和精力的事情。我建立了一个 django程序,它可以从不同的来源存储收入统计,我可以用这些去简历视图和用于统计工具的api。

所以在过去的几天里,我写了一个脚本,它可以登入到其他的网页并抓取数据,或者,如果这些网页有 api,可以直接访问 api。我发现了一些事情。

1.requests >httplib2(requests多于httplib2);

2.soap很糟糕,但它至少是一个api,suds使soap好一点。我了解到soap是我说知道的api中,唯一一个完全基于.net开发的。

3.beautiful soup是一个很好的求助对象;

4.我确实十分惊讶,这么多企业能在如此蹩脚的技术中生存下来。

我拯救了 google adsense,他们将会拥有最好的api,并且因此成为最简单的实现。他有着比我预想的要多的挑战。显然你无法仅仅插入用户名/密码或是apikey去获取获得进入api的入口,你必须完成整个oauth2的握手流程。

不幸的是,我发现文档不如我希望过得那样容易查询。我发现了很多死链接。我认为,在这方面google的人应该做的更好。例如,在他们的up to date developer docs文档中,我发现他们指出了broken link to read more about authentication and authorization。(好的,多么奇怪,我尽快提交了这个问题,这个链接终于开始工作了,我猜你会感谢我。)

所以,这篇博客将尝试记录从adsense获取报表到我的django应用的过程。

为了使用google的api来访问adsense报表,你需要使用adsense management api. 这个api只提供oauth,所以你需要在浏览器中至少完成一次认证过程,来获取你的证书,然后你可以保存这些证书来进行下一步操作。说实话,我已经听说过oauth很多次了,但是直到现在,我在实践中仍没有需要来使用它。所以我是边做边学,并欢迎大家留言指出我说的不对的地方。

就我所知,google对于它的各种产品都拥有一个庞大的api。在研究adsense之前,你需要在google api 控制台注册你的应用。我已经成功注册了我的应用。因为我还没有一个可用的url地址,我现在暂时使用我的开发url(localhost:8000)。它运作起来似乎正常。并使用提供的这个链接下载json文件。

还有,当你管理你的apis的时候,你需要打开服务选项卡,打开adsense management api选项。否则,当你尝试发送请求的时候,你会得到一个错误消息“access not configured”。

google已经创建了一个python 客户端库,你可以轻易的通过pip来安装这个库。它还包含一个django样例项目,这个项目使用这个库实现oauth2的握手过程。我想,它是使用django 1.1编写的(因为在写这个项目的时候,django 1.5才刚刚发布),所以它可能有点过时,但是它可是一个好的开始点。

我的应用很简单。我只需要读取指定日期的收益金额,并保存到我的本地数据库。

我在djaongo项目中创建了一个新的应用,叫做“adsense”。并创建了一个models.py文件来存储认证证书。

from django.contrib.auth.models import user
from django.db import models
from oauth2client.django_orm import credentialsfield
class credential(models.model):
id = models.foreignkey(user, primary_key=true)
credential = credentialsfield()
class revenue(models.model):
date = models.datefield(unique=true)
revenue = models.decimalfield(max_digits=7, decimal_places=2)
def __unicode__(self):
return ‘{0} ${1}’.format(self.date, self.revenue)

我把从api控制台下载的json文件放到我的应用的文件夹下面,并创建了一个views.py文件

import os
from django.conf import settings
from django.contrib.auth.decorators import login_required
from django.contrib.sites.models import site
from django.http import httpresponsebadrequest, httpresponse
from django.http import httpresponseredirect
from oauth2client import xsrfutil
from oauth2client.client import flow_from_clientsecrets
from oauth2client.django_orm import storage
from .models import credential
client_secrets = os.path.join(os.path.dirname(__file__), ‘client_secrets.json’)
flow = flow_from_clientsecrets(
client_secrets,
scope=’https://www.googleapis.com/auth/adsense.readonly’,
redirect_uri=’http://{0}/adsense/oauth2callback/’.format(
site.objects.get_current().domain))
@login_required
def index(request):
storage = storage(credential, ‘id’, request.user, ‘credential’)
credential = storage.get()
if credential is none or credential.invalid is true:
flow.params[‘state’] = xsrfutil.generate_token(settings.secret_key,
request.user)
authorize_url = flow.step1_get_authorize_url()
return httpresponseredirect(authorize_url)
else:
return httpresponse(‘already validated.’)
@login_required
def auth_return(request):
if not xsrfutil.validate_token(settings.secret_key,
request.request[‘state’], request.user):
return httpresponsebadrequest()
credential = flow.step2_exchange(request.request)
storage = storage(credential, ‘id’, request.user, ‘credential’)
storage.put(credential)
return httpresponseredirect(“/”)

在 urls.py 文件中我包含了一个链接指向我的应用的url文件

main urls.py:
from django.conf.urls import patterns, include, url
from django.contrib import admin
admin.autodiscover()
urlpatterns = patterns(
”,
url(r’^adsense/’, include(‘adsense.urls’, namespace=’adsense’)),
url(r’^admin/doc/’, include(‘django.contrib.admindocs.urls’)),
url(r’^admin/’, include(admin.site.urls)),
)
adsense/urls.py:
from django.conf.urls import patterns, url
urlpatterns = patterns(
‘adsense.views’,
url(r’^$’, ‘index’, name=’index’),
url(r’^oauth2callback/$’, ‘auth_return’, name=’auth_return’),
)

最后,创建了一个通过给定日期调用api并获取收益的类。它放在adsense/tasks.py,因为我准备把它当作任务,钩在 celery/ rabbitmq之上。

import datetime
import httplib2
from apiclient.discovery import build
from django.contrib.auth.models import user
from oauth2client.django_orm import storage
from .models import credential, revenue
today = datetime.date.today()
yesterday = today – datetime.timedelta(days=1)
class scraper(object):
def get_report(self, start_date=yesterday, end_date=today):
user = user.objects.get(pk=1)
storage = storage(credential, ‘id’, user, ‘credential’)
credential = storage.get()
if not credential is none or credential.invalid is false:
http = httplib2.http()
http = credential.authorize(http)
service = build(‘adsense’, ‘v1.2’, http=http)
reports = service.reports()
report = reports.generate(
startdate=start_date.strftime(‘%y-%m-%d’),
enddate=end_date.strftime(‘%y-%m-%d’),
dimension=’date’,
metric=’earnings’,
)
data = report.execute()
for row in data[‘rows’]:
date = row[0]
revenue = row[1]
record = revenue()
try:
r = revenue.objects.get(date=date)
pk = r.id
except revenue.doesnotexist:
pk = none
record.id = pk
record.date = date
record.revenue = revenue
record.save()

为了让它能工作起来,我在浏览器打开http://localhost:8000/adsense/。这时候会要求我登录google帐号。我为我的应用授权来访问adsense。然后,认证证书就会保存在我的本地数据库,然后我可以调用scraper get_report() 方法。祝贺我吧!。它能顺利工作了。

Posted in 未分类

发表评论