Updates a GTM Workspace Proposal. Try it now.
Request
HTTP request
PUT https://www.googleapis.com/tagmanager/v2/path
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
path |
string |
GTM workspace proposal's relative path: Example: accounts/{aid}/containers/{cid}/workspace/{wid}/workspace_proposal |
Request body
In the request body, supply data with the following structure:
{ "status": string, "reviewers": [ { "type": string, "gaiaId": long } ], "newComment": { "content": string }, "fingerprint": string }
Property name | Value | Description | Notes |
---|---|---|---|
status |
string |
If present, the status of the workspace proposal is updated.
Acceptable values are:
|
|
reviewers[] |
list |
If present, the list of reviewers of the workspace proposal is updated. | |
reviewers[].type |
string |
User type distinguishes between a user and the Google Tag Manager system.
Acceptable values are:
|
|
reviewers[].gaiaId |
long |
Gaia id associated with a user, absent for the Google Tag Manager system. | |
newComment |
nested object |
If present, a new comment is added to the workspace proposal history. | |
newComment.content |
string |
The contents of the reviewer or author comment. | |
fingerprint |
string |
When provided, this fingerprint must match the fingerprint of the proposal in storage. |
Response
If successful, this method returns a response body with the following structure:
{ "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 }
Property name | Value | Description | Notes |
---|---|---|---|
path |
string |
GTM workspace proposal's relative path. | |
status |
string |
The status of the workspace proposal as it goes through review.
Acceptable values are:
|
|
authors[] |
list |
List of authors for the workspace proposal. | |
authors[].type |
string |
User type distinguishes between a user and the Google Tag Manager system.
Acceptable values are:
|
|
authors[].gaiaId |
long |
Gaia id associated with a user, absent for the Google Tag Manager system. | |
reviewers[] |
list |
Lists of reviewers for the workspace proposal. | |
reviewers[].type |
string |
User type distinguishes between a user and the Google Tag Manager system.
Acceptable values are:
|
|
reviewers[].gaiaId |
long |
Gaia id associated with a user, absent for the Google Tag Manager system. | |
history[] |
list |
Records the history of comments and status changes. | |
history[].type |
string |
The history type distinguishing between comments and status changes.
Acceptable values are:
|
|
history[].comment |
nested object |
A user or reviewer comment. | |
history[].comment.content |
string |
The contents of the reviewer or author comment. | |
history[].statusChange |
nested object |
A change in the proposal's status. | |
history[].statusChange.oldStatus |
string |
The old proposal status before the status change.
Acceptable values are:
|
|
history[].statusChange.newStatus |
string |
The new proposal status after that status change.
Acceptable values are:
|
|
history[].createdBy |
nested object |
The party responsible for the change in history. | |
history[].createdBy.type |
string |
User type distinguishes between a user and the Google Tag Manager system.
Acceptable values are:
|
|
history[].createdBy.gaiaId |
long |
Gaia id associated with a user, absent for the Google Tag Manager system. | |
history[].createdTimestamp |
nested object |
When this history event was added to the workspace proposal. | |
history[].createdTimestamp.seconds |
long |
Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. | |
history[].createdTimestamp.nanos |
integer |
Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. | |
fingerprint |
string |
The fingerprint of the GTM workspace proposal as computed at storage time. This value is recomputed whenever the proposal is modified. |
Try it!
Use the APIs Explorer below to call this method on live data and see the response.