Method: advertisers.reachForecast.generateReachForecast

Генерирует прогноз охвата для заданного рекламодателя и конфигурации таргетинга.

HTTP-запрос

POST https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:generateReachForecast

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

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

Параметры
advertiserId

string ( int64 format)

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

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

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

JSON-представление 
{
  "targeting": {
    object (Targeting)
  },
  "campaignDuration": {
    object (CampaignDuration)
  },
  "currencyCode": string,
  "plannedProducts": [
    {
      object (PlannedProduct)
    }
  ],
  "minEffectiveFrequency": integer
}
Поля
targeting

object ( Targeting )

Обязательно. Параметры таргетинга планируемой кампании.

campaignDuration

object ( CampaignDuration )

Обязательно. Продолжительность запланированной кампании.

currencyCode

string

Обязательно. Код валюты для плана в формате ISO 4217.

plannedProducts[]

object ( PlannedProduct )

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

minEffectiveFrequency

integer

Необязательный параметр. Минимальная эффективная частота для сообщаемых показателей охвата. Это наименьшее количество раз, когда клиент должен увидеть рекламу, чтобы она считалась эффективной. Этот параметр влияет только на отчетность.

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

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

Ответное сообщение для ReachForecastService.GenerateReachForecast.

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

JSON-представление 
{
  "onTargetAudienceMetrics": {
    object (OnTargetAudienceMetrics)
  },
  "reachCurve": {
    object (ReachCurve)
  }
}
Поля
onTargetAudienceMetrics

object ( OnTargetAudienceMetrics )

Предполагаемый размер аудитории в целевом регионе.

reachCurve

object ( ReachCurve )

Сгенерированная кривая прогноза.

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

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

  • https://www.googleapis.com/auth/display-video

Для получения более подробной информации см.OAuth 2.0 Overview .

Целенаправленное воздействие

Настройки таргетинга для запланированной кампании.

JSON-представление 
{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ]
}
Поля
plannableLocationIds[]

string ( int64 format)

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

Доступные для планирования местоположения можно получить с помощью метода reachForecast.retrievePlannableLocations .

ageRange

enum ( PlannableAgeRange )

Необязательно. Целевой возрастной диапазон.

genders[]

enum ( Gender )

Необязательно. Варианты пола для целевой аудитории.

devices[]

enum ( DeviceType )

Необязательно. Целевые устройства.

Продолжительность кампании

Продолжительность действия плана действий.

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

  // Union field duration can be only one of the following:
  "durationDays": integer,
  "dateRange": {
    object (DateRange)
  }
  // End of list of possible types for union field duration.
}
Поля
duration полевых работ Союза. Выбор продолжительности кампании. duration может быть только одной из следующих:
durationDays

integer

Обязательно. Количество дней, на которые распространяется действие плана.

dateRange

object ( DateRange )

Обязательно. Диапазон дат, охватываемый планом.

Планируемый продукт

Настройка для конкретного продукта в рамках плана.

JSON-представление 
{
  "plannableProductCode": string,
  "budgetMicros": string,
  "advancedProductTargeting": {
    object (AdvancedProductTargeting)
  }
}
Поля
plannableProductCode

string

Обязательно. Код продукта, например, "VIDEO_REACH_CAMPAIGN".

budgetMicros

string ( int64 format)

Обязательно. Бюджет на данный продукт в микросекундах.

advancedProductTargeting

object ( AdvancedProductTargeting )

Необязательно. Необязательные параметры переопределения таргетинга на уровне отдельных позиций.

Расширенное таргетирование продуктов

Переопределение таргетинга для конкретного продукта.

JSON-представление 
{
  "surfaceTargetingSettings": {
    object (SurfaceTargetingSettings)
  },
  "targetFrequency": {
    object (TargetFrequency)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ],
  "userInterestIds": [
    string
  ],
  "userListIds": [
    string
  ],
  "youtubeSelectSettings": {
    object (YouTubeSelectSettings)
  },
  "dateRange": {
    object (DateRange)
  },
  "plannableLocationIds": [
    string
  ],
  "network": enum (PlannableNetwork)
}
Поля
surfaceTargetingSettings

object ( SurfaceTargetingSettings )

Необязательно. Планируемые поверхности для воздействия.

targetFrequency

object ( TargetFrequency )

