REST Resource: advertisers.lineItems

Zasób: LineItem

Jeden element zamówienia.

Zapis JSON
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "lineItemId": string,
  "displayName": string,
  "lineItemType": enum (LineItemType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "flight": {
    object (LineItemFlight)
  },
  "budget": {
    object (LineItemBudget)
  },
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "partnerRevenueModel": {
    object (PartnerRevenueModel)
  },
  "conversionCounting": {
    object (ConversionCountingConfig)
  },
  "creativeIds": [
    string
  ],
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "warningMessages": [
    enum (LineItemWarningMessage)
  ],
  "mobileApp": {
    object (MobileApp)
  },
  "reservationType": enum (ReservationType),
  "excludeNewExchanges": boolean,
  "youtubeAndPartnersSettings": {
    object (YoutubeAndPartnersSettings)
  }
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu elementu zamówienia.

advertiserId

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator reklamodawcy, do którego należy element zamówienia.

campaignId

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator kampanii, do której należy element zamówienia.

insertionOrderId

string (int64 format)

To pole jest wymagane. Stałe. Unikalny identyfikator zamówienia reklamowego, do którego należy element zamówienia.

lineItemId

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator elementu zamówienia. Przypisana przez system.

displayName

string

To pole jest wymagane. Wyświetlana nazwa elementu zamówienia.

Musi być zakodowany w formacie UTF-8 o maksymalnym rozmiarze 240 bajtów.

lineItemType

enum (LineItemType)

To pole jest wymagane. Stałe. Typ elementu zamówienia.

entityStatus

enum (EntityStatus)

To pole jest wymagane. Określa, czy element zamówienia może wydawać budżet i ustalać stawki za zasoby reklamowe.

  • W przypadku metody lineItems.create dozwolona jest tylko wartość ENTITY_STATUS_DRAFT. Aby aktywować element zamówienia, użyj metody lineItems.patch i po jego utworzeniu zmień stan na ENTITY_STATUS_ACTIVE.
  • Nie można zmienić stanu elementu zamówienia z powrotem na ENTITY_STATUS_DRAFT.
  • Jeśli nadrzędne zamówienie reklamowe elementu zamówienia jest nieaktywne, element nie może wydać budżetu, nawet jeśli jego stan to ENTITY_STATUS_ACTIVE.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji elementu zamówienia. Przypisana przez system.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

partnerCosts[]

object (PartnerCost)

Koszty partnera powiązane z elementem zamówienia.

Jeśli w metodzie lineItems.create nie będzie tych danych lub ich brak, nowo utworzony element zamówienia odziedziczy koszty partnera z nadrzędnego zamówienia reklamowego.

flight

object (LineItemFlight)

To pole jest wymagane. Godzina rozpoczęcia i zakończenia okresu wyświetlania elementu zamówienia.

budget

object (LineItemBudget)

To pole jest wymagane. Ustawienie alokacji budżetu elementu zamówienia.

pacing

object (Pacing)

To pole jest wymagane. Ustawienie szybkości wykorzystywania środków przez budżet elementu zamówienia.

frequencyCap

object (FrequencyCap)

To pole jest wymagane. Ustawienia limitu wyświetleń na użytkownika ustawionego w elemencie zamówienia.

Aby przypisać ograniczony limit, należy użyć pola maxImpressions w tym obiekcie ustawień.

partnerRevenueModel

object (PartnerRevenueModel)

To pole jest wymagane. Ustawienie modelu rozliczeniowego partnera powiązanego z elementem zamówienia.

conversionCounting

object (ConversionCountingConfig)

Ustawienie śledzenia konwersji elementu zamówienia.

creativeIds[]

string (int64 format)

Identyfikatory kreacji powiązanych z elementem zamówienia.

bidStrategy

object (BiddingStrategy)

To pole jest wymagane. Strategia ustalania stawek powiązana z elementem zamówienia.

integrationDetails

object (IntegrationDetails)

Szczegóły integracji elementu zamówienia.

targetingExpansion

object (TargetingExpansionConfig)

Ustawienia kierowania zoptymalizowanego elementu zamówienia.

Ta konfiguracja dotyczy tylko displayowych elementów zamówienia oraz elementów zamówienia wideo i audio, które korzystają z automatycznego określania stawek i kierują reklamy na odpowiednie listy odbiorców.

warningMessages[]

enum (LineItemWarningMessage)

Tylko dane wyjściowe. Komunikaty ostrzegawcze wygenerowane przez element zamówienia. Ostrzeżenia te nie blokują zapisywania elementu zamówienia, ale niektóre z nich mogą zablokować jego realizację.

mobileApp

object (MobileApp)

Aplikacja mobilna promowana w elemencie zamówienia.

Ma to zastosowanie tylko wtedy, gdy lineItemType ma wartość LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL lub LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL.

reservationType

enum (ReservationType)

Tylko dane wyjściowe. Typ rezerwacji elementu zamówienia.

excludeNewExchanges

boolean

Określa, czy nowe giełdy mają być wykluczone z automatycznego kierowania elementu zamówienia. To pole domyślnie ma wartość Fałsz.

youtubeAndPartnersSettings

object (YoutubeAndPartnersSettings)

Tylko dane wyjściowe. Ustawienia specyficzne dla elementów zamówienia typu YouTube i sieć partnerów wideo Google.

LineItemType

Możliwe typy elementu zamówienia.

Typ elementu zamówienia określa, które ustawienia i opcje, takie jak format reklam czy opcje kierowania, są odpowiednie.

Wartości w polu enum
LINE_ITEM_TYPE_UNSPECIFIED

Wartość typu nie jest określona lub jest nieznana w tej wersji.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_DISPLAY_DEFAULT Reklamy graficzne, HTML5, natywne lub rich media.
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL Reklamy displayowe, które zachęcają do instalacji aplikacji.
LINE_ITEM_TYPE_VIDEO_DEFAULT Reklamy wideo sprzedawane zgodnie z modelem CPM w różnych środowiskach.
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL Reklamy wideo, które zachęcają do instalacji aplikacji.
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY

Reklamy displayowe wyświetlane w zasobach reklamowych w aplikacjach mobilnych.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY

Reklamy wideo wyświetlane w zasobach reklamowych w aplikacjach mobilnych.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_AUDIO_DEFAULT Reklamy audio RTB sprzedawane do różnych środowisk.
LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP Reklamy Over-The-Top występują w zamówieniach reklamowych OTT. Ten typ dotyczy tylko elementów zamówienia z zamówieniem reklamowym insertionOrderType OVER_THE_TOP.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION

Reklamy wideo w YouTube promujące konwersje.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE

Reklamy wideo w YouTube (do 15 sekund), których nie można pominąć.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE

Reklamy wideo w YouTube prezentujące sekwencje w określonej kolejności za pomocą różnych formatów.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO

Reklamy audio w YouTube.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH

reklamy wideo w YouTube, które optymalizują docieranie do większej liczby unikalnych użytkowników przy niższych kosztach; Może obejmować bumpery reklamowe, reklamy In-Stream możliwe do pominięcia lub kombinację różnych typów.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE

Domyślne reklamy wideo w YouTube.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP

Reklamy wideo w YouTube na urządzenia CTV (do 15 sekund), których nie można pominąć.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP

Reklamy wideo w YouTube na urządzenia CTV, które optymalizują docieranie do większej liczby unikalnych użytkowników przy niższych kosztach. Może obejmować bumpery reklamowe, reklamy In-Stream możliwe do pominięcia lub kombinację różnych typów.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP

Domyślne reklamy wideo w YouTube na urządzenia CTV. Uwzględnij tylko reklamy w formacie In-Stream.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY

Celem tego typu elementu zamówienia jest wyświetlanie tej samej osobie docelowej liczby reklam w YouTube w określonym przedziale czasu.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW

reklamy wideo w YouTube, które mają na celu zwiększenie liczby obejrzeń za pomocą różnych formatów reklam;

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME

Reklamy displayowe wyświetlane w cyfrowych zewnętrznych zasobach reklamowych.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME

Reklamy wideo wyświetlane w cyfrowych zewnętrznych zasobach reklamowych.

Elementów zamówienia tego typu i ich ustawień kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LineItemFlight

Ustawienia, które kontrolują aktywny czas trwania elementu zamówienia.

Zapis JSON
{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  }
}
Pola
flightDateType

