API Reference

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

انواع منابع

  1. حساب ها
  2. متغیرهای داخلی
  3. مشتریان
  4. ظروف
  5. مقاصد
  6. محیط ها
  7. پوشه ها
  8. پیکربندی برچسب گوگل
  9. برچسب ها
  10. قالب ها
  11. تحولات
  12. محرک ها
  13. مجوزهای کاربر
  14. متغیرها
  15. سرصفحه های نسخه
  16. نسخه ها
  17. فضاهای کاری
  18. مناطق

حساب ها

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

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

متغیرهای داخلی

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST / +parent /built_in_variables یک یا چند متغیر داخلی GTM ایجاد می کند.
حذف DELETE / path یک یا چند متغیر داخلی GTM را حذف می کند.
فهرست GET / +parent /built_in_variables تمام متغیرهای داخلی فعال یک ظرف GTM را فهرست می کند.
برگرداندن POST / +path /built_in_variables:revert تغییرات را به متغیرهای داخلی GTM در یک فضای کاری GTM برمی‌گرداند.

مشتریان

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST / +parent /clients یک سرویس گیرنده GTM ایجاد می کند.
حذف DELETE / path یک کلاینت GTM را حذف می کند.
گرفتن GET / path مشتری GTM دریافت می کند.
فهرست GET / +parent /clients همه سرویس گیرندگان GTM یک فضای کاری کانتینر GTM را فهرست می کند.
برگرداندن POST / +path :revert تغییرات را به یک سرویس گیرنده GTM در یک فضای کاری GTM برمی گرداند.
به روز رسانی PUT / path یک کلاینت GTM را به روز می کند.

ظروف

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
ترکیب کردن POST / +path :combine ظروف را ترکیب می کند.
ايجاد كردن POST / +parent /containers یک کانتینر ایجاد می کند.
حذف DELETE / path یک ظرف را حذف می کند.
گرفتن GET / path یک کانتینر می گیرد.
فهرست GET / +parent /containers همه کانتینرهایی را که به یک حساب GTM تعلق دارند فهرست می کند.
جستجو GET /accounts/containers:lookup یک کانتینر را با شناسه مقصد جستجو می‌کند.
move_tag_id POST / +path :move_tag_id شناسه برچسب را از یک ظرف خارج کنید.
قطعه GET / +path :snippet قطعه برچسب گذاری یک کانتینر را دریافت می کند.
به روز رسانی PUT / path یک ظرف را به روز می کند.

مقاصد

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
گرفتن GET / path مقصد می گیرد.
ارتباط دادن POST / +parent /destinations:link مقصدی را به این کانتینر اضافه می کند و آن را از کانتینری که در حال حاضر به آن مرتبط است حذف می کند.
فهرست GET / +parent /destinations همه مقصدهای مرتبط با یک کانتینر GTM را فهرست می کند.

محیط ها

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

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

پوشه ها

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST / +parent /folders یک پوشه GTM ایجاد می کند.
حذف DELETE / path یک پوشه GTM را حذف می کند.
موجودیت ها POST / +path :entities همه موجودیت های موجود در یک پوشه GTM را فهرست کنید.
گرفتن GET / path یک پوشه GTM دریافت می کند.
فهرست GET / +parent /folders همه پوشه‌های GTM یک کانتینر را فهرست می‌کند.
move_entities_to_folder POST / +path :move_entities_to_folder موجودیت ها را به یک پوشه GTM منتقل می کند. اگر {folder_id} در مسیر درخواست برابر با 0 باشد، در عوض موجودیت‌ها را از پوشه‌ای که در حال حاضر به آن تعلق دارند خارج می‌کند.
برگرداندن POST / +path :revert تغییرات را به یک پوشه GTM در یک فضای کاری GTM برمی گرداند.
به روز رسانی PUT / path یک پوشه GTM را به روز می کند.

پیکربندی برچسب گوگل

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST / +parent /gtag_config یک پیکربندی برچسب گوگل ایجاد می کند.
حذف DELETE / path پیکربندی تگ Google را حذف می کند.
گرفتن GET / path پیکربندی برچسب گوگل را دریافت می کند.
فهرست GET / +parent /gtag_config تمام تنظیمات تگ Google را در یک Container فهرست می کند.
به روز رسانی PUT / path پیکربندی تگ Google را به روز می کند.

برچسب ها

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST / +parent /tags یک تگ GTM ایجاد می کند.
حذف DELETE / path برچسب GTM را حذف می کند.
گرفتن GET / path یک برچسب GTM دریافت می کند.
فهرست GET / +parent /tags همه برچسب‌های GTM یک کانتینر را فهرست می‌کند.
برگرداندن POST / +path :revert تغییرات را به یک برچسب GTM در یک فضای کاری GTM برمی‌گرداند.
به روز رسانی PUT / path یک برچسب GTM را به روز می کند.

