Tag: api

วิธีใช้ Google Sheets เป็นฐานข้อมูล เพื่อการเฝ้าระวังระบบ โดยการใช้งานผ่าน Google API Client Library for Python

kanakorn.h

January 30, 2018
ต่อจาก
คราวนี้ ใครมีข้อมูลที่เกิดขึ้นในเซิร์ฟเวอร์ภายในองค์กร แล้วต้องการส่งไปเขียนเก็บไว้ใน Google Sheets แบบต่อท้าย (Append)

เช่น ในตัวอย่างนี้ วัดระยะเวลาการโอนย้ายข้อมูล เปรียบเทียบระหว่าง rsync เพื่อสำรองข้อมูลไปไว้ในเครื่องเซิร์ฟเวอร์สำรองที่ต่างวิทยาเขต กับ การนำไปเก็บไว้ใน Google Drive ตามวิธีการที่กล่าวไว้ใน วิธีการ Upload ไฟล์ไปบน Google Drive File Stream ด้วย Google Client Library for Python

ผมได้เขียนโค๊ดเอาไว้ที่ https://github.com/nagarindkx/google.git
สามารถโคลนไปใช้งานได้ (ช่วย Reference กันด้วยนะครับ)

ขั้นตอนการใช้งานมีดังนี้
1. ใช้คำสั่ง
```
git clone https://github.com/nagarindkx/google.git
cd google
```
2. ติดตั้ง python, pip, google-api-python-client ตามที่เขียนไว้ใน การใช้งาน Google Drive API ด้วย Google Client Library for Python และสร้างโปรเจคใน Google Developer Console เปิดใช้งาน Google Sheets API, สร้าง Credentials > OAuth Client ID แล้ว download JSON มาไว้ในชื่อว่า client_secret.json
3. รูปแบบคำสั่งคือ
```
$ python append2gsheet.py --help

usage: append2gsheet.py [-h] [--auth_host_name AUTH_HOST_NAME]
                             [--noauth_local_webserver]
                             [--auth_host_port [AUTH_HOST_PORT [AUTH_HOST_PORT ...]]]
                             [--logging_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
                              --data DATA --sheetid SHEETID [--range RANGE]
                             [--value-input-option VALUEINPUTOPTION]

optional arguments:
 -h, --help show this help message and exit
 --auth_host_name AUTH_HOST_NAME
   Hostname when running a local web server.
 --noauth_local_webserver
   Do not run a local web server.
 --auth_host_port [AUTH_HOST_PORT [AUTH_HOST_PORT ...]]
   Port web server should listen on.
 --logging_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
   Set the logging level of detail.
 --data DATA CSV format
 --sheetid SHEETID Google Sheets ID
 --range RANGE Simply Sheet Name like 'Sheet1!A1'
 --value-input-option VALUEINPUTOPTION
   Optional: [RAW,USER_ENTERED]
```
4. สิ่งที่ต้องมี คือ Google Sheets ที่สร้างไว้แล้ว ให้สังเกตที่ URL
  ตัวข้อความที่อยู่หลัง https://docs.google.com/spreadsheets/d/ จะเป็น “Sheet ID” ซึ่งจะใช้ในตัวแปร “sheetid” ในขั้นต่อไป
5. ในแต่ละ Google Sheets จะประกอบด้วย หลาย Sheet ในที่นี้ จะเขียนลง Sheet ที่ชื่อว่า “Data” ซึ่งจะใช้ในตัวแปร “range” ในขั้นต่อไป
6. ตัวอย่างการใช้งาน เมื่อระบบทำการสำรองข้อมูล จับเวลา ก็จะทำการส่งข้อมูลไปเก็บในลักษณะ CSV อย่างนี้ส่งไป เช่น
```
20180129-12,37.0188,27.5338,943.7682,902.7372
```
  ซึ่งประกอบด้วย 5 ฟิลด์ คือ วันเวลาที่วัด และ ข้อมูล เป็นจำนวนวินาที อีก 4 ฟิลด์
  วิธีการส่งคำสั่งในการใช้งาน ครั้งแรก ต้องใส่ –noauth_local_webserver ด้วย
```
python append2gsheet.py --data 20180129-12,37.0188,27.5338,943.7682,902.7372 --sheetid 1YV_W_k8VkJbYn1fG1XXXXXXXXXXXXF8y5YtQwRC0DAY --range 'Data!A1' --noauth_local_webserver
```
  จะได้ผลดังนี้
  
  ให้เอา URL ไปเปิดบนเว็บ Browser ที่สามารถยืนยันตัวตนกับ Google ได้ ผลดังนี้
  
  แล้วก็ให้การอนุมัติ
  
  ก็จะได้ Verification Code อย่างนี้
  
  เอาไปใส่
  
  สำเร็จ และ ผลที่ได้
