認証が必要です
リクエスト
HTTP リクエスト
POST 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.edit.containers |
リクエスト本文
リクエストの本文には、以下のプロパティを使用して Variables リソースを指定します。
プロパティ名 | 値 | 説明 | メモ |
---|---|---|---|
必須プロパティ | |||
name |
string |
変数の表示名。 | 書き込み可能 |
parameter[].type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
type |
string |
GTM 変数の型。 | 書き込み可能 |
省略可能なプロパティ | |||
disablingTriggerId[] |
list |
モバイル コンテナのみ: 条件変数を無効にするためのトリガー ID のリスト。すべての無効化トリガーが false である一方で、有効化トリガーの 1 つが true の場合、変数は有効になります。順不同のセットとして扱われます。 | 書き込み可能 |
enablingTriggerId[] |
list |
モバイル コンテナのみ: 条件変数を有効にするためのトリガー ID のリスト。すべての無効化トリガーが false である一方で、有効化トリガーの 1 つが true の場合、変数は有効になります。順不同のセットとして扱われます。 | 書き込み可能 |
notes |
string |
コンテナでこの変数を利用する方法についてのユーザーのメモ。 | 書き込み可能 |
parameter[] |
list |
変数のパラメータ。 | 書き込み可能 |
parameter[].key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
parameter[].list[] |
list |
このリスト パラメータのパラメータ(キーは無視されます)。 | 書き込み可能 |
parameter[].map[] |
list |
このマップ パラメータのパラメータ(一意のキーが必要)。 | 書き込み可能 |
parameter[].value |
string |
指定された型のパラメータ値(「」などの変数参照も使用可)。 | 書き込み可能 |
scheduleEndMs |
long |
変数をスケジュール設定する終了タイムスタンプ(ミリ秒単位)。 | 書き込み可能 |
scheduleStartMs |
long |
変数をスケジュール設定する開始タイムスタンプ(ミリ秒単位)。 | 書き込み可能 |
レスポンス
成功すると、このメソッドによりレスポンスの本文で Variables リソースが返されます。
例
注: このメソッドで使用可能なコード例では、サポートされているプログラミング言語すべての例を示しているわけではありません(サポートされている言語の一覧については、クライアント ライブラリ ページをご覧ください)。
Java
Java クライアント ライブラリを使用します。
/* * Note: This code assumes you have an authorized tagmanager service object. */ /* * This request creates a new variable for the authorized user. */ // Create the variable object. Variable variable = new Variable(); variable.setName("randomNumber"); variable.setType("r"); // The random number type. try { Variable response = tagmanager.accounts().containers(). variables().create("123456", "54321", variable).execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); } /* * The results of the create method are stored in the response object. * The following code shows how to access the created Id and Fingerprint. */ System.out.println("Variable Id = " + response.getVariableId()); System.out.println("Variable Fingerprint = " + response.getFingerprint());
Python
Python クライアント ライブラリを使用します。
# Note: This code assumes you have an authorized tagmanager service object. # This request creates a new variable. try: response = tagmanager.accounts().containers().variables().create( accountId='23732470', containerId='801231', body={ 'name': 'random_number', 'type': 'r' } ).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 create method are stored in response object. # The following code shows how to access the created id and fingerprint. print 'Variable Id = %s' % response.get('variableId') print 'Variable Fingerprint = %s' % response.get('fingerprint')
試してみよう:
以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。