enum (LineItemFlightDateType)

To pole jest wymagane. Typ dat wyświetlania elementu zamówienia.

dateRange

object (DateRange)

Daty rozpoczęcia i zakończenia wyświetlania reklam z elementu zamówienia. Rozwiązuje się je w zależności od strefy czasowej reklamodawcy nadrzędnego.

  • Wymagane, gdy flightDateType ma wartość LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM. W innych przypadkach tylko dane wyjściowe.
  • Podczas tworzenia nowej emisji zarówno startDate, jak i endDate muszą przypadać w przyszłości.
  • Istniejący lot z lotem startDate w przeszłości ma zmienną endDate, ale stałą startDate.
  • endDate musi mieć wartość startDate lub późniejszą – zarówno przed 2037 rokiem, jak i później.

LineItemFlightDateType

Możliwe typy dat wyświetlania reklam elementu zamówienia.

Wartości w polu enum
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED Wartość typu nie jest określona lub jest nieznana w tej wersji.
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED Daty wyświetlania reklam z elementu zamówienia są dziedziczone z jego nadrzędnego zamówienia reklamowego.
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM Element zamówienia używa własnych niestandardowych dat wyświetlania reklam.

LineItemBudget

Ustawienia określające sposób przydzielania budżetu.

Zapis JSON
{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}
Pola
budgetAllocationType

