এই ডেভেলপারের নির্দেশিকা আপনাকে ট্যাগ ম্যানেজার API v2 এর মাধ্যমে Google ট্যাগ ম্যানেজার অ্যাকাউন্টের মধ্যে সত্তা অ্যাক্সেস, তৈরি এবং পরিচালনা করার জন্য প্রয়োজনীয় পদক্ষেপগুলি সম্পর্কে জানাবে।
ভূমিকা
এই নির্দেশিকাটি আপনাকে Google ট্যাগ ম্যানেজার অ্যাকাউন্ট অ্যাক্সেস এবং কনফিগার করার বিভিন্ন ধাপের মধ্য দিয়ে নিয়ে যাবে। সম্পূর্ণ করার পরে, আপনি নিম্নলিখিত কাজগুলি কীভাবে করবেন সে সম্পর্কে একটি প্রাথমিক ধারণা পাবেন:
- একটি ট্যাগ ম্যানেজার পরিষেবা অবজেক্ট তৈরি করুন।
- একজন ব্যবহারকারীকে প্রমাণীকরণ এবং অনুমোদন করুন।
- রিসোর্স অ্যাক্সেস এবং পরিচালনা করতে ট্যাগ ম্যানেজার API এর সাথে কাজ করুন।
শুরু করার আগে
নির্দেশিকাটি শুরু করার আগে, আমরা আপনাকে Google ট্যাগ ম্যানেজার সহায়তা কেন্দ্রে গিয়ে Google ট্যাগ ম্যানেজারের সাথে পরিচিত হওয়ার পরামর্শ দিচ্ছি।
একটি পরীক্ষা অ্যাকাউন্ট ব্যবহার করা
যদি আপনি ট্যাগ ম্যানেজার API ব্যবহার করে এন্টিটি তৈরি, কনফিগার বা মুছে ফেলার পরিকল্পনা করেন, তাহলে আমরা আপনাকে একটি টেস্ট অ্যাকাউন্ট দিয়ে আপনার কোডটি বাস্তবায়ন এবং যাচাই করার পরামর্শ দিচ্ছি। টেস্ট অ্যাকাউন্ট ব্যবহার করলে আপনি একটি সক্রিয় অ্যাকাউন্টে দুর্ঘটনাক্রমে পরিবর্তন করা থেকে বিরত থাকতে পারবেন। একবার আপনি পরীক্ষা করে নিশ্চিত হয়ে নিন যে টেস্ট অ্যাকাউন্ট ব্যবহার করে আপনার কোডটি প্রত্যাশা অনুযায়ী কাজ করছে, তাহলে আপনি আপনার আসল অ্যাকাউন্ট দিয়ে বাস্তবায়নটি ব্যবহার শুরু করতে পারেন।
একটি ভাষা নির্বাচন করুন
আপনার ইচ্ছামত প্রোগ্রামিং ভাষা নির্বাচন করুন। উদাহরণগুলি অনুসরণ করুন:
পাইথন
এই নির্দেশিকায় সমস্ত কোড স্নিপেটের জন্য পাইথন নির্বাচন করা হয়েছে।
জাভাস্ক্রিপ্ট
এই নির্দেশিকার সকল কোড স্নিপেটের জন্য জাভাস্ক্রিপ্ট নির্বাচন করা হয়েছে।
প্রোগ্রামের ওভারভিউ
এই নির্দেশিকায় অন্তর্ভুক্ত উদাহরণ প্রোগ্রামটি একটি কমান্ড-লাইন অ্যাপ। একটি অ্যাকাউন্ট আইডি দেওয়া হলে, অ্যাপটি গ্রিটিংস নামে একটি কন্টেইনার খুঁজে পায় এবং সেই কন্টেইনারে একটি ইউনিভার্সাল অ্যানালিটিক্স ট্যাগ তৈরি করে। যখন একজন ব্যবহারকারী hello-world.html ভিজিট করেন, তখন ট্যাগটি একটি পেজভিউ হিট পাঠায়।
এই অ্যাপ্লিকেশনটি তৈরি করতে, আপনাকে এই পদক্ষেপগুলি অনুসরণ করতে হবে:
- গুগল এপিআই কনসোলে আপনার ডেভেলপমেন্ট এনভায়রনমেন্ট এবং প্রোজেক্ট সেট আপ করুন।
- একটি ট্যাগ ম্যানেজার পরিষেবা অবজেক্ট তৈরি করুন।
- একটি ট্যাগ ম্যানেজার অ্যাকাউন্টে অ্যাক্সেস অনুমোদন করুন।
- একটি ট্যাগ ম্যানেজার পরিষেবা অবজেক্ট তৈরি করুন।
- API-কে জিজ্ঞাসা করুন, প্রতিক্রিয়া পরিচালনা করুন এবং ফলাফল আউটপুট করুন।
- একটি ইনিশিয়ালাইজড ট্যাগ ম্যানেজার সার্ভিস অবজেক্ট পান।
- নিম্নলিখিত কাজগুলি করার জন্য ট্যাগ ম্যানেজার API-কে জিজ্ঞাসা করতে ট্যাগ ম্যানেজার পরিষেবা অবজেক্ট ব্যবহার করুন:
- প্রমাণিত Google ট্যাগ ম্যানেজার অ্যাকাউন্টের জন্য গ্রিটিংস কন্টেইনারটি পুনরুদ্ধার করুন।
- একটি নতুন কর্মক্ষেত্র তৈরি করুন।
- ইউনিভার্সাল অ্যানালিটিক্স ট্যাগ তৈরি করুন।
- ট্যাগটি চালু করার জন্য ট্রিগার তৈরি করুন।
- ট্রিগারে আগুন লাগানোর জন্য ট্যাগটি আপডেট করুন।
আপনার উন্নয়ন পরিবেশ এবং প্রকল্প সেট আপ করুন
শুভেচ্ছা কন্টেইনার তৈরি করুন
এই নির্দেশিকাটি ধরে নিচ্ছে যে আপনার একটি Google ট্যাগ ম্যানেজার অ্যাকাউন্ট আছে যার নাম Greetings । Greetings নামে একটি অ্যাকাউন্ট এবং একটি কন্টেইনার তৈরি করতে Setup and Workflow (Web) এর নির্দেশাবলী অনুসরণ করুন।
একটি ক্লায়েন্ট লাইব্রেরি ইনস্টল করুন
শুরু করার আগে, একটি Google API ক্লায়েন্ট লাইব্রেরি ইনস্টল এবং কনফিগার করুন।
গুগল এপিআই কনসোলে একটি প্রকল্প তৈরি এবং কনফিগার করুন
ট্যাগ ম্যানেজার API ব্যবহার শুরু করার জন্য, আপনাকে প্রথমে সেটআপ টুলটি ব্যবহার করতে হবে, যা আপনাকে Google API কনসোলে একটি প্রকল্প তৈরি করতে এবং API সক্ষম করতে সহায়তা করে।
এই নির্দেশিকাটি একটি ইনস্টলড অ্যাপ্লিকেশন প্রমাণীকরণ প্রবাহ ব্যবহার করে। আপনার প্রকল্পের শংসাপত্র তৈরি করতে নীচের নির্দেশাবলী অনুসরণ করুন। অনুরোধ করা হলে, অ্যাপ্লিকেশন ধরণের জন্য Installed Application এবং ইনস্টলড অ্যাপ্লিকেশন ধরণের জন্য Other নির্বাচন করুন।
- ক্রেডেনশিয়াল পৃষ্ঠা থেকে, আপনার OAuth 2.0 ক্রেডেনশিয়াল তৈরি করতে ক্রেডেনশিয়াল তৈরি করুন > OAuth ক্লায়েন্ট আইডি ক্লিক করুন অথবা একটি পরিষেবা অ্যাকাউন্ট তৈরি করতে ক্রেডেনশিয়াল তৈরি করুন > পরিষেবা অ্যাকাউন্ট কী ক্লিক করুন ।
- যদি আপনি একটি OAuth ক্লায়েন্ট আইডি তৈরি করে থাকেন, তাহলে আপনার আবেদনের ধরণটি নির্বাচন করুন।
- ফর্মটি পূরণ করুন এবং তৈরি করুন এ ক্লিক করুন।
আপনার অ্যাপ্লিকেশনের ক্লায়েন্ট আইডি এবং পরিষেবা অ্যাকাউন্ট কীগুলি এখন শংসাপত্র পৃষ্ঠায় তালিকাভুক্ত করা হয়েছে। বিস্তারিত জানার জন্য, একটি ক্লায়েন্ট আইডিতে ক্লিক করুন; প্যারামিটারগুলি আইডির ধরণের উপর নির্ভর করে পরিবর্তিত হয়, তবে ইমেল ঠিকানা, ক্লায়েন্ট সিক্রেট, জাভাস্ক্রিপ্টের উৎস, অথবা পুনর্নির্দেশ URI অন্তর্ভুক্ত থাকতে পারে।
ডাউনলোড JSON বোতামে ক্লিক করে ক্লায়েন্টের বিবরণ ডাউনলোড করুন। এই ফাইলটির নাম পরিবর্তন করে client_secrets.json রাখুন। এই ফাইলটি পরবর্তীতে প্রমাণীকরণের জন্য ব্যবহার করা হবে।
একটি ট্যাগ ম্যানেজার পরিষেবা অবজেক্ট তৈরি করুন
ট্যাগ ম্যানেজার service অবজেক্ট হল যা আপনি API অনুরোধ করতে ব্যবহার করবেন।
ট্যাগ ম্যানেজার সার্ভিস অবজেক্ট তৈরি করতে প্রয়োজনীয় ধাপগুলি নিম্নরূপ:
- একটি Google ট্যাগ ম্যানেজার অ্যাকাউন্টে অ্যাক্সেস অনুমোদন করুন।
- ট্যাগ ম্যানেজার পরিষেবা অবজেক্টটি চালু করুন।
একটি Google ট্যাগ ম্যানেজার অ্যাকাউন্টে অ্যাক্সেস অনুমোদন করুন
যখন একজন ব্যবহারকারী Google Tag Manager API দিয়ে তৈরি একটি অ্যাপ্লিকেশন শুরু করেন, তখন তাকে অ্যাপ্লিকেশনটিকে তাদের Google Tag Manager অ্যাকাউন্টে অ্যাক্সেস দিতে হবে। এই প্রক্রিয়াটিকে অনুমোদন বলা হয়। ব্যবহারকারীদের অনুমোদনের জন্য প্রস্তাবিত পদ্ধতি হল OAuth 2.0। আপনি যদি আরও জানতে চান, তাহলে Tag Manager API Authorization পড়ুন।
নীচের কোডটি অ্যাপ্লিকেশনটির ব্যবহারকারীকে প্রমাণীকরণের জন্য উপরে তৈরি প্রকল্প এবং ক্লায়েন্টের বিবরণ ব্যবহার করে এবং তাদের পক্ষ থেকে 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-এর জন্য জিজ্ঞাসা করুন
ট্যাগ ম্যানেজার পরিষেবা অবজেক্টটি ট্যাগ ম্যানেজার API অনুসন্ধানের জন্য ব্যবহার করা যেতে পারে। নমুনা প্রোগ্রামটি বাস্তবায়নের জন্য নিম্নলিখিত পদক্ষেপগুলি প্রয়োজন:
- শুভেচ্ছা কন্টেইনারটি উদ্ধার করুন
- ইউনিভার্সাল অ্যানালিটিক্স ট্যাগ তৈরি করুন
- ট্যাগটি ফায়ার করার জন্য ট্রিগার তৈরি করুন
- ট্রিগারে আগুন লাগানোর জন্য ট্যাগটি আপডেট করুন
১. গ্রিটিংস কন্টেইনারটি উদ্ধার করুন
নিম্নলিখিত ফাংশনটি দেখায় যে কীভাবে একটি ট্যাগ ম্যানেজার পরিষেবা অবজেক্ট ব্যবহার করে ট্যাগ ম্যানেজার API-কে একটি অ্যাকাউন্টের সমস্ত কন্টেইনার তালিকাভুক্ত করতে এবং Greetings নামক কন্টেইনারটি পুনরুদ্ধার করতে ব্যবহার করা যেতে পারে।
পাইথন
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.'); }); }
এরপর প্রোগ্রামের প্রধান এক্সিকিউশন শাখা আপডেট করুন এবং findGreetingsContainer ফাংশনটি কল করুন, যা একটি Tag Manager accountId । উদাহরণস্বরূপ:
পাইথন
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 ব্যবহার করে, যা আমরা ট্রিগার এবং ট্যাগে আমাদের পরিবর্তনগুলি পরিচালনা করতে ব্যবহার করি। একটি ওয়ার্কস্পেস তৈরি করার সময় সেট করা যেতে পারে এমন প্রয়োজনীয় এবং ঐচ্ছিক বৈশিষ্ট্যের তালিকার জন্য আপনি Workspace তৈরি পদ্ধতির রেফারেন্স পর্যালোচনা করতে পারেন।
পাইথন
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); }
৩. ইউনিভার্সাল অ্যানালিটিক্স ট্যাগ তৈরি করুন
নিচের কোড স্নিপেটটি একটি ইউনিভার্সাল অ্যানালিটিক্স ট্যাগ তৈরি করতে ট্যাগ ম্যানেজার 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); }
৪. ট্যাগটি ফায়ার করার জন্য ট্রিগার তৈরি করুন
এখন যেহেতু একটি ট্যাগ তৈরি করা হয়েছে, পরবর্তী ধাপ হল এমন একটি ট্রিগার তৈরি করা যা যেকোনো পৃষ্ঠায় কাজ করবে।
ট্রিগারটির নাম হবে হ্যালো ওয়ার্ল্ড ট্রিগার এবং এটি যেকোনো পৃষ্ঠা দেখার জন্য কার্যকর হবে। উদাহরণস্বরূপ:
পাইথন
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); }
৫. ট্রিগারে আগুন লাগানোর জন্য ট্যাগটি আপডেট করুন
এখন যেহেতু একটি ট্যাগ এবং ট্রিগার তৈরি করা হয়েছে, তাদের একে অপরের সাথে যুক্ত করতে হবে। এটি করার জন্য, ট্যাগের সাথে যুক্ত 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 ইন্টারফেস এবং সমর্থিত ক্রিয়াকলাপ সম্পর্কে জানুন।
- প্যারামিটার রেফারেন্স - ট্যাগ এবং ভেরিয়েবলের জন্য প্যারামিটার সেট করা সম্পর্কে জানুন।
- সমর্থিত ট্যাগগুলির তালিকার জন্য ট্যাগ অভিধান রেফারেন্স পর্যালোচনা করুন।
- কনফিগার করা যেতে পারে এমন ভেরিয়েবলের তালিকার জন্য ভেরিয়েবল অভিধান রেফারেন্স পর্যালোচনা করুন।