Method: accountTypes.accounts.insights.retrieve

Получает маркетинговые данные и аналитику для заданного списка пользователей.

Эта функция доступна только партнерам по передаче данных.

Заголовки авторизации:

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

  • login-account : (Необязательно) Имя ресурса учетной записи, в которой находится учетная запись Google, для которой были предоставлены учетные данные. Если не указано, используется имя учетной записи из запроса. Формат: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account : (Необязательно) Имя ресурса учетной записи с установленной связью продукта с login-account . Формат: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

HTTP-запрос

POST https://datamanager.googleapis.com/v1/{parent=accountTypes/*/accounts/*}/insights:retrieve

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры пути

Параметры
parent

string

Обязательно. Родительская учетная запись, которой принадлежит список пользователей. Формат: accountTypes/{accountType}/accounts/{account}

Текст запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "baseline": {
    object (Baseline)
  },
  "userListId": string
}
Поля
baseline

object ( Baseline )

Обязательно. Исходные данные для запрашиваемой информации.

userListId

string

Обязательно. Идентификатор списка пользователей, для которых запрашиваются аналитические данные.

Ответный текст

Ответное сообщение для DM API MarketingDataInsightsService.RetrieveInsights

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "marketingDataInsights": [
    {
      object (MarketingDataInsight)
    }
  ]
}
Поля
marketingDataInsights[]

object ( MarketingDataInsight )

Содержит аналитические данные по маркетингу.

Области полномочий

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/datamanager

Исходный уровень

Базовые критерии, с которыми сравниваются полученные результаты.

JSON-представление 
{

  // Union field baseline can be only one of the following:
  "baselineLocation": {
    object (Location)
  },
  "locationAutoDetectionEnabled": boolean
  // End of list of possible types for union field baseline.
}
Поля
baseline поля объединения. Базовое местоположение, с которым сравниваются полученные данные. baseline может быть только одной из следующих:
baselineLocation

object ( Location )

Базовое местоположение запроса. Базовое местоположение представляет собой список запрашиваемых регионов, заданный оператором ИЛИ.

locationAutoDetectionEnabled

boolean

Если установить значение true, сервис попытается автоматически определить базовое местоположение для получения аналитических данных.

Расположение

Базовое местоположение запроса. Базовое местоположение указано в списке кодов регионов ISO 3166-1 alpha-2 (OR-list) для запрашиваемых регионов.

JSON-представление 
{
  "regionCodes": [
    string
  ]
}
Поля
regionCodes[]

string

Список кодов регионов ISO 3166-1 alpha-2.

MarketingDataInsight

Аналитические выводы на основе маркетинговых данных.

Эта функция доступна только партнерам по передаче данных.

JSON-представление 
{
  "dimension": enum (AudienceInsightsDimension),
  "attributes": [
    {
      object (MarketingDataInsightsAttribute)
    }
  ]
}
Поля
dimension

enum ( AudienceInsightsDimension )

Измерение, к которому относится данное понимание.

attributes[]

object ( MarketingDataInsightsAttribute )

Анализ значений заданного параметра.

AudienceInsightsDimension

Возможные параметры для использования при получении аналитических выводов.

Перечисления
AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED Не указан.
AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN Значение в этой версии неизвестно.
AFFINITY_USER_INTEREST Интерес пользователя, основанный на сходстве интересов.
IN_MARKET_USER_INTEREST Интерес пользователей на рынке.
AGE_RANGE Возрастной диапазон.
GENDER Пол.

MarketingDataInsightsAttribute

Анализ совокупности связанных атрибутов одного и того же измерения.

JSON-представление 
{
  "userInterestId": string,
  "lift": number,
  "ageRange": enum (AgeRange),
  "gender": enum (Gender)
}
Поля
userInterestId

string ( int64 format)

Идентификатор заинтересованности пользователя.

lift

number

Показатель повышения интереса аудитории к значению атрибута по сравнению с базовым уровнем. Диапазон [0-1].

ageRange

enum ( AgeRange )

Возрастной диапазон целевой аудитории, для которой предназначен лифт.

gender

enum ( Gender )

Пол целевой аудитории, для которой предоставляется лифт.

Возрастной диапазон

Демографические возрастные диапазоны

Перечисления
AGE_RANGE_UNSPECIFIED Не указан.
AGE_RANGE_UNKNOWN Неизвестный.
AGE_RANGE_18_24 В возрасте от 18 до 24 лет.
AGE_RANGE_25_34 В возрасте от 25 до 34 лет.
AGE_RANGE_35_44 В возрасте от 35 до 44 лет.
AGE_RANGE_45_54 В возрасте от 45 до 54 лет.
AGE_RANGE_55_64 В возрасте от 55 до 64 лет.
AGE_RANGE_65_UP 65 лет и старше.

Пол

Тип демографического пола (например, женский).

Перечисления
GENDER_UNSPECIFIED Не указан.
GENDER_UNKNOWN Неизвестный.
GENDER_MALE Мужской.
GENDER_FEMALE Женский.