คู่มือสำหรับนักพัฒนาซอฟต์แวร์นี้จะอธิบายขั้นตอนที่จำเป็นในการเข้าถึง สร้าง และจัดการเอนทิตีภายในบัญชี Google Tag Manager ผ่าน Tag Manager API v2
เกริ่นนำ
คู่มือนี้จะอธิบายขั้นตอนต่างๆ ในการเข้าถึงและกำหนดค่าบัญชี Google Tag Manager เมื่อเสร็จสิ้น คุณจะมีความเข้าใจขั้นพื้นฐานเกี่ยวกับวิธีทำงานต่อไปนี้
- สร้างออบเจ็กต์บริการ Tag Manager
- ตรวจสอบสิทธิ์และให้สิทธิ์ผู้ใช้
- ใช้งาน Tag Manager API เพื่อเข้าถึงและจัดการทรัพยากร
ก่อนเริ่มต้น
ก่อนที่จะเริ่มคู่มือนี้ เราขอแนะนำให้คุณทำความคุ้นเคยกับ Google Tag Manager โดยไปที่ ศูนย์ช่วยเหลือของ Google Tag Manager
การใช้บัญชีทดสอบ
หากคุณต้องการใช้ Tag Manager API เพื่อสร้าง กำหนดค่า หรือลบเนื้อหา เราขอแนะนำให้คุณติดตั้งและยืนยันโค้ดด้วยบัญชีทดสอบ การใช้บัญชีทดสอบจะช่วยป้องกันไม่ให้คุณทำการเปลี่ยนแปลงบัญชีที่ใช้งานอยู่โดยไม่ตั้งใจ เมื่อคุณทดสอบและยืนยันว่าโค้ดทำงานได้แล้ว เมื่อใช้บัญชีทดสอบแล้ว คุณก็เริ่มใช้ การติดตั้งใช้งานกับบัญชีจริงได้
เลือกภาษา
เลือกภาษาการเขียนโปรแกรมที่คุณต้องการทำตามตัวอย่าง
Python
ระบบจะเลือก Python ไว้สำหรับข้อมูลโค้ดทั้งหมดในคู่มือนี้
JavaScript
มีการเลือก JavaScript สำหรับข้อมูลโค้ดทั้งหมดในคู่มือนี้
ภาพรวมของโปรแกรม
โปรแกรมตัวอย่างที่รวมอยู่ในคู่มือนี้เป็นแอปบรรทัดคำสั่ง โดยพิจารณาจากรหัสบัญชี แอปจะค้นหาคอนเทนเนอร์ชื่อ Greetings และสร้างแท็ก Universal Analytics ในคอนเทนเนอร์นั้น เมื่อผู้ใช้เข้าชม hello-world.html แท็กจะส่ง Hit การดูหน้าเว็บ
ในการพัฒนาแอปพลิเคชันนี้ คุณต้องทำตามขั้นตอนต่อไปนี้
- ตั้งค่าสภาพแวดล้อมในการพัฒนาซอฟต์แวร์และโปรเจ็กต์ในคอนโซล Google API
- สร้างออบเจ็กต์บริการ Tag Manager
- ให้สิทธิ์เข้าถึงบัญชี Tag Manager
- สร้างออบเจ็กต์บริการ Tag Manager
- ค้นหา API, จัดการการตอบกลับ และแสดงผลลัพธ์
- รับออบเจ็กต์บริการ Tag Manager เริ่มต้น
- ใช้ออบเจ็กต์บริการ Tag Manager เพื่อค้นหา
Tag Manager API เพื่อทำสิ่งต่อไปนี้
- ดึงข้อมูลคอนเทนเนอร์ Greetings ของบัญชี Google Tag Manager ที่ตรวจสอบสิทธิ์แล้ว
- สร้างพื้นที่ทำงานใหม่
- สร้างแท็ก Universal Analytics
- สร้างทริกเกอร์เพื่อเริ่มการทำงานของแท็ก
- อัปเดตแท็กให้เริ่มทำงานในทริกเกอร์
ตั้งค่าสภาพแวดล้อมการพัฒนาและโปรเจ็กต์ของคุณ
สร้างคอนเทนเนอร์คำทักทาย
คู่มือนี้จะถือว่าคุณมีบัญชี Google Tag Manager ที่มีคอนเทนเนอร์ชื่อคำทักทาย ทำตามวิธีการสำหรับการตั้งค่าและเวิร์กโฟลว์ (เว็บ) เพื่อสร้างบัญชีและคอนเทนเนอร์ที่ชื่อว่าคำทักทาย
ติดตั้งไลบรารีของไคลเอ็นต์
ก่อนเริ่มต้น ให้ติดตั้งและกำหนดค่าไลบรารีของไคลเอ็นต์ Google APIs
สร้างและกำหนดค่าโปรเจ็กต์ในคอนโซล Google API
หากต้องการเริ่มต้นใช้งาน Tag Manager API ก่อนอื่นคุณต้องใช้เครื่องมือตั้งค่า ซึ่งจะแนะนำขั้นตอนการสร้างโปรเจ็กต์ในคอนโซล Google API การเปิดใช้ API และสร้างข้อมูลเข้าสู่ระบบ
คู่มือนี้ใช้ขั้นตอนการตรวจสอบสิทธิ์แอปพลิเคชันที่ติดตั้ง ทำตามวิธีการด้านล่างเพื่อสร้างข้อมูลเข้าสู่ระบบโปรเจ็กต์ เมื่อมีข้อความแจ้ง ให้เลือก Installed Application สำหรับประเภทแอปพลิเคชันและ Other สำหรับประเภทแอปพลิเคชันที่ติดตั้ง
- จากหน้าข้อมูลเข้าสู่ระบบ ให้คลิกสร้างข้อมูลเข้าสู่ระบบ > รหัสไคลเอ็นต์ OAuth เพื่อสร้างข้อมูลเข้าสู่ระบบ OAuth 2.0 หรือสร้างข้อมูลเข้าสู่ระบบ > คีย์บัญชีบริการเพื่อสร้างบัญชีบริการ
- หากคุณสร้างรหัสไคลเอ็นต์ OAuth ให้เลือกประเภทแอปพลิเคชัน
- กรอกแบบฟอร์มและคลิกสร้าง
ตอนนี้รหัสไคลเอ็นต์และคีย์บัญชีบริการของแอปพลิเคชันจะแสดงอยู่ในหน้าข้อมูลเข้าสู่ระบบ โปรดคลิกรหัสไคลเอ็นต์เพื่อดูรายละเอียด พารามิเตอร์จะแตกต่างกันไปขึ้นอยู่กับประเภทรหัส แต่อาจรวมถึงอีเมล รหัสลับไคลเอ็นต์ ต้นทาง JavaScript หรือ URI การเปลี่ยนเส้นทาง
ดาวน์โหลดรายละเอียดไคลเอ็นต์โดยคลิกปุ่มดาวน์โหลด JSON เปลี่ยนชื่อไฟล์นี้เป็น client_secrets.json เราจะใช้ไฟล์นี้ในการตรวจสอบสิทธิ์ในภายหลัง
สร้างออบเจ็กต์บริการ Tag Manager
ออบเจ็กต์ service ของ Tag Manager คือสิ่งที่คุณจะใช้เพื่อสร้างคำขอ API
ขั้นตอนที่จำเป็นในการสร้างออบเจ็กต์บริการ Tag Manager มีดังนี้
- ให้สิทธิ์เข้าถึงบัญชี Google Tag Manager
- สร้างอินสแตนซ์บริการ Tag Manager
ให้สิทธิ์เข้าถึงบัญชี Google Tag Manager
เมื่อผู้ใช้เริ่มใช้แอปพลิเคชันที่สร้างด้วย Google Tag Manager API จะต้องให้สิทธิ์การเข้าถึงบัญชี Google Tag Manager แก่แอปพลิเคชันนั้น กระบวนการนี้เรียกว่าการให้สิทธิ์ วิธีที่แนะนำในการให้สิทธิ์ผู้ใช้คือ OAuth 2.0 หากต้องการดูข้อมูลเพิ่มเติม โปรดอ่านการให้สิทธิ์ Tag Manager API
โค้ดด้านล่างใช้รายละเอียดโปรเจ็กต์และไคลเอ็นต์ที่สร้างขึ้นด้านบนเพื่อตรวจสอบสิทธิ์ผู้ใช้แอปพลิเคชัน และขอสิทธิ์เข้าถึง Google Tag Manager ในนามของผู้ใช้
แอปพลิเคชันจะพยายามเปิดเบราว์เซอร์เริ่มต้นและนำผู้ใช้ ไปยัง URL ที่โฮสต์บน google.com จากนั้นผู้ใช้จะได้รับข้อความแจ้งให้ลงชื่อเข้าใช้และให้สิทธิ์แอปพลิเคชันเข้าถึงบัญชีเครื่องจัดการแท็ก เมื่อให้สิทธิ์แล้ว แอปพลิเคชันจะพยายามอ่านรหัสจากหน้าต่างเบราว์เซอร์ จากนั้นปิดหน้าต่าง
หมายเหตุ: หากเกิดข้อผิดพลาด แอปพลิเคชันจะแจ้งให้ผู้ใช้ป้อนรหัสการให้สิทธิ์ในบรรทัดคำสั่งแทน
Python
"""Access and manage a Google Tag Manager account."""
import argparse
import sys
import httplib2
from apiclient.discovery import build
from oauth2client import client
from oauth2client import file
from oauth2client import tools
def GetService(api_name, api_version, scope, client_secrets_path):
"""Get a service that communicates to a Google API.
Args:
api_name: string The name of the api to connect to.
api_version: string The api version to connect to.
scope: A list of strings representing the auth scopes to authorize for the
connection.
client_secrets_path: string A path to a valid client secrets file.
Returns:
A service that is connected to the specified API.
"""
# Parse command-line arguments.
parser = argparse.ArgumentParser(
formatter_class=argparse.RawDescriptionHelpFormatter,
parents=[tools.argparser])
flags = parser.parse_args([])
# Set up a Flow object to be used if we need to authenticate.
flow = client.flow_from_clientsecrets(
client_secrets_path, scope=scope,
message=tools.message_if_missing(client_secrets_path))
# Prepare credentials, and authorize HTTP object with them.
# If the credentials don't exist or are invalid run through the native client
# flow. The Storage object will ensure that if successful the good
# credentials will get written back to a file.
storage = file.Storage(api_name + '.dat')
credentials = storage.get()
if credentials is None or credentials.invalid:
credentials = tools.run_flow(flow, storage, flags)
http = credentials.authorize(http=httplib2.Http())
# Build the service object.
service = build(api_name, api_version, http=http)
return service
def main(argv):
# Define the auth scopes to request.
scope = ['https://www.googleapis.com/auth/tagmanager.edit.containers']
# Authenticate and construct service.
service = GetService('tagmanager', 'v2', scope, 'client_secrets.json')
if __name__ == '__main__':
main(sys.argv)
JavaScript
<html>
<head>
<script type="text/javascript">
// Your Client ID can be retrieved from your project in the Google
// Developer Console, https://console.developers.google.com
var CLIENT_ID = TODO;
var SCOPES = [
'https://www.googleapis.com/auth/tagmanager.manage.accounts',
'https://www.googleapis.com/auth/tagmanager.edit.containers',
'https://www.googleapis.com/auth/tagmanager.delete.containers',
'https://www.googleapis.com/auth/tagmanager.edit.containerversions',
'https://www.googleapis.com/auth/tagmanager.manage.users',
'https://www.googleapis.com/auth/tagmanager.publish'
];
// Parameter values used by the script
ACCOUNT_PATH = TODO; // such as: 'accounts/555555';
CONTAINER_NAME = 'Greetings';
WORKSPACE_NAME = 'Example workspace';
/**
* Check if current user has authorization for this application.
*
* @param {bool} immediate Whether login should use the "immediate mode", which
* causes the security token to be refreshed behind the scenes with no UI.
*/
function checkAuth(immediate) {
var authorizeCheckPromise = new Promise((resolve) => {
gapi.auth.authorize(
{ client_id: CLIENT_ID, scope: SCOPES.join(' '), immediate: immediate },
resolve);
});
authorizeCheckPromise
.then(handleAuthResult)
.then(loadTagManagerApi)
.then(runTagManagerExample)
.catch(() => {
console.log('You must authorize any access to the api.');
});
}
/**
* Check if current user has authorization for this application.
*/
function checkAuth() {
checkAuth(true);
}
/**
* Initiate auth flow in response to user clicking authorize button.
*
* @param {Event} event Button click event.
* @return {boolean} Returns false.
*/
function handleAuthClick(event) {
checkAuth();
return false;
}
/**
* Handle response from authorization server.
*
* @param {Object} authResult Authorization result.
* @return {Promise} A promise to call resolve if authorize or redirect to a
* login flow.
*/
function handleAuthResult(authResult) {
return new Promise((resolve, reject) => {
var authorizeDiv = document.getElementById('authorize-div');
if (authResult && !authResult.error) {
// Hide auth UI, then load client library.
authorizeDiv.style.display = 'none';
resolve();
} else {
// Show auth UI, allowing the user to initiate authorization by
// clicking authorize button.
authorizeDiv.style.display = 'inline';
reject();
}
});
}
/**
* Load Tag Manager API client library.
*
* @return {Promise} A promise the load the Tag Manager API library.
*/
function loadTagManagerApi() {
return new Promise((resolve, reject) => {
console.log('Load Tag Manager api');
gapi.client.load('tagmanager', 'v2', resolve);
});
}
/**
* Interacts with the tagmanager api v2 to create a container, workspace,
* trigger, and tag.
*
* @return {Promise} A promise to run the Tag Manager example.
*/
function runTagManagerExample() {
return new Promise((resolve, reject) => {
console.log('Running Tag Manager Example.');
resolve();
});
}
/**
* Logs an error message to the console.
*
* @param {string|Object} error The error to log to the console.
*/
function handleError(error) {
console.log('Error when interacting with GTM API');
console.log(error);
}
/**
* Wraps an API request into a promise.
*
* @param {Object} a request to the API.
* @return {Promise} A promise to execute the API request.
*/
function requestPromise(request) {
return new Promise((resolve, reject) => {
request.execute((response) => {
if (response.code) {
reject(response);
}
resolve(response);
});
});
}
</script>
<script src="https://apis.google.com/js/client.js?onload=checkAuth">
</script>
</head>
<body>
<div id="authorize-div" style="display: none">
<span>Authorize access to Tag Manager API</span>
<!--Button for the user to click to initiate auth sequence -->
<button id="authorize-button" onclick="handleAuthClick(event)">
Authorize
</button>
</div>
<pre id="output"></pre>
</body>
</html>
ค้นหา API ของ Tag Manager
คุณใช้ออบเจ็กต์บริการ Tag Manager เพื่อค้นหา Tag Manager API ได้ คุณต้องทำตามขั้นตอนต่อไปนี้เพื่อใช้โปรแกรมตัวอย่าง
- เรียกข้อมูลคอนเทนเนอร์คำทักทาย
- สร้างแท็ก Universal Analytics
- สร้างทริกเกอร์เพื่อเริ่มการทำงานของแท็ก
- อัปเดตแท็กให้เริ่มทำงานในทริกเกอร์
1. ดึงข้อมูลคอนเทนเนอร์คำทักทาย
ฟังก์ชันต่อไปนี้แสดงวิธีใช้ออบเจ็กต์บริการ Tag Manager เพื่อค้นหา Tag Manager API เพื่อแสดงคอนเทนเนอร์ทั้งหมดของบัญชีและเรียกคอนเทนเนอร์ชื่อGreetings
Python
def FindGreetingsContainer(service, account_path):
"""Find the greetings container.
Args:
service: the Tag Manager service object.
account_path: the path of the Tag Manager account from which to retrieve the
Greetings container.
Returns:
The greetings container if it exists, or None if it does not.
"""
# Query the Tag Manager API to list all containers for the given account.
container_wrapper = service.accounts().containers().list(
parent=account_path).execute()
# Find and return the Greetings container if it exists.
for container in container_wrapper['container']:
if container['name'] == 'Greetings':
return container
return None
JavaScript
/**
* Returns the greetings container if it exists.
*
* @param {string} accountPath The account which contains the Greetings
* container.
* @return {Promise} A promise to find the greetings container.
*/
function findContainer(accountPath, containerName) {
console.log('Finding container in account:' + accountPath);
var request = gapi.client.tagmanager.accounts.containers.list({
'parent': accountPath
});
return requestPromise(request)
.then((response) => {
var containers = response.container || [];
var container =
containers.find((container) => container.name === containerName);
return container ||
Promise.reject('Unable to find ' + containerName +' container.');
});
}
จากนั้นอัปเดตสาขาการดำเนินการหลักของโปรแกรมเพื่อเรียกใช้ฟังก์ชัน findGreetingsContainer ตาม Tag Manager accountId เช่น
Python
def main(argv):
# Get tag manager account ID from command line.
assert len(argv) == 2 and 'usage: gtm-api-hello-world.py <account_id>'
account_id = str(argv[1])
account_path = 'accounts/%s' % account_id
# Define the auth scopes to request.
scope = ['https://www.googleapis.com/auth/tagmanager.edit.containers']
# Authenticate and construct service.
service = GetService('tagmanager', 'v2', scope, 'client_secrets.json')
# Find the greetings container.
container = FindGreetingsContainer(service, account_path)
if __name__ == '__main__':
main(sys.argv)
JavaScript
/**
* Interacts with the tagmanager api v2 to create a container, workspace,
* trigger, and tag.
*
* @return {Promise} A promise to run the tag manager example.
*/
function runTagManagerExample() {
return new Promise((resolve, reject) => {
console.log('Running Tag Manager Example.');
var trigger = null;
var workspace = null;
findContainer(ACCOUNT_PATH, CONTAINER_NAME)
.catch(handleError);
resolve();
});
}
2. สร้างพื้นที่ทำงานใหม่
ข้อมูลโค้ดต่อไปนี้ใช้ Tag Manager API ในการสร้างพื้นที่ทำงานใหม่ ซึ่งเราจะใช้เพื่อจัดการการเปลี่ยนแปลงทริกเกอร์และแท็ก คุณสามารถตรวจสอบข้อมูลอ้างอิงเมธอดการสร้าง Workspace เพื่อดูรายการพร็อพเพอร์ตี้ที่จำเป็นและที่ไม่บังคับซึ่งตั้งค่าได้เมื่อสร้างพื้นที่ทำงาน
Python
def CreateWorkspace(service, container):
"""Creates a workspace named 'my workspace'.
Args:
service: the Tag Manager service object.
container: the container to insert the workspace within.
Returns:
The created workspace.
"""
return service.accounts().containers().workspaces().create(
parent=container['path'],
body={
'name': 'my workspace',
}).execute()
JavaScript
/**
* Creates a workspace in the Greetings container.
*
* @param {Object} container The container to create a new workspace.
* @return {Promise} A promise to create a workspace.
*/
function createWorkspace(container) {
console.log('Creating workspace in container:' + container.path);
var request = gapi.client.tagmanager.accounts.containers.workspaces.create(
{ 'parent': container.path },
{ name: WORKSPACE_NAME, description: 'my workspace created via api' });
return requestPromise(request);
}
3. สร้างแท็ก Universal Analytics
ข้อมูลโค้ดต่อไปนี้ใช้ Tag Manager API ในการสร้างแท็ก Universal Analytics คุณไปที่ข้อมูลอ้างอิงวิธีสร้างแท็กเพื่อดูรายการพร็อพเพอร์ตี้ที่จำเป็นและไม่บังคับซึ่งตั้งค่าได้เมื่อสร้างแท็ก และดูรายการพร็อพเพอร์ตี้สำหรับแท็กแต่ละประเภทได้ที่ข้อมูลอ้างอิงจากพจนานุกรมแท็ก
Python
def CreateHelloWorldTag(service, workspace, tracking_id):
"""Create the Universal Analytics Hello World Tag.
Args:
service: the Tag Manager service object.
workspace: the workspace to create a tag within.
tracking_id: the Universal Analytics tracking ID to use.
Returns:
The created tag.
"""
hello_world_tag = {
'name': 'Universal Analytics Hello World',
'type': 'ua',
'parameter': [{
'key': 'trackingId',
'type': 'template',
'value': str(tracking_id),
}],
}
return service.accounts().containers().workspaces().tags().create(
parent=workspace['path'],
body=hello_world_tag).execute()
JavaScript
/**
* Creates a universal analytics tag.
*
* @param {Object} workspace The workspace to create the tag
* @return {Promise} A promise to create a hello world tag.
*/
function createHelloWorldTag(workspace) {
console.log('Creating hello world tag');
var helloWorldTag = {
'name': 'Universal Analytics Hello World',
'type': 'ua',
'parameter':
[{ 'key': 'trackingId', 'type': 'template', 'value': 'UA-1234-5' }],
};
var request =
gapi.client.tagmanager.accounts.containers.workspaces.tags.create(
{ 'parent': workspace.path }, helloWorldTag);
return requestPromise(request);
}
4. สร้างทริกเกอร์เพื่อเริ่มการทำงานของแท็ก
เมื่อสร้างแท็กเสร็จแล้ว ขั้นตอนถัดไปคือการสร้างทริกเกอร์ที่จะเริ่มทำงานในหน้าเว็บ
ทริกเกอร์จะมีชื่อว่า Hello World Trigger และจะเริ่มทำงานสำหรับการดูหน้าเว็บทั้งหมด เช่น
Python
def CreateHelloWorldTrigger(service, workspace):
"""Create the Hello World Trigger.
Args:
service: the Tag Manager service object.
workspace: the workspace to create the trigger within.
Returns:
The created trigger.
"""
hello_world_trigger = {
'name': 'Hello World Rule',
'type': 'PAGEVIEW'
}
return service.accounts().containers().workspaces().triggers().create(
parent=workspace['path'],
body=hello_world_trigger).execute()
JavaScript
/**
* Creates a page view trigger.
*
* @param {Object} workspace The workspace to create the trigger in.
* @return {Promise} A promise to create a page view trigger.
*/
function createHelloWorldTrigger(workspace) {
console.log('Creating hello world trigger in workspace');
var helloWorldTrigger = { 'name': 'Hello World Trigger', 'type': 'PAGEVIEW' };
var request =
gapi.client.tagmanager.accounts.containers.workspaces.triggers.create(
{ 'parent': workspace.path }, helloWorldTrigger);
return requestPromise(request);
}
5. อัปเดตแท็กให้เริ่มทำงานในทริกเกอร์
เมื่อสร้างแท็กและทริกเกอร์แล้ว แท็กและทริกเกอร์จะต้องเชื่อมโยงกัน หากต้องการทำเช่นนี้ ให้เพิ่ม triggerId ลงในรายการ firingTriggerIds ที่เชื่อมโยงกับแท็ก เช่น
Python
def UpdateHelloWorldTagWithTrigger(service, tag, trigger):
"""Update a Tag with a Trigger.
Args:
service: the Tag Manager service object.
tag: the tag to associate with the trigger.
trigger: the trigger to associate with the tag.
"""
# Get the tag to update.
tag = service.accounts().containers().workspaces().tags().get(
path=tag['path']).execute()
# Update the Firing Trigger for the Tag.
tag['firingTriggerId'] = [trigger['triggerId']]
# Update the Tag.
response = service.accounts().containers().workspaces().tags().update(
path=tag['path'],
body=tag).execute()
JavaScript
/**
* Updates a tag to fire on a particular trigger.
*
* @param {Object} tag The tag to update.
* @param {Object} trigger The trigger which causes the tag to fire.
* @return {Promise} A promise to update a tag to fire on a particular trigger.
*/
function updateHelloWorldTagWithTrigger(tag, trigger) {
console.log('Update hello world tag with trigger');
tag['firingTriggerId'] = [trigger.triggerId];
var request =
gapi.client.tagmanager.accounts.containers.workspaces.tags.update(
{ 'path': tag.path }, tag);
return requestPromise(request);
}
จากนั้นอัปเดตสาขาการดำเนินการหลักของโปรแกรมเพื่อเรียกใช้ฟังก์ชันสร้างและอัปเดต เช่น
Python
def main(argv):
# Get tag manager account ID from command line.
assert len(argv) == 2 and 'usage: gtm-api-hello-world.py <account_id>'
account_id = str(argv[1])
account_path = 'accounts/%s' % account_id
# Define the auth scopes to request.
scope = ['https://www.googleapis.com/auth/tagmanager.edit.containers']
# Authenticate and construct service.
service = GetService('tagmanager', 'v2', scope, 'client_secrets.json')
# Find the greetings container.
container = FindGreetingsContainer(service, account_path)
# Create a new workspace.
workspace = CreateWorkspace(service, container)
# Create the hello world tag.
tag = CreateHelloWorldTag(
service, workspace, 'UA-1234-5')
# Create the hello world Trigger.
trigger = CreateHelloWorldTrigger(
service, workspace)
# Update the hello world tag to fire based on the hello world tag.
UpdateHelloWorldTagWithTrigger(service, tag, trigger)
if __name__ == '__main__':
main(sys.argv)
JavaScript
/**
* Interacts with the tagmanager api v2 to create a container, workspace,
* trigger, and tag.
*
* @return {Promise} A promise to run the tag manager example.
*/
function runTagManagerExample() {
return new Promise((resolve, reject) => {
console.log('Running Tag Manager Example.');
var trigger = null;
var workspace = null;
findContainer(ACCOUNT_PATH, CONTAINER_NAME)
.then(createWorkspace)
.then((createdWorkspace) => {
workspace = createdWorkspace;
return createHelloWorldTrigger(workspace);
})
.then((createdTrigger) => {
trigger = createdTrigger;
return createHelloWorldTag(workspace);
})
.then((createdTag) => {
return updateHelloWorldTagWithTrigger(createdTag, trigger);
})
.catch(handleError);
resolve();
});
}
ตัวอย่างที่สมบูรณ์
ขยายส่วนนี้เพื่อดูตัวอย่างโค้ดที่สมบูรณ์ของขั้นตอนทั้งหมดในคู่มือ
Python
"""Access and manage a Google Tag Manager account."""
import argparse
import sys
import httplib2
from apiclient.discovery import build
from oauth2client import client
from oauth2client import file
from oauth2client import tools
def GetService(api_name, api_version, scope, client_secrets_path):
"""Get a service that communicates to a Google API.
Args:
api_name: string The name of the api to connect to.
api_version: string The api version to connect to.
scope: A list of strings representing the auth scopes to authorize for the
connection.
client_secrets_path: string A path to a valid client secrets file.
Returns:
A service that is connected to the specified API.
"""
# Parse command-line arguments.
parser = argparse.ArgumentParser(
formatter_class=argparse.RawDescriptionHelpFormatter,
parents=[tools.argparser])
flags = parser.parse_args([])
# Set up a Flow object to be used if we need to authenticate.
flow = client.flow_from_clientsecrets(
client_secrets_path, scope=scope,
message=tools.message_if_missing(client_secrets_path))
# Prepare credentials, and authorize HTTP object with them.
# If the credentials don't exist or are invalid run through the native client
# flow. The Storage object will ensure that if successful the good
# credentials will get written back to a file.
storage = file.Storage(api_name + '.dat')
credentials = storage.get()
if credentials is None or credentials.invalid:
credentials = tools.run_flow(flow, storage, flags)
http = credentials.authorize(http=httplib2.Http())
# Build the service object.
service = build(api_name, api_version, http=http)
return service
def FindGreetingsContainer(service, account_path):
"""Find the greetings container.
Args:
service: the Tag Manager service object.
account_path: the path of the Tag Manager account from which to retrieve the
Greetings container.
Returns:
The greetings container if it exists, or None if it does not.
"""
# Query the Tag Manager API to list all containers for the given account.
container_wrapper = service.accounts().containers().list(
parent=account_path).execute()
# Find and return the Greetings container if it exists.
for container in container_wrapper['container']:
if container['name'] == 'Greetings':
return container
return None
def CreateWorkspace(service, container):
"""Creates a workspace named 'my workspace'.
Args:
service: the Tag Manager service object.
container: the container to insert the workspace within.
Returns:
The created workspace.
"""
return service.accounts().containers().workspaces().create(
parent=container['path'],
body={
'name': 'my workspace',
}).execute()
def CreateHelloWorldTag(service, workspace, tracking_id):
"""Create the Universal Analytics Hello World Tag.
Args:
service: the Tag Manager service object.
workspace: the workspace to create a tag within.
tracking_id: the Universal Analytics tracking ID to use.
Returns:
The created tag.
"""
hello_world_tag = {
'name': 'Universal Analytics Hello World',
'type': 'ua',
'parameter': [{
'key': 'trackingId',
'type': 'template',
'value': str(tracking_id),
}],
}
return service.accounts().containers().workspaces().tags().create(
parent=workspace['path'],
body=hello_world_tag).execute()
def CreateHelloWorldTrigger(service, workspace):
"""Create the Hello World Trigger.
Args:
service: the Tag Manager service object.
workspace: the workspace to create the trigger within.
Returns:
The created trigger.
"""
hello_world_trigger = {
'name': 'Hello World Rule',
'type': 'PAGEVIEW'
}
return service.accounts().containers().workspaces().triggers().create(
parent=workspace['path'],
body=hello_world_trigger).execute()
def UpdateHelloWorldTagWithTrigger(service, tag, trigger):
"""Update a Tag with a Trigger.
Args:
service: the Tag Manager service object.
tag: the tag to associate with the trigger.
trigger: the trigger to associate with the tag.
"""
# Get the tag to update.
tag = service.accounts().containers().workspaces().tags().get(
path=tag['path']).execute()
# Update the Firing Trigger for the Tag.
tag['firingTriggerId'] = [trigger['triggerId']]
# Update the Tag.
response = service.accounts().containers().workspaces().tags().update(
path=tag['path'],
body=tag).execute()
def main(argv):
# Get tag manager account ID from command line.
assert len(argv) == 2 and 'usage: gtm-api-hello-world.py <account_id>'
account_id = str(argv[1])
account_path = 'accounts/%s' % account_id
# Define the auth scopes to request.
scope = ['https://www.googleapis.com/auth/tagmanager.edit.containers']
# Authenticate and construct service.
service = GetService('tagmanager', 'v2', scope, 'client_secrets.json')
# Find the greetings container.
container = FindGreetingsContainer(service, account_path)
# Create a new workspace.
workspace = CreateWorkspace(service, container)
# Create the hello world tag.
tag = CreateHelloWorldTag(
service, workspace, 'UA-1234-5')
# Create the hello world Trigger.
trigger = CreateHelloWorldTrigger(
service, workspace)
# Update the hello world tag to fire based on the hello world tag.
UpdateHelloWorldTagWithTrigger(service, tag, trigger)
if __name__ == '__main__':
main(sys.argv)
JavaScript
<html>
<head>
<script type="text/javascript">
// Your Client ID can be retrieved from your project in the Google
// Developer Console, https://console.developers.google.com
var CLIENT_ID = TODO;
var SCOPES = [
'https://www.googleapis.com/auth/tagmanager.manage.accounts',
'https://www.googleapis.com/auth/tagmanager.edit.containers',
'https://www.googleapis.com/auth/tagmanager.delete.containers',
'https://www.googleapis.com/auth/tagmanager.edit.containerversions',
'https://www.googleapis.com/auth/tagmanager.manage.users',
'https://www.googleapis.com/auth/tagmanager.publish'
];
// Parameter values used by the script
ACCOUNT_PATH = TODO; // such as: 'accounts/555555';
CONTAINER_NAME = 'Greetings';
WORKSPACE_NAME = 'Example workspace';
/**
* Check if current user has authorization for this application.
*
* @param {bool} immediate Whether login should use the "immediate mode",
* which causes the security token to be refreshed behind the scenes
* with no UI.
*/
function checkAuth(immediate) {
var authorizeCheckPromise = new Promise((resolve) => {
gapi.auth.authorize(
{ client_id: CLIENT_ID, scope: SCOPES.join(' '), immediate: immediate },
resolve);
});
authorizeCheckPromise
.then(handleAuthResult)
.then(loadTagManagerApi)
.then(runTagManagerExample)
.catch(() => {
console.log('You must authorize any access to the api.');
});
}
/**
* Check if current user has authorization for this application.
*/
function checkAuth() {
checkAuth(true);
}
/**
* Initiate auth flow in response to user clicking authorize button.
*
* @param {Event} event Button click event.
* @return {boolean} Returns false.
*/
function handleAuthClick(event) {
checkAuth();
return false;
}
/**
* Handle response from authorization server.
*
* @param {Object} authResult Authorization result.
* @return {Promise} A promise to call resolve if authorize or redirect to a
* login flow.
*/
function handleAuthResult(authResult) {
return new Promise((resolve, reject) => {
var authorizeDiv = document.getElementById('authorize-div');
if (authResult && !authResult.error) {
// Hide auth UI, then load client library.
authorizeDiv.style.display = 'none';
resolve();
} else {
// Show auth UI, allowing the user to initiate authorization by
// clicking authorize button.
authorizeDiv.style.display = 'inline';
reject();
}
});
}
/**
* Load Tag Manager API client library.
* @return {Promise} A promise to load the tag manager api library.
*/
function loadTagManagerApi() {
return new Promise((resolve, reject) => {
console.log('Load Tag Manager api');
gapi.client.load('tagmanager', 'v2', resolve);
});
}
/**
* Interacts with the tagmanager api v2 to create a container,
* workspace, trigger, and tag.
*
* @return {Promise} A promise to run the tag manager example.
*/
function runTagManagerExample() {
return new Promise((resolve, reject) => {
console.log('Running Tag Manager Example.');
var trigger = null;
var workspace = null;
findContainer(ACCOUNT_PATH, CONTAINER_NAME)
.then(createWorkspace)
.then((createdWorkspace) => {
workspace = createdWorkspace;
return createHelloWorldTrigger(workspace);
})
.then((createdTrigger) => {
trigger = createdTrigger;
return createHelloWorldTag(workspace);
})
.then((createdTag) => {
return updateHelloWorldTagWithTrigger(createdTag, trigger);
})
.catch(handleError);
resolve();
});
}
/**
* Returns the greetings container if it exists.
*
* @param {string} accountPath The account which contains the Greetings
* container.
* @param {string} containerName The name of the container to find.
* @return {Promise} A promise to find the greetings container.
*/
function findContainer(accountPath, containerName) {
console.log('Finding container in account:' + accountPath);
var request = gapi.client.tagmanager.accounts.containers.list({
'parent': accountPath
});
return requestPromise(request)
.then((response) => {
var containers = response.container || [];
var container = containers.find(
(container) => container.name === containerName);
return container || Promise.reject(
'Unable to find ' + containerName +' container.');
});
}
/**
* Creates a workspace in the Greetings container.
*
* @param {Object} container The container to create a new workspace.
* @return {Promise} A promise to create a workspace.
*/
function createWorkspace(container) {
console.log('Creating workspace in container:' + container.path);
var request = gapi.client.tagmanager.accounts.containers.workspaces.create(
{ 'parent': container.path },
{ name: WORKSPACE_NAME, description: 'my workspace created via api' });
return requestPromise(request);
}
/**
* Creates a page view trigger.
*
* @param {Object} workspace The workspace to create the trigger in.
* @return {Promise} A promise to create a page view trigger.
*/
function createHelloWorldTrigger(workspace) {
console.log('Creating hello world trigger in workspace');
var helloWorldTrigger =
{ 'name': 'Hello World Trigger', 'type': 'PAGEVIEW' };
var request =
gapi.client.tagmanager.accounts.containers.workspaces.triggers.create(
{ 'parent': workspace.path }, helloWorldTrigger);
return requestPromise(request);
}
/**
* Creates a universal analytics tag.
*
* @param {Object} workspace The workspace to create the tag
* @return {Promise} A promise to create a hello world tag.
*/
function createHelloWorldTag(workspace) {
console.log('Creating hello world tag');
var helloWorldTag = {
'name': 'Universal Analytics Hello World',
'type': 'ua',
'parameter':
[{ 'key': 'trackingId', 'type': 'template', 'value': 'UA-1234-5' }],
};
var request =
gapi.client.tagmanager.accounts.containers.workspaces.tags.create(
{ 'parent': workspace.path }, helloWorldTag);
return requestPromise(request);
}
/**
* Updates a tag to fire on a particular trigger.
*
* @param {Object} tag The tag to update.
* @param {Object} trigger The trigger which causes the tag to fire.
* @return {Promise} A promise to update a tag to fire on a particular
* trigger.
*/
function updateHelloWorldTagWithTrigger(tag, trigger) {
console.log('Update hello world tag with trigger');
tag['firingTriggerId'] = [trigger.triggerId];
var request =
gapi.client.tagmanager.accounts.containers.workspaces.tags.update(
{ 'path': tag.path }, tag);
return requestPromise(request);
}
/**
* Logs an error message to the console.
*
* @param {string|Object} error The error to log to the console.
*/
function handleError(error) {
console.log('Error when interacting with GTM API');
console.log(error);
}
/**
* Wraps an API request into a promise.
*
* @param {Object} request the API request.
* @return {Promise} A promise to execute the api request.
*/
function requestPromise(request) {
return new Promise((resolve, reject) => {
request.execute((response) => {
if (response.code) {
reject(response);
}
resolve(response);
});
});
}
</script>
<script src="https://apis.google.com/js/client.js?onload=checkAuth">
</script>
</head>
<body>
<div id="authorize-div" style="display: none">
<span>Authorize access to Tag Manager API</span>
<!--Button for the user to click to initiate auth sequence -->
<button id="authorize-button" onclick="handleAuthClick(event)">
Authorize
</button>
</div>
<pre id="output"></pre>
</body>
</html>
ขั้นตอนถัดไป
เมื่อคุ้นเคยกับวิธีการทำงานของ API แล้ว เรายังมีแหล่งข้อมูลเพิ่มเติมให้คุณดังนี้
- เอกสารอ้างอิง API – ดูข้อมูลเกี่ยวกับอินเทอร์เฟซ API และการดำเนินการที่รองรับ
- ข้อมูลอ้างอิงเกี่ยวกับพารามิเตอร์ – ดูข้อมูลเกี่ยวกับการตั้งค่าพารามิเตอร์สำหรับแท็กและตัวแปร
- ตรวจสอบข้อมูลอ้างอิงพจนานุกรมแท็กเพื่อดูรายการแท็กที่รองรับ
- ตรวจสอบการอ้างอิงพจนานุกรมตัวแปรสำหรับรายการตัวแปรที่กำหนดค่าได้