enum (LineItemBudgetAllocationType)

To pole jest wymagane. Typ przydziału budżetu.

Typ LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC ma zastosowanie tylko wtedy, gdy w nadrzędnym zamówieniu reklamowym włączone jest automatyczne przydzielanie budżetu.

budgetUnit

enum (BudgetUnit)

Tylko dane wyjściowe. Jednostka budżetu określa, czy budżet zależy od waluty, czy od wyświetleń. Ta wartość jest dziedziczona z nadrzędnego zamówienia reklamowego.

maxAmount

string (int64 format)

Maksymalna kwota budżetu, jaką wydaje element zamówienia. Musi być większy niż 0.

Gdy budgetAllocationType jest:

  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC, to pole jest stałe i ustawiane przez system.
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED, jeśli budgetUnit to:
    • BUDGET_UNIT_CURRENCY: to pole przedstawia maksymalną kwotę budżetu do wydania, wyrażoną w milionowej walucie reklamodawcy. Na przykład 1500 000 oznacza 1, 5 jednostki standardowej waluty.
    • BUDGET_UNIT_IMPRESSIONS, to pole reprezentuje maksymalną liczbę wyświetleń do zrealizowania.
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED, to pole nie ma zastosowania i będzie ignorowane przez system.

LineItemBudgetAllocationType

Możliwe typy przydziału budżetu.

Wartości w polu enum
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED Wartość typu nie jest określona lub jest nieznana w tej wersji.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC W elemencie zamówienia włączono automatyczne przydzielanie budżetu.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED Do elementu zamówienia jest przydzielana stała maksymalna kwota budżetu.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED Do elementu zamówienia nie jest stosowany żaden limit budżetu.

PartnerRevenueModel

Ustawienia określające sposób obliczania przychodów partnera.

Zapis JSON
{
  "markupType": enum (PartnerRevenueModelMarkupType),
  "markupAmount": string
}
Pola
markupType

enum (PartnerRevenueModelMarkupType)

To pole jest wymagane. Typ marży w modelu rozliczeniowym partnera.

markupAmount

string (int64 format)

To pole jest wymagane. Kwota marży według modelu rozliczeniowego partnera. Wartość nie może być mniejsza niż 0.

  • Jeśli markupType ma wartość PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM, to pole przedstawia marżę CPM wyrażoną w milionowej walucie reklamodawcy. Na przykład 1500 000 oznacza 1, 5 jednostki standardowej waluty.
  • Jeśli markupType ma wartość PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP, to pole przedstawia marżę procentową kosztu mediów w milisekundach. Na przykład 100 oznacza 0,1% (0,001 w postaci dziesiętnej).
  • Jeśli markupType ma wartość PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP, to pole przedstawia marżę procentową całkowitego kosztu mediów w milisekundach. Na przykład 100 oznacza 0,1% (0,001 w postaci dziesiętnej).

PartnerRevenueModelMarkupType

Możliwe typy marży w modelu rozliczeniowym partnera.

Wartości w polu enum
PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED Wartość typu nie jest określona lub jest nieznana w tej wersji.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM Oblicz przychody partnera na podstawie stałego CPM.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP

Oblicz przychody partnera na podstawie procentowej dopłaty z kosztu mediów.

PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP Oblicz przychody partnera na podstawie dopłaty procentowej od całkowitego kosztu mediów, która obejmuje wszystkie koszty partnera i koszty danych.

ConversionCountingConfig

Ustawienia określające sposób zliczania konwersji.

Zliczane będą wszystkie konwersje po kliknięciu. W przypadku zliczania konwersji po obejrzeniu można ustawić wartość procentową.

Zapis JSON
{
  "postViewCountPercentageMillis": string,
  "floodlightActivityConfigs": [
    {
      object (TrackingFloodlightActivityConfig)
    }
  ]
}
Pola
postViewCountPercentageMillis

string (int64 format)

Procent konwersji po obejrzeniu do zliczenia w milisekundach (1/1000 procenta). Musi mieścić się w zakresie od 0 do 100 000 włącznie.

Aby np. śledzić 50% konwersji po kliknięciu, ustaw wartość 50 000.

floodlightActivityConfigs[]

object (TrackingFloodlightActivityConfig)

Konfiguracje aktywności Floodlight używane do śledzenia konwersji.

Liczba zliczonych konwersji to suma wszystkich konwersji zliczonych przez wszystkie identyfikatory aktywności Floodlight określone w tym polu.

TrackingFloodlightActivityConfig

Ustawienia, które kontrolują zachowanie pojedynczej konfiguracji aktywności Floodlight.

Zapis JSON
{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}
Pola
floodlightActivityId

string (int64 format)

To pole jest wymagane. Identyfikator aktywności Floodlight.

postClickLookbackWindowDays

integer

To pole jest wymagane. Liczba dni po kliknięciu reklamy, w których może zostać zaliczona konwersja. Wartość musi mieścić się w przedziale od 0 do 90 włącznie.

postViewLookbackWindowDays

integer

To pole jest wymagane. Liczba dni po wyświetleniu reklamy, w których może zostać zaliczona konwersja. Wartość musi mieścić się w przedziale od 0 do 90 włącznie.

LineItemWarningMessage

Komunikaty ostrzegawcze wygenerowane przez element zamówienia. Ostrzeżenia tego typu nie blokują zapisywania elementu zamówienia, ale mogą zablokować jego realizację.

Wartości w polu enum
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED Nie określono lub jest nieznany.
INVALID_FLIGHT_DATES Ten element zamówienia ma nieprawidłowe daty wyświetlania reklam. Element zamówienia nie będzie wyświetlany.
EXPIRED Data zakończenia tego elementu zamówienia już minęła.
PENDING_FLIGHT Realizacja tego elementu zamówienia rozpocznie się w przyszłości.
ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED Wszystkie giełdy obsługiwane przez partnerów są wykluczone przez kierowanie. Element zamówienia nie będzie wyświetlany.
INVALID_INVENTORY_SOURCE Nie masz ustawionego kierowania na żadne aktywne źródło zasobów reklamowych. Element zamówienia nie będzie wyświetlany.
APP_INVENTORY_INVALID_SITE_TARGETING Ustawienia kierowania na aplikacje i adresy URL tego elementu zamówienia nie obejmują żadnych aplikacji mobilnych. Ten typ elementu zamówienia wymaga uwzględnienia aplikacji mobilnych w ustawieniach kierowania na kanał, listę witryn lub aplikacje. Element zamówienia nie będzie wyświetlany.
APP_INVENTORY_INVALID_AUDIENCE_LISTS Ten element zamówienia nie jest kierowany na żadnych użytkowników urządzeń mobilnych. Ten typ elementu zamówienia wymaga kierowania na listę użytkowników obejmującą użytkowników urządzeń mobilnych. Element zamówienia nie będzie wyświetlany.
NO_VALID_CREATIVE Ten element zamówienia nie zawiera żadnej prawidłowej kreacji. Element zamówienia nie będzie wyświetlany.
PARENT_INSERTION_ORDER_PAUSED Zamówienie reklamowe tego elementu zamówienia jest wstrzymane. Element zamówienia nie będzie wyświetlany.
PARENT_INSERTION_ORDER_EXPIRED Zamówienie reklamowe powiązane z tym elementem zamówienia ma datę zakończenia w przeszłości. Element zamówienia nie będzie wyświetlany.
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION

Ten element zamówienia używa ustawienia excludeFirstPartyAudience, które zostało wycofane i zaplanowane do wycofania po 25 marca 2023 roku.

Aby uwzględnić wycofanie pola excludeFirstPartyAudience, przed 25 marca 2023 r. zaktualizuj integrację interfejsu API, aby bezpośrednio wykluczać własne listy odbiorców za pomocą kierowania na odbiorców.

MobileApp

Aplikacja mobilna promowana przez element zamówienia promujący instalacje aplikacji mobilnej.

Zapis JSON
{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}
Pola
appId

string

To pole jest wymagane. Identyfikator aplikacji udostępniany przez sklep na platformie.

Aplikacje na Androida są rozpoznawane na podstawie identyfikatora pakietu używanego w Sklepie Play na Androida (np. com.google.android.gm).

Aplikacje na iOS są identyfikowane na podstawie dziewięciocyfrowego identyfikatora używanego przez sklep Apple App Store, np. 422689480.

platform

enum (Platform)

Tylko dane wyjściowe. Platforma aplikacji.

displayName

string

Tylko dane wyjściowe. Nazwa aplikacji.

publisher

string

Tylko dane wyjściowe. Wydawca aplikacji.

Platforma

Możliwe platformy aplikacji mobilnych.

Wartości w polu enum
PLATFORM_UNSPECIFIED Nie określono platformy.
IOS platformie iOS.
ANDROID Android.

YoutubeAndPartnersSettings

Ustawienia elementów zamówienia typu YouTube i sieć partnerów wideo Google.

Zapis JSON
{
  "biddingStrategy": {
    object (YoutubeAndPartnersBiddingStrategy)
  },
  "viewFrequencyCap": {
    object (FrequencyCap)
  },
  "thirdPartyMeasurementSettings": {
    object (YoutubeAndPartnersThirdPartyMeasurementSettings)
  },
  "inventorySourceSettings": {
    object (YoutubeAndPartnersInventorySourceConfig)
  },
  "contentCategory": enum (YoutubeAndPartnersContentCategory),
  "effectiveContentCategory": enum (YoutubeAndPartnersContentCategory),
  "targetFrequency": {
    object (TargetFrequency)
  },
  "linkedMerchantId": string,
  "relatedVideoIds": [
    string
  ],
  "leadFormId": string,
  "videoAdSequenceSettings": {
    object (VideoAdSequenceSettings)
  }
}
Pola
biddingStrategy

object (YoutubeAndPartnersBiddingStrategy)

To pole jest wymagane. Strategia ustalania stawek w elemencie zamówienia typu YouTube i sieć partnerów wideo Google.

viewFrequencyCap

object (FrequencyCap)

Ustawienia limitu wyświetleń na użytkownika przypisanego do elementu zamówienia.

Aby przypisać ograniczony limit, należy użyć pola maxViews w tym obiekcie ustawień.

thirdPartyMeasurementSettings

object (YoutubeAndPartnersThirdPartyMeasurementSettings)

Opcjonalnie. Ustawienia zewnętrznej usługi pomiarowej elementu zamówienia.

inventorySourceSettings

object (YoutubeAndPartnersInventorySourceConfig)

Ustawienia określające, na jakie zasoby reklamowe YouTube i sieć partnerów wideo Google będzie kierowany element zamówienia.

contentCategory

enum (YoutubeAndPartnersContentCategory)

Rodzaj treści, w których będą wyświetlane reklamy YouTube i sieci partnerów wideo Google.

effectiveContentCategory

enum (YoutubeAndPartnersContentCategory)

Tylko dane wyjściowe. Kategoria treści obowiązująca podczas wyświetlania elementu zamówienia. Jeśli ustawisz kategorię treści zarówno na poziomie elementu zamówienia, jak i reklamodawcy, podczas wyświetlania elementu zamówienia zostanie zastosowana bardziej rygorystyczna kategoria.

targetFrequency

object (TargetFrequency)

Średnia liczba wyświetleń reklam z tego elementu zamówienia tej samej osobie w określonym czasie.

linkedMerchantId

string (int64 format)

Identyfikator sprzedawcy połączonego z elementem zamówienia w pliku danych o produktach.

relatedVideoIds[]

string

Identyfikatory filmów są widoczne pod główną reklamą wideo, która jest odtwarzana w aplikacji YouTube na urządzeniach mobilnych.

leadFormId

string (int64 format)

Identyfikator formularza służącego do pozyskiwania potencjalnych klientów.

videoAdSequenceSettings

object (VideoAdSequenceSettings)

Ustawienia związane z VideoAdSequence.

YoutubeAndPartnersThirdPartyMeasurementSettings

Ustawienia określające, jakie dane dostawców zewnętrznych mierzą określone dane elementu zamówienia.

Zapis JSON
{
  "viewabilityVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandSafetyVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "reachVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandLiftVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ]
}
Pola
viewabilityVendorConfigs[]

object (ThirdPartyVendorConfig)

Dostawcy zewnętrzni do pomiaru widoczności.

Usługa obejmuje tych dostawców zewnętrznych:

  • THIRD_PARTY_VENDOR_MOAT
  • THIRD_PARTY_VENDOR_DOUBLE_VERIFY
  • THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE
  • THIRD_PARTY_VENDOR_COMSCORE
  • THIRD_PARTY_VENDOR_TELEMETRY
  • THIRD_PARTY_VENDOR_MEETRICS
brandSafetyVendorConfigs[]

object (ThirdPartyVendorConfig)

Dostawcy zewnętrzni do pomiaru bezpieczeństwa marki.

Usługa obejmuje tych dostawców zewnętrznych:

  • THIRD_PARTY_VENDOR_ZERF
  • THIRD_PARTY_VENDOR_DOUBLE_VERIFY
  • THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE
reachVendorConfigs[]

object (ThirdPartyVendorConfig)

Zewnętrzni dostawcy narzędzi do pomiaru zasięgu.

