نمای کلی Google Analytics Admin API

خلاصه: این سند نمای کلی سطح بالایی از «نسخه ۱.۰ میانای برنامه‌سازی کاربردی سرپرست Google Analytics» ارائه می‌دهد.

این «میانای برنامه‌سازی کاربردی» ویژگی‌هایی را در کانال‌های «آلفا» و «بتا» ارائه می‌دهد. محصولات آلفا و بتا ممکن است پشتیبانی محدودی داشته باشند و تغییرات در این محصولات ممکن است با سایر نسخه‌های آلفا و بتا سازگار نباشد.

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

بتا: هیچ تغییر اساسی در این کانال پیش‌بینی نمی‌شود.

برای اعلان‌های رسمی Google Analytics API، در گروه اعلان Google Analytics API مشترک شوید.

مقدمه

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

می‌توانید از «ای‌پی‌آی سرپرست Google Analytics» برای موارد زیر استفاده کنید:

• حساب‌های جدید را آماده کنید.
• مدیریت حساب‌ها.
• تنظیمات هم‌رسانی داده را مدیریت کنید.
• خلاصه‌های حساب را فهرست کنید.
• رویدادهای سابقه تغییر را جستجو کنید.
• مدیریت دارایی‌ها.
• مدیریت زیرمجموعه ویژگی.
• جمع‌آوری داده‌های کاربر را تصدیق کنید.
• ارسال درخواست‌های حذف کاربر برای یک دارایی (آلفا).
• مدیریت تنظیم حفظ داده‌ها برای دارایی.
• مدیریت تنظیمات Google Signals برای دارایی (آلفا).
• مدیریت جریان‌ها.
• مدیریت کردن کدهای مخفی Measurement Protocol.
• مدیریت طرح‌واره مقدار تبدیل SKAdNetwork (نسخه آلفا).
• تولید تکه‌کد برچسب Google برای «جریان‌های داده وب» (نسخه آلفا).
• رویدادهای کلیدی را مدیریت کنید.
• مدیریت رویدادهای تبدیل (منسوخ).
• مدیریت قوانین ایجاد رویداد (آلفا)
• مدیریت قوانین ویرایش رویداد (آلفا)
• ابعاد سفارشی را مدیریت کنید.
• مدیریت سنجه‌های سفارشی.
• پیوندها بین دارایی‌های Google Analytics و پروژه‌های Firebase را مدیریت کنید.
• پیوندها بین دارایی‌های Google Analytics و حساب‌های Google Ads را مدیریت کنید.
• مدیریت پیشنهادهای پیوند بین دارایی Google Analytics و تبلیغ‌کننده Display & Video 360 (نسخه آلفا).
• مدیریت پیوندهای بین دارایی Google Analytics و آگهی‌دهنده Display & Video 360 (آلفا).
• مدیریت پیوندها بین دارایی Google Analytics و Search Ads 360 (نسخه آلفا).
• مدیریت پیوندها بین دارایی Google Analytics و پروژه BigQuery (نسخه آلفا).
• مدیریت اجازه‌های کاربر برای سلسله مراتب حساب و دارایی‌های Google Analytics (نسخه آلفا).
• تولید گزارش‌های دسترسی به داده‌ها.
• مدیریت مخاطبان (آلفا).
• مدیریت مجموعه‌های داده گسترده (نسخه آلفا).

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

در اینجا روش‌های دردسترس آمده است.

تأمین حساب

• accounts.provisionAccountTicket

این روش فیلد accountTicketId را برمی‌گرداند که باید در نشانی وب «شرایط خدمات» (TOS) گنجانده شود:

https://analytics.google.com/analytics/web/?provisioningSignup=false#/termsofservice/ACCOUNT_TICKET_ID

وقتی کاربر از نشانی وب «شرایط خدمات» بازدید کند و «شرایط خدمات» را بپذیرد، ایجاد حساب Google Analytics تکمیل خواهد شد. نمونه تدارک حساب را ببینید.

مدیریت حساب‌ها

• accounts.delete
• accounts.get
• accounts.list
• accounts.patch

مدیریت تنظیمات هم‌رسانی داده

• accounts.getDataSharingSettings

فهرست کردن خلاصه‌های حساب

• accountSummaries.list

جستجوی رویدادهای سابقه تغییر

• accounts.searchChangeHistoryEvents

مدیریت دارایی‌ها

• properties.get
• properties.patch
• properties.delete
• properties.list
• properties.create

مدیریت زیرمجموعه ویژگی (آلفا)

• properties.provisionSubproperty

تصدیق جمع‌آوری داده‌های کاربر

• properties.acknowledgeUserDataCollection

حذف کاربر (آلفا)

• properties.submitUserDeletion

مدیریت تنظیمات نگهداری داده‌ها

• properties.getDataRetentionSettings
• properties.updateDataRetentionSettings

مدیریت تنظیمات «سیگنال‌های Google» (آلفا)

• properties.getGoogleSignalsSettings
• properties.updateGoogleSignalsSettings

مدیریت جریان‌های داده‌ها

• properties.dataStreams.create
• properties.dataStreams.get
• properties.dataStreams.list
• properties.dataStreams.patch
• properties.dataStreams.delete

مدیریت رمزهای Measurement Protocol

• properties.dataStreams.measurementProtocolSecrets.create
• properties.dataStreams.measurementProtocolSecrets.get
• properties.dataStreams.measurementProtocolSecrets.patch
• properties.dataStreams.measurementProtocolSecrets.list
• properties.dataStreams.measurementProtocolSecrets.delete

مدیریت طرح‌واره مقدار تبدیل SKAdNetwork (آلفا)