7. แต่จะเห็นว่า ข้อมูล ตัวเลขที่ใส่เข้ามา จะถูกแปลงเป็นข้อความ ซึ่ง สามารถแก้ไขได้ด้วยการใส่ –value-input-option USER_ENTERED
```
python append2gsheet.py --data 20180129-12,37.0188,27.5338,943.7682,902.7372 --sheetid 1YV_W_k8VkJbYn1fG1XXXXXXXXXXXXF8y5YtQwRC0DAY --range 'Data!A1' --noauth_local_webserver --value-input-option USER_ENTERED
```
  ผลที่ได้คือ คือ บรรทัดล่าง จะได้ชนิดเป็น Numeric มาเลย
8. เมื่อเก็บผลเรียบร้อยแล้ว สามารถดูเป็น Chart แบบ Realtime ได้
เผื่อเป็นประโยชนครับ
January 30, 2018
การใช้งาน Google Drive API ด้วย Google Client Library for Python

kanakorn.h

September 6, 2017
ในบทความนี้ จะแนะนำวิธีการเขียน Python เพื่อติดต่อกับ Google Drive API ทาง Google Client Library ซึ่ง จะใช้ REST v2 [1] เนื่องจาก ใน REST v3 ยังหาทางแสดง Progress ไม่ได้ (หากได้แล้วจะมา Update นะ)

สิ่งต้องมี
1. Python 2.6 ขึ้นไป
2. PIP Package Management Tool
3. เครื่องต้องต่อ Internet ได้
4. แน่นอน มี Google Account
ขั้นที่ 1: เปิดใช้ Drive API

เปิด URL https://console.cloud.google.com แล้วคลิก Select a project

จากนั้นคลิกปุ่ม + เพือสร้าง Project

ตั้งชื่อ Project แล้วคลิก Save

เลือก Project ที่สร้างขึ้น เลือก API Library ที่ต้องการ ในที่นี้คือ Google Drive API

แล้วคลิก Enable

จากนั้น Create Credentials

เลือกชนิดเป็น OAuth Client ID แล้วกรอกข้อมูลดังนี้

สร้าง Consent Screen

เลือก Application Type เป็น Web Application, ระบุ Name (จะแสดงตอนขอ Permission) แล้วตั้งค่า URL ทั้ง 2 อันเป็น http://localhost:8080

และ สุดท้าย คลิก Download

ก็จะได้ไฟล์ JSON มา ส่งนี้จะเรียกว่า “Client Secret File” ให้เก็บไฟล์ไว้ใน Directory เดียวกันกับที่ต้องการจะเขียน Python Code โดยสามารถแก้ไขเปลี่ยนชื่อ เช่น ตั้งเป็น client_secret.json

ขั้นที่ 2: ติดตั้ง Google Client Library

ติดตั้งด้วย pip ตามคำสั่งต่อไปนี้
```
pip install --upgrade google-api-python-client
```
ขั้นที่ 3: เขียน Code เพื่อติดต่อ Drive API

จาก Python Quickstart [1] เป็นการเริ่มต้นที่ดีมาก เราสามารถนำ Code มาเป็นจุดเริ่มต้นได้ โดยตัวอย่างจะทำการติดต่อไปยัง Google Drive แล้ว List รายการของไฟล์ 10 อันดับแรกออกมา

ตัวอย่างที่ Google ให้มา จะอ้างอิงไปยัง Credentials Path ไปยัง directory “.credentials” ใน “Home Directory” ของผู้ใช้ แต่ในตัวอย่างที่จะแสดงต่อไปนี้ ได้แก้ไขให้ “Client Secret File” อยู่ที่ directory เดียวกับ python file และเมื่อทำการ Authorization แล้วก็จะได้ “Credential File” มาเก็บไว้ที่เดียวกัน