Usługa obejmuje tych dostawców zewnętrznych:

  • THIRD_PARTY_VENDOR_NIELSEN
  • THIRD_PARTY_VENDOR_COMSCORE
  • THIRD_PARTY_VENDOR_KANTAR
brandLiftVendorConfigs[]

object (ThirdPartyVendorConfig)

Dostawcy zewnętrzni do pomiaru wyników marki.

Usługa obejmuje tych dostawców zewnętrznych:

  • THIRD_PARTY_VENDOR_DYNATA
  • THIRD_PARTY_VENDOR_KANTAR

ThirdPartyVendorConfig

Ustawienia określające sposób konfigurowania zewnętrznych dostawców usług pomiarowych.

Zapis JSON
{
  "vendor": enum (ThirdPartyVendor),
  "placementId": string
}
Pola
vendor

enum (ThirdPartyVendor)

Zewnętrzny dostawca usług pomiarowych.

placementId

string

Identyfikator używany przez platformę dostawcy zewnętrznego do identyfikowania elementu zamówienia.

ThirdPartyVendor

Dostawcy, którzy oferują zewnętrzne usługi pomiarowe.

Wartości w polu enum
THIRD_PARTY_VENDOR_UNSPECIFIED Nieznany dostawca zewnętrzny.
THIRD_PARTY_VENDOR_MOAT Moat.
THIRD_PARTY_VENDOR_DOUBLE_VERIFY DoubleVerify.
THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE Integral Ad Science.
THIRD_PARTY_VENDOR_COMSCORE Comscore,
THIRD_PARTY_VENDOR_TELEMETRY Dane telemetryczne.
THIRD_PARTY_VENDOR_MEETRICS Meetrics
THIRD_PARTY_VENDOR_ZEFR ZEFR.
THIRD_PARTY_VENDOR_NIELSEN firmy Nielsen.
THIRD_PARTY_VENDOR_KANTAR Kantar
THIRD_PARTY_VENDOR_DYNATA Dynata.

YoutubeAndPartnersInventorySourceConfig

Ustawienia, które określają, na jakie zasoby reklamowe YouTube i jakie zasoby reklamowe w YouTube będą kierowane element zamówienia typu YouTube i sieć partnerów wideo Google.

Zapis JSON
{
  "includeYoutubeSearch": boolean,
  "includeYoutubeVideos": boolean,
  "includeGoogleTv": boolean,
  "includeYoutubeVideoPartners": boolean
}
Pola
includeYoutubeVideos

boolean

Określa, czy kierować reklamy na zasoby kanałów i filmów w YouTube oraz na filmy z YouTube umieszczone na innych stronach.

includeGoogleTv

boolean

Opcjonalnie. Określa, czy ustawić kierowanie na zasoby reklamowe w aplikacjach wideo dostępnych w Google TV.

includeYoutubeVideoPartners

boolean

Określa, czy ustawić kierowanie na zasoby reklamowe w kolekcji witryn i aplikacji partnerów, które przestrzegają tych samych standardów bezpieczeństwa marki co YouTube.

YoutubeAndPartnersContentCategory

Kategorie bezpieczeństwa marki w treściach dostępnych w YouTube i sieci partnerów wideo Google.

Wartości w polu enum
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED Kategoria treści nie jest określona lub jest nieznana w tej wersji.
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD Kategoria obejmująca szeroki zakres treści odpowiednich dla większości marek. treść opiera się na wytycznych YouTube na temat tworzenia filmów odpowiednich do wyświetlania reklam.
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED Kategoria obejmująca wszystkie treści w YouTube i sieci partnerów wideo, która spełnia standardy generowania przychodu.
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED Kategoria obejmująca ograniczony zakres treści, które spełniają podwyższone wymagania, zwłaszcza w zakresie niestosownego języka i podtekstów seksualnych.

TargetFrequency

Ustawienie, które określa średnią liczbę wyświetleń reklamy tej samej osobie w określonym czasie.

Zapis JSON
{
  "targetCount": string,
  "timeUnit": enum (TimeUnit),
  "timeUnitCount": integer
}
Pola
targetCount

string (int64 format)

Docelowa liczba wyświetleń reklam tej samej osobie w okresie określonym przez timeUnit i timeUnitCount.

timeUnit

enum (TimeUnit)

Jednostka czasu, w której zostanie zastosowana docelowa częstotliwość.

Obowiązuje ta jednostka czasu:

  • TIME_UNIT_WEEKS
timeUnitCount

integer

Ostatnia wartość w kolumnie timeUnit docelowej częstotliwości.

W zależności od wartości atrybutu timeUnit obowiązują te ograniczenia:

  • TIME_UNIT_WEEKS – musi wynosić 1

VideoAdSequenceSettings

Ustawienia związane z VideoAdSequence.

Zapis JSON
{
  "minimumDuration": enum (VideoAdSequenceMinimumDuration),
  "steps": [
    {
      object (VideoAdSequenceStep)
    }
  ]
}
Pola
minimumDuration

enum (VideoAdSequenceMinimumDuration)

Minimalny odstęp czasu, po którego upływie ten sam użytkownik zobaczy tę sekwencję ponownie.

steps[]

object (VideoAdSequenceStep)

Kroki, z których składa się sekwencja.

VideoAdSequenceMinimumDuration

Wyliczenie możliwego minimalnego czasu interwału, zanim ten sam użytkownik zobaczy ponownie VideoAdSequence.

Wartości w polu enum
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED Nieokreślone lub nieznane.
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK 7 dni.
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH 30 dni.

VideoAdSequenceStep

Szczegół pojedynczego kroku w elemencie VideoAdSequence.

Zapis JSON
{
  "stepId": string,
  "adGroupId": string,
  "previousStepId": string,
  "interactionType": enum (InteractionType)
}
Pola
stepId

string (int64 format)

Identyfikator kroku.

adGroupId

string (int64 format)

Identyfikator odpowiedniej grupy reklam odpowiadającej danemu krokowi.

previousStepId

string (int64 format)

Identyfikator poprzedniego kroku. Pierwszy krok nie zawiera poprzedniego kroku.

interactionType

enum (InteractionType)

Interakcja z poprzedniego kroku, która doprowadzi widza do tego kroku. Pierwszy krok nie ma przypisanego typu interakcyjności.

InteractionType

Typy interakcji na etapie.

Wartości w polu enum
INTERACTION_TYPE_UNSPECIFIED Nieokreślone lub nieznane
INTERACTION_TYPE_PAID_VIEW Płatne wyświetlenie.
INTERACTION_TYPE_SKIP Pominięte przez widza.
INTERACTION_TYPE_IMPRESSION Obejrzenie reklamy.
INTERACTION_TYPE_ENGAGED_IMPRESSION Wyświetlenie reklamy, które nie zostało od razu pominięte przez użytkownika, ale nie nastąpiło też w związku ze zdarzeniem podlegającym rozliczeniu.

Metody

bulkEditAssignedTargetingOptions

Zbiorcze edytowanie opcji kierowania w wielu elementach zamówienia.

bulkListAssignedTargetingOptions

Wyświetla listę opcji kierowania przypisanych do wielu elementów zamówienia w różnych typach kierowania.

bulkUpdate

Aktualizuje wiele elementów zamówienia.

create

Tworzy nowy element zamówienia.

delete

Usuwa element zamówienia.

duplicate

Powiela element zamówienia.

generateDefault

Tworzy nowy element zamówienia z ustawieniami (w tym kierowaniem) odziedziczonymi z zamówienia reklamowego i entity_status (ENTITY_STATUS_DRAFT).

get

Pobiera element zamówienia.

list

Wyświetla listę elementów zamówienia we właściwościach reklamodawcy.

patch

Aktualizuje istniejący element zamówienia.