API Quickstart با استفاده از خط فرمان

این صفحه به شما نشان می دهد که چگونه با استفاده از خط فرمان با Google Analytics Data API v1 شروع کنید.

مرحله 1. API را فعال کنید

برای ایجاد یک پروژه Cloud Platform جدید، روی این دکمه کلیک کنید، به طور خودکار Google Analytics Data API v1 را فعال کنید و اعتبارنامه OAuth2 مورد نیاز برای این آموزش را ایجاد کنید:

Google Analytics Data API v1 را فعال کنید

شما به طور خودکار به کادر گفتگوی پیکربندی اعتبارنامه OAuth2 هدایت خواهید شد. هنگامی که از شما پرسیده شد "از کجا تماس می گیرید؟" را انتخاب کنید "Desktop" را انتخاب کنید.

در گفتگوی حاصل، روی DOWNLOAD CLIENT CONFIGURATION کلیک کنید و فایل 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]

شناسه دارایی Google Analytics 4 خود را جایگزین [YOUR-GA4-ProPERTY-ID] کنید. مثلا:

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 (برای "داده") استفاده می کنید و قبل از نام فایل با علامت @ قرار می گیرید. این فایل باید در همان دایرکتوری باشد که دستور curl را در آن اجرا می کنید.

تبریک می گویم! شما اولین درخواست خود را به Google Analytics Data API ارسال کرده اید.