מדריך למתחילים ל-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 תיפתח בחלון דפדפן חדש.

שליחת הבקשה

כדי לשלוח את הבקשה ל-Google Analytics Data API, משתמשים ב-curl ובתוכן הגוף מ-request.json. הזינו את הפקודה הבאה בשורת הפקודה:

  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 כדי לקבל אסימון אימות.

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

כל הכבוד! שלחת את הבקשה הראשונה שלך ל-Google Analytics Data API.