REST Resource: advertisers.lineItems

Zasób: LineItem

pojedynczy 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)
  },
  "containsEuPoliticalAds": enum (EuPoliticalAdvertisingStatus)
}
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)

Wymagany. Niezmienne. 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. Przypisany przez system.
displayName

string

Wymagany. Wyświetlana nazwa elementu zamówienia.

Musi być zakodowany w formacie UTF-8 i mieć maksymalny rozmiar 240 bajtów.
lineItemType

enum (LineItemType)

Wymagany. Niezmienne. Typ elementu zamówienia.
entityStatus

enum (EntityStatus)

Wymagany. Określa, czy element zamówienia może wykorzystać 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 utworzeniu elementu zamówienia zmień jego stan na ENTITY_STATUS_ACTIVE.
  • Nie można zmienić stanu elementu zamówienia z innego stanu z powrotem na ENTITY_STATUS_DRAFT.
  • Jeśli nadrzędne zamówienie reklamowe elementu zamówienia nie jest aktywne, element zamówienia nie może wykorzystać swojego 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. Przypisany przez system.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
partnerCosts[]

object (PartnerCost)

Koszty partnera powiązane z elementem zamówienia.

Jeśli w metodzie lineItems.create nie ma wartości lub jest ona pusta, nowo utworzony element zamówienia odziedziczy koszty partnera z nadrzędnego zamówienia reklamowego.
flight

object (LineItemFlight)

Wymagany. Godzina rozpoczęcia i zakończenia wyświetlania elementu zamówienia.
budget

object (LineItemBudget)

Wymagany. Ustawienie alokacji budżetu elementu zamówienia.
pacing

object (Pacing)

Wymagany. Ustawienie szybkości wykorzystywania budżetu elementu zamówienia.
frequencyCap

object (FrequencyCap)

Wymagany. Ustawienia limitu wyświetleń elementu zamówienia.

Jeśli przypisujesz limit, musisz użyć pola maxImpressions w tym obiekcie ustawień.
partnerRevenueModel

object (PartnerRevenueModel)

Wymagany. Ustawienie modelu rozliczeniowego partnera w elemencie 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)

Wymagany. Strategia ustalania stawek elementu zamówienia.
integrationDetails

object (IntegrationDetails)

Szczegóły integracji elementu zamówienia.
targetingExpansion

object (TargetingExpansionConfig)

Ustawienia kierowania zoptymalizowanego elementu zamówienia.

Ta konfiguracja ma zastosowanie tylko w przypadku elementów zamówienia typu displayowego, wideo lub audio, które korzystają z automatycznego określania stawek i są kierowane na odpowiednie listy odbiorców.
warningMessages[]

enum (LineItemWarningMessage)

Tylko dane wyjściowe. Komunikaty ostrzegawcze wygenerowane przez element zamówienia. Te ostrzeżenia nie blokują zapisywania elementu zamówienia, ale niektóre z nich mogą uniemożliwić jego wyświetlanie.
mobileApp

object (MobileApp)

Aplikacja mobilna promowana przez element zamówienia.

Ma to zastosowanie tylko wtedy, gdy element 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ć automatycznie wykluczane z kierowania przez element zamówienia. Domyślnie to pole ma wartość false.
youtubeAndPartnersSettings

object (YoutubeAndPartnersSettings)

Tylko dane wyjściowe. Ustawienia dotyczące elementów zamówienia typu YouTube i sieć partnerów wideo Google.
containsEuPoliticalAds

enum (EuPoliticalAdvertisingStatus)

Czy ten element zamówienia będzie wyświetlać reklamy polityczne w Unii Europejskiej.

Jeśli w przypadku reklamodawcy nadrzędnego ustawiono wartość containsEuPoliticalAds, to w tym polu zostanie przypisana wartość DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING, o ile nie określono inaczej.DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING To pole można następnie zaktualizować za pomocą interfejsu, interfejsu API lub plików danych strukturalnych.

LineItemType

Możliwe typy elementu zamówienia.

