การเริ่มต้นใช้งาน API อย่างรวดเร็วโดยใช้บรรทัดคำสั่ง

หน้านี้แสดงวิธีเริ่มต้นใช้งาน Google Analytics Data API v1 โดยใช้บรรทัดคำสั่ง

ขั้นตอนที่ 1 เปิดใช้ API

คลิกปุ่มนี้เพื่อสร้างโปรเจ็กต์ Cloud Platform ใหม่ เปิดใช้ Google Analytics Data API v1 โดยอัตโนมัติ และสร้างข้อมูลเข้าสู่ระบบ OAuth2 ที่จำเป็นสำหรับบทแนะนำนี้

เปิดใช้ Google Analytics Data API v1

ระบบจะเปลี่ยนเส้นทางคุณไปยังกล่องโต้ตอบการกำหนดค่าข้อมูลเข้าสู่ระบบ OAuth2 โดยอัตโนมัติ เลือก "เดสก์ท็อป" เมื่อระบบถามว่า "คุณโทรจากที่ไหน"

ในกล่องโต้ตอบที่แสดง ให้คลิกดาวน์โหลดการกำหนดค่าไคลเอ็นต์ แล้วบันทึกไฟล์ credentials.json ไปยังไดเรกทอรีการทำงาน

หรือจะทำตามขั้นตอนเหล่านี้เพื่อสร้างข้อมูลเข้าสู่ระบบ OAuth2 ในโปรเจ็กต์ที่มีอยู่ด้วยตนเองก็ได้

ขั้นตอนที่ 2 ติดตั้งและเริ่มต้น Cloud SDK

คุณต้องติดตั้งเครื่องมือบรรทัดคำสั่ง gcloud ในเครื่องการพัฒนา

ขั้นตอนที่ 3: เรียก API

ตอนนี้คุณสามารถใช้ Google Analytics Data API เพื่อค้นหาพร็อพเพอร์ตี้ Google Analytics 4 ได้แล้ว

เลือกเอนทิตีการรายงาน

ในบทแนะนำนี้ เราจะใช้ตัวแปรสภาพแวดล้อม GA4_PROPERTY_ID เพื่อจัดเก็บรหัสพร็อพเพอร์ตี้ที่จะใช้ในคำขอ API

ป้อนค่าต่อไปนี้ในบรรทัดคำสั่งเพื่อตั้งค่าตัวแปร GA4_PROPERTY_ID

export GA4_PROPERTY_ID=[YOUR-GA4-PROPERTY-ID]

แทนที่ [YOUR-GA4-PROPERTY-ID] ด้วยตัวระบุพร็อพเพอร์ตี้ Google Analytics 4 เช่น

export GA4_PROPERTY_ID=1234567890

สร้างคำขอ JSON

ไฟล์ request.json ต่อไปนี้แสดงวิธีสร้างรายงานอย่างง่าย

สร้างไฟล์คำขอ JSON ที่มีข้อความต่อไปนี้ แล้วบันทึกเป็นไฟล์ข้อความธรรมดา request.json ในไดเรกทอรีการทำงาน

request.json

{
  "dateRanges": [{ "startDate": "2020-09-01", "endDate": "2020-09-15" }],
  "dimensions": [{ "name": "country" }],
  "metrics": [{ "name": "activeUsers" }]
}

ตรวจสอบสิทธิ์

หากต้องการรับข้อมูลเข้าสู่ระบบของผู้ใช้ในตัวอย่างนี้ ให้เรียกใช้คำสั่งต่อไปนี้และใช้เส้นทางไปยังไฟล์ JSON สำหรับข้อมูลรับรองที่ดาวน์โหลดมาในขั้นตอนที่ 1

gcloud auth application-default login \
    --scopes=https://www.googleapis.com/auth/analytics.readonly \
    --client-id-file=[PATH/TO/credentials.json]

กล่องโต้ตอบความยินยอมของผู้ใช้ OAuth จะเปิดขึ้นในหน้าต่างเบราว์เซอร์ใหม่

ส่งคำขอ

ใช้ curl และเนื้อหาเนื้อหาจาก request.json เพื่อส่งคําขอไปยัง Google Analytics Data API ป้อนข้อมูลต่อไปนี้ในบรรทัดคำสั่ง

  curl -X POST \
  -H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
  -H "Content-Type: application/json; charset=utf-8" \
  https://analyticsdata.googleapis.com/v1beta/properties/$GA4_PROPERTY_ID:runReport -d @request.json

คำสั่ง curl ใช้คำสั่ง gcloud auth application-default print-access-token เพื่อรับโทเค็นการตรวจสอบสิทธิ์

โปรดทราบว่าหากต้องการส่งชื่อไฟล์เพื่อขดลวด ให้ใช้ตัวเลือก -d (สำหรับ "data") และใส่เครื่องหมาย @ ไว้หน้าชื่อไฟล์ ไฟล์นี้ควรอยู่ในไดเรกทอรีเดียวกับที่คุณ เรียกใช้คำสั่ง curl

ยินดีด้วย คุณได้ส่งคำขอแรกไปยัง Google Analytics Data API แล้ว