قالب ها

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST / +parent /templates یک الگوی سفارشی GTM ایجاد می کند.
حذف DELETE / path یک الگوی GTM را حذف می کند.
گرفتن GET / path یک الگوی GTM دریافت می کند.
فهرست GET / +parent /templates همه الگوهای GTM یک فضای کاری کانتینر GTM را فهرست می کند.
برگرداندن POST / +path :revert تغییرات را به یک الگوی GTM در یک فضای کاری GTM برمی‌گرداند.
به روز رسانی PUT / path یک الگوی GTM را به روز می کند.

تحولات

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST / +parent /transformations یک GTM Transformation ایجاد می کند.
حذف DELETE / path تبدیل GTM را حذف می کند.
گرفتن GET / path تبدیل GTM دریافت می کند.
فهرست GET / +parent /transformations تمام تغییرات GTM یک فضای کاری کانتینر GTM را فهرست می کند.
برگرداندن POST / +path :revert تغییرات را به یک GTM Transformation در یک GTM Workspace برمی گرداند.
به روز رسانی PUT / path تبدیل GTM را به روز می کند.

محرک ها

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST / +parent /triggers یک تریگر GTM ایجاد می کند.
حذف DELETE / path یک تریگر GTM را حذف می کند.
گرفتن GET / path یک ماشه GTM دریافت می کند.
فهرست GET / +parent /triggers همه محرک‌های GTM یک کانتینر را فهرست می‌کند.
برگرداندن POST / +path :revert تغییرات را به یک راه‌انداز GTM در یک فضای کاری GTM برمی‌گرداند.
به روز رسانی PUT / path یک تریگر GTM را به روز می کند.

مجوزهای کاربر

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

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

متغیرها

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST / +parent /variables یک متغیر GTM ایجاد می کند.
حذف DELETE / path یک متغیر GTM را حذف می کند.
گرفتن GET / path یک متغیر GTM دریافت می کند.
فهرست GET / +parent /variables همه متغیرهای GTM یک کانتینر را فهرست می کند.
برگرداندن POST / +path :revert تغییرات را به یک متغیر GTM در یک فضای کاری GTM برمی‌گرداند.
به روز رسانی PUT / path یک متغیر GTM را به روز می کند.

سرصفحه های نسخه

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
آخرین GET / +parent /version_headers:latest آخرین هدر نسخه ظرف را دریافت می کند
فهرست GET / +parent /version_headers تمام نسخه‌های کانتینر یک کانتینر GTM را فهرست می‌کند.

نسخه ها

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
حذف DELETE / path یک نسخه کانتینر را حذف می کند.
گرفتن GET / path یک نسخه کانتینر دریافت می کند.
زنده GET / +parent /versions:live نسخه کانتینر زنده (یعنی منتشر شده) را دریافت می کند
انتشار POST / +path :publish یک نسخه کانتینر را منتشر می کند.
set_latest POST / +path :set_latest آخرین نسخه مورد استفاده را برای همگام سازی فضاهای کاری هنگام تشخیص تداخل و خطا تنظیم می کند.
حذف کردن POST / +path :undelete یک نسخه کانتینر را حذف می کند.
به روز رسانی PUT / path یک نسخه کانتینر را به روز می کند.

فضاهای کاری

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST / +parent /workspaces یک فضای کاری ایجاد می کند.
create_version POST / +path :create_version یک نسخه کانتینر را از موجودیت های موجود در فضای کاری ایجاد می کند، فضای کاری را حذف می کند و نسخه کانتینر پایه را روی نسخه ایجاد شده جدید تنظیم می کند.
حذف DELETE / path یک فضای کاری را حذف می کند.
گرفتن GET / path یک فضای کاری می گیرد.
getStatus GET / +path /status موجودیت های متناقض و اصلاح شده را در فضای کاری پیدا می کند.
فهرست GET / +parent /workspaces همه فضاهای کاری را که به یک ظرف GTM تعلق دارند فهرست می کند.
quick_preview POST / +path :quick_preview سریع یک فضای کاری را با ایجاد یک نسخه کانتینر جعلی از همه موجودات در فضای کاری ارائه شده پیش نمایش می کند.
حل کردن_تعارض POST / +path :resolve_conflict تداخل ادغام یک موجودیت فضای کاری را با به روز رسانی آن به موجودیت حل شده ارسال شده در درخواست حل می کند.
همگام سازی POST / +path :sync با به‌روزرسانی همه موجودیت‌های فضای کاری اصلاح‌نشده و نمایش تداخل‌ها برای موجودیت‌های اصلاح‌شده، یک فضای کاری را با آخرین نسخه ظرف همگام‌سازی می‌کند.
به روز رسانی PUT / path یک فضای کاری را به روز می کند.

مناطق

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/tagmanager/v2، مگر اینکه خلاف آن ذکر شده باشد
ايجاد كردن POST / +parent /zones یک منطقه GTM ایجاد می کند.
حذف DELETE / path یک منطقه GTM را حذف می کند.
گرفتن GET / path یک منطقه GTM دریافت می کند.
فهرست GET / +parent /zones همه مناطق GTM یک فضای کاری کانتینر GTM را فهرست می کند.
برگرداندن POST / +path :revert تغییرات را به یک منطقه GTM در یک فضای کاری GTM برمی‌گرداند.
به روز رسانی PUT / path یک منطقه GTM را به روز می کند.