یک گزارش سفارشی از دادههای رویداد Google Analytics شما را برمیگرداند. گزارش ها حاوی آماری است که از داده های جمع آوری شده توسط کد رهگیری گوگل آنالیتیکس به دست آمده است. داده های برگردانده شده از API به صورت جدولی با ستون هایی برای ابعاد و معیارهای درخواستی است. معیارها اندازه گیری های فردی فعالیت کاربر در دارایی شما هستند، مانند کاربران فعال یا تعداد رویدادها. ابعاد، معیارها را در برخی از معیارهای رایج، مانند نام کشور یا رویداد، تجزیه میکنند.
درخواست HTTP
POST https://analyticsdata.googleapis.com/v1alpha:runReport
URL از دستور GRPC Transcoding استفاده می کند.
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON | |
---|---|
{ "entity": { object ( |
زمینه های | |
---|---|
entity | ملکی که وقایع آن پیگیری می شود. در یک درخواست دسته ای، این موجودیت باید یا نامشخص باشد یا با موجودیت در سطح دسته ای سازگار باشد. |
dimensions[] | ابعاد درخواستی و نمایش داده شده |
metrics[] | معیارهای درخواست شده و نمایش داده شده |
dateRanges[] | محدوده تاریخ داده برای خواندن. اگر چندین محدوده تاریخ درخواست شود، هر ردیف پاسخ حاوی یک شاخص محدوده تاریخ مبتنی بر صفر خواهد بود. اگر دو محدوده تاریخ همپوشانی داشته باشند، دادههای رویداد برای روزهای همپوشانی در ردیفهای پاسخ برای هر دو محدوده تاریخ گنجانده میشود. در یک درخواست گروهی، این |
offset | تعداد ردیف ردیف شروع. ردیف اول به عنوان ردیف 0 محاسبه می شود. |
limit | تعداد ردیف هایی که باید برگردانده شوند. اگر پارامتر |
metricAggregations[] | تجمیع معیارها مقادیر متریک انبوه در ردیفهایی نشان داده میشوند که در آن dimensionValues روی "RESERVED_(MetricAggregation)" تنظیم شده است. |
dimensionFilter | بند فیلتر ابعاد. برای استفاده در این فیلتر باید ابعاد درخواست شود. معیارها را نمی توان در این فیلتر استفاده کرد. |
metricFilter | بند فیلتر معیارها. در مرحله پس از تجمع، مشابه SQL دارای بند اعمال می شود. برای استفاده در این فیلتر باید معیارها را درخواست کرد. در این فیلتر نمی توان از ابعاد استفاده کرد. |
orderBys[] | نحوه ترتیب ردیف ها در پاسخ را مشخص می کند. |
currencyCode | یک کد ارز در قالب ISO4217، مانند "AED"، "USD"، "JPY". اگر فیلد خالی باشد، گزارش از واحد پول پیشفرض موجودیت استفاده میکند. |
cohortSpec | گروه کوهورت مرتبط با این درخواست. اگر یک گروه کوهورت در درخواست وجود دارد، بعد "همگروهی" باید وجود داشته باشد. |
keepEmptyRows | اگر نادرست یا نامشخص باشد، هر ردیف با تمام معیارهای برابر با 0 برگردانده نخواهد شد. اگر درست باشد، اگر این ردیفها بهطور جداگانه توسط فیلتر حذف نشوند، برگردانده میشوند. |
returnPropertyQuota | وضعیت فعلی سهمیه این Analytics Property را تغییر میدهد یا خیر. سهمیه در PropertyQuota برگردانده می شود. |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از RunReportResponse
است.
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/analytics.readonly
-
https://www.googleapis.com/auth/analytics