認証が必要です
リクエスト
HTTP リクエスト
POST https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/tags
パラメータ
パラメータ名 | 値 | 説明 |
---|---|---|
パスパラメータ | ||
accountId |
string |
GTM アカウント ID。 |
containerId |
string |
GTM コンテナ ID。 |
承認
このリクエストは、次のスコープでの承認が必要です(認証と承認の詳細をご確認ください)。
スコープ |
---|
https://www.googleapis.com/auth/tagmanager.edit.containers |
リクエスト本文
リクエストの本文には、以下のプロパティを使用して Tags リソースを指定します。
プロパティ名 | 値 | 説明 | メモ |
---|---|---|---|
必須プロパティ | |||
name |
string |
タグの表示名。 | 書き込み可能 |
parameter[].type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
priority.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
type |
string |
GTM タグのタイプ。 | 書き込み可能 |
省略可能なプロパティ | |||
blockingRuleId[] |
list |
ブロックルール ID。リストにあるルールのいずれかが true の場合、タグは配信されません。 | 書き込み可能 |
blockingTriggerId[] |
list |
ブロック トリガー ID。リストにあるトリガーのいずれかが true の場合、タグは配信されません。 | 書き込み可能 |
firingRuleId[] |
list |
配信ルール ID。リストにあるルールのいずれかが true で、blockingRuleIds のすべてが false の場合(指定されている場合)は、タグが配信されます。 |
書き込み可能 |
firingTriggerId[] |
list |
配信トリガー ID。リストにあるトリガーのいずれかが true で、blockingTriggerIds のすべてが false の場合(指定されている場合)は、タグが配信されます。 |
書き込み可能 |
liveOnly |
boolean |
true に設定すると、このタグは実際の環境でのみ配信されます(プレビュー モードやデバッグモードでは配信されません)。 | 書き込み可能 |
notes |
string |
コンテナでこのタグを利用する方法についてのユーザーのメモ。 | 書き込み可能 |
parameter[] |
list |
タグのパラメータ。 | 書き込み可能 |
parameter[].key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
parameter[].list[] |
list |
このリスト パラメータのパラメータ(キーは無視されます)。 | 書き込み可能 |
parameter[].map[] |
list |
このマップ パラメータのパラメータ(一意のキーが必要)。 | 書き込み可能 |
parameter[].value |
string |
指定された型のパラメータ値(「」などの変数参照も使用可)。 | 書き込み可能 |
paused |
boolean |
タグが一時停止になっている場合は true です。 | 書き込み可能 |
priority |
nested object |
ユーザー定義のタグの優先度(数値)。タグは優先度の高い順に非同期で配信されます。優先度の数値が最も大きいタグが最初に配信されます。タグの優先度は正または負の値で指定できます。デフォルト値は 0 です。 | 書き込み可能 |
priority.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
priority.list[] |
list |
このリスト パラメータのパラメータ(キーは無視されます)。 | 書き込み可能 |
priority.map[] |
list |
このマップ パラメータのパラメータ(一意のキーが必要)。 | 書き込み可能 |
priority.value |
string |
指定された型のパラメータ値(「」などの変数参照も使用可)。 | 書き込み可能 |
scheduleEndMs |
long |
タグをスケジュール設定する終了タイムスタンプ(ミリ秒単位)。 | 書き込み可能 |
scheduleStartMs |
long |
タグをスケジュール設定する開始タイムスタンプ(ミリ秒単位)。 | 書き込み可能 |
レスポンス
成功すると、このメソッドによりレスポンスの本文で Tags リソースが返されます。
例
注: このメソッドで使用可能なコード例では、サポートされているプログラミング言語すべての例を示しているわけではありません(サポートされている言語の一覧については、クライアント ライブラリ ページをご覧ください)。
Java
Java クライアント ライブラリを使用します。
/* * Note: This code assumes you have an authorized tagmanager service object. */ /* * This request creates a new tag. */ // Construct the parameters. Parameter arg0 = new Parameter(); arg0.setType("template"); arg0.setKey("trackingId"); arg0.setValue("UA-123456-1"); Parameter arg1 = new Parameter(); arg1.setType("template"); arg1.setKey("type"); arg1.setValue("TRACK_TRANSACTION"); // Construct the tag object. Tag tag = new Tag(); tag.setName("Sample Universal Analytics Tag"); tag.setType("ua"); tag.setLiveOnly(false); tag.setParameter(Arrays.asList(arg0, arg1)); try { Tag response = tagmanager.accounts().containers(). tags().create("123456", "54321", tag).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 response object. * The following code shows how to access the created id and fingerprint. */ System.out.println("Tag id = " + response.getTagId()); System.out.println("Tag Fingerprint = " + response.getFingerprint());
Python
Python クライアント ライブラリを使用します。
# Note: This code assumes you have an authorized tagmanager service object. # This request creates a new container tag. try: response = tagmanager.accounts().containers().tags().create( accountId='123456', containerId='54321', body={ 'name': 'Universal Analytics Tag', 'type': 'ua', 'liveOnly': False, 'parameter': [ { 'type': 'template', 'key': 'trackingId', 'value': 'UA-123456-1' }, { 'type': 'template', 'key': 'type', 'value': 'TRACK_TRANSACTION' } ] } ).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 the response object. # The following code shows how to access the created id and fingerprint. print response.get('tagId') print response.get('fingerprint')
試してみよう:
以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。