Code ต้นฉบับ สามารถดูได้จาก https://developers.google.com/drive/v2/web/quickstart/python ในที่นี้จะเปลี่ยนเฉพาะส่วนที่ต้องการข้างต้น และ เขียน Comment เพื่ออธิบายเพิ่มเติมเป็นภาษาไทย (ซึ่งไม่สามารถเขียนลงไปใน Python Code ได้) โดยตั้งชื่อไฟล์ว่า listfile.py
```
from __future__ import print_function
...
# การกำหนด SCOPES ต้องสอดคล้องกับบริการที่เราจะใช้งาน
SCOPES = 'https://www.googleapis.com/auth/drive.metadata.readonly'

# แก้ไข Client Secret File ให้สอดคล้องกับไฟล์ที่ได้จาก ขั้นตอนที่ 1
CLIENT_SECRET_FILE = 'client_secret.json'
# แก้ไข Application Name ตามต้องการ
APPLICATION_NAME = 'Drive API Python Quickstart'

...
def get_credentials():
...
 # ไม่ใช้
 # home_dir =os.path.expanduser('~')
 
 # เดิม อยู่ใน os.path.join(home_dir, '.credentials')
 # แก้ไขให้อยู่ที่ Current Working Directory เดียวกันเลย
 credential_dir = os.getcwd()
 ...
 # เดิม os.path.join(credential_dir,'drive-python-quickstart.json')
 # ตั้งชื่อ Credential ตามต้องการ 
 credential_path = os.path.join(credential_dir,'drive_credential.json')
...

def main():
...
 credentials = get_credentials()
 http = credentials.authorize(httplib2.Http())

 # ตรงนี้สำคัญ จะต้องเลือกใช้ REST Version ที่ต้องการ
 # ในที่นี้ ใช้ REST v2
 service = discovery.build('drive', 'v2', http=http)
 
 # ส่วนของการเขียน Code
 # ตัวอย่างนี้ เรียกใช้ files().list()
 # โดยตั้งค่า maxResults เป็น 10 ก็คือ เรียกเฉพาะ 10 รายการแรก
 # อ้างอิงจาก https://developers.google.com/drive/v2/reference/files/list
 results = service.files().list(maxResults=10).execute()

 # จาก อ้างอิง จะเห็นได้ว่า files().list() นั้น Return หรือ Response
 # items[] ซึ่งมี element เป็น รายการของไฟล์
 items = results.get('items', [])
 
 # ตรวจสอบว่ามีไฟล์หรือไม่
 if not items:
   print('No files found.')
 else:
   # หากมีไฟล์อยู่
   print('Files:')
   # loop เพื่อแสดงไฟล์ที่มีอยู่ ในที่นี้ จะไม่เกิน maxResults ข้างต้น
   for item in items:
     # แสดงฟิลด์ title และ id
     # เพิ่มเติม .encode('utf-8') ด้วย
     print('{0} ({1})'.format(item['title'].encode('utf-8'), item['id']))

if __name__ == '__main__':
 main()
```
ขั้นที่ 4: Run

ตอนนี้ใน Directory จะมีไฟล์
- client_secrets.json
- listfile.py
ใช้คำสั่ง
```
python listfile.py
```
หากเป็นการ Run ครั้งแรก ซึ่งจะยังไม่มีไฟล์ drive_credential.json โปรแกรมก็จะทำตาม “flow” โดย ถ้า run command line บนเครื่องที่มี X Window ก็จะเปิด Web Page ไปยัง Google เพื่อ Authorization

และเปิด Web นี้ ให้คลิกเลือก Account ที่จะติดต่อด้วย

หน้า Consent Screen คืออย่างนี้ คลิกอนุญาต

ผลที่ได้

Reference:

[1] https://developers.google.com/drive/v2/web/quickstart/python
September 6, 2017
การพัฒนา API อย่างมืออาชีพ และทำไมต้อง RESTful Service

niti.c

August 29, 2016

API คืออะไร?
API ย่อมาจาก Application Programming Interface คือการพัฒนาโปรแกรมสำหรับเป็นส่วนติดต่อเซอร์วิสของแอพพลิเคชั่น หรือโมดูลต่างๆ เพื่อให้คนภายนอกมาเรียกใช้งาน หรือกล่าวอย่างง่ายๆ ก็คือการเขียนโปรแกรมเพื่อให้บริการสำหรับให้คนอื่นมาเรียกใช้งาน ซึ่งแนวคิดเรื่องการสร้าง API เพื่อการใช้งานก็มีมาอย่างยาวนานแล้ว ยกตัวอย่างเช่นตั้งแต่ที่มีการสร้างระบบปฎิบัติการ (OS) ก็จะมีการติดต่อ API ของไดร์เวอร์อุปกรณ์ฮาร์แวร์ต่างๆ ของเครื่องคอมพิวเตอร์เพื่อเรียกใช้งานอุปกรณ์นั้นๆ ตามคำสั่งของนักพัฒนา (more…)

August 29, 2016