Method: accounts.runAccessReport

یک گزارش سفارشی از سوابق دسترسی به داده ها را برمی گرداند. این گزارش سوابقی از هر بار خواندن داده های گزارش Google Analytics توسط کاربر ارائه می دهد. سوابق دسترسی تا 2 سال حفظ می شود.

گزارش های دسترسی به داده ها را می توان برای یک ملک درخواست کرد. گزارش‌ها ممکن است برای هر دارایی درخواست شوند، اما ابعادی که به سهمیه مربوط نمی‌شوند را فقط می‌توان در دارایی‌های Google Analytics 360 درخواست کرد. این روش فقط برای مدیران در دسترس است.

این سوابق دسترسی به داده ها شامل گزارش GA UI، GA UI Explorations، GA Data API و محصولات دیگری مانند Firebase و Admob است که می توانند داده ها را از Google Analytics از طریق پیوند بازیابی کنند. این سوابق شامل تغییرات پیکربندی دارایی مانند افزودن جریان یا تغییر منطقه زمانی ملک نمی‌شود. برای تاریخچه تغییر پیکربندی، به searchChangeHistoryEvents مراجعه کنید.

برای ارائه بازخورد خود در مورد این API، فرم بازخورد Google Analytics Access Reports را تکمیل کنید.

درخواست HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=accounts/*}:runAccessReport

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
entity

string

گزارش دسترسی به داده از درخواست در سطح دارایی یا سطح حساب پشتیبانی می کند. در صورت درخواست در سطح حساب، گزارش‌های دسترسی به داده شامل همه دسترسی‌ها برای همه دارایی‌های تحت آن حساب می‌شود.

برای درخواست در سطح دارایی، موجودیت باید به عنوان مثال 'properties/123' باشد اگر "123" شناسه دارایی GA4 شما باشد. برای درخواست در سطح حساب، نهاد باید به عنوان مثال "accounts/1234" باشد اگر "1234" شناسه حساب GA4 شما باشد.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}
فیلدها
dimensions[]

object ( AccessDimension )

ابعاد درخواستی و نمایش داده شده در پاسخ. درخواست تا 9 بعد مجاز است.

metrics[]

object ( AccessMetric )

معیارهای درخواست شده و نمایش داده شده در پاسخ. درخواست تا 10 معیار مجاز است.

dateRanges[]

object ( AccessDateRange )

محدوده تاریخ سوابق دسترسی برای خواندن. اگر چندین محدوده تاریخ درخواست شود، هر ردیف پاسخ حاوی یک شاخص محدوده تاریخ مبتنی بر صفر خواهد بود. اگر دو محدوده تاریخ همپوشانی داشته باشند، رکوردهای دسترسی برای روزهای همپوشانی در ردیف‌های پاسخ برای هر دو محدوده تاریخ گنجانده می‌شود. درخواست ها تا 2 محدوده تاریخ مجاز هستند.

dimensionFilter

object ( AccessFilterExpression )

فیلترهای ابعاد به شما امکان می دهند پاسخ گزارش را به مقادیر ابعاد خاصی که با فیلتر مطابقت دارند محدود کنید. به عنوان مثال، فیلتر کردن روی سوابق دسترسی یک کاربر. برای کسب اطلاعات بیشتر، برای مثال به مبانی فیلترهای ابعاد مراجعه کنید. معیارها را نمی توان در این فیلتر استفاده کرد.

metricFilter

object ( AccessFilterExpression )

فیلترهای متریک به شما امکان می دهند پاسخ گزارش را به مقادیر متریک خاصی که با فیلتر مطابقت دارند محدود کنید. فیلترهای متریک پس از جمع‌آوری ردیف‌های گزارش اعمال می‌شوند، شبیه به SQL have-clause. در این فیلتر نمی توان از ابعاد استفاده کرد.

offset

string ( int64 format)

تعداد ردیف ردیف شروع. سطر اول به عنوان ردیف 0 شمارش می شود. اگر افست مشخص نشده باشد، به عنوان 0 در نظر گرفته می شود. اگر افست صفر باشد، این روش صفحه اول نتایج را با ورودی های limit برمی گرداند.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

limit

string ( int64 format)

تعداد ردیف هایی که باید برگردانده شوند. اگر مشخص نشده باشد، 10000 ردیف برگردانده می شود. API حداکثر 100000 سطر در هر درخواست را برمی گرداند، مهم نیست که چقدر درخواست کنید. limit باید مثبت باشد

API ممکن است تعداد ردیف‌های کمتری از limit درخواستی را برگرداند، اگر تعداد ردیف‌های باقی‌مانده به اندازه limit نباشد. به عنوان مثال، کمتر از 300 مقدار ممکن برای country بعد وجود دارد، بنابراین هنگام گزارش تنها country ، نمی توانید بیش از 300 ردیف دریافت کنید، حتی اگر limit روی مقدار بالاتر تنظیم کنید.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

timeZone

string

منطقه زمانی این درخواست اگر مشخص شده باشد. اگر مشخص نشده باشد، از منطقه زمانی ملک استفاده می شود. منطقه زمانی درخواست برای تفسیر تاریخ شروع و پایان گزارش استفاده می‌شود.

قالب بندی شده به عنوان رشته های پایگاه داده منطقه زمانی IANA ( https://www.iana.org/time-zones) . به عنوان مثال "آمریکا/نیویورک" یا "آسیا/توکیو".

orderBys[]

object ( AccessOrderBy )

نحوه ترتیب ردیف ها در پاسخ را مشخص می کند.

returnEntityQuota

boolean

وضعیت فعلی سهمیه این Analytics Property را تغییر می‌دهد یا خیر. سهمیه در AccessQuota برگردانده می شود. برای درخواست‌های سطح حساب، این فیلد باید نادرست باشد.

includeAllUsers

boolean

اختیاری. تعیین می‌کند که آیا کاربرانی که هرگز تماس API برقرار نکرده‌اند در پاسخ گنجانده شود یا خیر. اگر درست باشد، همه کاربرانی که به ویژگی یا حساب مشخص شده دسترسی دارند، صرف نظر از اینکه تماس API برقرار کرده اند یا خیر، در پاسخ گنجانده می شوند. اگر نادرست باشد، فقط کاربرانی که یک تماس API برقرار کرده اند شامل می شوند.

expandGroups

boolean

اختیاری. تصمیم می گیرد که آیا کاربران را در گروه های کاربری بازگرداند یا خیر. این فیلد فقط زمانی کار می کند که includeAllUsers روی true تنظیم شده باشد. اگر درست باشد، همه کاربرانی که به دارایی یا حساب مشخص شده دسترسی دارند، برمی گرداند. اگر نادرست باشد، فقط کاربرانی که دسترسی مستقیم دارند بازگردانده خواهند شد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از RunAccessReportResponse است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit