इस डेवलपर की गाइड में, ऐक्सेस करने, बनाने, और मैनेज करने के ज़रूरी चरणों के बारे में बताया गया है Tag Manager API v2 के ज़रिए Google Tag Manager खाते में मौजूद इकाइयां.
परिचय
इस गाइड में, Google Analytics को ऐक्सेस और कॉन्फ़िगर करने का तरीका बताया गया है 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 पर जाता है, टैग एक पेज व्यू हिट भेजता है.
इस ऐप्लिकेशन को डेवलप करने के लिए, आपको यह तरीका अपनाना होगा:
- Google API कंसोल में अपना डेवलपमेंट एनवायरमेंट और प्रोजेक्ट सेट अप करें.
- Tag Manager सेवा ऑब्जेक्ट बनाएं.
- Tag Manager खाते का ऐक्सेस दें.
- Tag Manager सेवा ऑब्जेक्ट बनाएं.
- एपीआई से क्वेरी करें, रिस्पॉन्स को मैनेज करें, और आउटपुट दें.
- शुरू किया गया Tag Manager सेवा ऑब्जेक्ट पाएं.
- क्वेरी करने के लिए Tag Manager सेवा ऑब्जेक्ट का इस्तेमाल करें
Tag Manager API की मदद से ये काम किए जा सकते हैं:
- इसके लिए Greetings कंटेनर वापस पाएं: पुष्टि किया गया Google Tag Manager खाता.
- एक नया फ़ाइल फ़ोल्डर बनाएं.
- Universal Analytics टैग बनाएं.
- टैग सक्रिय करने के लिए ट्रिगर बनाएं.
- ट्रिगर पर फ़ायर करने के लिए टैग अपडेट करें.
अपने डेवलपमेंट एनवायरमेंट और प्रोजेक्ट को सेट अप करें
Greetings कंटेनर बनाएं
इस गाइड में यह मान लिया गया है कि आपके पास कंटेनर वाला Google Tag Manager खाता है ग्रीटिंग नाम का इस्तेमाल करें. सेटअप और वर्कफ़्लो के निर्देशों का पालन करें खाता और कंटेनर बनाने के लिए (वेब) का नाम ग्रीटिंग है.
क्लाइंट लाइब्रेरी इंस्टॉल करना
शुरू करने से पहले, Google API क्लाइंट लाइब्रेरी.
Google API (एपीआई) कंसोल में प्रोजेक्ट बनाएं और उसे कॉन्फ़िगर करें
Tag Manager API का इस्तेमाल शुरू करने के लिए, इस्तेमाल करें सेटअप टूल की मदद से, सेटअप टूल की मदद ली जा सकती है. Google API (एपीआई) कंसोल, एपीआई चालू करना, और क्रेडेंशियल बनाना.
यह गाइड इंस्टॉल किए गए ऐप्लिकेशन की पुष्टि करने की सुविधा का इस्तेमाल करती है
फ़्लो. अपने प्रोजेक्ट के क्रेडेंशियल बनाने के लिए, नीचे दिए गए निर्देशों का पालन करें. टास्क कब शुरू होगा
संकेत दिया जाए, APPLICATION के लिए Installed Application चुनें
इंस्टॉल किए गए ऐप्लिकेशन के लिए TYPE और Other
TYPE.
- क्रेडेंशियल पेज पर जाकर, क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी का इस्तेमाल करके, अपने OAuth 2.0 क्रेडेंशियल बनाएं या क्रेडेंशियल बनाएं > दी गई सेवा खाता कुंजी का इस्तेमाल करें.
- अगर आपने OAuth क्लाइंट आईडी बनाया है, तो चुनें कि आपका ऐप्लिकेशन किस तरह का है.
- फ़ॉर्म भरें और बनाएं पर क्लिक करें.
आपके ऐप्लिकेशन के क्लाइंट आईडी और सेवा खाते की कुंजियां अब यहां दी गई हैं क्रेडेंशियल पेज. ज़्यादा जानकारी के लिए, क्लाइंट आईडी पर क्लिक करें; पैरामीटर में अंतर होता है यह आईडी टाइप के आधार पर तय होता है, लेकिन इसमें ईमेल पता, क्लाइंट सीक्रेट, JavaScript ऑरिजिन या रीडायरेक्ट यूआरआई.
JSON डाउनलोड करें पर क्लिक करके क्लाइंट की जानकारी डाउनलोड करें
बटन. इस फ़ाइल का नाम बदलकर client_secrets.json करें. इस फ़ाइल को
का इस्तेमाल बाद में पुष्टि करने के लिए किया जाता है.
Tag Manager सेवा ऑब्जेक्ट बनाना
Tag Manager service ऑब्जेक्ट का इस्तेमाल करके,
एपीआई अनुरोध की संख्या.
Tag Manager सेवा ऑब्जेक्ट बनाने के लिए, नीचे दिए गए निर्देशों का पालन करें:
- Google Tag Manager खाते का ऐक्सेस दें.
- Tag Manager सेवा ऑब्जेक्ट को इंस्टैंशिएट करें.
Google Tag Manager खाते का ऐक्सेस देना
जब कोई उपयोगकर्ता Google Tag Manager API की मदद से बनाया गया ऐप्लिकेशन शुरू करता है, उन्हें इस ऐप्लिकेशन को अपने Google Tag Manager का ऐक्सेस देना होगा जोड़ें. इस प्रोसेस को अनुमति देना कहते हैं. इसके लिए सुझाए गए तरीके OAuth 2.0 उपयोगकर्ताओं को अनुमति दे रहा है. ज़्यादा जानकारी के लिए, Tag Manager API की अनुमति देना लेख पढ़ें.
नीचे दिया गया कोड प्रोजेक्ट और क्लाइंट की जानकारी का इस्तेमाल करता है ऐप्लिकेशन के उपयोगकर्ता को प्रमाणित करने के लिए ऊपर बनाया गया है और उनसे को ऐक्सेस करने की अनुमति दी हुई है.
ऐप्लिकेशन डिफ़ॉल्ट ब्राउज़र को खोलने और उपयोगकर्ता को google.com पर होस्ट किए गए किसी यूआरएल पर ले जाएगा. उपयोगकर्ता को साइन-इन करने का संकेत दिया जाएगा और ऐप्लिकेशन को अपने Tag Manager खाते का ऐक्सेस दें. अनुमति मिलने के बाद, ऐप्लिकेशन, ब्राउज़र विंडो से कोड को पढ़ने का प्रयास करेगा, फिर बंद कर देगा क्लिक करें.
ध्यान दें: अगर कोई गड़बड़ी होती है, तो ऐप्लिकेशन इसके बजाय, उपयोगकर्ता को निर्देश पर अपना ऑथराइज़ेशन कोड डालने का प्रॉम्प्ट लाइन.
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>
Tag Manager API की क्वेरी करना
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 फ़ंक्शन को टैग मैनेजर दिया गया
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 का इस्तेमाल करता है 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. टैग सक्रिय करने के लिए ट्रिगर बनाएं
टैग बन जाने के बाद, अगला चरण एक ट्रिगर बनाना है, जो ट्रिगर किया जा सकता है.
ट्रिगर का नाम नमस्ते 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 के बारे में जानें इंटरफ़ेस और समर्थित संचालन.
- पैरामीटर रेफ़रंस – टैग और वैरिएबल के लिए पैरामीटर सेट करने के बारे में जानें.
- टैग की समीक्षा करें इस्तेमाल किए जा सकने वाले टैग की सूची के लिए डिक्शनरी के रेफ़रंस.
- वैरिएबल डिक्शनरी की समीक्षा करें कॉन्फ़िगर किए जा सकने वाले वैरिएबल की सूची के लिए रेफ़रंस.