Accounts.containers.workspaces.proposal: create

GTM ワークスペース プロポーザルを作成します。 こちらからお試しいただけます。

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/tagmanager/v2/+parent/proposal

パラメータ

パラメータ名 説明
パスパラメータ
parent string GTM ワークスペースの API 相対パス。 例: accounts/{aid}/containers/{cid}/workspace/{wid}

リクエスト本文

リクエストの本体では、次の構造でデータを指定します:

{
  "reviewers": [
    {
      "type": string,
      "gaiaId": long
    }
  ],
  "initialComment": {
    "content": string
  }
}
プロパティ名 説明 メモ
reviewers[] list ワークスペース プロポーザルをレビューするユーザーのリスト。
reviewers[].type string ユーザータイプにより、ユーザーと Google タグ マネージャー システムが区別されます。

有効な値は次のとおりです。
  • "gaiaId"
  • "system"
reviewers[].gaiaId long GAIA ID はユーザーに関連付けられていますが、Google タグ マネージャー システムには存在しません。
initialComment nested object 存在する場合は、ワークスペース プロポーザルに関連付ける最初のコメント。
initialComment.content string レビュー担当者や作成者のコメントの内容。

レスポンス

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

{
  "path": string,
  "status": string,
  "authors": [
    {
      "type": string,
      "gaiaId": long
    }
  ],
  "reviewers": [
    {
      "type": string,
      "gaiaId": long
    }
  ],
  "history": [
    {
      "type": string,
      "comment": {
        "content": string
      },
      "statusChange": {
        "oldStatus": string,
        "newStatus": string
      },
      "createdBy": {
        "type": string,
        "gaiaId": long
      },
      "createdTimestamp": {
        "seconds": long,
        "nanos": integer
      }
    }
  ],
  "fingerprint": string
}
プロパティ名 説明 メモ
path string GTM ワークスペース プロポーザルの相対パス。
status string レビュー中のワークスペース プロポーザルのステータス。

有効な値は次のとおりです。
  • "approved"
  • "cancelled"
  • "completed"
  • "requested"
  • "reviewed"
  • "statusUnspecified"
authors[] list ワークスペース プロポーザルの作成者のリスト。
authors[].type string ユーザータイプにより、ユーザーと Google タグ マネージャー システムが区別されます。

有効な値は次のとおりです。
  • "gaiaId"
  • "system"
authors[].gaiaId long GAIA ID はユーザーに関連付けられていますが、Google タグ マネージャー システムには存在しません。
reviewers[] list ワークスペース プロポーザルのレビュー担当者のリスト。
reviewers[].type string ユーザータイプにより、ユーザーと Google タグ マネージャー システムが区別されます。

有効な値は次のとおりです。
  • "gaiaId"
  • "system"
reviewers[].gaiaId long GAIA ID はユーザーに関連付けられていますが、Google タグ マネージャー システムには存在しません。
history[] list コメントとステータスの変更の履歴を記録します。
history[].type string コメントとステータスの変更を区別する履歴タイプ。

有効な値は次のとおりです。
  • "comment"
  • "statusChange"
  • "unspecified"
history[].comment nested object ユーザーやレビュー担当者のコメント。
history[].comment.content string レビュー担当者や作成者のコメントの内容。
history[].statusChange nested object プロポーザルのステータスの変更。
history[].statusChange.oldStatus string ステータス変更前の古いプロポーザル ステータス。

有効な値は次のとおりです。
  • "approved"
  • "cancelled"
  • "completed"
  • "requested"
  • "reviewed"
  • "statusUnspecified"
history[].statusChange.newStatus string ステータス変更後の新しいプロポーザル ステータス。

有効な値は次のとおりです。
  • "approved"
  • "cancelled"
  • "completed"
  • "requested"
  • "reviewed"
  • "statusUnspecified"
history[].createdBy nested object 履歴の変化に責任を持つ当事者。
history[].createdBy.type string ユーザータイプにより、ユーザーと Google タグ マネージャー システムが区別されます。

有効な値は次のとおりです。
  • "gaiaId"
  • "system"
history[].createdBy.gaiaId long GAIA ID はユーザーに関連付けられていますが、Google タグ マネージャー システムには存在しません。
history[].createdTimestamp nested object この履歴イベントがワークスペース プロポーザルに追加されたとき。
history[].createdTimestamp.seconds long UNIX エポック 1970-01-01T00:00:00Z からの UTC 時刻の秒数を表します。0001-01-01T00:00:00Z から 9999-12-31T23:59:59Z の範囲(境界を含む)になります。
history[].createdTimestamp.nanos integer 非負の小数以下の秒数(ナノ秒単位)。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0~999,999,999 の範囲(境界を含む)になります。
fingerprint string 保存時に計算された GTM ワークスペース プロポーザルのフィンガープリント。この値は、プロポーザルが変更されるたびに再計算されます。

試してみましょう

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