Предоставление учетных записей, контролируемых партнерами – Руководство разработчика API

Введение

createAccountTree — это часть Provisioning API, которую можно использовать для создания новых учетных записей Google Analytics в любом масштабе. В отличие от createAccountTicket , createAccountTree не требует какого-либо взаимодействия с конечным пользователем для завершения создания учетной записи; процесс полностью автоматизирован. Это полезно, когда вам необходимо предоставить учетную запись Analytics, которой вы управляете от имени клиента, и когда вы предоставляете своему клиенту настраиваемое представление этих данных.

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

Прежде чем вы начнете

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

  • Прочтите страницу клиентских библиотек , чтобы получить полный список клиентских библиотек для конкретного языка программирования, которые работают с API.
  • Прочтите Справочное руководство , чтобы узнать об интерфейсе API и о том, как получить доступ к данным без клиентской библиотеки.

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

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

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

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

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

Предоставление учетной записи

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

  • Поля аккаунта
    • accountName .
  • Поля веб-свойств
    • webpropertyName для свойства.
    • URL- websiteUrl . Это должен быть URL-адрес, связанный с свойством пользователя для этого аккаунта 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. По этой причине мы рекомендуем вашей организации использовать сервисную учетную запись для управления учетной записью Analytics, а не отдельную учетную запись пользователя.

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

Разъяснение взаимоотношений со счетами

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