Typ elementu zamówienia określa, które ustawienia i opcje mają zastosowanie, np. format reklam lub opcje kierowania.

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 kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.
LINE_ITEM_TYPE_DISPLAY_DEFAULT reklamy graficzne, HTML5, natywne lub multimedialne;
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL Wyświetlaj reklamy, które zachęcają do instalowania 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 zwiększają liczbę instalacji aplikacji.
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY

Reklamy displayowe wyświetlane w zasobach reklamowych aplikacji mobilnych.

Elementów zamówienia tego typu i ich 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 aplikacji mobilnych.

Elementów zamówienia tego typu i ich kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.
LINE_ITEM_TYPE_AUDIO_DEFAULT Reklamy audio RTB sprzedawane w różnych środowiskach.
LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP Reklamy Over-The-Top w zamówieniach reklamowych OTT. Ten typ ma zastosowanie tylko do elementów zamówienia z zamówieniem reklamowym typu 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 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 kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE

Reklamy wideo w YouTube, które opowiadają historię w określonej kolejności, wykorzystując różne formaty.

Elementów zamówienia tego typu i ich 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 kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH

Reklamy wideo w YouTube, które są zoptymalizowane pod kątem docierania 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ę tych rodzajów reklam.

Elementów zamówienia tego typu i ich 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 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ądzeniach CTV (do 15 sekund), których nie można pominąć.

Elementów zamówienia tego typu i ich 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ądzeniach 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ę tych rodzajów reklam.

Elementów zamówienia tego typu i ich 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 telewizorach Smart TV. Uwzględniaj tylko format reklam In-Stream.

Elementów zamówienia tego typu i ich 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świetlenie reklam w YouTube określonej liczbie osób w określonym czasie.

Elementów zamówienia tego typu i ich 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 wyświetleń dzięki różnym formatom reklam.

Elementów zamówienia tego typu i ich 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 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 kierowania nie można tworzyć ani aktualizować za pomocą interfejsu API.

LineItemFlight

Ustawienia, które kontrolują okres aktywności elementu zamówienia.

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

enum (LineItemFlightDateType)

Wymagany. Typ dat wyświetlania elementu zamówienia.
dateRange

object (DateRange)

Daty rozpoczęcia i zakończenia okresu wyświetlania elementu zamówienia. Są one rozwiązywane w odniesieniu do strefy czasowej reklamodawcy nadrzędnego.

  • Wymagany, gdy wartość atrybutu flightDateType to LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM. W przeciwnym razie tylko dane wyjściowe.
  • Podczas tworzenia nowego lotu zarówno startDate, jak i endDate muszą przypadać w przyszłości.
  • Istniejący lot z datą startDate w przeszłości ma modyfikowalną wartość endDate, ale niemodyfikowalną wartość startDate.
  • W polu endDate musi występować data startDate lub późniejsza, ale przed rokiem 2037.

LineItemFlightDateType

Możliwe typy dat wyświetlania 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 Okres wyświetlania elementu zamówienia jest dziedziczony z 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)

Wymagany. Typ przydziału budżetu.

LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC ma zastosowanie tylko wtedy, gdy w przypadku nadrzędnego zamówienia reklamowego włączone jest automatyczne przydzielanie budżetu.
budgetUnit

enum (BudgetUnit)

Tylko dane wyjściowe. Jednostka budżetu określa, czy budżet jest oparty na walucie, czy na wyświetleniach. Ta wartość jest dziedziczona z nadrzędnego zlecenia wstawiania.
maxAmount

string (int64 format)

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

Gdy budgetAllocationType ma wartość:

  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC to pole jest niezmienne i jest ustawiane przez system.
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED, jeśli budgetUnit to:
    • BUDGET_UNIT_CURRENCY, to pole zawiera maksymalną kwotę budżetu do wydania w mikrojednostkach waluty reklamodawcy. Na przykład 1500000 oznacza 1, 5 jednostki waluty.
    • BUDGET_UNIT_IMPRESSIONS: to pole określa 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 alokacji 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 Dla elementu zamówienia włączone jest automatyczne przydzielanie budżetu.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED Do elementu zamówienia jest przypisana stała maksymalna kwota budżetu.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED Do elementu zamówienia nie jest stosowany 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)

Wymagany. Typ marży modelu rozliczeniowego partnera.
markupAmount

string (int64 format)

Wymagany. Kwota marży modelu rozliczeniowego partnera. Musi być równa lub większa niż 0.

  • Gdy markupType ma wartość PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM, to pole zawiera marżę CPM w mikro jednostkach waluty reklamodawcy. Na przykład 1500000 oznacza 1, 5 jednostki waluty.
  • Gdy markupType ma wartość PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP, to pole przedstawia procentową marżę od kosztu mediów w milisekundach. Na przykład 100 oznacza 0,1% (w postaci dziesiętnej 0,001).
  • Gdy wartość markupType jest ustawiona na PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP, to pole przedstawia całkowitą marżę procentową od kosztu mediów w milisekundach. Na przykład 100 oznacza 0,1% (w postaci dziesiętnej 0,001).

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 Obliczanie przychodów partnera na podstawie stałego CPM.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP

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

ConversionCountingConfig

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

Będą zliczane wszystkie konwersje po kliknięciu. W przypadku zliczania konwersji po wyświetleniu można ustawić wartość procentową.

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

string (int64 format)

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

Jeśli na przykład chcesz śledzić 50% konwersji po kliknięciu, ustaw wartość 50000.
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.

Nie można zaktualizować tego pola, jeśli do elementu zamówienia jest przypisany algorytm ustalania stawek niestandardowych. Jeśli w tym samym żądaniu ustawisz to pole i przypiszesz algorytm określania stawek niestandardowych, aktywności Floodlight muszą być zgodne z aktywnościami używanymi przez ten algorytm.

TrackingFloodlightActivityConfig

Ustawienia, które kontrolują działanie pojedynczej konfiguracji aktywności Floodlight.

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

string (int64 format)

Wymagany. Identyfikator aktywności Floodlight.
postClickLookbackWindowDays

integer

Wymagany. Liczba dni po kliknięciu reklamy, w których może zostać zarejestrowana konwersja. Musi mieścić się w zakresie od 0 do 90 włącznie.
postViewLookbackWindowDays

integer

Wymagany. Liczba dni po wyświetleniu reklamy, w których może zostać zarejestrowana konwersja. Musi mieścić się w zakresie od 0 do 90 włącznie.

LineItemWarningMessage

Komunikaty ostrzegawcze wygenerowane przez element zamówienia. Te typy ostrzeżeń nie blokują zapisywania elementu zamówienia, ale mogą uniemożliwiać jego wyświetlanie.

Wartości w polu enum
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED Nieokreślony lub 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 jest w przeszłości.
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. Typ tego elementu zamówienia wymaga uwzględnienia aplikacji mobilnych w ustawieniach kanału, listy witryn lub kierowania na 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. Typ tego elementu zamówienia wymaga kierowania na listę użytkowników urządzeń mobilnych. Element zamówienia nie będzie wyświetlany.
NO_VALID_CREATIVE Ten element zamówienia nie zawiera żadnych prawidłowych 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 tego elementu zamówienia ma datę zakończenia w przeszłości. Element zamówienia nie będzie wyświetlany.

MobileApp

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

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

string

Wymagany. Identyfikator aplikacji podany przez sklep platformy.

Aplikacje na Androida są identyfikowane za pomocą identyfikatora pakietu używanego w Sklepie Play na Androida, np. com.google.android.gm.

Aplikacje na iOS są identyfikowane za pomocą 9-cyfrowego identyfikatora aplikacji 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 platformy iOS.
ANDROID platforma Androida,

YoutubeAndPartnersSettings

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

Zapis JSON 
{
  "viewFrequencyCap": {
    object (FrequencyCap)
  },
  "thirdPartyMeasurementConfigs": {
    object (ThirdPartyMeasurementConfigs)
  },
  "inventorySourceSettings": {
    object (YoutubeAndPartnersInventorySourceConfig)
  },
  "contentCategory": enum (YoutubeAndPartnersContentCategory),
  "effectiveContentCategory": enum (YoutubeAndPartnersContentCategory),
  "targetFrequency": {
    object (TargetFrequency)
  },
  "linkedMerchantId": string,
  "relatedVideoIds": [
    string
  ],
  "leadFormId": string,
  "videoAdSequenceSettings": {
    object (VideoAdSequenceSettings)
  },
  "videoAdInventoryControl": {
    object (VideoAdInventoryControl)
  }
}
Pola
viewFrequencyCap

object (FrequencyCap)

Wyświetl ustawienia limitu wyświetleń na użytkownika w elemencie zamówienia.

Jeśli przypisujesz limit, musisz użyć pola maxViews w tym obiekcie ustawień.
thirdPartyMeasurementConfigs

object (ThirdPartyMeasurementConfigs)

Opcjonalnie. Konfiguracje zewnętrznych usług pomiarowych elementu zamówienia.
inventorySourceSettings

object (YoutubeAndPartnersInventorySourceConfig)

Ustawienia, które określają, na jakie zasoby reklamowe YouTube i sieci partnerów wideo Google będzie kierowany element zamówienia.
contentCategory

enum (YoutubeAndPartnersContentCategory)

Tylko dane wyjściowe. Rodzaj treści, przy których będą wyświetlane reklamy w YouTube i sieci partnerów.
effectiveContentCategory

enum (YoutubeAndPartnersContentCategory)

Tylko dane wyjściowe. Kategoria treści, która obowiązuje podczas wyświetlania elementu zamówienia. Jeśli kategoria treści jest ustawiona zarówno w elemencie zamówienia, jak i u reklamodawcy, podczas wyświetlania elementu zamówienia będzie obowiązywać bardziej restrykcyjna kategoria.

Nowe elementy zamówienia będą dziedziczyć tylko ustawienia na poziomie reklamodawcy.
targetFrequency

object (TargetFrequency)

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

string (int64 format)

Opcjonalnie. Identyfikator sprzedawcy, który jest połączony z elementem zamówienia w przypadku pliku danych o produktach.
relatedVideoIds[]

string

Opcjonalnie. Identyfikatory filmów wyświetlają się pod główną reklamą wideo, która jest odtwarzana w aplikacji YouTube na urządzeniach mobilnych.
leadFormId

string (int64 format)

Opcjonalnie. Identyfikator formularza, który ma generować potencjalnych klientów.
videoAdSequenceSettings

object (VideoAdSequenceSettings)

Opcjonalnie. Ustawienia związane z VideoAdSequence.
videoAdInventoryControl

object (VideoAdInventoryControl)

Opcjonalnie. Ustawienia określające, które zasoby reklamowe są dozwolone w przypadku tego elementu zamówienia.

ThirdPartyMeasurementConfigs

Ustawienia, które określają, którzy dostawcy zewnętrzni mierzą określone wskaźniki elementu zamówienia.

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

object (ThirdPartyVendorConfig)

Opcjonalnie. Zewnętrzni dostawcy usług pomiaru widoczności.

Dotyczy to 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)

Opcjonalnie. Zewnętrzni dostawcy usług pomiaru bezpieczeństwa marki.

Dotyczy to tych dostawców zewnętrznych:

  • THIRD_PARTY_VENDOR_ZEFR
  • THIRD_PARTY_VENDOR_DOUBLE_VERIFY
  • THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE
reachVendorConfigs[]

object (ThirdPartyVendorConfig)

Opcjonalnie. Zewnętrzni dostawcy usług pomiaru zasięgu.

Dotyczy to tych dostawców zewnętrznych:

  • THIRD_PARTY_VENDOR_NIELSEN
  • THIRD_PARTY_VENDOR_COMSCORE
  • THIRD_PARTY_VENDOR_KANTAR
brandLiftVendorConfigs[]

object (ThirdPartyVendorConfig)

Opcjonalnie. Zewnętrzni dostawcy usług pomiaru wyników marki.

Dotyczy to tych dostawców zewnętrznych:

  • THIRD_PARTY_VENDOR_DYNATA
  • THIRD_PARTY_VENDOR_KANTAR
  • THIRD_PARTY_VENDOR_NIELSEN

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ę zewnętrznego dostawcy do identyfikowania elementu zamówienia.

ThirdPartyVendor

Dostawcy, którzy przeprowadzają pomiary przez firmy zewnętrzne.

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 Nielsen.
THIRD_PARTY_VENDOR_KANTAR Kantar.
THIRD_PARTY_VENDOR_DYNATA Dynata.
THIRD_PARTY_VENDOR_TRANSUNION Transunion.

