Usługa Menedżera tagów

Usługa Menedżer tagów Google zapewnia autoryzowanemu użytkownikowi dostęp do danych interfejsu Tag Manager API. Ta usługa umożliwia użytkownikom Menedżera tagów zarządzanie kontami, kontenerami, środowiskami, wersjami, obszarami roboczymi, folderami, zmiennymi, regułami, tagami i uprawnieniami użytkowników w Menedżerze tagów.

Jest to usługa zaawansowana, którą należy włączyć przed użyciem.

Dokumentacja

Szczegółowe informacje o tej usłudze znajdziesz w dokumentacji referencyjnej interfejsu Tag Manager API V2.

Podobnie jak wszystkie usługi zaawansowane w Google Apps Script, usługa Menedżer tagów używa tych samych obiektów, metod i parametrów co publiczny interfejs API. Więcej informacji znajdziesz w artykule Jak określa się sygnatury metod.

Aby zgłosić problemy i uzyskać inną pomoc, odwiedź Centrum pomocy Menedżera tagów Google.

Przykładowy kod

Poniższy przykładowy kod pokazuje, jak korzystać z kilku funkcji usługi Menedżer tagów.

Tworzy wersję kontenera ze zmienną, regułą i tagiem.

Poniższy przykładowy kod używa interfejsu Tag Manager API w wersji 2, aby najpierw utworzyć kontener o nazwie zawierającej sygnaturę czasową z bieżącą datą, co zwiększa prawdopodobieństwo, że będzie ona niepowtarzalna. Następnie tworzy on obszar roboczy ze zmienną o losowej wartości i regułą, która jest aktywowana przy każdym wyświetleniu strony. Następnie przykładowy kod używa reguły do utworzenia dowolnego tagu pikselowego, który uruchamia piksel do //example.com z dodanym na końcu adresu URL mechanizmem omijania pamięci podręcznej. Na koniec próbka tworzy wersję kontenera z tymi encjami, rejestruje ją i zwraca do późniejszego wykorzystania.

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);
  }
}

Publikuje wersję kontenera i szybko wyświetla podgląd bieżącej wersji roboczej kontenera.

Poniższy przykładowy kod korzysta z interfejsu Tag Manager API w wersji 2, aby zaakceptować wersję kontenera, która mogła zostać utworzona w poprzednim przykładzie, oraz pobrać z niej identyfikatory konta, kontenera i wersji. Przykładowy kod wykorzystuje te identyfikatory do opublikowania wersji kontenera na całym świecie. Na koniec próbka tworzy szybki podgląd nowego obszaru roboczego i rejestruje go.

advanced/tagManager.gs
/**
 * 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 pathParts = version.path.split("/");
    const containerPath = pathParts.slice(0, 4).join("/");
    // 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);
  }
}

Tworzy i ponownie autoryzuje środowisko użytkownika.

Poniższy przykładowy kod korzysta z interfejsu Tag Manager API w wersji 2, aby zaakceptować wersję kontenera i wyodrębnić identyfikatory konta, kontenera i wersji. Przykładowy kod wykorzystuje te identyfikatory do utworzenia środowiska użytkownika, które wskazuje wersję kontenera wejściowego i rejestruje środowisko użytkownika. Przykładowy kod kończy się zapisaniem środowiska ponownie autoryzowanego użytkownika.

advanced/tagManager.gs
/**
 * 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 pathParts = version.path.split("/");
    const containerPath = pathParts.slice(0, 4).join("/");
    // 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);
  }
}

Rejestruje wszystkie e-maile i uprawnienia dostępu do kontenera na koncie.

Poniższy przykładowy kod korzysta z interfejsu Tag Manager API w wersji 2, aby znaleźć listę wszystkich uprawnień na koncie Menedżera tagów. Następnie próbka rejestruje adres e-mail użytkownika, identyfikator kontenera i typy uprawnień dostępu do kontenera dla każdego wpisu.

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);
  }
}