API Reference

این مرجع API بر اساس نوع منبع سازماندهی شده است. هر نوع منبع دارای یک یا چند نمایش داده و یک یا چند روش است.

انواع منابع

  1. حساب ها
  2. نسخه های کانتینری
  3. ظروف
  4. محیط ها
  5. Environments.reauthorize_environments
  6. پوشه ها
  7. Folders.entities
  8. Folders.move_folders
  9. مجوزها
  10. برچسب ها
  11. محرک ها
  12. متغیرها

حساب ها

برای جزئیات منابع حساب ها، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v1، مگر اینکه خلاف آن ذکر شده باشد
گرفتن GET /accounts/ accountId یک حساب GTM دریافت می کند.
فهرست GET /accounts تمام حساب‌های GTM را که کاربر به آنها دسترسی دارد فهرست می‌کند.
به روز رسانی PUT /accounts/ accountId یک حساب GTM را به روز می کند.

نسخه های کانتینری

برای جزئیات منابع نسخه‌های کانتینر، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v1، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST /accounts/ accountId /containers/ containerId /versions یک نسخه کانتینر ایجاد می کند.
حذف DELETE /accounts/ accountId /containers/ containerId /versions/ containerVersionId یک نسخه کانتینر را حذف می کند.
گرفتن GET /accounts/ accountId /containers/ containerId /versions/ containerVersionId نسخه کانتینری را دریافت می کند.
فهرست GET /accounts/ accountId /containers/ containerId /versions تمام نسخه‌های کانتینر یک ظرف GTM را فهرست می‌کند.
انتشار POST /accounts/ accountId /containers/ containerId /versions/ containerVersionId /publish نسخه کانتینری را منتشر می کند.
بازگرداندن POST /accounts/ accountId /containers/ containerId /versions/ containerVersionId /restore یک نسخه کانتینر را بازیابی می کند. با این کار پیکربندی فعلی کانتینر (شامل متغیرها، محرک‌ها و برچسب‌های آن) بازنویسی می‌شود. این عملیات هیچ تاثیری بر نسخه ای که در حال ارائه است (یعنی نسخه منتشر شده) نخواهد داشت.
حذف کردن POST /accounts/ accountId /containers/ containerId /versions/ containerVersionId /undelete یک نسخه ظرف را حذف می کند.
به روز رسانی PUT /accounts/ accountId /containers/ containerId /versions/ containerVersionId نسخه کانتینر را به روز می کند.

ظروف

برای جزئیات منابع Containers، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v1، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST /accounts/ accountId /containers یک ظرف ایجاد می کند.
حذف DELETE /accounts/ accountId /containers/ containerId یک ظرف را حذف می کند.
گرفتن GET /accounts/ accountId /containers/ containerId ظرف می گیرد.
فهرست GET /accounts/ accountId /containers همه کانتینرهایی را که به یک حساب GTM تعلق دارند فهرست می کند.
به روز رسانی PUT /accounts/ accountId /containers/ containerId یک ظرف را به روز می کند.

محیط ها

برای جزئیات منابع محیطی، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v1، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST /accounts/ accountId /containers/ containerId /environments یک محیط GTM ایجاد می کند.
حذف DELETE /accounts/ accountId /containers/ containerId /environments/ environmentId یک محیط GTM را حذف می کند.
گرفتن GET /accounts/ accountId /containers/ containerId /environments/ environmentId یک محیط GTM دریافت می کند.
فهرست GET /accounts/ accountId /containers/ containerId /environments همه محیط‌های GTM یک ظرف GTM را فهرست می‌کند.
به روز رسانی PUT /accounts/ accountId /containers/ containerId /environments/ environmentId یک محیط GTM را به روز می کند.

Environments.reauthorize_environments

برای جزئیات منابع Environments.reauthorize_environments، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v1، مگر اینکه خلاف آن ذکر شده باشد
به روز رسانی PUT /accounts/ accountId /containers/ containerId /reauthorize_environments/ environmentId کد مجوز برای محیط GTM را دوباره تولید می کند.

پوشه ها

