- Żądanie HTTP
- Parametry ścieżki
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- Kierowanie
- CampaignDuration
- PlannedProduct
- AdvancedProductTargeting
- SurfaceTargetingSettings
- YouTubeSelectSettings
- OnTargetAudienceMetrics
- ReachCurve
- ReachForecast
- PlannedProductReachForecast
- PlannedProductForecast
- Wypróbuj
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 |
Wymagane. Identyfikator reklamodawcy, który będzie prowadzić zaplanowaną kampanię. |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
|---|
{ "targeting": { object ( |
| Pola | |
|---|---|
targeting |
Wymagane. Parametry kierowania planowanej kampanii. |
campaignDuration |
Wymagane. Czas trwania planowanej kampanii. |
currencyCode |
Wymagane. Kod waluty planu w formacie ISO 4217. |
plannedProducts[] |
Wymagane. Lista elementów zamówienia do uwzględnienia w prognozie. |
minEffectiveFrequency |
Opcjonalnie: Minimalna efektywna częstotliwość w przypadku raportowanych danych o zasięgu. Jest to najmniejsza liczba wyświetleń reklamy, które musi zobaczyć klient, aby uznać ją za skuteczną. To ustawienie ma wpływ tylko na raportowanie. Musi mieścić się w przedziale od 1 do 10 włącznie. Jeśli nie zostanie określona, zostanie zastosowana wartość domyślna 1. |
Treść odpowiedzi
Wiadomość z odpowiedzią dla usługi ReachForecastService.GenerateReachForecast.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
|---|
{ "onTargetAudienceMetrics": { object ( |
| Pola | |
|---|---|
onTargetAudienceMetrics |
Szacunkowe wielkości grup odbiorców w wybranym regionie. |
reachCurve |
Wygenerowana krzywa prognozy. |
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/display-video
Więcej informacji znajdziesz w OAuth 2.0 Overview.
Kierowanie
Ustawienia kierowania zaplanowanej kampanii.
| Zapis JSON |
|---|
{ "plannableLocationIds": [ string ], "ageRange": enum ( |
| Pola | |
|---|---|
plannableLocationIds[] |
Wymagane. Identyfikatory lokalizacji, na które można kierować reklamy. Lokalizacje, w których można zaplanować kampanię, można pobrać za pomocą metody |
ageRange |
Opcjonalnie: Przedział wiekowy, na który chcesz kierować reklamy. |
genders[] |
Opcjonalnie: Opcje płci, na które chcesz kierować reklamy. |
devices[] |
Opcjonalnie: Urządzenia, na które chcesz kierować reklamy. |
CampaignDuration
Czas trwania planu zasięgu.
| Zapis JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"durationDays": integer,
"dateRange": {
object ( |
| Pola | |
|---|---|
| Wybór czasu trwania kampanii. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól: | |
durationDays |
Wymagane. Liczba dni, na które obejmuje plan. |
dateRange |
Wymagane. Zakres dat, w którym obowiązuje abonament. |
| Koniec pól wykluczających się nawzajem. | |
PlannedProduct
Konfiguracja konkretnej usługi w ramach planu.
| Zapis JSON |
|---|
{
"plannableProductCode": string,
"budgetMicros": string,
"advancedProductTargeting": {
object ( |
| Pola | |
|---|---|
plannableProductCode |
Wymagane. Kod produktu, np. „VIDEO_REACH_CAMPAIGN”. |
budgetMicros |
Wymagane. Budżet tego produktu w mikro. |
advancedProductTargeting |
Opcjonalnie: Opcjonalne zastąpienia kierowania na poziomie elementu zamówienia. |
AdvancedProductTargeting
Zastępowanie kierowania na konkretne produkty.
| Zapis JSON |
|---|
{ "surfaceTargetingSettings": { object ( |
| Pola | |
|---|---|
surfaceTargetingSettings |
Opcjonalnie: Platformy, na które można kierować reklamy. |
targetFrequency |
Opcjonalnie: Średnia liczba wyświetleń reklam tej samej osobie w określonym czasie. |
frequencyCap |
Opcjonalnie: Limit wyświetleń na użytkownika dla konkretnego produktu. |
ageRange |
Opcjonalnie: Przedział wiekowy, na który chcesz kierować reklamy. |
genders[] |
Opcjonalnie: Opcje płci, na które chcesz kierować reklamy. |
devices[] |
Opcjonalnie: Urządzenia, na które chcesz kierować reklamy. |
userInterestIds[] |
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 |
userListIds[] |
Opcjonalnie: Identyfikatory list użytkowników, na które chcesz kierować reklamy. Listy użytkowników, których można uwzględnić w planowaniu, można pobrać za pomocą metody |
youtubeSelectSettings |
Opcjonalnie: Ustawienia YouTube Select. |
dateRange |
Opcjonalnie: Zakres dat, na który chcesz kierować reklamy. |
plannableLocationIds[] |
Opcjonalnie: Identyfikatory lokalizacji, na które można kierować reklamy. |
network |
Opcjonalnie: Sieć docelowa. |
SurfaceTargetingSettings
Wybór kierowania na platformę.
| Zapis JSON |
|---|
{
"surfaces": [
enum ( |
| Pola | |
|---|---|
surfaces[] |
Opcjonalnie: Powierzchnie docelowe. |
YouTubeSelectSettings
Ustawienia lineupów YouTube Select.
| Zapis JSON |
|---|
{ "lineupId": string } |
| Pola | |
|---|---|
lineupId |
Opcjonalnie: Identyfikator lineupu YouTube Select. |
OnTargetAudienceMetrics
Szacunkowe wielkości grup odbiorców w przypadku docelowego obszaru geograficznego.
| Zapis JSON |
|---|
{ "youtubeAudienceSize": string, "censusAudienceSize": string } |
| Pola | |
|---|---|
youtubeAudienceSize |
Szacunkowa wielkość grupy odbiorców w YouTube. |
censusAudienceSize |
Wielkość odbiorców na podstawie danych statystycznych dotyczących wybranej lokalizacji. |
ReachCurve
Wygenerowana krzywa zasięgu.
| Zapis JSON |
|---|
{
"reachForecasts": [
{
object ( |
| Pola | |
|---|---|
reachForecasts[] |
Punkty na krzywej, uporządkowane według kosztu. |
ReachForecast
Pojedynczy punkt na krzywej zasięgu.
| Zapis JSON |
|---|
{ "costMicros": string, "plannedProductReachForecasts": [ { object ( |
| Pola | |
|---|---|
costMicros |
Całkowity koszt w częściach milionowych w tym momencie. |
plannedProductReachForecasts[] |
Zestawienie dla poszczególnych produktów w tym punkcie kosztów. |
forecast |
Prognoza zbiorcza dla całego planu. |
PlannedProductReachForecast
Prognoza skuteczności konkretnego produktu.
| Zapis JSON |
|---|
{
"costMicros": string,
"plannableProductCode": string,
"plannedProductForecast": {
object ( |
| Pola | |
|---|---|
costMicros |
Koszt tego produktu w częściach milionowych. |
plannableProductCode |
Kod produktu. |
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 |
Liczba unikalnych użytkowników, do których udało się dotrzeć i którzy pasują do definicji docelowej grupy demograficznej. |
onTargetImpressions |
Liczba wyświetleń wśród docelowych odbiorców. |
trueviewViews |
Liczba obejrzeń reklam TrueView. |
totalReach |
Łączna liczba unikalnych użytkowników, do których udało się dotrzeć. |
totalImpressions |
Łączna liczba wyświetleń. |
viewableImpressions |
Liczba widocznych wyświetleń. |
onTargetCoviewReach |
Liczba unikalnych użytkowników, do których udało się dotrzeć i którzy pasują do definicji docelowych odbiorców, w tym osób oglądających wspólnie. |
totalCoviewReach |
Łączna liczba unikalnych użytkowników, do których udało się dotrzeć, w tym osób oglądających wspólnie. |
onTargetCoviewImpressions |
Liczba wyświetleń w grupie docelowej, w tym wyświetleń w ramach wspólnego oglądania. |
totalCoviewImpressions |
Łączna liczba wyświetleń, w tym wyświetleń w ramach wspólnego oglądania. |