שירות TagManager

שירות Google Tag Manager מספק גישה לנתוני Tag Manager API למשתמש מורשה. השירות הזה מאפשר למשתמשים ב-Tag Manager לנהל את החשבונות, המאגרים, הסביבות, הגרסאות, סביבות העבודה, התיקיות, המשתנים, הטריגרים, התגים וההרשאות של המשתמשים ב-Tag Manager.

חומרי עזר

מידע מפורט על השירות הזה זמין במסמכי העזרה של Tag Manager API V2.

כמו כל השירותים המתקדמים ב-Apps Script, שירות Tag Manager משתמש באותם אובייקטים, שיטות ופרמטרים כמו ב-API הציבורי. מידע נוסף זמין במאמר איך נקבעות חתימות השיטות.

כדי לדווח על בעיות ולקבל תמיכה נוספת, אפשר להיכנס למרכז העזרה של Google Tag Manager.

קוד לדוגמה

בדוגמת הקוד שבהמשך מוסבר איך להשתמש בכמה תכונות של שירות Tag Manager.

יצירת גרסה של מאגר תגים עם משתנה, טריגר ותג.

קוד הדוגמה שבהמשך משתמש ב-Tag Manager API V2 כדי ליצור קודם מאגר עם שם שמתוזמן עם חותמת זמן של התאריך הנוכחי, כדי לשפר את הסיכויים שהוא יהיה ייחודי. לאחר מכן, הדוגמה יוצרת סביבת עבודה עם משתנה ערך אקראי וטריגר שמופעל בכל צפייה בדף. לאחר מכן, הדוגמה משתמשת בטריגר כדי ליצור תג פיקסל שרירותי שמפעיל פיקסל ב-//example.com עם ביטול מטמון שמצורף לסוף כתובת ה-URL. לבסוף, הדוגמה יוצרת גרסה של מאגר תגים עם הישויות שלמעלה, מתעדת את הגרסה ומחזירה אותה לשימוש מאוחר יותר.

advanced/tagManager.gs
/**
 * Creates a container version for a particular account
 * with the input accountPath.
 * @param {string} accountPath The account path.
 * @return {string} The tag manager container version.
 */