• properties.dataStreams.sKAdNetworkConversionValueSchema.get
• properties.dataStreams.sKAdNetworkConversionValueSchema.create
• properties.dataStreams.sKAdNetworkConversionValueSchema.delete
• properties.dataStreams.sKAdNetworkConversionValueSchema.update
• properties.dataStreams.sKAdNetworkConversionValueSchema.list

مدیریت رویدادهای کلیدی

• properties.keyEvents.create
• properties.keyEvents.get
• properties.keyEvents.list
• properties.keyEvents.delete
• properties.keyEvents.patch

مدیریت رویدادهای تبدیل

منسوخ‌شده: به‌جای آن از منبع و روش‌های KeyEvent استفاده کنید.

• properties.conversionEvents.create
• properties.conversionEvents.get
• properties.conversionEvents.list
• properties.conversionEvents.delete
• properties.conversionEvents.patch

مدیریت قوانین ایجاد رویداد (آلفا)

• properties.dataStreams.eventCreateRules.create
• properties.dataStreams.eventCreateRules.get
• properties.dataStreams.eventCreateRules.list
• properties.dataStreams.eventCreateRules.delete
• properties.dataStreams.eventCreateRules.patch

مدیریت قوانین ویرایش رویداد (آلفا)

• properties.dataStreams.eventEditRules.create
• properties.dataStreams.eventEditRules.get
• properties.dataStreams.eventEditRules.list
• properties.dataStreams.eventEditRules.delete
• properties.dataStreams.eventEditRules.patch
• properties.dataStreams.eventEditRules.reorder

مدیریت ابعاد سفارشی

• properties.customDimensions.create
• properties.customDimensions.get
• properties.customDimensions.list
• properties.customDimensions.patch
• properties.customDimensions.archive

مدیریت سنجه‌های سفارشی

• properties.customMetrics.create
• properties.customMetrics.get
• properties.customMetrics.list
• properties.customMetrics.patch
• properties.customMetrics.archive

پیونددهی پروژه Firebase

• properties.firebaseLinks.create
• properties.firebaseLinks.list
• properties.firebaseLinks.delete

پیوند کردن حساب Google Ads

• properties.googleAdsLinks.create
• properties.googleAdsLinks.list
• properties.googleAdsLinks.patch
• properties.googleAdsLinks.delete

تولید برچسب Google (آلفا)

• properties.webDataStreams.getGlobalSiteTag

پیشنهادهای پیوند بین دارایی Google Analytics و تبلیغ‌کننده Display & Video 360 (نسخه آلفا)

• properties.displayVideo360AdvertiserLinkProposals.create
• properties.displayVideo360AdvertiserLinkProposals.approve
• properties.displayVideo360AdvertiserLinkProposals.cancel
• properties.displayVideo360AdvertiserLinkProposals.list
• properties.displayVideo360AdvertiserLinkProposals.get
• properties.displayVideo360AdvertiserLinkProposals.delete

پیوند حساب تبلیغ‌کننده «ویدیو ۳۶۰» و «شبکه تبلیغات» (نسخه آلفا)

• properties.displayVideo360AdvertiserLinks.create
• properties.displayVideo360AdvertiserLinks.get
• properties.displayVideo360AdvertiserLinks.list
• properties.displayVideo360AdvertiserLinks.delete
• properties.displayVideo360AdvertiserLinks.patch

پیونددهی حساب Search Ads 360 (نسخه آلفا)

• properties.searchAds360Links.create
• properties.searchAds360Links.delete
• properties.searchAds360Links.patch
• properties.searchAds360Links.list
• properties.searchAds360Links.get

درباره راه‌اندازی ادغام Analytics Search Ads 360 برای دارایی Google Analytics بیشتر بدانید.

پیوند دادن حساب BigQuery (آلفا)

• properties.bigQueryLinks.create
• properties.bigQueryLinks.delete
• properties.bigQueryLinks.get
• properties.bigQueryLinks.list
• properties.bigQueryLinks.patch

درباره راه‌اندازی صادر کردن BigQuery برای دارایی Google Analytics بیشتر بدانید.

مدیریت اجازه‌های کاربر (آلفا)

• accounts.accessBindings.create
• accounts.accessBindings.delete
• accounts.accessBindings.patch
• accounts.accessBindings.list
• accounts.accessBindings.get
• accounts.accessBindings.batchCreate
• accounts.accessBindings.batchDelete
• accounts.accessBindings.batchUpdate
• accounts.accessBindings.batchGet
• properties.accessBindings.create
• properties.accessBindings.delete
• properties.accessBindings.patch
• properties.accessBindings.list
• properties.accessBindings.get
• properties.accessBindings.batchCreate
• properties.accessBindings.batchDelete
• properties.accessBindings.batchUpdate
• properties.accessBindings.batchGet

گزارش‌های دسترسی به داده‌ها

• properties.runAccessReport

برای اطلاعات بیشتر درباره این ویژگی، راهنمای «گزارش‌های دسترسی به داده‌ها» را ببینید.

مدیریت مخاطبان (آلفا)

• properties.audiences.create
• properties.audiences.archive
• properties.audiences.patch
• properties.audiences.list
• properties.audiences.get

درباره مخاطبان در Google Analytics بیشتر بدانید.

مدیریت «مجموعه‌داده‌های گسترده» (آلفا)

• properties.expandedDataSets.create
• properties.expandedDataSets.delete
• properties.expandedDataSets.patch
• properties.expandedDataSets.list
• properties.expandedDataSets.get

درباره «مجموعه‌های داده گسترده» در Google Analytics 360 بیشتر بدانید.