API مدیریت
این راهنمای مرجع برای مدیریت API نسخه 3.0 است. جزئیات کاملی در مورد پرس و جوها و پاسخ ها برای داده های پیکربندی Google Analytics ارائه می دهد. برای راهنمای مفاهیم و ساختار داده‌های پیکربندی، نسخه 3.0 را ببینید .
هر بخش در این راهنما روش درخواست و پاسخ را برای یک نوع موجودیت در داده های پیکربندی برای یک کاربر احراز هویت شده تعریف می کند. درخواست ها همه در قالب REST نشان داده می شوند. در انتهای صفحه برای هر روش، می توانید با استفاده از "Try it!" درخواست را به صورت تعاملی در APIs Explorer امتحان کنید. ارتباط دادن.
انواع منابع
- خلاصه حساب
- لینک های کاربر حساب
- حساب ها
- پیوندهای AdWords
- منابع داده سفارشی
- ابعاد سفارشی
- معیارهای سفارشی
- آزمایش
- فیلترها
- اهداف
- شناسه مشتری
- لینک های فیلتر پروفایل
- لینک های کاربر پروفایل
- مخاطبان بازاریابی مجدد
- بخش ها
- گزارش های نمونه برداری نشده
- آپلودها
- بازدیدها (نمایه ها)
- ویژگی های وب
- لینک های کاربری Webproperty
خلاصه حساب
برای جزئیات منابع خلاصه حساب، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| فهرست | GET /management/accountSummaries | خلاصه‌های حساب را فهرست می‌کند (درخت سبک متشکل از حساب‌ها/ویژگی‌ها/پروفایل‌ها) که کاربر به آنها دسترسی دارد. |
لینک های کاربر حساب
برای جزئیات منبع پیوندهای کاربر حساب، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| حذف | DELETE /management/accounts/ accountId /entityUserLinks/ linkId | یک کاربر را از حساب داده شده حذف می کند. |
| درج کنید | POST /management/accounts/ accountId /entityUserLinks | اگر کاربر کمتر از 100 حساب داشته باشد، یک کاربر جدید به حساب داده شده اضافه می کند. |
| فهرست | GET /management/accounts/ accountId /entityUserLinks | پیوندهای حساب کاربری را برای یک حساب معین فهرست می کند. |
| به روز رسانی | PUT /management/accounts/ accountId /entityUserLinks/ linkId | مجوزها را برای یک کاربر موجود در حساب داده شده به روز می کند. |
حساب ها
برای جزئیات منابع حساب ها، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| فهرست | GET /management/accounts | تمام حساب هایی که کاربر به آنها دسترسی دارد را فهرست می کند. |
پیوندهای AdWords
برای جزئیات منبع پیوندهای AdWords، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| حذف | DELETE /management/accounts/ accountId /webproperties/ webPropertyId /entityAdWordsLinks/ webPropertyAdWordsLinkId | یک پیوند دارای وب - AdWords را حذف می کند. |
| گرفتن | GET /management/accounts/ accountId /webproperties/ webPropertyId /entityAdWordsLinks/ webPropertyAdWordsLinkId | یک ویژگی وب - پیوند AdWords را برمی‌گرداند که کاربر به آن دسترسی دارد. |
| درج کنید | POST /management/accounts/ accountId /webproperties/ webPropertyId /entityAdWordsLinks | یک پیوند webProperty-AdWords ایجاد می کند. |
| فهرست | GET /management/accounts/ accountId /webproperties/ webPropertyId /entityAdWordsLinks | پیوندهای webProperty-AdWords را برای یک ویژگی وب معین فهرست می کند. |
| پچ | PATCH /management/accounts/ accountId /webproperties/ webPropertyId /entityAdWordsLinks/ webPropertyAdWordsLinkId | پیوند webProperty-AdWords موجود را به روز می کند. این روش از معنای پچ پشتیبانی می کند. |
| به روز رسانی | PUT /management/accounts/ accountId /webproperties/ webPropertyId /entityAdWordsLinks/ webPropertyAdWordsLinkId | پیوند webProperty-AdWords موجود را به روز می کند. |
منابع داده سفارشی
برای جزئیات منابع منابع داده سفارشی، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| فهرست | GET /management/accounts/ accountId /webproperties/ webPropertyId /customDataSources | فهرست منابع داده سفارشی که کاربر به آنها دسترسی دارد. |
ابعاد سفارشی
برای جزئیات منابع ابعاد سفارشی، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| گرفتن | GET /management/accounts/ accountId /webproperties/ webPropertyId /customDimensions/ customDimensionId | یک بعد سفارشی دریافت کنید که کاربر به آن دسترسی دارد. |
| درج کنید | POST /management/accounts/ accountId /webproperties/ webPropertyId /customDimensions | یک بعد سفارشی جدید ایجاد کنید. |
| فهرست | GET /management/accounts/ accountId /webproperties/ webPropertyId /customDimensions | ابعاد سفارشی که کاربر به آنها دسترسی دارد را فهرست می کند. |
| پچ | PATCH /management/accounts/ accountId /webproperties/ webPropertyId /customDimensions/ customDimensionId | یک بعد سفارشی موجود را به روز می کند. این روش از معنای پچ پشتیبانی می کند. |
| به روز رسانی | PUT /management/accounts/ accountId /webproperties/ webPropertyId /customDimensions/ customDimensionId | یک بعد سفارشی موجود را به روز می کند. |
معیارهای سفارشی
برای جزئیات منابع معیارهای سفارشی، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| گرفتن | GET /management/accounts/ accountId /webproperties/ webPropertyId /customMetrics/ customMetricId | معیاری سفارشی دریافت کنید که کاربر به آن دسترسی دارد. |
| درج کنید | POST /management/accounts/ accountId /webproperties/ webPropertyId /customMetrics | یک متریک سفارشی جدید ایجاد کنید. |
| فهرست | GET /management/accounts/ accountId /webproperties/ webPropertyId /customMetrics | معیارهای سفارشی را که کاربر به آنها دسترسی دارد فهرست می کند. |
| پچ | PATCH /management/accounts/ accountId /webproperties/ webPropertyId /customMetrics/ customMetricId | یک سنجه سفارشی موجود را به روز می کند. این روش از معنای پچ پشتیبانی می کند. |
| به روز رسانی | PUT /management/accounts/ accountId /webproperties/ webPropertyId /customMetrics/ customMetricId | یک سنجه سفارشی موجود را به روز می کند. |
آزمایش
برای جزئیات منابع آزمایشی، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| حذف | DELETE /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /experiments/ experimentId | یک آزمایش را حذف کنید. |
| گرفتن | GET /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /experiments/ experimentId | آزمایشی را برمی‌گرداند که کاربر به آن دسترسی دارد. |
| درج کنید | POST /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /experiments | یک آزمایش جدید ایجاد کنید. |
| فهرست | GET /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /experiments | آزمایش هایی را که کاربر به آنها دسترسی دارد فهرست می کند. |
| پچ | PATCH /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /experiments/ experimentId | یک آزمایش موجود را به‌روزرسانی کنید. این روش از معنای پچ پشتیبانی می کند. |
| به روز رسانی | PUT /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /experiments/ experimentId | یک آزمایش موجود را به‌روزرسانی کنید. |
فیلترها
برای جزئیات منابع فیلترها، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| حذف | DELETE /management/accounts/ accountId /filters/ filterId | یک فیلتر را حذف کنید |
| گرفتن | GET /management/accounts/ accountId /filters/ filterId | فیلترهایی را که کاربر به آن دسترسی دارد برمی‌گرداند. |
| درج کنید | POST /management/accounts/ accountId /filters | یک فیلتر جدید ایجاد کنید. |
| فهرست | GET /management/accounts/ accountId /filters | تمام فیلترهای یک حساب را فهرست می کند |
| پچ | PATCH /management/accounts/ accountId /filters/ filterId | یک فیلتر موجود را به روز می کند. این روش از معنای پچ پشتیبانی می کند. |
| به روز رسانی | PUT /management/accounts/ accountId /filters/ filterId | یک فیلتر موجود را به روز می کند. |
اهداف
برای جزئیات منابع اهداف، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| گرفتن | GET /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /goals/ goalId | هدفی را دریافت می کند که کاربر به آن دسترسی دارد. |
| درج کنید | POST /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /goals | یک هدف جدید ایجاد کنید. |
| فهرست | GET /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /goals | اهدافی را که کاربر به آنها دسترسی دارد فهرست می کند. |
| پچ | PATCH /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /goals/ goalId | یک هدف موجود را به روز می کند. این روش از معنای پچ پشتیبانی می کند. |
| به روز رسانی | PUT /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /goals/ goalId | یک هدف موجود را به روز می کند. |
شناسه مشتری
برای جزئیات منابع Management.clientId، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| hashClientId | POST /management/clientId:hashClientId | شناسه مشتری داده شده را هش می کند. |
لینک های فیلتر پروفایل
برای جزئیات منبع پیوندهای فیلتر نمایه، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| حذف | DELETE /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /profileFilterLinks/ linkId | پیوند فیلتر پروفایل را حذف کنید. |
| گرفتن | GET /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /profileFilterLinks/ linkId | پیوند فیلتر نمایه واحد را برمی‌گرداند. |
| درج کنید | POST /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /profileFilterLinks | یک لینک فیلتر پروفایل جدید ایجاد کنید. |
| فهرست | GET /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /profileFilterLinks | تمام پیوندهای فیلتر نمایه را برای یک نمایه فهرست می کند. |
| پچ | PATCH /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /profileFilterLinks/ linkId | پیوند فیلتر نمایه موجود را به روز کنید. این روش از معنای پچ پشتیبانی می کند. |
| به روز رسانی | PUT /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /profileFilterLinks/ linkId | پیوند فیلتر نمایه موجود را به روز کنید. |
لینک های کاربر پروفایل
برای جزئیات منبع پیوندهای کاربر نمایه، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| حذف | DELETE /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /entityUserLinks/ linkId | کاربر را از نمای داده شده (نمایه) حذف می کند. |
| درج کنید | POST /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /entityUserLinks | کاربر جدیدی را به نمای داده شده (نمایه) اضافه می کند. |
| فهرست | GET /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /entityUserLinks | پیوندهای پروفایل کاربر را برای یک نمای معین (نمایه) فهرست می کند. |
| به روز رسانی | PUT /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /entityUserLinks/ linkId | مجوزها را برای یک کاربر موجود در نمای داده شده (نمایه) به روز می کند. |
مخاطبان بازاریابی مجدد
برای جزئیات منابع مخاطبان بازاریابی مجدد، به صفحه نمایش منبع مراجعه کنید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| حذف | DELETE /management/accounts/ accountId /webproperties/ webPropertyId /remarketingAudiences/ remarketingAudienceId | مخاطبان بازاریابی مجدد را حذف کنید. |
| گرفتن | GET /management/accounts/ accountId /webproperties/ webPropertyId /remarketingAudiences/ remarketingAudienceId | مخاطبان بازاریابی مجدد را به دست می آورد که کاربر به آنها دسترسی دارد. |
| درج کنید | POST /management/accounts/ accountId /webproperties/ webPropertyId /remarketingAudiences | مخاطبان بازاریابی مجدد جدیدی ایجاد می کند. |
| فهرست | GET /management/accounts/ accountId /webproperties/ webPropertyId /remarketingAudiences | مخاطبین بازاریابی مجدد را که کاربر به آنها دسترسی دارد فهرست می کند. |
| پچ | PATCH /management/accounts/ accountId /webproperties/ webPropertyId /remarketingAudiences/ remarketingAudienceId | مخاطبان بازاریابی مجدد موجود را به روز می کند. این روش از معنای پچ پشتیبانی می کند. |
| به روز رسانی | PUT /management/accounts/ accountId /webproperties/ webPropertyId /remarketingAudiences/ remarketingAudienceId | مخاطبان بازاریابی مجدد موجود را به روز می کند. |
بخش ها
برای جزئیات منابع بخش ها، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| فهرست | GET /management/segments | بخش هایی را که کاربر به آنها دسترسی دارد فهرست می کند. |
گزارش های نمونه برداری نشده
برای جزئیات منابع گزارش های نمونه برداری نشده، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| حذف | DELETE /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /unsampledReports/ unsampledReportId | یک گزارش نمونه برداری نشده را حذف می کند. |
| گرفتن | GET /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /unsampledReports/ unsampledReportId | یک گزارش بدون نمونه را برمی گرداند. |
| درج کنید | POST /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /unsampledReports | یک گزارش بدون نمونه جدید ایجاد کنید. |
| فهرست | GET /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId /unsampledReports | گزارش های نمونه برداری نشده ای را که کاربر به آنها دسترسی دارد فهرست می کند. |
آپلودها
برای جزئیات منبع آپلود، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| حذف آپلود داده | POST /management/accounts/ accountId /webproperties/ webPropertyId /customDataSources/ customDataSourceId /deleteUploadData | اطلاعات مرتبط با آپلود قبلی را حذف کنید. |
| گرفتن | GET /management/accounts/ accountId /webproperties/ webPropertyId /customDataSources/ customDataSourceId /uploads/ uploadId | آپلودهایی را که کاربر به آنها دسترسی دارد فهرست کنید. |
| فهرست | GET /management/accounts/ accountId /webproperties/ webPropertyId /customDataSources/ customDataSourceId /uploads | آپلودهایی را که کاربر به آنها دسترسی دارد فهرست کنید. |
| آپلود داده | POST | داده ها را برای یک منبع داده سفارشی آپلود کنید. |
بازدیدها (نمایه ها)
برای مشاهده (نمایه ها) جزئیات منابع، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| حذف | DELETE /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId | یک نما (نمایه) را حذف می کند. |
| گرفتن | GET /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId | یک نمای (نمایه) که کاربر به آن دسترسی دارد دریافت می کند. |
| درج کنید | POST /management/accounts/ accountId /webproperties/ webPropertyId /profiles | یک نمای جدید (نمایه) ایجاد کنید. |
| فهرست | GET /management/accounts/ accountId /webproperties/ webPropertyId /profiles | نماها (پروفایل) را که کاربر به آنها دسترسی دارد فهرست می کند. |
| پچ | PATCH /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId | یک نمای (نمایه) موجود را به روز می کند. این روش از معنای پچ پشتیبانی می کند. |
| به روز رسانی | PUT /management/accounts/ accountId /webproperties/ webPropertyId /profiles/ profileId | یک نمای (نمایه) موجود را به روز می کند. |
ویژگی های وب
برای جزئیات منابع Web Properties، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| گرفتن | GET /management/accounts/ accountId /webproperties/ webPropertyId | دارایی را دریافت می کند که کاربر به آن دسترسی دارد. |
| درج کنید | POST /management/accounts/ accountId /webproperties | یک ویژگی جدید ایجاد می کند. |
| فهرست | GET /management/accounts/ accountId /webproperties | ویژگی هایی را که کاربر به آنها دسترسی دارد فهرست می کند. |
| پچ | PATCH /management/accounts/ accountId /webproperties/ webPropertyId | یک ویژگی موجود را به روز می کند. این روش از معنای پچ پشتیبانی می کند. |
| به روز رسانی | PUT /management/accounts/ accountId /webproperties/ webPropertyId | یک ویژگی موجود را به روز می کند. |
لینک های کاربری Webproperty
برای جزئیات منبع پیوندهای کاربر Webproperty، صفحه نمایش منبع را ببینید.
| روش | درخواست HTTP | شرح |
|---|---|---|
| URI های مربوط به https://www.googleapis.com/analytics/v3، مگر اینکه به طور دیگری ذکر شده باشد | ||
| حذف | DELETE /management/accounts/ accountId /webproperties/ webPropertyId /entityUserLinks/ linkId | یک کاربر را از ویژگی وب داده شده حذف می کند. |
| درج کنید | POST /management/accounts/ accountId /webproperties/ webPropertyId /entityUserLinks | یک کاربر جدید به ویژگی وب داده شده اضافه می کند. |
| فهرست | GET /management/accounts/ accountId /webproperties/ webPropertyId /entityUserLinks | پیوندهای webProperty-user را برای یک ویژگی وب معین فهرست می کند. |
| به روز رسانی | PUT /management/accounts/ accountId /webproperties/ webPropertyId /entityUserLinks/ linkId | مجوزهای یک کاربر موجود در ویژگی وب داده شده را به روز می کند. |