מדריך למתחילים ל-API באמצעות שורת הפקודה

שלב 1. הפעלת ה-API

כדי ליצור פרויקט חדש ב-Google Cloud באופן אוטומטי, לוחצים על הלחצ�� הבא להפעיל את Google Analytics Data API v1 וליצור את פרטי הכניסה של OAuth2 הדרושים מדריך:

תתבצע הפניה אוטומטית להגדרת פרטי הכניסה של OAuth2 כשתיבת הדו-שיח שואלת את השאלה לאן אתה מתקשר?, בוחרים באפשרות מחשב.

בתיבת הדו-שיח שנפתחת, לוחצים על הורדת הגדרת הלקוח ושומרים את הקובץ. credentials.json לספריית העבודה שלך.

לחלופין, אפשר לבצע את השלבים הבאים ליצירת OAuth2 פרטי כניסה בחשבון קיים פרויקט באופן ידני.

שלב 2. התקנה והפעלה של Cloud SDK

נדרשת שורת הפקודה gcloud שמותקן במכונת הפיתוח שלך.

שלב 3: ביצוע קריאה ל-API

עכשיו אפשר להשתמש ב-Google Analytics Data API כדי לשלוח שאילתות לגבי Google Analytics לנכס.

בחירת ישות שמדווחת

במדריך הזה נשתמש במשתנה הסביבה GA_PROPERTY_ID כדי לאחסן מזהה הנכס שישמש בבקשות API.

מזינים את הפקודה הבאה בשורת הפקודה כדי להגדיר את המשתנה GA_PROPERTY_ID:

export GA_PROPERTY_ID=[YOUR_GA_PROPERTY_ID]

מחליפים את [YOUR_GA_PROPERTY_ID] בנכס Google Analytics שלכם מזהה. לדוגמה:

export GA_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/$GA_PROPERTY_ID:runReport -d @request.json

הפקודה curl משתמשת בפקודה gcloud auth application-default print-access-token כדי לקבל אסימון אימות.

הערה: כדי להעביר שם קובץ ל-Curl, משתמשים באפשרות -d (ל'נתונים') מופיע לפני שם הקובץ עם הסימן @. הקובץ צריך להיות באותה ספרייה שבה מריצים את פקודת ה-curl.