function createContainerVersion(accountPath) {
  const date = new Date();
  // Creates a container in the account, using the current timestamp to make
  // sure the container is unique.
  try {
    const container = TagManager.Accounts.Containers.create(
        {
          'name': 'appscript tagmanager container ' + date.getTime(),
          'usageContext': ['WEB']
        },
        accountPath);
    const containerPath = container.path;
    // Creates a workspace in the container to track entity changes.
    const workspace = TagManager.Accounts.Containers.Workspaces.create(
        {'name': 'appscript workspace', 'description': 'appscript workspace'},
        containerPath);
    const workspacePath = workspace.path;
    // Creates a random value variable.
    const variable = TagManager.Accounts.Containers.Workspaces.Variables.create(
        {'name': 'apps script variable', 'type': 'r'},
        workspacePath);
    // Creates a trigger that fires on any page view.
    const trigger = TagManager.Accounts.Containers.Workspaces.Triggers.create(
        {'name': 'apps script trigger', 'type': 'PAGEVIEW'},
        workspacePath);
    // Creates a arbitary pixel that fires the tag on all page views.
    const tag = TagManager.Accounts.Containers.Workspaces.Tags.create(
        {
          'name': 'apps script tag',
          'type': 'img',
          'liveOnly': false,
          'parameter': [
            {'type': 'boolean', 'key': 'useCacheBuster', 'value': 'true'}, {
              'type': 'template',
              'key': 'cacheBusterQueryParam',
              'value': 'gtmcb'
            },
            {'type': 'template', 'key': 'url', 'value': '//example.com'}
          ],
          'firingTriggerId': [trigger.triggerId]
        },
        workspacePath);
    // Creates a container version with the variabe, trigger, and tag.
    const version = TagManager.Accounts.Containers.Workspaces
        .create_version(
            {'name': 'apps script version'}, workspacePath)
        .containerVersion;
    console.log(version);
    return version;
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

הפקודה מפרסמת גרסה של מאגר התגים ומציגה תצוגה מקדימה מהירה של טיוטת המאגר הנוכחית.

בקוד לדוגמה שבהמשך נעשה שימוש ב-Tag Manager API V2 כדי לקבל גרסה של מאגר תגים שייתכן שנוצרה בדוגמה שלמעלה, ולשלוף ממנה את מזהי החשבון, המאגר והגרסה. בדוגמה הזו נעשה שימוש במזהים האלה כדי לפרסם גרסה של מאגר בזמן אמת לכולם. לבסוף, הדוגמה יוצרת תצוגה מקדימה מהירה של סביבת עבודה חדשה ומתעדת את התצוגה המקדימה המהירה ביומן.

advanced/tagManager.gs
/**
 * Retrieves the container path from a container version path.
 * @param  {string} versionPath The version path.
 * @return {string}             The container path.
 */
function grabContainerPath(versionPath) {
  const pathParts = versionPath.split('/');
  return pathParts.slice(0, 4).join('/');
}

/**
 * Publishes a container version publically to the world and creates a quick
 * preview of the current container draft.
 * @param {object} version The container version.
 */
function publishVersionAndQuickPreviewDraft(version) {
  try {
    const containerPath = grabContainerPath(version.path);
    // Publish the input container version.
    TagManager.Accounts.Containers.Versions.publish(version.path);
    const workspace = TagManager.Accounts.Containers.Workspaces.create(
        {'name': 'appscript workspace', 'description': 'appscript workspace'},
        containerPath);
    const workspaceId = workspace.path;
    // Quick previews the current container draft.
    const quickPreview = TagManager.Accounts.Containers.Workspaces
        .quick_preview(workspace.path);
    console.log(quickPreview);
  } catch (e) {
    // TODO (Developer) - Handle exceptions
    console.log('Failed with error: $s', e.error);
  }
}

יצירת סביבה של משתמש והענקת הרשאה מחדש.

בקוד לדוגמה שבהמשך נעשה שימוש ב-Tag Manager API V2 כדי לקבל גרסה של מאגר התגים ולחלץ את מזהי החשבון, מאגר התגים והגרסה. בדוגמה הזו נעשה שימוש במזהים האלה כדי ליצור סביבה של משתמש שמפנה לגרסה של קובץ האימג' של הקלט, ומתעדת ביומן את סביבה המשתמש. בסיום הדוגמה מתועדת בסביבת המשתמש הרשאה מחדש.

advanced/tagManager.gs
/**
 * Retrieves the container path from a container version path.
 * @param  {string} versionPath The version path.
 * @return {string}             The container path.
 */
function grabContainerPath(versionPath) {
  const pathParts = versionPath.split('/');
  return pathParts.slice(0, 4).join('/');
}

/**
 * Creates and reauthorizes a user environment in a container that points
 * to a container version passed in as an argument.
 * @param {object} version The container version object.
 */
function createAndReauthorizeUserEnvironment(version) {
  try {
    // Creates a container version.
    const containerPath = grabContainerPath(version.path);
    // Creates a user environment that points to a container version.
    const environment = TagManager.Accounts.Containers.Environments.create(
        {
          'name': 'test_environment',
          'type': 'user',
          'containerVersionId': version.containerVersionId
        },
        containerPath);
    console.log('Original user environment: ' + environment);
    // Reauthorizes the user environment that points to a container version.
    TagManager.Accounts.Containers.Environments.reauthorize(
        {}, environment.path);
    console.log('Reauthorized user environment: ' + environment);
  } catch (e) {
    // TODO (Developer) - Handle exceptions
    console.log('Failed with error: $s', e.error);
  }
}

רישום ביומן של כל כתובות האימייל והרשאות הגישה לקונטיינרים בחשבון.

בקוד לדוגמה שבהמשך נעשה שימוש ב-Tag Manager API V2 כדי למצוא רשימה של כל ההרשאות בחשבון Tag Manager. לאחר מכן, הדוגמה מתעדת ביומן את כתובת האימייל של המשתמש, מזהה המאגר ואת סוגי הרשאות הגישה למאגר לכל רשומה.

advanced/tagManager.gs
/**
 * Logs all emails and container access permission within an account.
 * @param {string} accountPath The account path.
 */
function logAllAccountUserPermissionsWithContainerAccess(accountPath) {
  try {
    const userPermissions =
      TagManager.Accounts.User_permissions.list(accountPath).userPermission;
    for (let i = 0; i < userPermissions.length; i++) {
      const userPermission = userPermissions[i];
      if ('emailAddress' in userPermission) {
        const containerAccesses = userPermission.containerAccess;
        for (let j = 0; j < containerAccesses.length; j++) {
          const containerAccess = containerAccesses[j];
          console.log(
              'emailAddress:' + userPermission.emailAddress +
            ' containerId:' + containerAccess.containerId +
            ' containerAccess:' + containerAccess.permission);
        }
      }
    }
  } catch (e) {
    // TODO (Developer) - Handle exceptions
    console.log('Failed with error: $s', e.error);
  }
}