このページは Cloud Translation API によって翻訳されました。

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,
        "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,
        "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`	エンティティによって表される変換。

試してみよう:

以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。