Синхронизация аккаунтов, управляемых партнерами: руководство по API для разработчиков

Введение

Метод createAccountTree относится к API синхронизации и может использоваться для создания аккаунтов Google Аналитики. В отличие от метода createAccountTicket, для createAccountTree не требуется действий конечного пользователя: аккаунт создается автоматически. Это полезно, если нужно создать аккаунт Google Аналитики, чтобы управлять им от имени клиента, а также при создании специального представления для клиента.

Этот API предназначен для партнеров, управляющих сайтами или веб-ресурсами пользователей. Если пользователи самостоятельно управляют своими сайтами или веб-ресурсами, необходимо создать аккаунты Аналитики, контролируемые пользователями.

Перед началом работы

Доступ ко всем Google Analytics API осуществляется одинаково. Прежде чем начать работу с API синхронизации, ознакомьтесь со следующими материалами:

В каждой библиотеке реализован один служебный объект Google Analytics, который обеспечивает доступ ко всем данным API синхронизации. Чтобы создать служебный объект, обычно нужно выполнить следующие действия:

  1. Зарегистрировать приложение в Google API Console.
  2. Разрешить создавать новые аккаунты Google Analytics.
  3. Создать служебный объект Google Analytics.

Если вы не выполнили эти действия, перед продолжением прочитайте вводное руководство по Google Analytics API, в котором описывается, с чего нужно начинать создание приложения. Это поможет вам использовать Google Analytics API для выполнения рабочих операций.

Шаблон аккаунта

Получив доступ к этому API, вы должны предоставить новый аккаунт Google Аналитики, который будет выполнять роль шаблона. Вновь создаваемые аккаунты будут наследовать от него различные параметры, включая данные о лице, принявшем Условия использования, и организации, а также настройки обмена данными. Подробная информация о шаблоне аккаунта и наследуемых от него параметрах приведена в справке по методу createAccountTree.

Синхронизация аккаунта

Чтобы синхронизировать новый аккаунт Google Аналитики, отправьте запрос в конечную точку API createAccountTree. Вам понадобится следующая информация:

  • Поля аккаунта.
    • Название аккаунта accountName.
  • Поля веб-ресурса.
    • Название ресурса webpropertyName.
    • URL ресурса websiteUrl. Он должен быть связан с ресурсом пользователя этого аккаунта Google Analytics.
  • Поля представлений.
    • Название представления profileName.
    • Часовой пояс представления timezone.

Указав необходимые данные, отправьте авторизованный вызов в конечную точку API.

POST https://www.googleapis.com/analytics/v3/provisioning/createAccountTree
{
    "accountName": "Analytics Account",
    "webpropertyName": "Default Property",
    "profileName": "Default View",
    "timezone": "America/Los_Angeles",
    "websiteUrl": "www.example-pet-store.com",
}

В случае успешного выполнения вы получите ответ API с информацией по созданному аккаунту, веб-ресурсу и представлению:

{
    "account": {
        "id": "999999999",
        "name": "Analytics Account",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "webproperty": {
        "id": "UA-999999999-1",
        "name": "Default Property",
        "websiteUrl": "www.example-pet-store.com",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "profile": {
        "id": "999999999",
        "name": "Default View",
        "timezone": "America/Los_Angeles",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    ...
}

Право собственности на аккаунт и управление им

Созданный аккаунт Google Analytics принадлежит пользователю, осуществившему авторизацию запроса с помощью OAuth. Поэтому мы рекомендуем компании использовать для управления сервисный аккаунт, а не индивидуальный.

Когда аккаунт будет создан, вы сможете настраивать его с помощью Management API. Вот несколько стандартных задач для новых аккаунтов:

Взаимоотношение аккаунтов

Как и все остальные Google API, проект Google Cloud необходимо начинать с запроса на авторизацию. Как описано в документации на OAuth 2.0, в этом аккаунте вы будете управлять учетными данными для запросов API. Тем не менее созданный аккаунт Google Analytics связан не с проектом Google Cloud или его управляемыми аккаунтами, а только с пользовательским или служебным аккаунтом, с которого отправлен авторизованный запрос. С помощью Management API можно настроить доступ к аккаунту Google Analytics.