Hello Analytics Reporting API v4; การเริ่มต้นใช้งาน Python อย่างรวดเร็วสำหรับแอปพลิเคชันที่ติดตั้ง

บทแนะนำนี้จะแนะนำขั้นตอนที่จำเป็นในการเข้าถึง Analytics Reporting API เวอร์ชัน 4

1. เปิดใช้ API

หากต้องการเริ่มต้นใช้งาน Analytics Reporting API v4 ก่อนอื่นคุณต้องใช้เครื่องมือการตั้งค่า ซึ่งจะแนะนำขั้นตอนการสร้างโปรเจ็กต์ในคอนโซล Google API เปิดใช้ API และสร้างข้อมูลเข้าสู่ระบบ

หมายเหตุ: หากต้องการสร้างรหัสเว็บไคลเอ็นต์หรือไคลเอ็นต์แอปพลิเคชันที่ติดตั้ง คุณต้องตั้งค่าชื่อผลิตภัณฑ์ในหน้าจอความยินยอม หากยังไม่ได้ทํา ระบบจะแจ้งให้กําหนดค่าหน้าจอขอความยินยอม

สร้างข้อมูลเข้าสู่ระบบ

  • เปิดหน้าข้อมูลเข้าสู่ระบบ
  • คลิกสร้างข้อมูลเข้าสู่ระบบ แล้วเลือกรหัสไคลเอ็นต์ OAuth
  • เลือกอื่นๆ ในส่วนประเภทแอปพลิเคชัน
  • ตั้งชื่อรหัสไคลเอ็นต์quickstart แล้วคลิกquickstart

จากหน้าข้อมูลเข้าสู่ระบบ ให้คลิกรหัสไคลเอ็นต์ที่สร้างขึ้นใหม่ แล้วคลิกดาวน์โหลด JSON แล้วบันทึกเป็น client_secrets.json คุณจะต้องใช้รหัสนี้ภายหลังในบทแนะนำ

2. ติดตั้งไลบรารีของไคลเอ็นต์

การใช้ pip ร่วมกับ venv เป็นวิธีที่แนะนำสำหรับการติดตั้งแพ็กเกจ Python: sudo -s apt-get install python3-venv python3 -m venv analytics-quickstart source analytics-quickstart/bin/activate pip install --upgrade google-api-python-upgrade

3. ตั้งค่าตัวอย่าง

คุณจะต้องสร้างไฟล์เดียวที่ชื่อ HelloAnalytics.py ซึ่งจะมีโค้ดตัวอย่างที่ระบุ

  1. คัดลอกหรือดาวน์โหลดซอร์สโค้ดต่อไปนี้ลงใน HelloAnalytics.py
  2. ย้าย client_secrets.json ที่ดาวน์โหลดก่อนหน้านี้ไปยังไดเรกทอรีเดียวกันกับโค้ดตัวอย่าง
  3. แทนที่ค่าของ VIEW_ID คุณใช้โปรแกรมสำรวจบัญชีเพื่อค้นหารหัสข้อมูลพร็อพเพอร์ตี้ได้
"""Hello Analytics Reporting API V4."""

import argparse

from apiclient.discovery import build
import httplib2
from oauth2client import client
from oauth2client import file
from oauth2client import tools

SCOPES = ['https://www.googleapis.com/auth/analytics.readonly']
CLIENT_SECRETS_PATH = 'client_secrets.json' # Path to client_secrets.json file.
VIEW_ID = '<REPLACE_WITH_VIEW_ID>'


def initialize_analyticsreporting():
  """Initializes the analyticsreporting service object.

  Returns:
    analytics an authorized analyticsreporting service object.
  """
  # Parse command-line arguments.
  parser = argparse.ArgumentParser(
      formatter_class=argparse.RawDescriptionHelpFormatter,
      parents=[tools.argparser])
  flags = parser.parse_args([])

  # Set up a Flow object to be used if we need to authenticate.
  flow = client.flow_from_clientsecrets(
      CLIENT_SECRETS_PATH, scope=SCOPES,
      message=tools.message_if_missing(CLIENT_SECRETS_PATH))

  # Prepare credentials, and authorize HTTP object with them.
  # If the credentials don't exist or are invalid run through the native client
  # flow. The Storage object will ensure that if successful the good
  # credentials will get written back to a file.
  storage = file.Storage('analyticsreporting.dat')
  credentials = storage.get()
  if credentials is None or credentials.invalid:
    credentials = tools.run_flow(flow, storage, flags)
  http = credentials.authorize(http=httplib2.Http())

  # Build the service object.
  analytics = build('analyticsreporting', 'v4', http=http)

  return analytics