برای جزئیات منابع پوشه ها، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v1، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST /accounts/ accountId /containers/ containerId /folders یک پوشه GTM ایجاد می کند.
حذف DELETE /accounts/ accountId /containers/ containerId /folders/ folderId یک پوشه GTM را حذف می کند.
گرفتن GET /accounts/ accountId /containers/ containerId /folders/ folderId یک پوشه GTM دریافت می کند.
فهرست GET /accounts/ accountId /containers/ containerId /folders همه پوشه‌های GTM یک کانتینر را فهرست می‌کند.
به روز رسانی PUT /accounts/ accountId /containers/ containerId /folders/ folderId یک پوشه GTM را به روز می کند.

Folders.entities

برای جزئیات منابع Folders.entities، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v1، مگر اینکه خلاف آن ذکر شده باشد
فهرست GET /accounts/ accountId /containers/ containerId /folders/ folderId /entities همه موجودیت های موجود در یک پوشه GTM را فهرست کنید.

Folders.move_folders

برای جزئیات منابع Folders.move_folders، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v1، مگر اینکه خلاف آن ذکر شده باشد
به روز رسانی PUT /accounts/ accountId /containers/ containerId /move_folders/ folderId موجودیت ها را به یک پوشه GTM منتقل می کند.

مجوزها

برای جزئیات منابع مجوز، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v1، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST /accounts/ accountId /permissions حساب کاربری و مجوزهای کانتینر را ایجاد می کند.
حذف DELETE /accounts/ accountId /permissions/ permissionId کاربر را از حساب حذف می کند و دسترسی به آن و همه کانتینرهای آن را لغو می کند.
گرفتن GET /accounts/ accountId /permissions/ permissionId مجوزهای حساب کاربری و کانتینر را دریافت می کند.
فهرست GET /accounts/ accountId /permissions همه کاربرانی که به حساب دسترسی دارند را به همراه مجوزهای حساب و کانتینری که به هر یک از آنها اعطا شده است فهرست کنید.
به روز رسانی PUT /accounts/ accountId /permissions/ permissionId مجوزهای کانتینر و حساب کاربر را به روز می کند.

برچسب ها

برای جزئیات منابع برچسب ها، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v1، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST /accounts/ accountId /containers/ containerId /tags یک تگ GTM ایجاد می کند.
حذف DELETE /accounts/ accountId /containers/ containerId /tags/ tagId یک تگ GTM را حذف می کند.
گرفتن GET /accounts/ accountId /containers/ containerId /tags/ tagId یک برچسب GTM دریافت می کند.
فهرست GET /accounts/ accountId /containers/ containerId /tags تمام برچسب‌های GTM یک کانتینر را فهرست می‌کند.
به روز رسانی PUT /accounts/ accountId /containers/ containerId /tags/ tagId یک تگ GTM را به روز می کند.

محرک ها

برای جزئیات منابع Triggers، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v1، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST /accounts/ accountId /containers/ containerId /triggers یک تریگر GTM ایجاد می کند.
حذف DELETE /accounts/ accountId /containers/ containerId /triggers/ triggerId یک ماشه GTM را حذف می کند.
گرفتن GET /accounts/ accountId /containers/ containerId /triggers/ triggerId یک ماشه GTM دریافت می کند.
فهرست GET /accounts/ accountId /containers/ containerId /triggers همه محرک‌های GTM یک کانتینر را فهرست می‌کند.
به روز رسانی PUT /accounts/ accountId /containers/ containerId /triggers/ triggerId یک ماشه GTM را به روز می کند.

متغیرها

برای جزئیات منابع متغیرها، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v1، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST /accounts/ accountId /containers/ containerId /variables یک متغیر GTM ایجاد می کند.
حذف DELETE /accounts/ accountId /containers/ containerId /variables/ variableId یک متغیر GTM را حذف می کند.
گرفتن GET /accounts/ accountId /containers/ containerId /variables/ variableId یک متغیر GTM دریافت می کند.
فهرست GET /accounts/ accountId /containers/ containerId /variables تمام متغیرهای GTM یک کانتینر را فهرست می کند.
به روز رسانی PUT /accounts/ accountId /containers/ containerId /variables/ variableId یک متغیر GTM را به روز می کند.