Workspaces: sync

未変更のワークスペース エンティティをすべて更新し、変更済みエンティティの競合を表示することによって、ワークスペースを最新のコンテナ バージョンに同期します。 実習をご覧ください。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 価値 説明
パスパラメータ
path string GTM ワークスペースの API 相対パス。 例: accounts/{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 GTM BuiltInVariable の API 相対パス。
mergeConflict[].entityInWorkspace.builtInVariable.accountId string GTM アカウント ID。
mergeConflict[].entityInWorkspace.builtInVariable.containerId string GTM コンテナ ID。
mergeConflict[].entityInWorkspace.builtInVariable.workspaceId string GTM ワークスペース ID。
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 GTM BuiltInVariable の API 相対パス。
mergeConflict[].entityInBaseVersion.builtInVariable.accountId string GTM アカウント ID。
mergeConflict[].entityInBaseVersion.builtInVariable.containerId string GTM コンテナ ID。
mergeConflict[].entityInBaseVersion.builtInVariable.workspaceId string GTM ワークスペース ID。
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 Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。