注意:此开发者网站正在向 developers.google.com/tag-platform 迁移,2021 年 9 月 30 日起系统会将您重定向到新的网址

Variables:list

需要授权

列出容器的所有 GTM 变量。 立即试用查看示例

请求

HTTP 请求

GET https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/variables

参数

参数名称 说明
路径参数
accountId string GTM 帐号 ID。
containerId string GTM 容器 ID。

授权

此请求至少需要获得以下任一范围的授权(详细了解身份验证和授权)。

范围
https://www.googleapis.com/auth/tagmanager.readonly
https://www.googleapis.com/auth/tagmanager.edit.containers

请求正文

请勿使用此方法提供请求正文。

响应

如果成功,此方法将返回采用以下结构的响应正文:

{
  "variables": [
    accounts.containers.variables Resource
  ]
}
属性名称 说明 备注
variables[] list GTM 容器的所有 GTM 变量。

示例

备注:此方法的代码示例并未列出所有受支持的编程语言(请参阅客户端库页面,查看受支持的语言列表)。

Java

使用 Java 客户端库

/*
 * Note: This code assumes you have an authorized tagmanager service object.
 */

/*
 * This request lists variables for the authorized user.
 */
try {
  ListVariablesResponse variables = tagmanager.accounts().containers().
      variables().list("123456", "54321").execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * The results of the list method are stored in the variables object.
 * The following code shows how to iterate through them.
 */
for (Variable variable: variables.getVariables()) {
  System.out.println("Account Id = " + variable.getAccountId());
  System.out.println("Container Id = " + variable.getContainerId());
  System.out.println("Variable Id = " + variable.getVariableId());
  System.out.println("Variable Name = " + variable.getName());
  System.out.println("Variable Type = " + variable.getType());
  System.out.println("Variable Notes = " + variable.getNotes());
  if (variable.getParameter() != null) {
    for (Parameter parameter : variable.getParameter()) {
      System.out.println("Parameter Type = " + parameter.getType());
      System.out.println("Parameter Key = " + parameter.getKey());
      System.out.println("Parameter Value = " + parameter.getValue());
    }
  }
  if (variable.getEnablingTriggerId() != null) {
    for (String enablingTriggerId : variable.getEnablingTriggerId()) {
      System.out.println("Enabling Trigger Id = " + enablingTriggerId);
    }
  }
  if (variable.getDisablingTriggerId() != null) {
    for (String disablingTriggerId : variable.getDisablingTriggerId()) {
      System.out.println("Disabling Trigger Id " + disablingTriggerId);
    }
  }
  System.out.println("Variable Fingerprint = "
      + variable.getFingerprint());
}

Python

使用 Python 客户端库

# Note: This code assumes you have an authorized tagmanager service object.

# This request lists variables for the authorized user.
try:
  variables = tagmanager.accounts().containers().variables().list(
      accountId='123456',
      containerId='54321'
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

# The results of the list method are stored in the variables object.
# The following code shows how to iterate through them.
for variable in variables.get('variables', []):
  print 'Account Id = %s' % variable.get('accountId')
  print 'Container Id = %s' % variable.get('containerId')
  print 'Variable Id = %s' % variable.get('variableId')
  print 'Variable Name = %s' % variable.get('name')
  print 'Variable Type = %s' % variable.get('type')
  print 'Variable notes = %s' % variable.get('notes')
  for parameter in variable.get('parameter', []):
    print 'Parameter Type = %s' % parameter.get('type')
    print 'Parameter Key = %s' % parameter.get('key')
    print 'Parameter Value = %s' % parameter.get('value')
  for enablingTrigerId in variable.get('enablingTrigerId', []):
    print 'Enabling Trigger Id = %s' % enablingTrigerId
  for disablingTriggerId in variable.get('disablingTriggerId', []):
    print 'Disabling Trigger Id = %s' % disablingTriggerId
  print 'Variable Fingerprint = %s\n\n' % variable.get('fingerprint')

试用一下!

请使用下面的 API Explorer 针对实际数据调用此方法,并查看响应。