YoutubeAndPartnersInventorySourceConfig

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

Zapis JSON 
{
  "includeYoutube": boolean,
  "includeGoogleTv": boolean,
  "includeYoutubeVideoPartners": boolean
}
Pola
includeYoutube

boolean

Opcjonalnie. Określa, czy kierować reklamy na zasoby reklamowe w YouTube. Obejmuje to zarówno wyszukiwanie, jak i kanały oraz filmy.
includeGoogleTv

boolean

Opcjonalnie. Określa, czy kierować reklamy na zasoby reklamowe w aplikacjach wideo dostępnych w Google TV.
includeYoutubeVideoPartners

boolean

Określa, czy kierować reklamy na zasoby reklamowe w zbiorze partnerskich witryn i aplikacji przestrzegających tych samych norm bezpieczeństwa marki co YouTube.

YoutubeAndPartnersContentCategory

Kategorie bezpieczeństwa marki w przypadku treści w YouTube i sieci partnerów.

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ści są wybierane na podstawie 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óre spełniają 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 niewłaściwego języka i podtekstów seksualnych.

TargetFrequency

Ustawienie, które określa średnią liczbę wyświetleń reklam 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 parametry timeUnit i timeUnitCount.
timeUnit

enum (TimeUnit)

Jednostka czasu, w której będzie stosowana docelowa częstotliwość.

Obowiązuje ta jednostka czasu:

  • TIME_UNIT_WEEKS
timeUnitCount

integer

Liczba timeUnit, przez którą będzie obowiązywać docelowa częstotliwość.

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

  • TIME_UNIT_WEEKS – musi mieć wartość 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órym ten sam użytkownik ponownie zobaczy tę sekwencję.
steps[]

object (VideoAdSequenceStep)

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

VideoAdSequenceMinimumDuration

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

Wartości w polu enum
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED Nieokreślony lub nieznany.
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK 7 dni.
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH 30 dni.

VideoAdSequenceStep

Szczegóły pojedynczego kroku w obiekcie 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 w kroku.
previousStepId

string (int64 format)

Identyfikator poprzedniego kroku. Pierwszy krok nie ma poprzedniego kroku.
interactionType

enum (InteractionType)

Interakcja w poprzednim kroku, która doprowadzi widza do tego kroku. Pierwszy krok nie ma parametru interactionType.

InteractionType

Typy interakcji w kroku.

Wartości w polu enum
INTERACTION_TYPE_UNSPECIFIED Nieokreślone lub nieznane
INTERACTION_TYPE_PAID_VIEW Wyświetlenie płatne.
INTERACTION_TYPE_SKIP Pominięcie przez widza.
INTERACTION_TYPE_IMPRESSION Wyświetlenie reklamy (obejrzanej).
INTERACTION_TYPE_ENGAGED_IMPRESSION Wyświetlenie reklamy, które nie zostało od razu pominięte przez widza, ale nie osiągnęło też zdarzenia naliczanego do rachunku.

VideoAdInventoryControl

Kontrola zasobów reklamowych w reklamach wideo używana w przypadku niektórych typów elementów zamówienia YouTube.

Zapis JSON 
{
  "allowInStream": boolean,
  "allowInFeed": boolean,
  "allowShorts": boolean
}
Pola
allowInStream

boolean

Opcjonalnie. Określa, czy reklamy mogą się wyświetlać w formacie In-Stream.
allowInFeed

boolean

Opcjonalnie. Określa, czy reklamy mogą się wyświetlać w formacie In-Feed.
allowShorts

boolean

Opcjonalnie. Określa, czy reklamy mogą wyświetlać się w formacie Shorts.

Metody

bulkEditAssignedTargetingOptions

 Zbiorcze edytowanie opcji kierowania w wielu elementach zamówienia.

bulkListAssignedTargetingOptions

 Wyświetla przypisane opcje kierowania w przypadku 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

 Duplikuje element zamówienia.

generateDefault

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

get

 Pobiera element zamówienia.

list

 Wyświetla listę elementów zamówienia reklamodawcy.

patch

 Aktualizuje dotychczasowy element zamówienia.