Workspaces: sync

Синхронизирует рабочую область с последней версией контейнера, обновляя все неизмененные объекты рабочей области и отображая конфликты для измененных объектов. Попробуй это сейчас .

Запрос

HTTP-запрос

POST https://www.googleapis.com/tagmanager/v2/+path:sync

Параметры

Имя параметра Ценить Описание
Параметры пути
path string Относительный путь API GTM Workspace. Пример: аккаунты/{account_id}/containers/{container_id}/workspaces/{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 Представляет, как объект был изменен в рабочей области.

Приемлемые значения:
  • " added "
  • " changeStatusUnspecified "
  • " deleted "
  • " none "
  • " updated "
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 Представляет, как объект был изменен в рабочей области.

Приемлемые значения:
  • " added "
  • " changeStatusUnspecified "
  • " deleted "
  • " none "
  • " updated "
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.
mergeConflict[].entityInWorkspace.builtInVariable. accountId string Идентификатор аккаунта GTM.
mergeConflict[].entityInWorkspace.builtInVariable. containerId string Идентификатор контейнера GTM.
mergeConflict[].entityInWorkspace.builtInVariable. workspaceId string Идентификатор рабочей области GTM.
mergeConflict[].entityInWorkspace.builtInVariable. type string Тип встроенной переменной.

Приемлемые значения:
  • " advertiserId "
  • " advertisingTrackingEnabled "
  • " ampBrowserLanguage "
  • " ampCanonicalHost "
  • " ampCanonicalPath "
  • " ampCanonicalUrl "
  • " ampClientId "
  • " ampClientMaxScrollX "
  • " ampClientMaxScrollY "
  • " ampClientScreenHeight "
  • " ampClientScreenWidth "
  • " ampClientScrollX "
  • " ampClientScrollY "
  • " ampClientTimestamp "
  • " ampClientTimezone "
  • " ampGtmEvent "
  • " ampPageDownloadTime "
  • " ampPageLoadTime "
  • " ampPageViewId "
  • " ampReferrer "
  • " ampTitle "
  • " ampTotalEngagedTime "
  • " appId "
  • " appName "
  • " appVersionCode "
  • " appVersionName "
  • " builtInVariableTypeUnspecified "
  • " clickClasses "
  • " clickElement "
  • " clickId "
  • " clickTarget "
  • " clickText "
  • " clickUrl "
  • " clientName "
  • " containerId "
  • " containerVersion "
  • " debugMode "
  • " deviceName "
  • « elementVisibilityFirstTime »
  • " elementVisibilityRatio "
  • " elementVisibilityRecentTime "
  • « elementVisibilityTime »
  • " environmentName "
  • " errorLine "
  • " errorMessage "
  • " errorUrl "
  • " event "
  • " eventName "
  • " firebaseEventParameterCampaign "
  • " firebaseEventParameterCampaignAclid "
  • " firebaseEventParameterCampaignAnid "
  • " firebaseEventParameterCampaignClickTimestamp "
  • " firebaseEventParameterCampaignContent "
  • " firebaseEventParameterCampaignCp1 "
  • " firebaseEventParameterCampaignGclid "
  • " firebaseEventParameterCampaignSource "
  • " firebaseEventParameterCampaignTerm "
  • " firebaseEventParameterCurrency "
  • " firebaseEventParameterDynamicLinkAcceptTime "
  • " firebaseEventParameterDynamicLinkLinkid "
  • " firebaseEventParameterNotificationMessageDeviceTime "
  • " firebaseEventParameterNotificationMessageId "
  • " firebaseEventParameterNotificationMessageName "
  • " firebaseEventParameterNotificationMessageTime "
  • " firebaseEventParameterNotificationTopic "
  • " firebaseEventParameterPreviousAppVersion "
  • " firebaseEventParameterPreviousOsVersion "
  • " firebaseEventParameterPrice "
  • " firebaseEventParameterProductId "
  • " firebaseEventParameterQuantity "
  • " firebaseEventParameterValue "
  • " firstPartyServingUrl "
  • " formClasses "
  • " formElement "
  • " formId "
  • " formTarget "
  • " formText "
  • " formUrl "
  • " historySource "
  • " htmlId "
  • " language "
  • " newHistoryFragment "
  • " newHistoryState "
  • " newHistoryUrl "
  • " oldHistoryFragment "
  • " oldHistoryState "
  • " oldHistoryUrl "
  • " osVersion "
  • " pageHostname "
  • " pagePath "
  • " pageUrl "
  • " platform "
  • " queryString "
  • " randomNumber "
  • " referrer "
  • " requestMethod "
  • " requestPath "
  • " resolution "
  • " scrollDepthDirection "
  • " scrollDepthThreshold "
  • " scrollDepthUnits "
  • " sdkVersion "
  • " serverPageLocationHostname "
  • " serverPageLocationPath "
  • " serverPageLocationUrl "
  • " videoCurrentTime "
  • " videoDuration "
  • " videoPercent "
  • " videoProvider "
  • " videoStatus "
  • " videoTitle "
  • " videoUrl "
  • " videoVisible "
  • " visitorRegion "
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.
mergeConflict[].entityInBaseVersion.builtInVariable. accountId string Идентификатор аккаунта GTM.
mergeConflict[].entityInBaseVersion.builtInVariable. containerId string Идентификатор контейнера GTM.
mergeConflict[].entityInBaseVersion.builtInVariable. workspaceId string Идентификатор рабочей области GTM.
mergeConflict[].entityInBaseVersion.builtInVariable. type string Тип встроенной переменной.

Приемлемые значения:
  • " advertiserId "
  • " advertisingTrackingEnabled "
  • " ampBrowserLanguage "
  • " ampCanonicalHost "
  • " ampCanonicalPath "
  • " ampCanonicalUrl "
  • " ampClientId "
  • " ampClientMaxScrollX "
  • " ampClientMaxScrollY "
  • " ampClientScreenHeight "
  • " ampClientScreenWidth "
  • " ampClientScrollX "
  • " ampClientScrollY "
  • " ampClientTimestamp "
  • " ampClientTimezone "
  • " ampGtmEvent "
  • " ampPageDownloadTime "
  • " ampPageLoadTime "
  • " ampPageViewId "
  • " ampReferrer "
  • " ampTitle "
  • " ampTotalEngagedTime "
  • " appId "
  • " appName "
  • " appVersionCode "
  • " appVersionName "
  • " builtInVariableTypeUnspecified "
  • " clickClasses "
  • " clickElement "
  • " clickId "
  • « clickTarget »
  • " clickText "
  • " clickUrl "
  • " clientName "
  • " containerId "
  • " containerVersion "
  • " debugMode "
  • " deviceName "
  • « elementVisibilityFirstTime »
  • " elementVisibilityRatio "
  • " elementVisibilityRecentTime "
  • « elementVisibilityTime »
  • " environmentName "
  • " errorLine "
  • " errorMessage "
  • " errorUrl "
  • " event "
  • " eventName "
  • " firebaseEventParameterCampaign "
  • " firebaseEventParameterCampaignAclid "
  • " firebaseEventParameterCampaignAnid "
  • " firebaseEventParameterCampaignClickTimestamp "
  • " firebaseEventParameterCampaignContent "
  • " firebaseEventParameterCampaignCp1 "
  • " firebaseEventParameterCampaignGclid "
  • " firebaseEventParameterCampaignSource "
  • " firebaseEventParameterCampaignTerm "
  • " firebaseEventParameterCurrency "
  • " firebaseEventParameterDynamicLinkAcceptTime "
  • " firebaseEventParameterDynamicLinkLinkid "
  • " firebaseEventParameterNotificationMessageDeviceTime "
  • " firebaseEventParameterNotificationMessageId "
  • " firebaseEventParameterNotificationMessageName "
  • " firebaseEventParameterNotificationMessageTime "
  • " firebaseEventParameterNotificationTopic "
  • " firebaseEventParameterPreviousAppVersion "
  • " firebaseEventParameterPreviousOsVersion "
  • " firebaseEventParameterPrice "
  • " firebaseEventParameterProductId "
  • " firebaseEventParameterQuantity "
  • " firebaseEventParameterValue "
  • " firstPartyServingUrl "
  • " formClasses "
  • " formElement "
  • " formId "
  • " formTarget "
  • " formText "
  • " formUrl "
  • " historySource "
  • " htmlId "
  • " language "
  • " newHistoryFragment "
  • " newHistoryState "
  • " newHistoryUrl "
  • " oldHistoryFragment "
  • " oldHistoryState "
  • " oldHistoryUrl "
  • " osVersion "
  • " pageHostname "
  • " pagePath "
  • " pageUrl "
  • " platform "
  • " queryString "
  • " randomNumber "
  • " referrer "
  • " requestMethod "
  • " requestPath "
  • " resolution "
  • " scrollDepthDirection "
  • " scrollDepthThreshold "
  • " scrollDepthUnits "
  • " sdkVersion "
  • " serverPageLocationHostname "
  • " serverPageLocationPath "
  • " serverPageLocationUrl "
  • " videoCurrentTime "
  • " videoDuration "
  • " videoPercent "
  • " videoProvider "
  • " videoStatus "
  • " videoTitle "
  • " videoUrl "
  • " videoVisible "
  • " visitorRegion "
mergeConflict[].entityInBaseVersion.builtInVariable. name string Имя встроенной переменной, которое будет использоваться для ссылки на встроенную переменную.
mergeConflict[].entityInBaseVersion. gtagConfig nested object Конфигурация gtag, представленная объектом.

Попробуй это!

Используйте API-интерфейс ниже, чтобы вызвать этот метод для реальных данных и просмотреть ответ.