با بهروزرسانی همه موجودیتهای فضای کاری اصلاحنشده و نمایش تداخلها برای موجودیتهای اصلاحشده، یک فضای کاری را با آخرین نسخه ظرف همگامسازی میکند. الآن امتحانش کن .
درخواست
درخواست HTTP
POST https://www.googleapis.com/tagmanager/v2/+path:sync
مولفه های
نام پارامتر | ارزش | شرح |
---|---|---|
پارامترهای مسیر | ||
path | string | مسیر نسبی API GTM Workspace. مثال: accounts/{account_id}/containers/{container_id}/workspace/{workspace_id} |
مجوز
این درخواست به مجوز با محدوده زیر نیاز دارد:
محدوده |
---|
https://www.googleapis.com/auth/tagmanager.edit.containers |
برای اطلاعات بیشتر، به صفحه احراز هویت و مجوز مراجعه کنید.
درخواست بدن
با این روش بدنه درخواستی ارائه نکنید.
واکنش
در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:
{ "syncStatus": { "mergeConflict": boolean, "syncError": boolean }, "mergeConflict": [ { "entityInWorkspace": { "tag": accounts.containers.workspaces.tags Resource, "trigger": accounts.containers.workspaces.triggers Resource, "variable": accounts.containers.workspaces.variables Resource, "folder": accounts.containers.workspaces.folders Resource, "client": accounts.containers.workspaces.clients Resource, "transformation": accounts.containers.workspaces.transformations Resource, "zone": accounts.containers.workspaces.zones Resource, "customTemplate": accounts.containers.workspaces.templates Resource, "builtInVariable": { "path": string, "accountId": string, "containerId": string, "workspaceId": string, "type": string, "name": string }, "gtagConfig": accounts.containers.workspaces.gtag_config Resource, "changeStatus": string }, "entityInBaseVersion": { "tag": accounts.containers.workspaces.tags Resource, "trigger": accounts.containers.workspaces.triggers Resource, "variable": accounts.containers.workspaces.variables Resource, "folder": accounts.containers.workspaces.folders Resource, "client": accounts.containers.workspaces.clients Resource, "transformation": accounts.containers.workspaces.transformations Resource, "zone": accounts.containers.workspaces.zones Resource, "customTemplate": accounts.containers.workspaces.templates Resource, "builtInVariable": { "path": string, "accountId": string, "containerId": string, "workspaceId": string, "type": string, "name": string }, "gtagConfig": accounts.containers.workspaces.gtag_config Resource, "changeStatus": string } } ] }
نام ملک | ارزش | شرح | یادداشت |
---|---|---|---|
syncStatus | nested object | نشان می دهد که آیا همگام سازی باعث تضاد ادغام یا خطای همگام سازی شده است. | |
syncStatus. mergeConflict | boolean | عملیات همگام سازی یک تضاد ادغام را شناسایی کرد. | |
syncStatus. syncError | boolean | در حین عملیات همگام سازی خطایی رخ داد. | |
mergeConflict[] | list | تضاد ادغام پس از همگام سازی. اگر این فیلد خالی نباشد، همگام سازی همچنان موفق تلقی می شود. اما تا زمانی که تمام تضادها حل نشده باشد، نمی توان نسخه ای ایجاد کرد. | |
mergeConflict[]. entityInWorkspace | nested object | موجودیت فضای کاری که تغییرات متناقضی نسبت به نسخه پایه دارد. اگر موجودی در یک فضای کاری حذف شود، همچنان با وضعیت تغییر حذف شده ظاهر می شود. | |
mergeConflict[].entityInWorkspace. tag | nested object | برچسبی که توسط موجودیت نمایش داده می شود. | |
mergeConflict[].entityInWorkspace. trigger | nested object | ماشه توسط موجودیت نشان داده می شود. | |
mergeConflict[].entityInWorkspace. variable | nested object | متغیری که توسط موجودیت نمایش داده می شود. | |
mergeConflict[].entityInWorkspace. folder | nested object | پوشه ای که توسط نهاد نمایش داده می شود. | |
mergeConflict[].entityInWorkspace. changeStatus | string | نشان دهنده چگونگی تغییر موجودیت در فضای کاری است. مقادیر قابل قبول عبارتند از:
| |
mergeConflict[]. entityInBaseVersion | nested object | موجودیت نسخه پایه (از آخرین عملیات همگام سازی) که تغییرات متناقضی نسبت به فضای کاری دارد. اگر این فیلد وجود نداشته باشد، به این معنی است که موجودیت فضای کاری از نسخه پایه حذف شده است. | |
mergeConflict[].entityInBaseVersion. tag | nested object | برچسبی که توسط موجودیت نمایش داده می شود. | |
mergeConflict[].entityInBaseVersion. trigger | nested object | ماشه توسط موجودیت نشان داده می شود. | |
mergeConflict[].entityInBaseVersion. variable | nested object | متغیری که توسط موجودیت نمایش داده می شود. | |
mergeConflict[].entityInBaseVersion. folder | nested object | پوشه ای که توسط نهاد نمایش داده می شود. | |
mergeConflict[].entityInBaseVersion. changeStatus | string | نشان دهنده چگونگی تغییر موجودیت در فضای کاری است. مقادیر قابل قبول عبارتند از:
| |
mergeConflict[].entityInWorkspace. client | nested object | مشتری که توسط نهاد نمایندگی می شود. | |
mergeConflict[].entityInBaseVersion. client | nested object | مشتری که توسط نهاد نمایندگی می شود. | |
mergeConflict[].entityInWorkspace. transformation | nested object | تبدیلی که توسط موجودیت نشان داده می شود. | |
mergeConflict[].entityInBaseVersion. transformation | nested object | تبدیلی که توسط موجودیت نشان داده می شود. | |
mergeConflict[].entityInWorkspace. zone | nested object | منطقه ای که توسط نهاد نشان داده می شود. | |
mergeConflict[].entityInWorkspace. customTemplate | nested object | الگوی سفارشی که توسط نهاد نمایش داده می شود. | |
mergeConflict[].entityInWorkspace. builtInVariable | nested object | متغیر ساخته شده توسط موجودیت نمایش داده می شود. | |
mergeConflict[].entityInWorkspace.builtInVariable. path | string | مسیر نسبی API GTM BuiltInVariable. | |
mergeConflict[].entityInWorkspace.builtInVariable. accountId | string | شناسه حساب GTM. | |
mergeConflict[].entityInWorkspace.builtInVariable. containerId | string | شناسه کانتینر GTM. | |
mergeConflict[].entityInWorkspace.builtInVariable. workspaceId | string | شناسه فضای کاری GTM. | |
mergeConflict[].entityInWorkspace.builtInVariable. type | string | نوع متغیر داخلی مقادیر قابل قبول عبارتند از:
| |
mergeConflict[].entityInWorkspace.builtInVariable. name | string | نام متغیر داخلی که باید برای اشاره به متغیر داخلی استفاده شود. | |
mergeConflict[].entityInWorkspace. gtagConfig | nested object | پیکربندی gtag توسط موجودیت نمایش داده می شود. | |
mergeConflict[].entityInBaseVersion. zone | nested object | منطقه ای که توسط نهاد نشان داده می شود. | |
mergeConflict[].entityInBaseVersion. customTemplate | nested object | الگوی سفارشی که توسط نهاد نمایش داده می شود. | |
mergeConflict[].entityInBaseVersion. builtInVariable | nested object | متغیر ساخته شده توسط موجودیت نمایش داده می شود. | |
mergeConflict[].entityInBaseVersion.builtInVariable. path | string | مسیر نسبی API GTM BuiltInVariable. | |
mergeConflict[].entityInBaseVersion.builtInVariable. accountId | string | شناسه حساب GTM. | |
mergeConflict[].entityInBaseVersion.builtInVariable. containerId | string | شناسه کانتینر GTM. | |
mergeConflict[].entityInBaseVersion.builtInVariable. workspaceId | string | شناسه فضای کاری GTM. | |
mergeConflict[].entityInBaseVersion.builtInVariable. type | string | نوع متغیر داخلی مقادیر قابل قبول عبارتند از:
| |
mergeConflict[].entityInBaseVersion.builtInVariable. name | string | نام متغیر داخلی که باید برای اشاره به متغیر داخلی استفاده شود. | |
mergeConflict[].entityInBaseVersion. gtagConfig | nested object | پیکربندی gtag توسط موجودیت نمایش داده می شود. |
آن را امتحان کنید!
از APIs Explorer زیر برای فراخوانی این روش در دادههای زنده و دیدن پاسخ استفاده کنید.