def get_report(analytics):
  # Use the Analytics Service Object to query the Analytics Reporting API V4.
  return analytics.reports().batchGet(
      body={
        'reportRequests': [
        {
          'viewId': VIEW_ID,
          'dateRanges': [{'startDate': '7daysAgo', 'endDate': 'today'}],
          'metrics': [{'expression': 'ga:sessions'}]
        }]
      }
  ).execute()


def print_response(response):
  """Parses and prints the Analytics Reporting API V4 response"""

  for report in response.get('reports', []):
    columnHeader = report.get('columnHeader', {})
    dimensionHeaders = columnHeader.get('dimensions', [])
    metricHeaders = columnHeader.get('metricHeader', {}).get('metricHeaderEntries', [])
    rows = report.get('data', {}).get('rows', [])

    for row in rows:
      dimensions = row.get('dimensions', [])
      dateRangeValues = row.get('metrics', [])

      for header, dimension in zip(dimensionHeaders, dimensions):
        print header + ': ' + dimension

      for i, values in enumerate(dateRangeValues):
        print 'Date range (' + str(i) + ')'
        for metricHeader, value in zip(metricHeaders, values.get('values')):
          print metricHeader.get('name') + ': ' + value


def main():

  analytics = initialize_analyticsreporting()
  response = get_report(analytics)
  print_response(response)

if __name__ == '__main__':
  main()

4. เรียกใช้ตัวอย่าง

เรียกใช้ตัวอย่างโดยใช้:

python HelloAnalytics.py
  • แอปพลิเคชันจะโหลดหน้าการให้สิทธิ์ในเบราว์เซอร์
  • หากคุณยังไม่ได้ลงชื่อเข้าใช้บัญชี Google ของคุณ ระบบจะแจ้งให้คุณลงชื่อเข้าใช้ หากคุณเข้าสู่ระบบบัญชี Google หลายบัญชี ระบบจะขอให้คุณเลือกบัญชีที่จะใช้ในการให้สิทธิ์

เมื่อทําตามขั้นตอนเหล่านี้เสร็จแล้ว ตัวอย่างจะแสดงจํานวนเซสชันในช่วง 7 วันที่ผ่านมาสำหรับข้อมูลพร็อพเพอร์ตี้ที่ระบุ

การแก้ปัญหา

AttributeError: ออบเจ็กต์ "Module_six_moves_urllib_parse" ไม่มีแอตทริบิวต์ "urlparse"

ข้อผิดพลาดนี้อาจเกิดขึ้นใน Mac OSX ที่มีการโหลดการติดตั้งเริ่มต้นของโมดูล "6" (ทรัพยากร Dependency ของไลบรารีนี้) โหลดก่อนที่ PIP ดังกล่าวจะติดตั้ง หากต้องการแก้ไขปัญหานี้ ให้เพิ่มตำแหน่งการติดตั้งของ PIP ลงในตัวแปรสภาพแวดล้อมของระบบ PYTHONPATH ดังนี้

  • ระบุตำแหน่งการติดตั้งของ PIP ด้วยคำสั่งต่อไปนี้

    pip แสดงหก | grep "สถานที่ตั้ง:" | ตัด -d " " -f2

  • เพิ่มบรรทัดต่อไปนี้ลงในไฟล์ ~/.bashrc โดยแทนที่ &lt;pip_install_path&gt; ด้วยค่าที่กำหนดข้างต้น

    ส่งออก PYTHONPATH=$PYTHONPATH:<pip_install_path>

  • โหลดไฟล์ ~/.bashrc ซ้ำในหน้าต่างเทอร์มินัลที่เปิดอยู่โดยใช้คำสั่งต่อไปนี้

    แหล่งที่มา ~/.bashrc