نمای کلی Google Analytics Data API

می‌توانید از Data API برای دسترسی برنامه‌نویسی‌شده به داده‌های گزارش Google Analytics استفاده کنید.

درباره دارایی‌های Google Analytics بیشتر بدانید.

داده‌های برگشتی ازسوی API با داده‌های نشان‌داده‌شده در میانای کاربر Google Analytics سازگار است و به‌طور کامل از تنظیمات هویت گزارش‌دهی-- مثل ترکیبی، مشاهده‌شده، یا مبتنی بر دستگاه-- که برای دارایی Google Analytics شما پیکربندی شده است پیروی می‌کند.

در اینجا چند نمونه از مواردی که می‌توانید بااستفاده از Google Analytics Data API v1 گزارش کنید آورده شده است:

  • برنامه Android شما در هفته گذشته چند کاربر فعال روزانه داشته است.
  • تعداد بازدیدهای صفحه ۱۰ صفحه برتر سایت شما در ۲۸ روز گذشته.
  • تعداد کاربران فعال برنامه iOS شما در ۳۰ دقیقه گذشته براساس کشور.

همچنین می‌توانید از Google Analytics Data API v1 برای انجام کارهای زیر استفاده کنید:

  • داشبوردهای سفارشی برای نمایش داده‌های Google Analytics بسازید.
  • برای صرفه‌جویی در زمان، تکالیف گزارش‌دهی پیچیده را خودکارسازی کنید.
  • داده‌های Google Analytics خود را با سایر برنامه‌های کسب‌وکار ادغام کنید.

ثبات داده‌ها و هویت گزارش‌دهنده

‫Google Analytics Data API v1 به همان داده‌های گزارش دسترسی دارد که میانای Google Analytics دسترسی دارد. داده‌های برگردانده‌شده توسط میانای برنامه‌سازی کاربردی کاملاً به تنظیمات هویت گزارش‌کننده پیکربندی‌شده برای دارایی Google Analytics شما احترام می‌گذارد، بنابراین تعداد کاربران، حذف موارد تکراری، و مدل‌سازی داده‌ها با فضای هویت انتخاب‌شده (مانند «ترکیبی»، «مشاهده‌شده»، یا «مبتنی بر دستگاه») در تنظیمات دارایی شما مطابقت دارد.

برای کسب اطلاعات بیشتر درباره اینکه فضاهای هویت مختلف چگونه می‌توانند بر گزارش‌های شما تأثیر بگذارند، به گزارش هویت مراجعه کنید.

شروع کنید

برای شروع کار با کتابخانه کارخواه در Java،‏ Python،‏ Node.js،‏ PHP،‏ C#،‏ Go، یا Ruby، به شروع سریع کتابخانه کارخواه مراجعه کنید. برای آشنایی با نحوه ساختن پُرسمان‌ها، فیلتر کردن ابعاد، و خواندن پاسخ‌ها، ساختن گزارش را ببینید، یا پُرسمان‌ها را به‌صورت تعاملی در کاوشگر پُرسمان آزمایش کنید.

درخواست و پاسخ نمونه runReport

برای پُرسمان کردن داده‌های رویداد ازطریق REST، درخواست POST را به نقطه پایانی runReport با بدنه RunReportRequest JSON ارسال کنید که dateRanges،‏ dimensions، و metrics را مشخص می‌کند:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [
    { "startDate": "7daysAgo", "endDate": "yesterday" }
  ],
  "dimensions": [
    { "name": "country" }
  ],
  "metrics": [
    { "name": "activeUsers" }
  ]
}

یا فرمان معادل curl را بااستفاده از Application Default Credentials اجرا کنید:

curl -X POST \
  "https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport" \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "x-goog-user-project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "dateRanges": [
      { "startDate": "7daysAgo", "endDate": "yesterday" }
    ],
    "dimensions": [
      { "name": "country" }
    ],
    "metrics": [
      { "name": "activeUsers" }
    ]
  }'

«میانای برنامه‌سازی کاربردی» RunReportResponse حاوی سرصفحه‌های ستون و ردیف‌های داده را برمی‌گرداند:

{
  "dimensionHeaders": [
    { "name": "country" }
  ],
  "metricHeaders": [
    { "name": "activeUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "United States" }],
      "metricValues": [{ "value": "4820" }]
    },
    {
      "dimensionValues": [{ "value": "Japan" }],
      "metricValues": [{ "value": "2541" }]
    }
  ],
  "rowCount": 2,
  "kind": "analyticsData#runReport"
}

روش‌های دردسترس

در اینجا فهرستی از روش‌های «میانای برنامه‌سازی کاربردی داده» ارائه شده است. برای جزئیات بیشتر، مستندات مرجع را ببینید.

  • runReport این روش گزارش سفارشی‌شده‌ای از داده‌های رویداد Google Analytics شما برمی‌گرداند و روش ترجیحی برای پُرسمان‌های گزارش ساده است.
  • batchRunReports این نسخه دسته‌ای روش runReport است که به شما امکان می‌دهد بااستفاده از یک فراخوانی API، چندین گزارش تولید کنید.
  • runPivotReport این روش یک گزارش محوری سفارشی از داده‌های رویداد Google Analytics شما برمی‌گرداند. گزارش‌های محوری نسبت به گزارش‌های معمولی قالب‌های پیشرفته‌تر و گویاتری هستند. هر محور ستون‌ها و ردیف‌های بُعد قابل‌مشاهده را در پاسخ گزارش شرح می‌دهد.
  • batchRunPivotReports این نسخه دسته‌ای از روش runPivotReport است که به شما امکان می‌دهد بااستفاده از یک فراخوانی API، چندین گزارش تولید کنید.
  • getMetadata این روش فراداده‌های مربوط به ابعاد و سنجه‌های دردسترس در روش‌های گزارش‌دهی را برمی‌گرداند. برای کاوش ابعاد و سنجه‌ها استفاده می‌شود. پاسخ این روش همچنین شامل ابعاد و سنجه‌های سفارشی دردسترس برای دارایی Google Analytics مشخص‌شده است.
  • checkCompatibility این روش ابعاد و سنجه‌هایی را فهرست می‌کند که می‌توانند به درخواست گزارش اضافه شوند و سازگاری را حفظ کنند.
  • runRealtimeReport این روش گزارشی سفارشی از داده‌های رویداد هم‌زمان را برای دارایی‌تان برمی‌گرداند. رویدادها چند ثانیه پس‌از ارسال به Google Analytics در گزارش‌های هم‌زمان نشان داده می‌شوند. گزارش‌های بلادرنگ رویدادها و داده‌های استفاده را برای بازه‌های زمانی از لحظه کنونی تا ۳۰ دقیقه قبل (تا ۶۰ دقیقه برای دارایی‌های Google Analytics 360) نشان می‌دهد.
  • properties.audienceExports گروهی از روش‌ها که به شما امکان می‌دهند صادر کردن «مخاطب» را تولید کنید، که شامل نماگرفتی از کاربران در مخاطب است.
  • properties.recurringAudienceLists (پیش‌نمایش اولیه) گروهی از روش‌ها که به شما امکان می‌دهد برون‌بردهای مخاطب تکرارشونده را مدیریت کنید. صادر کردن مخاطب تکرارشونده هر روز فهرست‌های مخاطب جدیدی تولید می‌کند.
  • runFunnelReport (پیش‌نمایش اولیه) این روش گزارش قیف سفارشی‌سازی‌شده‌ای از داده‌های رویداد Google Analytics شما برمی‌گرداند. کاوش قیف به شما امکان می‌دهد مراحلی را که کاربران برای تکمیل یک تکلیف طی می‌کنند به‌تصویر بکشید و به‌سرعت ببینید در هر مرحله چقدر موفق یا ناموفق هستند.
  • properties.chat (نسخه پیش‌نمای اولیه) این روش دسترسی مکالمه‌ای برنامه‌ریزی‌شده به پرسیدن از مشاور در Google Analytics را فراهم می‌کند. می‌توانید درباره داده‌های رویدادتان سؤالاتی به زبان طبیعی بپرسید، تغییرات عملکرد را تشخیص دهید، و اطلاعات آماری جدولی و روایی ساختاریافته دریافت کنید.

ابعاد و سنجه‌های پشتیبانی‌شده

برای مشاهده فهرست همه ابعاد و سنجه‌های پشتیبانی‌شده توسط Data API، به مستندات طرح‌واره API مراجعه کنید.