Method: advertisers.reachForecast.generateReachForecast

Generuje prognozę zasięgu dla danego reklamodawcy i konfiguracji kierowania.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

Wymagane. Identyfikator reklamodawcy, który będzie prowadzić planowaną kampanię.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "targeting": {
    object (Targeting)
  },
  "campaignDuration": {
    object (CampaignDuration)
  },
  "currencyCode": string,
  "plannedProducts": [
    {
      object (PlannedProduct)
    }
  ],
  "minEffectiveFrequency": integer
}
Pola
targeting

object (Targeting)

Wymagane. Parametry kierowania zaplanowanej kampanii.

campaignDuration

object (CampaignDuration)

Wymagane. Czas trwania planowanej kampanii.

currencyCode

string

Wymagane. Kod waluty planu w formacie ISO 4217.

plannedProducts[]

object (PlannedProduct)

Wymagane. Lista elementów zamówienia, które mają zostać uwzględnione w prognozie.

minEffectiveFrequency

integer

Opcjonalnie. Minimalna efektywna częstotliwość w przypadku raportowanych danych o zasięgu. Jest to najmniejsza liczba wyświetleń reklamy, która jest uznawana za skuteczną. To ustawienie ma wpływ tylko na raportowanie.

Musi należeć do zakresu od 1 do 10 włącznie. Jeśli nie określisz tu żadnej wartości, zostanie użyte ustawienie domyślne 1.

Treść odpowiedzi

Wiadomość odpowiedzi dla ReachForecastService.GenerateReachForecast.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "onTargetAudienceMetrics": {
    object (OnTargetAudienceMetrics)
  },
  "reachCurve": {
    object (ReachCurve)
  }
}
Pola
onTargetAudienceMetrics

object (OnTargetAudienceMetrics)

Szacunkowe wielkości grup odbiorców w wybranym regionie.

reachCurve

object (ReachCurve)

Wygenerowana krzywa prognozy.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w sekcji OAuth 2.0 Overview.

Kierowanie

Ustawienia kierowania zaplanowanej kampanii.

Zapis JSON
{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ]
}
Pola
plannableLocationIds[]

string (int64 format)

Wymagane. Identyfikatory lokalizacji, na które można kierować reklamy.

Lokalizacje, w których można zaplanować kampanię, można pobrać za pomocą metody reachForecast.retrievePlannableLocations.

ageRange

enum (PlannableAgeRange)

Opcjonalnie. Przedział wiekowy, na który chcesz kierować reklamy.

genders[]

enum (Gender)

Opcjonalnie. Opcje płci, na które chcesz kierować reklamy.

devices[]

enum (DeviceType)

Opcjonalnie. Urządzenia, na które chcesz kierować reklamy.

CampaignDuration

Czas trwania planu zasięgu.

Zapis 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.
}
Pola
Pole zbiorcze duration. Wybór czasu trwania kampanii. duration może mieć tylko jedną z tych wartości:
durationDays

integer

Wymagane. Liczba dni, przez które obowiązuje plan.

dateRange

object (DateRange)

Wymagane. Zakres dat, w którym obowiązuje plan.

PlannedProduct

Konfiguracja konkretnej usługi w ramach planu.

Zapis JSON
{
  "plannableProductCode": string,
  "budgetMicros": string,
  "advancedProductTargeting": {
    object (AdvancedProductTargeting)
  }
}
Pola
plannableProductCode

string

Wymagane. Kod produktu, np. „VIDEO_REACH_CAMPAIGN”.

budgetMicros

string (int64 format)

Wymagane. Budżet tego produktu w mikro.

advancedProductTargeting

object (AdvancedProductTargeting)

Opcjonalnie. Opcjonalne zastąpienia kierowania na poziomie elementu zamówienia.

AdvancedProductTargeting

Zastępowanie kierowania na konkretne produkty.

Zapis 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)
}
Pola
surfaceTargetingSettings

object (SurfaceTargetingSettings)

Opcjonalnie. Platformy, na które można kierować reklamy.

targetFrequency

object (TargetFrequency)

Opcjonalnie. Średnia liczba wyświetleń reklam tej samej osobie w określonym czasie.

frequencyCap

object (FrequencyCap)

Opcjonalnie. Limit wyświetleń na użytkownika dla konkretnego produktu.

ageRange

enum (PlannableAgeRange)

Opcjonalnie. Przedział wiekowy, na który chcesz kierować reklamy.

genders[]

enum (Gender)

Opcjonalnie. Opcje płci, na które chcesz kierować reklamy.

devices[]

enum (DeviceType)

Opcjonalnie. Urządzenia, na które chcesz kierować reklamy.

userInterestIds[]

string

Opcjonalnie. Identyfikatory zainteresowań użytkowników, na które chcesz kierować reklamy.

