- HTTP-запрос
- Параметры пути
- Тело запроса
- Тело ответа
- Области авторизации
- InsightsАудитория
- InsightsАудиторияАтрибутГруппа
- АудиторияКомпозицияРаздел
- АтрибутКомпозицияАудитории
- АудиторияСоставМетрики
- АудиторияКомпозицияАтрибутКластер
- Попробуй это!
Возвращает коллекцию атрибутов, представленных в интересующей аудитории, с метриками, которые сравнивают долю каждого атрибута в аудитории с его долей в базовой аудитории.
Список выброшенных ошибок: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError
HTTP-запрос
POST https://googleads.googleapis.com/v14/customers/{customerId}:generateAudienceCompositionInsights
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
customerId | Необходимый. Идентификатор клиента. |
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{ "audience": { object ( |
Поля | |
---|---|
audience | Необходимый. Аудитория, представляющая интерес, для которой запрашивается информация. |
baselineAudience | Базовая аудитория, с которой сравнивается интересующая аудитория. |
dataMonth | Диапазон исторических данных за один месяц, используемый для анализа, в формате «гггг-мм». Если этот параметр не установлен, будет возвращена информация за последние тридцать дней. |
dimensions[] | Необходимый. Размеры аудитории, для которых должны быть возвращены сведения о составе. |
customerInsightsGroup | Имя планируемого клиента. Это определяемое пользователем значение. |
Тело ответа
Ответное сообщение для AudienceInsightsService.GenerateAudienceCompositionInsights
.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"sections": [
{
object ( |
Поля | |
---|---|
sections[] | Содержимое аналитического отчета, организованное по разделам. Каждый раздел связан с одним из значений AudienceInsightsDimension в запросе. В каждом измерении может быть более одного раздела. |
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/adwords
Дополнительную информацию см. в обзоре OAuth 2.0 .
InsightsАудитория
Набор пользователей, определяемый различными характеристиками, информацию о которых можно запросить в AudienceInsightsService.
JSON-представление |
---|
{ "countryLocations": [ { object ( |
Поля | |
---|---|
countryLocations[] | Необходимый. Страны для зрителей. |
subCountryLocations[] | Атрибуты географического положения подстраны. Если они присутствуют, каждый из них должен содержаться в одной из стран этой аудитории. Если его нет, то аудитория географически относится к странеМестоположения и не дальше. |
gender | Пол для аудитории. При его отсутствии аудитория не ограничивается по полу. |
ageRanges[] | Возрастные диапазоны аудитории. Если они отсутствуют, аудитория представляет всех людей старше 18 лет, соответствующих другим атрибутам. |
parentalStatus | Родительский статус для зрителей. При его отсутствии аудитория не ограничивается родительским статусом. |
incomeRanges[] | Диапазоны процентилей доходов домохозяйств для аудитории. При его отсутствии аудитория не ограничивается диапазоном доходов домохозяйств. |
dynamicLineups[] | Динамические подборки, представляющие контент YouTube, просматриваемый аудиторией. |
topicAudienceCombinations[] | Комбинация атрибутов сущности, категории и интересов пользователя, определяющая аудиторию. Комбинация имеет логическую структуру «И из ИЛИ»: атрибуты внутри каждой InsightsAudienceAttributeGroup объединяются с помощью OR, а сами комбинации объединяются с помощью AND. Например, выражение (Сущность ИЛИ Сходство) И (Присутствующий на рынке ИЛИ Категория) может быть сформировано с использованием двух групп InsightsAudienceAttributeGroups с двумя атрибутами в каждой. |
InsightsАудиторияАтрибутГруппа
Список AudienceInsightsAttributes.
JSON-представление |
---|
{
"attributes": [
{
object ( |
Поля | |
---|---|
attributes[] | Необходимый. Коллекция атрибутов аудитории, которые нужно объединить с помощью логического ИЛИ. Атрибуты не обязательно должны быть одного измерения. В этом контексте поддерживаются только объекты сети знаний, категории продуктов и услуг, а также аудитории по интересам и заинтересованным покупателям. |
АудиторияКомпозицияРаздел
Коллекция связанных атрибутов одного типа в отчете о составе аудитории.
JSON-представление |
---|
{ "dimension": enum ( |
Поля | |
---|---|
dimension | Тип атрибутов в этом разделе. |
topAttributes[] | Наиболее релевантные сегменты для этой аудитории. Если измерение имеет значение GENDER, AGE_RANGE или PARENTAL_STATUS, то этот список атрибутов является исчерпывающим. |
clusteredAttributes[] | Дополнительные атрибуты для этой аудитории, сгруппированные в кластеры. Заполняется только в том случае, если измерение имеет значение YOUTUBE_CHANNEL. |
АтрибутКомпозицияАудитории
Атрибут аудитории с метаданными и метриками.
JSON-представление |
---|
{ "attributeMetadata": { object ( |
Поля | |
---|---|
attributeMetadata | Атрибут с его метаданными. |
metrics | Показатели общего доступа и индексирования для атрибута. |
АудиторияСоставМетрики
Показатели доли и индекса, связанные с атрибутом в отчете о составе аудитории.
JSON-представление |
---|
{ "baselineAudienceShare": number, "audienceShare": number, "index": number, "score": number } |
Поля | |
---|---|
baselineAudienceShare | Доля (от 0 до 1 включительно) базовой аудитории, соответствующей атрибуту. |
audienceShare | Доля (от 0 до 1 включительно) конкретной аудитории, соответствующей атрибуту. |
index | Отношение AudienceShare к baselineAudienceShare или ноль, если это соотношение не определено или не имеет смысла. |
score | Оценка релевантности от 0 до 1 включительно. |
АудиторияКомпозицияАтрибутКластер
Коллекция связанных атрибутов с метаданными и показателями в отчете о составе аудитории.
JSON-представление |
---|
{ "clusterDisplayName": string, "clusterMetrics": { object ( |
Поля | |
---|---|
clusterDisplayName | Имя этого кластера атрибутов |
clusterMetrics | Если измерение, связанное с этим кластером, — YOUTUBE_CHANNEL, тоclusterMetrics — это метрики, связанные с кластером в целом. Для других измерений это поле не задано. |
attributes[] | Отдельные атрибуты, составляющие этот кластер, с метаданными и метриками. |