Необязательно. Среднее количество показов рекламы одному и тому же человеку за определенный период времени.

frequencyCap

object ( FrequencyCap )

Необязательно. Ограничение частоты для конкретного продукта.

ageRange

enum ( PlannableAgeRange )

Необязательно. Целевой возрастной диапазон.

genders[]

enum ( Gender )

Необязательно. Варианты пола для целевой аудитории.

devices[]

enum ( DeviceType )

Необязательно. Целевые устройства.

userInterestIds[]

string

Необязательно. Идентификаторы интересов пользователей, на которых будет ориентирована целевая аудитория.

Запланированные интересы пользователей можно получить с помощью метода reachForecast.retrievePlannableUserInterests .

userListIds[]

string

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

Списки пользователей, подлежащих планированию, можно получить с помощью метода reachForecast.retrievePlannableUserInterests .

youtubeSelectSettings

object ( YouTubeSelectSettings )

Необязательно. YouTube. Выберите настройки.

dateRange

object ( DateRange )

Необязательно. Диапазон дат для выбора целевой даты.

plannableLocationIds[]

string ( int64 format)

Необязательно. Идентификаторы планируемых местоположений для целевого воздействия.

network

enum ( PlannableNetwork )

Необязательно. Целевая сеть.

SurfaceTargetingSettings

Выбор целевого объекта на поверхности.

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

enum ( PlannableSurface )

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

YouTubeSelectSettings

Настройки выбора составов участников на YouTube.

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

string ( int64 format)

Необязательно. Идентификатор списка избранных видео на YouTube.

OnTargetAudienceMetrics

Оценка численности целевой аудитории в конкретном регионе.

JSON-представление 
{
  "youtubeAudienceSize": string,
  "censusAudienceSize": string
}
Поля
youtubeAudienceSize

string ( int64 format)

Примерный размер аудитории YouTube.

censusAudienceSize

string ( int64 format)

Размер аудитории определяется на основе данных переписи населения целевого региона.

ReachCurve

Сгенерированная кривая охвата.

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

object ( ReachForecast )

Точки вдоль кривой, упорядоченные по стоимости.

ReachForecast

Отдельная точка на кривой охвата.

JSON-представление 
{
  "costMicros": string,
  "plannedProductReachForecasts": [
    {
      object (PlannedProductReachForecast)
    }
  ],
  "forecast": {
    object (PlannedProductForecast)
  }
}
Поля
costMicros

string ( int64 format)

Общая стоимость на этом этапе в микроэлементах.

plannedProductReachForecasts[]

object ( PlannedProductReachForecast )

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

forecast

object ( PlannedProductForecast )

Сводный прогноз по всему плану.

Прогнозируемый охват запланированного продукта

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

JSON-представление 
{
  "costMicros": string,
  "plannableProductCode": string,
  "plannedProductForecast": {
    object (PlannedProductForecast)
  }
}
Поля
costMicros

string ( int64 format)

Стоимость данного продукта указана в микроэлементах.

plannableProductCode

string

Код продукта.

plannedProductForecast

object ( PlannedProductForecast )

Показатели производительности продукта.

Прогнозирование запланированного продукта

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

JSON-представление 
{
  "onTargetReach": string,
  "onTargetImpressions": string,
  "trueviewViews": string,
  "totalReach": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}
Поля
onTargetReach

string ( int64 format)

Количество уникальных людей, соответствующих целевому определению.

onTargetImpressions

string ( int64 format)

Количество показов, соответствующих целевому показу.

trueviewViews

string ( int64 format)

Количество просмотров TrueView.

totalReach

string ( int64 format)

Общее количество уникальных пользователей, до которых был осуществлен контакт.

totalImpressions

string ( int64 format)

Общее количество показов.

viewableImpressions

string ( int64 format)

Количество видимых показов.

onTargetCoviewReach

string ( int64 format)

Количество уникальных людей, соответствующих целевому определению, включая зрителей, разделяющих вашу аудиторию.

totalCoviewReach

string ( int64 format)

Общее количество уникальных зрителей, включая тех, кто смотрел трансляцию вместе с автором.

onTargetCoviewImpressions

string ( int64 format)

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

totalCoviewImpressions

string ( int64 format)

Общее количество показов, включая совместные просмотры.