Zainteresowania użytkowników, które można zaplanować, można pobrać za pomocą metody reachForecast.retrievePlannableUserInterests.

userListIds[]

string

Opcjonalnie. Identyfikatory list użytkowników, na które chcesz kierować reklamy.

Listy użytkowników, które można zaplanować, można pobrać za pomocą metody reachForecast.retrievePlannableUserInterests.

youtubeSelectSettings

object (YouTubeSelectSettings)

Opcjonalnie. Ustawienia YouTube Select.

dateRange

object (DateRange)

Opcjonalnie. Zakres dat, na który chcesz kierować reklamy.

plannableLocationIds[]

string (int64 format)

Opcjonalnie. Identyfikatory lokalizacji, na które można kierować reklamy.

network

enum (PlannableNetwork)

Opcjonalnie. Sieć, na którą chcesz kierować reklamy.

SurfaceTargetingSettings

Wybór kierowania na platformę.

Zapis JSON
{
  "surfaces": [
    enum (PlannableSurface)
  ]
}
Pola
surfaces[]

enum (PlannableSurface)

Opcjonalnie. Powierzchnie, na które chcesz kierować reklamy.

YouTubeSelectSettings

Ustawienia lineupów YouTube Select.

Zapis JSON
{
  "lineupId": string
}
Pola
lineupId

string (int64 format)

Opcjonalnie. Identyfikator lineupu YouTube Select.

OnTargetAudienceMetrics

Szacunkowa wielkość grup odbiorców w wybranym regionie.

Zapis JSON
{
  "youtubeAudienceSize": string,
  "censusAudienceSize": string
}
Pola
youtubeAudienceSize

string (int64 format)

Szacunkowa wielkość grupy odbiorców w YouTube.

censusAudienceSize

string (int64 format)

Wielkość grupy odbiorców na podstawie danych statystycznych dotyczących wybranej lokalizacji.

ReachCurve

Wygenerowana krzywa zasięgu.

Zapis JSON
{
  "reachForecasts": [
    {
      object (ReachForecast)
    }
  ]
}
Pola
reachForecasts[]

object (ReachForecast)

Punkty na krzywej uporządkowane według kosztu.

ReachForecast

Pojedynczy punkt na krzywej zasięgu.

Zapis JSON
{
  "costMicros": string,
  "plannedProductReachForecasts": [
    {
      object (PlannedProductReachForecast)
    }
  ],
  "forecast": {
    object (PlannedProductForecast)
  }
}
Pola
costMicros

string (int64 format)

Całkowity koszt w częściach milionowych w tym punkcie.

plannedProductReachForecasts[]

object (PlannedProductReachForecast)

Zestawienie dla poszczególnych produktów w tym punkcie kosztowym.

forecast

object (PlannedProductForecast)

Zagregowana prognoza dla całego planu.

PlannedProductReachForecast

Prognoza wyników konkretnego produktu.

Zapis JSON
{
  "costMicros": string,
  "plannableProductCode": string,
  "plannedProductForecast": {
    object (PlannedProductForecast)
  }
}
Pola
costMicros

string (int64 format)

Koszt tego produktu w częściach milionowych.

plannableProductCode

string

Kod produktu.

plannedProductForecast

object (PlannedProductForecast)

Dane dotyczące skuteczności produktu.

PlannedProductForecast

Dane o skuteczności dla punktu prognozy.

Zapis JSON
{
  "onTargetReach": string,
  "onTargetImpressions": string,
  "trueviewViews": string,
  "totalReach": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}
Pola
onTargetReach

string (int64 format)

Liczba unikalnych użytkowników, którzy spełniają definicję docelowych odbiorców.

onTargetImpressions

string (int64 format)

Liczba wyświetleń wśród docelowych odbiorców.

trueviewViews

string (int64 format)

Liczba obejrzeń reklam TrueView.

totalReach

string (int64 format)

Łączna liczba unikalnych użytkowników, do których dotarła reklama.

totalImpressions

string (int64 format)

Łączna liczba wyświetleń.

viewableImpressions

string (int64 format)

Liczba widocznych wyświetleń.

onTargetCoviewReach

string (int64 format)

Liczba unikalnych osób, do których udało się dotrzeć i które spełniają definicję docelowych odbiorców, w tym osób oglądających wspólnie.

totalCoviewReach

string (int64 format)

Łączna liczba unikalnych użytkowników, do których dotarła reklama, w tym osoby oglądające wspólnie.

onTargetCoviewImpressions

string (int64 format)

Liczba wyświetleń wśród docelowych odbiorców, w tym osób oglądających wspólnie.

totalCoviewImpressions

string (int64 format)

Łączna liczba wyświetleń, w tym wyświetleń w ramach wspólnego oglądania.