এই বিকাশকারীর নির্দেশিকা আপনাকে ট্যাগ ম্যানেজার API v2 এর মাধ্যমে একটি Google ট্যাগ ম্যানেজার অ্যাকাউন্টের মধ্যে সত্তাগুলি অ্যাক্সেস, তৈরি এবং পরিচালনা করার জন্য প্রয়োজনীয় পদক্ষেপগুলির মধ্য দিয়ে চলে।
ভূমিকা
একটি Google ট্যাগ ম্যানেজার অ্যাকাউন্ট অ্যাক্সেস এবং কনফিগার করার জন্য এই নির্দেশিকা আপনাকে বিভিন্ন ধাপের মধ্য দিয়ে চলে। সমাপ্তির পরে, নিম্নলিখিত কাজগুলি কীভাবে করতে হয় সে সম্পর্কে আপনার একটি প্রাথমিক ধারণা থাকবে:
- একটি ট্যাগ ম্যানেজার পরিষেবা বস্তু তৈরি করুন।
- একজন ব্যবহারকারীকে প্রমাণীকরণ এবং অনুমোদন করুন।
- সম্পদ অ্যাক্সেস এবং পরিচালনা করতে ট্যাগ ম্যানেজার API এর সাথে কাজ করুন।
আপনি শুরু করার আগে
আপনি গাইড শুরু করার আগে, আমরা সুপারিশ করি যে আপনি Google ট্যাগ ম্যানেজার সহায়তা কেন্দ্রে গিয়ে Google ট্যাগ ম্যানেজারের সাথে পরিচিত হন।
একটি পরীক্ষা অ্যাকাউন্ট ব্যবহার করে
আপনি যদি সত্তা তৈরি করতে, কনফিগার করতে বা মুছতে ট্যাগ ম্যানেজার API ব্যবহার করতে চান, তাহলে আমরা সুপারিশ করি যে আপনি একটি পরীক্ষার অ্যাকাউন্টের মাধ্যমে আপনার কোডটি প্রয়োগ ও যাচাই করুন৷ একটি পরীক্ষা অ্যাকাউন্ট ব্যবহার করা আপনাকে একটি সক্রিয় অ্যাকাউন্টে দুর্ঘটনাজনিত পরিবর্তন করা থেকে বিরত রাখতে সাহায্য করবে। একবার আপনি পরীক্ষা করেছেন এবং নিশ্চিত করেছেন যে আপনার কোড পরীক্ষা অ্যাকাউন্ট ব্যবহার করে প্রত্যাশিতভাবে কাজ করছে, তারপর আপনি আপনার আসল অ্যাকাউন্টগুলির সাথে বাস্তবায়ন ব্যবহার শুরু করতে পারেন।
একটি ভাষা নির্বাচন করুন
আপনি যে প্রোগ্রামিং ভাষাতে উদাহরণগুলি অনুসরণ করতে চান তা নির্বাচন করুন:
পাইথন
এই নির্দেশিকায় সমস্ত কোড স্নিপেটের জন্য পাইথন নির্বাচন করা হয়েছে।
জাভাস্ক্রিপ্ট
এই গাইডের সমস্ত কোড স্নিপেটের জন্য JavaScript নির্বাচন করা হয়েছে।
প্রোগ্রাম ওভারভিউ
এই নির্দেশিকায় অন্তর্ভুক্ত উদাহরণ প্রোগ্রামটি একটি কমান্ড-লাইন অ্যাপ। একটি অ্যাকাউন্ট আইডি দেওয়া, অ্যাপটি গ্রিটিংস নামে একটি ধারক খুঁজে পায় এবং সেই পাত্রে একটি ইউনিভার্সাল অ্যানালিটিক্স ট্যাগ তৈরি করে৷ যখন একজন ব্যবহারকারী hello-world.html পরিদর্শন করে, তখন ট্যাগটি একটি পেজভিউ হিট পাঠায়।
এই অ্যাপ্লিকেশনটি বিকাশ করতে, আপনাকে এই পদক্ষেপগুলি অনুসরণ করতে হবে:
- Google API কনসোলে আপনার উন্নয়ন পরিবেশ এবং প্রকল্প সেট আপ করুন।
- একটি ট্যাগ ম্যানেজার পরিষেবা বস্তু তৈরি করুন।
- একটি ট্যাগ ম্যানেজার অ্যাকাউন্টে অ্যাক্সেস অনুমোদন করুন।
- একটি ট্যাগ ম্যানেজার পরিষেবা বস্তু তৈরি করুন।
- API জিজ্ঞাসা করুন, প্রতিক্রিয়া পরিচালনা করুন এবং ফলাফলগুলি আউটপুট করুন।
- একটি প্রাথমিক ট্যাগ ম্যানেজার পরিষেবা বস্তু পান।
- নিম্নলিখিত কাজগুলি করার জন্য ট্যাগ ম্যানেজার API-কে জিজ্ঞাসা করতে ট্যাগ ম্যানেজার পরিষেবা অবজেক্ট ব্যবহার করুন:
- প্রমাণীকৃত Google ট্যাগ ম্যানেজার অ্যাকাউন্টের জন্য অভিবাদন ধারকটি পুনরুদ্ধার করুন।
- একটি নতুন কর্মক্ষেত্র তৈরি করুন।
- ইউনিভার্সাল অ্যানালিটিক্স ট্যাগ তৈরি করুন।
- ট্যাগ ফায়ার করতে ট্রিগার তৈরি করুন।
- ট্রিগারে ফায়ার করতে ট্যাগ আপডেট করুন।
আপনার উন্নয়ন পরিবেশ এবং প্রকল্প সেট আপ করুন
অভিবাদন ধারক তৈরি করুন
এই নির্দেশিকাটি অনুমান করে আপনার একটি Google ট্যাগ ম্যানেজার অ্যাকাউন্ট রয়েছে যার নাম একটি ধারক রয়েছে । একটি অ্যাকাউন্ট এবং গ্রিটিংস নামে একটি ধারক তৈরি করতে সেটআপ এবং ওয়ার্কফ্লো (ওয়েব) এর নির্দেশাবলী অনুসরণ করুন৷
একটি ক্লায়েন্ট লাইব্রেরি ইনস্টল করুন
আপনি শুরু করার আগে, একটি Google APIs ক্লায়েন্ট লাইব্রেরি ইনস্টল এবং কনফিগার করুন।
Google API কনসোলে একটি প্রকল্প তৈরি এবং কনফিগার করুন
ট্যাগ ম্যানেজার API ব্যবহার শুরু করার জন্য, আপনাকে প্রথমে সেটআপ টুল ব্যবহার করতে হবে, যা আপনাকে Google API কনসোলে একটি প্রকল্প তৈরি করতে, API সক্ষম করার এবং শংসাপত্র তৈরি করার মাধ্যমে গাইড করে।
এই নির্দেশিকাটি একটি ইনস্টল করা অ্যাপ্লিকেশন প্রমাণীকরণ প্রবাহ ব্যবহার করে। আপনার প্রকল্পের শংসাপত্র তৈরি করতে নীচের নির্দেশাবলী অনুসরণ করুন। প্রম্পট করা হলে, অ্যাপ্লিকেশনের প্রকারের জন্য Installed Application এবং ইনস্টল করা অ্যাপ্লিকেশনের প্রকারের জন্য Other নির্বাচন করুন৷
- শংসাপত্র পৃষ্ঠা থেকে, আপনার OAuth 2.0 শংসাপত্র তৈরি করতে শংসাপত্র তৈরি করুন > OAuth ক্লায়েন্ট আইডি বা একটি পরিষেবা অ্যাকাউন্ট তৈরি করতে শংসাপত্র তৈরি করুন > পরিষেবা অ্যাকাউন্ট কী-তে ক্লিক করুন।
- আপনি যদি একটি OAuth ক্লায়েন্ট আইডি তৈরি করেন, তাহলে আপনার আবেদনের ধরন নির্বাচন করুন।
- ফর্মটি পূরণ করুন এবং তৈরি করুন ক্লিক করুন।
আপনার অ্যাপ্লিকেশনের ক্লায়েন্ট আইডি এবং পরিষেবা অ্যাকাউন্ট কীগুলি এখন শংসাপত্র পৃষ্ঠায় তালিকাভুক্ত করা হয়েছে৷ বিস্তারিত জানার জন্য, একটি ক্লায়েন্ট আইডি ক্লিক করুন; আইডি প্রকারের উপর নির্ভর করে প্যারামিটারগুলি পরিবর্তিত হয়, তবে ইমেল ঠিকানা, ক্লায়েন্ট সিক্রেট, জাভাস্ক্রিপ্টের উত্স, বা ইউআরআইগুলি পুনঃনির্দেশিত হতে পারে।
ডাউনলোড JSON বোতামে ক্লিক করে ক্লায়েন্টের বিবরণ ডাউনলোড করুন। এই ফাইলটির নাম পরিবর্তন করে client_secrets.json করুন। এই ফাইল পরে প্রমাণীকরণ উদ্দেশ্যে ব্যবহার করা হবে.
একটি ট্যাগ ম্যানেজার পরিষেবা বস্তু তৈরি করুন
ট্যাগ ম্যানেজার service অবজেক্ট হল যা আপনি API অনুরোধ করতে ব্যবহার করবেন।
একটি ট্যাগ ম্যানেজার পরিষেবা অবজেক্ট তৈরি করার জন্য প্রয়োজনীয় পদক্ষেপগুলি নিম্নরূপ:
- একটি Google ট্যাগ ম্যানেজার অ্যাকাউন্টে অ্যাক্সেস অনুমোদন করুন।
- ট্যাগ ম্যানেজার সার্ভিস অবজেক্ট ইনস্ট্যান্টিয়েট করুন।
একটি Google ট্যাগ ম্যানেজার অ্যাকাউন্টে অ্যাক্সেস অনুমোদন করুন
যখন একজন ব্যবহারকারী Google ট্যাগ ম্যানেজার API দিয়ে তৈরি একটি অ্যাপ্লিকেশন শুরু করেন, তখন তাদের তাদের Google ট্যাগ ম্যানেজার অ্যাকাউন্টে অ্যাপ্লিকেশন অ্যাক্সেস দিতে হবে। এই প্রক্রিয়াটিকে অনুমোদন বলা হয়। ব্যবহারকারীদের অনুমোদনের জন্য প্রস্তাবিত পদ্ধতি হল OAuth 2.0। আপনি যদি আরও জানতে চান, ট্যাগ ম্যানেজার API অনুমোদন পড়ুন।
নীচের কোডটি অ্যাপ্লিকেশনটির ব্যবহারকারীকে প্রমাণীকরণ করতে উপরে তৈরি প্রকল্প এবং ক্লায়েন্টের বিশদ ব্যবহার করে এবং তাদের পক্ষে Google ট্যাগ ম্যানেজার অ্যাক্সেস করার জন্য তাদের অনুমতি চায়।
অ্যাপ্লিকেশনটি ডিফল্ট ব্রাউজার খোলার চেষ্টা করবে এবং ব্যবহারকারীকে google.com-এ হোস্ট করা URL-এ নেভিগেট করবে৷ ব্যবহারকারীকে সাইন-ইন করার জন্য অনুরোধ করা হবে এবং তাদের ট্যাগ ম্যানেজার অ্যাকাউন্টে অ্যাপ্লিকেশানের অ্যাক্সেস মঞ্জুর করা হবে। একবার মঞ্জুর হলে, অ্যাপ্লিকেশনটি ব্রাউজার উইন্ডো থেকে একটি কোড পড়ার চেষ্টা করবে, তারপর উইন্ডোটি বন্ধ করে দেবে।
দ্রষ্টব্য : যদি একটি ত্রুটি ঘটে, তবে অ্যাপ্লিকেশনটি ব্যবহারকারীকে কমান্ড লাইনে তাদের অনুমোদন কোড প্রবেশ করতে অনুরোধ করবে।
পাইথন
"""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)
জাভাস্ক্রিপ্ট
<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 জিজ্ঞাসা করুন
ট্যাগ ম্যানেজার সার্ভিস অবজেক্টটি ট্যাগ ম্যানেজার এপিআই জিজ্ঞাসা করতে ব্যবহার করা যেতে পারে। নমুনা প্রোগ্রাম বাস্তবায়নের জন্য নিম্নলিখিত পদক্ষেপগুলি প্রয়োজন:
- অভিবাদন ধারক পুনরুদ্ধার করুন
- ইউনিভার্সাল অ্যানালিটিক্স ট্যাগ তৈরি করুন
- ট্যাগ ফায়ার করতে ট্রিগার তৈরি করুন
- ট্রিগারে ফায়ার করতে ট্যাগ আপডেট করুন
1. অভিবাদন ধারক পুনরুদ্ধার করুন
নিম্নলিখিত ফাংশনটি ব্যাখ্যা করে যে কীভাবে একটি ট্যাগ ম্যানেজার পরিষেবা অবজেক্ট ব্যবহার করা যেতে পারে ট্যাগ ম্যানেজার API-কে একটি অ্যাকাউন্টের সমস্ত কন্টেইনার তালিকাভুক্ত করতে এবং গ্রিটিংস নামের কন্টেইনারটি পুনরুদ্ধার করতে।
পাইথন
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
জাভাস্ক্রিপ্ট
/**
* 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.');
});
}
পরবর্তীতে একটি ট্যাগ ম্যানেজার accountId দেওয়া findGreetingsContainer ফাংশন কল করতে প্রোগ্রামটির প্রধান এক্সিকিউশন শাখা আপডেট করুন। যেমন:
পাইথন
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)
জাভাস্ক্রিপ্ট
/**
* 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. একটি নতুন কর্মক্ষেত্র তৈরি করুন৷
নিম্নলিখিত কোড স্নিপেট একটি নতুন ওয়ার্কস্পেস তৈরি করতে ট্যাগ ম্যানেজার API ব্যবহার করে, যা আমরা ট্রিগার এবং ট্যাগের পরিবর্তনগুলি পরিচালনা করতে ব্যবহার করি। আপনি প্রয়োজনীয় এবং ঐচ্ছিক বৈশিষ্ট্যগুলির তালিকার জন্য ওয়ার্কস্পেস তৈরি পদ্ধতির রেফারেন্স পর্যালোচনা করতে পারেন যা একটি ওয়ার্কস্পেস তৈরি করার সময় সেট করা যেতে পারে।
পাইথন
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()
জাভাস্ক্রিপ্ট
/**
* 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. ইউনিভার্সাল অ্যানালিটিক্স ট্যাগ তৈরি করুন
একটি ইউনিভার্সাল অ্যানালিটিক্স ট্যাগ তৈরি করতে নিম্নলিখিত কোড স্নিপেট ট্যাগ ম্যানেজার API ব্যবহার করে। আপনি প্রয়োজনীয় এবং ঐচ্ছিক বৈশিষ্ট্যগুলির তালিকার জন্য ট্যাগ তৈরির পদ্ধতির রেফারেন্স পর্যালোচনা করতে পারেন যা একটি ট্যাগ তৈরি করার সময় সেট করা যেতে পারে এবং প্রতিটি ট্যাগের প্রকারের বৈশিষ্ট্যগুলির তালিকার জন্য ট্যাগ অভিধান রেফারেন্স ।
পাইথন
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()
জাভাস্ক্রিপ্ট
/**
* 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. ট্যাগ ফায়ার করতে ট্রিগার তৈরি করুন
এখন একটি ট্যাগ তৈরি করা হয়েছে, পরবর্তী ধাপ হল একটি ট্রিগার তৈরি করা যা যেকোনো পৃষ্ঠায় ফায়ার হবে।
ট্রিগারটির নাম হবে হ্যালো ওয়ার্ল্ড ট্রিগার এবং যেকোনো পৃষ্ঠা দেখার জন্য ফায়ার হবে। যেমন:
পাইথন
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()
জাভাস্ক্রিপ্ট
/**
* 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. ট্রিগারে ফায়ার করার জন্য ট্যাগ আপডেট করুন
এখন যেহেতু একটি ট্যাগ এবং ট্রিগার তৈরি করা হয়েছে, তাদের একে অপরের সাথে যুক্ত করা দরকার। এটি করার জন্য, ট্যাগের সাথে যুক্ত firingTriggerIds তালিকায় triggerId যোগ করুন। যেমন:
পাইথন
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()
জাভাস্ক্রিপ্ট
/**
* 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);
}
পরবর্তীতে ক্রিয়েট এবং আপডেট ফাংশনগুলিকে কল করার জন্য প্রোগ্রামের প্রধান এক্সিকিউশন শাখা আপডেট করুন। যেমন:
পাইথন
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)
জাভাস্ক্রিপ্ট
/**
* 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();
});
}
সম্পূর্ণ উদাহরণ
গাইডের সমস্ত ধাপের সম্পূর্ণ কোড উদাহরণ দেখতে এই বিভাগটি প্রসারিত করুন।
পাইথন
"""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)
জাভাস্ক্রিপ্ট
<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 ইন্টারফেস এবং সমর্থিত ক্রিয়াকলাপ সম্পর্কে জানুন।
- প্যারামিটার রেফারেন্স - ট্যাগ এবং ভেরিয়েবলের জন্য প্যারামিটার সেট করা সম্পর্কে জানুন।
- সমর্থিত ট্যাগের তালিকার জন্য ট্যাগ অভিধানের রেফারেন্স পর্যালোচনা করুন।
- কনফিগার করা যেতে পারে এমন ভেরিয়েবলের তালিকার জন্য পরিবর্তনশীল অভিধানের রেফারেন্স পর্যালোচনা করুন।