REST Resource: accounts.containers.environments

資源:Environment

代表 Google 代碼管理工具環境。請注意,使用者可以建立、刪除及更新 USER 類型的環境,但只能更新其他類型環境的 enableDebug 和 url 欄位。

JSON 表示法
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "environmentId": string,
  "type": enum (EnvironmentType),
  "fingerprint": string,
  "name": string,
  "description": string,
  "enableDebug": boolean,
  "url": string,
  "authorizationCode": string,
  "authorizationTimestamp": string,
  "tagManagerUrl": string,

  // Union field Link can be only one of the following:
  "containerVersionId": string,
  "workspaceId": string
  // End of list of possible types for union field Link.
}
欄位
path

string

GTM 環境的 API 相對路徑。

accountId

string

Google 代碼管理工具帳戶 ID。

containerId

string

GTM 容器 ID。

environmentId

string

GTM 環境 ID 是 GTM 環境的專屬 ID。

type

enum (EnvironmentType)

這個環境的類型。

fingerprint

string

在儲存時計算的 GTM 環境指紋。環境變更時,系統會重新計算這個值。

name

string

環境顯示名稱。只能在 USER 類型環境中設定或變更。

description

string

環境說明。只能在 USER 類型環境中設定或變更。

enableDebug

boolean

是否要預設為環境啟用偵錯功能。

url

string

環境的預設預覽頁面網址。

authorizationCode

string

環境授權碼。

authorizationTimestamp

string (Timestamp format)

授權碼的上次更新時間戳記。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

tagManagerUrl

string

系統自動產生的代碼管理工具使用者介面連結

containerVersionId

string

代表容器版本的連結。

workspaceId

string

代表工作區快速預覽的連結。

EnvironmentType

列舉
user 指向使用者定義的環境。
live 指向目前的使用中容器版本。
latest 指向最新容器版本。
workspace 自動管理環境,指向工作區預覽或工作區建立的版本。

方法

create

建立 Google 代碼管理工具環境。

delete

刪除 GTM 環境。

get

取得 GTM 環境。

list

列出 GTM 容器的所有 GTM 環境。

reauthorize

重新產生 GTM 環境的授權碼。

update

更新 Google 代碼管理工具環境。