این سند یک نمای کلی از Google Analytics Core Reporting API نسخه 3.0 ارائه می دهد. برای مرجع دقیق API، به راهنمای مرجع مراجعه کنید.
معرفی
Google Analytics Core Reporting API به شما امکان دسترسی به بیشتر داده های گزارش در Google Analytics را می دهد. با Core Reporting API می توانید:
- داشبوردهای سفارشی برای نمایش داده های Google Analytics بسازید.
- با خودکار کردن وظایف گزارش گیری پیچیده در زمان صرفه جویی کنید.
- داده های Google Analytics خود را با سایر برنامه های تجاری ادغام کنید.
انتخاب یک نسخه
ما اخیراً نسخه جدیدی از Core Reporting API را راه اندازی کردیم.
- ساخت اپلیکیشن جدید؟ - توصیه می کنیم از آخرین نسخه 3.0 استفاده کنید.
- از نسخه قدیمی 2.3 استفاده می کنید؟ - راهنمای مهاجرت را برای جزئیات در مورد نحوه به روز رسانی برنامه خود برای استفاده از نسخه جدید بخوانید.
شروع شدن
می خواهید فوراً شروع کنید؟ آموزش Hello Analytics API را بخوانید.
هر برنامه ای که از API استفاده می کند باید چند مرحله را برای ثبت نام، مجوز دادن به کاربر و کار با API طی کند. این آموزش شما را در هر مرحله راهنمایی می کند و در پایان یک برنامه کاربردی خواهید داشت که می توانید آن را سفارشی کنید.
بررسی اجمالی مفهومی
Core Reporting API داده‌های گزارش را برمی‌گرداند که شامل آماری است که از داده‌های جمع‌آوری‌شده توسط کد رهگیری Google Analytics به دست آمده است. هر گزارش به عنوان ابعاد و معیارها سازماندهی شده است. شما از Core Reporting API برای جست‌وجوی ابعاد و معیارها استفاده می‌کنید تا گزارش‌های سفارشی بسازید.
3 مفهوم اساسی زیر بنای Core Reporting API وجود دارد:
- نحوه ارتباط گزارش ها با کاربران و بازدیدها (نمایه ها).
- ساختار یک گزارش و نحوه ساخت پرس و جو
- کار با پاسخ API
گزارش ها، کاربران و بازدیدها (نمایه ها)
برای درخواست داده های گزارش برای یک کاربر، برنامه شما باید کاربر را شناسایی کند و یک نمای (نمایه) برای بازیابی داده ها مشخص کند. یک کاربر با دریافت اعتبار مجوز و ارسال آنها در هر درخواست API شناسایی می شود. نما (نمایه) بخشی از سلسله مراتب پیکربندی Google Analytics است و با شناسه view (نمایه) شناسایی می شود.
چند راه برای یافتن شناسه نمای (نمایه) شما وجود دارد.
- برنامه شما می‌تواند از مدیریت API برای عبور از سلسله‌مراتب پیکربندی مدیریت برای دریافت شناسه نما (نمایه) استفاده کند.
- در URL هر گزارش در Google Analytics.
اسکرین شات
- در Google Analytics ، روی Admin در نوار منو کلیک کنید. اکانت و خاصیتی که نما به آن تعلق دارد را انتخاب کنید. در ستون VIEW ، روی View Settings کلیک کنید تا شناسه View را دریافت کنید.
اسکرین شات
پرس و جو برای ابعاد و متریک
شما API مربوط به داده های گزارش Google Analytics را که شامل ابعاد و معیارها است، پرس و جو می کنید. معیارها اندازه گیری های فردی فعالیت کاربر در دارایی شما هستند، مانند جلسات و بازدید از صفحه. ابعاد معیارها را در برخی از معیارهای رایج، مانند کشور یا مرورگر، تجزیه می‌کنند. هنگامی که یک پرس و جو ایجاد می کنید، مشخص می کنید که چه ابعاد و معیارهایی را در داده های گزارش خود می خواهید.
از راهنمای مرجع ابعاد و معیارهای تعاملی برای کاوش در همه ابعاد و معیارهای ارائه شده از طریق API استفاده کنید. همچنین راهنمای مرجع Core Reporting API را بخوانید تا در مورد نحوه تعیین ابعاد و معیارها در یک پرس و جوی API بیاموزید.
کار با گزارش ها
داده های بازگردانده شده از API را می توان به عنوان یک جدول با سربرگ و لیستی از ردیف ها در نظر گرفت. هر پاسخ API از یک هدر تشکیل شده است که نام و نوع داده هر ستون را توصیف می کند. پاسخ همچنین حاوی لیستی از ردیف‌ها است که در آن هر ردیف فهرستی از سلول‌ها با داده‌ها به ترتیب سرصفحه‌ها است. شما از اطلاعات هدر برای تعیین نوع داده در هر سلول استفاده می کنید.
برای اطلاعات بیشتر در مورد پاسخ API ، راهنمای مرجع گزارش اصلی API را بخوانید.
سهمیه بندی و سیاست های کاهش ارزش
Google Analytics API میلیون ها عملیات را انجام می دهد. برای محافظت از سیستم در برابر دریافت عملیات بیشتر از توان آن، و برای اطمینان از توزیع عادلانه منابع سیستم، لازم است از یک سیستم سهمیه استفاده شود. راهنمای محدودیت ها و سهمیه ها را برای محدودیت های خاص بخوانید.
برای جزئیات در مورد نحوه رسیدگی به تغییرات ستون‌های Core Reporting API (یعنی ابعاد و معیارها)، خط‌مشی انحلال داده را بخوانید. برای آشنایی با نحوه استفاده از API فراداده برای بررسی ستون‌های منسوخ شده، به راهنمای برنامه‌نویس Metadata API مراجعه کنید.
مراحل بعدی
اکنون که متوجه شدید که API چگونه کار می کند، ما مجموعه ای از منابع برای کمک به شما در شروع کار داریم:
- برای یادگیری نحوه کار با API ، راهنمای توسعه دهنده را بخوانید.
- از ابزار تعاملی Query Explorer برای ساخت بصری پرس و جوها و مشاهده پاسخ از طریق API استفاده کنید.
- مقاله Common Queries را بخوانید که چندین مورد از رایج ترین پرس و جوها را در Core Reporting API فهرست می کند.
- برای فهرستی از تمام داده‌های موجود از طریق API، مرجع ابعاد و معیارها را بررسی کنید.
- صفحه Libraries & Samples را برای فهرستی از تمام کتابخانه‌های مشتری موجود که می‌توان با این API استفاده کرد، بررسی کنید.