Workspaces: getStatus

ワークスペース内で競合しているエンティティと変更されたエンティティを見つけます。 実習をご覧ください。

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/tagmanager/v2/+path/status

パラメータ

パラメータ名 値 説明
パスパラメータ
path string GTM ワークスペースの API 相対パス。 例: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}

認証

このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。

スコープ
https://www.googleapis.com/auth/tagmanager.edit.containers
https://www.googleapis.com/auth/tagmanager.readonly

詳しくは、認証と認可のページをご覧ください。

リクエストの本文

このメソッドでは、リクエストの本文を指定しません。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "workspaceChange": [
    {
      "tag": accounts.containers.workspaces.tags Resource,
      "trigger": accounts.containers.workspaces.triggers Resource,
      "variable": accounts.containers.workspaces.variables Resource,
      "folder": accounts.containers.workspaces.folders Resource,
      "changeStatus": string
    }
  ],
  "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,
        "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,
        "changeStatus": string
      }
    }
  ]
}
プロパティ名 値 説明 メモ
workspaceChange[] list ワークスペースで変更されたエンティティ。
workspaceChange[].tag nested object エンティティによって表されているタグ。
workspaceChange[].trigger nested object エンティティによって表されているトリガー。
workspaceChange[].variable nested object エンティティによって表されている変数。
workspaceChange[].folder nested object エンティティによって表されているフォルダ。
workspaceChange[].changeStatus string エンティティがワークスペース内でどのように変更されたかを表します。

有効な値は次のとおりです。
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
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"

実習

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