Variables: list

認証が必要です

コンテナのすべての GTM 変数を一覧表示します。 今すぐ試すまたは例を見る

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 説明
パスパラメータ
accountId string GTM アカウント ID。
containerId string GTM コンテナ ID。

承認

このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です(認証と承認の詳細をご確認ください)。

範囲
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 を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。