Method: customers.generateAudienceCompositionInsights

Возвращает коллекцию атрибутов, представленных в интересующей аудитории, с метриками, которые сравнивают долю каждого атрибута в аудитории с его долей в базовой аудитории.

Список выброшенных ошибок: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

HTTP-запрос

POST https://googleads.googleapis.com/v16/customers/{customerId}:generateAudienceCompositionInsights

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

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

Параметры
customerId

string

Необходимый. Идентификатор клиента.

Тело запроса

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

JSON-представление
{
  "audience": {
    object (InsightsAudience)
  },
  "baselineAudience": {
    object (InsightsAudience)
  },
  "dataMonth": string,
  "dimensions": [
    enum (AudienceInsightsDimension)
  ],
  "customerInsightsGroup": string
}
Поля
audience

object ( InsightsAudience )

Необходимый. Аудитория, представляющая интерес, для которой запрашивается информация.

baselineAudience

object ( InsightsAudience )

Базовая аудитория, с которой сравнивается интересующая аудитория.

dataMonth

string

Диапазон исторических данных за один месяц, используемый для анализа, в формате «гггг-мм». Если этот параметр не установлен, будет возвращена информация за последние тридцать дней.

dimensions[]

enum ( AudienceInsightsDimension )

Необходимый. Размеры аудитории, для которых должны быть возвращены сведения о составе.

customerInsightsGroup

string

Имя планируемого клиента. Это определяемое пользователем значение.

Тело ответа

Ответное сообщение для AudienceInsightsService.GenerateAudienceCompositionInsights .

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

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

object ( AudienceCompositionSection )

Содержимое аналитического отчета, организованное по разделам. Каждый раздел связан с одним из значений AudienceInsightsDimension в запросе. В каждом измерении может быть более одного раздела.

Области авторизации

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

АудиторияКомпозицияРаздел

Коллекция связанных атрибутов одного типа в отчете о составе аудитории.

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

enum ( AudienceInsightsDimension )

Тип атрибутов в этом разделе.

topAttributes[]

object ( AudienceCompositionAttribute )

Наиболее релевантные сегменты для этой аудитории. Если измерение имеет значение GENDER, AGE_RANGE или PARENTAL_STATUS, то этот список атрибутов является исчерпывающим.

clusteredAttributes[]

object ( AudienceCompositionAttributeCluster )

Дополнительные атрибуты для этой аудитории, сгруппированные в кластеры. Заполняется только в том случае, если измерение имеет значение YOUTUBE_CHANNEL.

АтрибутКомпозицияАудитории

Атрибут аудитории с метаданными и метриками.

JSON-представление
{
  "attributeMetadata": {
    object (AudienceInsightsAttributeMetadata)
  },
  "metrics": {
    object (AudienceCompositionMetrics)
  }
}
Поля
attributeMetadata

object ( AudienceInsightsAttributeMetadata )

Атрибут с его метаданными.

metrics

object ( AudienceCompositionMetrics )

Показатели общего доступа и индексирования для атрибута.

АудиторияСоставМетрики

Показатели доли и индекса, связанные с атрибутом в отчете о составе аудитории.

JSON-представление
{
  "baselineAudienceShare": number,
  "audienceShare": number,
  "index": number,
  "score": number
}
Поля
baselineAudienceShare

number

Доля (от 0 до 1 включительно) базовой аудитории, соответствующей атрибуту.

audienceShare

number

Доля (от 0 до 1 включительно) конкретной аудитории, соответствующей атрибуту.

index

number

Отношение AudienceShare к baselineAudienceShare или ноль, если это соотношение не определено или не имеет смысла.

score

number

Оценка релевантности от 0 до 1 включительно.

АудиторияКомпозицияАтрибутКластер

Коллекция связанных атрибутов с метаданными и показателями в отчете о составе аудитории.

JSON-представление
{
  "clusterDisplayName": string,
  "clusterMetrics": {
    object (AudienceCompositionMetrics)
  },
  "attributes": [
    {
      object (AudienceCompositionAttribute)
    }
  ]
}
Поля
clusterDisplayName

string

Имя этого кластера атрибутов

clusterMetrics

object ( AudienceCompositionMetrics )

Если измерение, связанное с этим кластером, — YOUTUBE_CHANNEL, тоclusterMetrics — это метрики, связанные с кластером в целом. Для других измерений это поле не задано.

attributes[]

object ( AudienceCompositionAttribute )

Отдельные атрибуты, составляющие этот кластер, с метаданными и метриками.