REST Resource: inventorySources

Zasób: InventorySource

Źródło zasobów reklamowych.

Zapis JSON 
{
  "name": string,
  "inventorySourceId": string,
  "displayName": string,
  "inventorySourceType": enum (InventorySourceType),
  "inventorySourceProductType": enum (InventorySourceProductType),
  "commitment": enum (InventorySourceCommitment),
  "deliveryMethod": enum (InventorySourceDeliveryMethod),
  "dealId": string,
  "status": {
    object (InventorySourceStatus)
  },
  "exchange": enum (Exchange),
  "updateTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "publisherName": string,
  "timeRange": {
    object (TimeRange)
  },
  "creativeConfigs": [
    {
      object (CreativeConfig)
    }
  ],
  "guaranteedOrderId": string,
  "readWriteAccessors": {
    object (InventorySourceAccessors)
  },
  "readAdvertiserIds": [
    string
  ],
  "readPartnerIds": [
    string
  ]
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu źródła zasobów reklamowych.
inventorySourceId

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator źródła zasobów reklamowych. Przypisany przez system.
displayName

string

Wyświetlana nazwa źródła zasobów reklamowych.

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

enum (InventorySourceType)

Określa typ źródła zasobów reklamowych.
inventorySourceProductType

enum (InventorySourceProductType)

Tylko dane wyjściowe. Typ produktu źródła zasobów reklamowych, który określa sposób sprzedaży zasobów reklamowych.
commitment

enum (InventorySourceCommitment)

Czy źródło zasobów reklamowych ma gwarantowaną czy niegwarantowaną realizację.
deliveryMethod

enum (InventorySourceDeliveryMethod)

Sposób dostarczania źródła zasobów reklamowych.

  • W przypadku źródeł niegwarantowanych zasobów reklamowych jedyną dopuszczalną wartością jest INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
  • W przypadku gwarantowanych źródeł zasobów reklamowych akceptowane wartości to INVENTORY_SOURCE_DELIVERY_METHOD_TAG i INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
dealId

string

Identyfikator w przestrzeni giełdy, który jednoznacznie identyfikuje źródło zasobów reklamowych.

Musi być unikalny dla kupujących w ramach każdej giełdy, ale niekoniecznie unikalny w ramach różnych giełd.
status

object (InventorySourceStatus)

Ustawienia stanu źródła zasobów reklamowych.
exchange

enum (Exchange)

Giełda, do której należy źródło zasobów reklamowych.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji źródła zasobów reklamowych. 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".
rateDetails

object (RateDetails)

Wymagane. Szczegóły stawek źródła zasobów reklamowych.
publisherName

string

Nazwa wydawcy lub sprzedawcy źródła zasobów reklamowych.
timeRange

object (TimeRange)

Zakres czasu, w którym to źródło zasobów reklamowych rozpoczyna i kończy wyświetlanie reklam.
creativeConfigs[]

object (CreativeConfig)

Wymagania dotyczące kreacji w źródle zasobów reklamowych.

Nie dotyczy pakietów aukcyjnych.
guaranteedOrderId

string

Niezmienne. Identyfikator zamówienia gwarantowanego, do którego należy to źródło zasobów reklamowych.

Ma zastosowanie tylko wtedy, gdy wartość parametru commitment to INVENTORY_SOURCE_COMMITMENT_GUARANTEED.
readWriteAccessors

object (InventorySourceAccessors)

Partnerzy lub reklamodawcy, którzy mają uprawnienia do odczytu i zapisu w przypadku źródła zasobów reklamowych.

Dane wyjściowe tylko wtedy, gdy commitment ma wartość INVENTORY_SOURCE_COMMITMENT_GUARANTEED. W takim przypadku akcesory odczytu/zapisu są dziedziczone z elementu nadrzędnego w gwarantowanej kolejności.

Wymagane, gdy wartość parametru commitment to INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED.

Jeśli wartość commitment to INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED, a w tym polu jest ustawiony partner, wszyscy reklamodawcy należący do tego partnera będą automatycznie mieć dostęp tylko do odczytu do źródła zasobów reklamowych. Tacy reklamodawcy nie będą uwzględniani w readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Tylko dane wyjściowe. Identyfikatory reklamodawców z dostępem tylko do odczytu do źródła zasobów reklamowych.
readPartnerIds[]

string (int64 format)

Tylko dane wyjściowe. Identyfikatory partnerów, którzy mają dostęp tylko do odczytu do źródła zasobów reklamowych.

Wszyscy reklamodawcy partnerów w tym polu dziedziczą dostęp tylko do odczytu do źródła zasobów reklamowych.

InventorySourceType

Możliwe typy źródeł zasobów reklamowych.

Wartości w polu enum
INVENTORY_SOURCE_TYPE_UNSPECIFIED Typ źródła zasobów reklamowych nie jest określony lub jest nieznany w tej wersji.
INVENTORY_SOURCE_TYPE_PRIVATE Prywatne źródło zasobów reklamowych.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Pakiet aukcji.

InventorySourceProductType

Możliwe typy produktów źródła zasobów reklamowych.

Wartości w polu enum
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED Typ produktu nie jest określony lub jest nieznany w tej wersji. Modyfikowanie źródeł asortymentu tego typu produktu nie jest obsługiwane przez interfejs API.
PREFERRED_DEAL Źródło zasobów reklamowych sprzedaje zasoby reklamowe w ramach umowy preferencyjnej.
PRIVATE_AUCTION Źródło zasobów reklamowych sprzedaje zasoby reklamowe w ramach aukcji prywatnej.
PROGRAMMATIC_GUARANTEED Źródło zasobów reklamowych sprzedaje zasoby reklamowe w ramach automatyzacji gwarantowanej.
TAG_GUARANTEED Źródło zasobów reklamowych sprzedaje zasoby reklamowe za pomocą tagu umowy gwarantowanej.
YOUTUBE_RESERVE Źródło zasobów reklamowych sprzedaje zasoby reklamowe za pomocą YouTube Reserve.
INSTANT_RESERVE Źródło zasobów reklamowych sprzedaje zasoby reklamowe w ramach Szybkiej rezerwacji. Modyfikowanie źródeł asortymentu tego typu produktu nie jest obsługiwane przez interfejs API.
GUARANTEED_PACKAGE Źródło zasobów reklamowych sprzedaje zasoby reklamowe za pomocą pakietu gwarantowanego. Modyfikowanie źródeł asortymentu tego typu produktu nie jest obsługiwane przez interfejs API.
PROGRAMMATIC_TV Źródło zasobów reklamowych sprzedaje zasoby reklamowe za pomocą automatyzacji w telewizji. Modyfikowanie źródeł asortymentu tego typu produktu nie jest obsługiwane przez interfejs API.
AUCTION_PACKAGE Źródło zasobów reklamowych sprzedaje zasoby reklamowe za pomocą pakietu aukcji. Modyfikowanie źródeł asortymentu tego typu produktu nie jest obsługiwane przez interfejs API.

InventorySourceCommitment

Możliwe typy zobowiązań dotyczące źródła zasobów reklamowych.

Wartości w polu enum
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED Zobowiązanie nie jest określone lub jest nieznane w tej wersji.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED Zobowiązanie to gwarantowane wyświetlenia.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED Zobowiązanie to niegwarantowane wyświetlenia.

InventorySourceDeliveryMethod

Możliwe metody dostarczania w przypadku źródła zasobów reklamowych.

Wartości w polu enum
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED W tej wersji metoda dostawy nie jest określona lub jest nieznana.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC Metoda wyświetlania to automatyzacja.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG Metoda wyświetlania to tag.

InventorySourceStatus

Ustawienia związane ze stanem źródła zasobów reklamowych.

Zapis JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "sellerStatus": enum (EntityStatus),
  "sellerPauseReason": string,
  "configStatus": enum (InventorySourceConfigStatus)
}
Pola
entityStatus

enum (EntityStatus)

Określa, czy źródło zasobów reklamowych może wyświetlać reklamy.

Akceptowane wartości to ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED i ENTITY_STATUS_PAUSED. Wartością domyślną jest ENTITY_STATUS_ACTIVE.
entityPauseReason

string

Podana przez użytkownika przyczyna wstrzymania tego źródła zasobów reklamowych.

Maksymalna liczba znaków to 100.

Ma zastosowanie tylko wtedy, gdy parametr entityStatus ma wartość ENTITY_STATUS_PAUSED.
sellerStatus

enum (EntityStatus)

Tylko dane wyjściowe. Stan ustawiony przez sprzedawcę dla źródła zasobów reklamowych.

Dotyczy to tylko źródeł zasobów reklamowych zsynchronizowanych bezpośrednio z wydawcami. Akceptowane wartości to ENTITY_STATUS_ACTIVE i ENTITY_STATUS_PAUSED.
sellerPauseReason

string

Tylko dane wyjściowe. Podana przez sprzedawcę przyczyna wstrzymania tego źródła zasobów reklamowych.

Dotyczy tylko źródeł asortymentu zsynchronizowanych bezpośrednio z wydawcami i gdy parametr sellerStatus ma wartość ENTITY_STATUS_PAUSED.
configStatus

enum (InventorySourceConfigStatus)

Tylko dane wyjściowe. Stan konfiguracji źródła zasobów reklamowych.

Dotyczy tylko źródeł gwarantowanych zasobów reklamowych. Akceptowane wartości to INVENTORY_SOURCE_CONFIG_STATUS_PENDING i INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

Zanim źródło zasobów reklamowych będzie mogło wyświetlać reklamy, musi zostać skonfigurowane (wypełnij wymagane pola, wybierz kreacje i kampanię domyślną).

InventorySourceConfigStatus

Możliwe stany konfiguracji gwarantowanego źródła zasobów reklamowych.

Wartości w polu enum
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED Stan zatwierdzenia nie jest określony lub jest nieznany w tej wersji.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING Początkowy stan źródła gwarantowanych zasobów reklamowych. Źródło zasobów reklamowych w tym stanie wymaga konfiguracji.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED Stan po skonfigurowaniu przez kupującego gwarantowanego źródła zasobów reklamowych.

RateDetails

Ustawienia związane ze stawką źródła zasobów reklamowych.

Zapis JSON 
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
Pola
inventorySourceRateType

enum (InventorySourceRateType)

Typ stawki.

Akceptowane wartości to INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED, INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR i INVENTORY_SOURCE_RATE_TYPE_CPD.
rate

object (Money)

Stawka za źródło zasobów reklamowych.
unitsPurchased

string (int64 format)

Wymagane w przypadku gwarantowanych źródeł zasobów reklamowych. Liczba wyświetleń gwarantowana przez sprzedawcę.
minimumSpend

object (Money)

Tylko dane wyjściowe. Kwota, którą kupujący zobowiązał się z góry wydać na źródło zasobów reklamowych.

Dotyczy tylko źródeł gwarantowanych zasobów reklamowych.

InventorySourceRateType

Możliwe typy stawek dla źródła zasobów reklamowych.

Wartości w polu enum
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED Typ stawki nie jest określony lub jest nieznany w tej wersji.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED Typ stawki to CPM (stały).
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR Typ stawki to CPM (minimalny).
INVENTORY_SOURCE_RATE_TYPE_CPD Typ stawki to Koszt dzienny.
INVENTORY_SOURCE_RATE_TYPE_CPH Typ stawki to koszt za godzinę.
INVENTORY_SOURCE_RATE_TYPE_FLAT Typ stawki to stała.

Pieniądze

Reprezentuje kwotę pieniędzy z określeniem rodzaju waluty.

Zapis JSON 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Pola
currencyCode

string

Trzyliterowy kod waluty zdefiniowany w normie ISO 4217.
units

string (int64 format)

Jednostki całkowite kwoty. Jeśli na przykład currencyCode to "USD", to 1 jednostka to 1 dolar amerykański.
nanos

integer

Liczba jednostek nano (10^-9) kwoty. Wartość musi się mieścić w przedziale od -999 999 999 do +999 999 999 (włącznie). Jeśli units jest liczbą dodatnią, nanos musi być liczbą dodatnią lub zerem. Jeśli units wynosi zero, nanos może być dodatnie, równe zero lub ujemne. Jeśli units jest ujemna, nanos musi być ujemna lub wynosić zero. Na przykład wartość –1,75 PLN jest reprezentowana jako units=-1 i nanos=-750000000.

TimeRange

zakres czasu,

Zapis JSON 
{
  "startTime": string,
  "endTime": string
}
Pola
startTime

string (Timestamp format)

Wymagane. Dolna granica zakresu czasu (włącznie z wartościami granicznymi).

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".
endTime

string (Timestamp format)

Wymagane. Górna granica zakresu czasu (włącznie z wartościami granicznymi).

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".

CreativeConfig

Konfiguracja wymagań dotyczących kreacji dla źródła zasobów reklamowych.

Zapis JSON 
{
  "creativeType": enum (CreativeType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of mutually exclusive fields.
}
Pola
creativeType

enum (CreativeType)

Typ kreacji, którą można przypisać do źródła zasobów reklamowych. Obsługiwane są tylko te typy:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Dotyczy, gdy creative_type ma jedną z tych wartości:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Konfiguracja kreacji, które można przypisać do źródła zasobów reklamowych. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

Konfiguracja kreacji displayowych. Obowiązuje, gdy wartość właściwości creativeType to CREATIVE_TYPE_STANDARD.
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

Konfiguracja kreacji wideo. Obowiązuje, gdy wartość właściwości creativeType to CREATIVE_TYPE_VIDEO.
Koniec pól wykluczających się nawzajem.

InventorySourceDisplayCreativeConfig

Konfiguracja kreacji displayowych.

Zapis JSON 
{
  "creativeSize": {
    object (Dimensions)
  }
}
Pola
creativeSize

object (Dimensions)

Wymagania dotyczące rozmiaru kreacji displayowych, które można przypisać do źródła zasobów reklamowych.

InventorySourceVideoCreativeConfig

Konfiguracja kreacji wideo.

Zapis JSON 
{
  "duration": string
}
Pola
duration

string (Duration format)

Wymagania dotyczące czasu trwania kreacji wideo, które można przypisać do źródła zasobów reklamowych.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".

InventorySourceAccessors

Partnerzy lub reklamodawcy, którzy mają dostęp do źródła zasobów reklamowych.

Zapis JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of mutually exclusive fields.
}
Pola
Partnerzy lub reklamodawcy, którzy mają dostęp do źródła zasobów reklamowych. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
partner

object (PartnerAccessor)

Partner, który ma dostęp do źródła zasobów reklamowych.
advertisers

object (AdvertiserAccessors)

Reklamodawcy, którzy mają dostęp do źródła zasobów reklamowych. Wszyscy reklamodawcy muszą należeć do tego samego partnera.
Koniec pól wykluczających się nawzajem.

PartnerAccessor

Partner, który ma dostęp do źródła zasobów reklamowych.

Zapis JSON 
{
  "partnerId": string
}
Pola
partnerId

string (int64 format)

Identyfikator partnera.

AdvertiserAccessors

Reklamodawcy, którzy mają dostęp do źródła zasobów reklamowych.

Zapis JSON 
{
  "advertiserIds": [
    string
  ]
}
Pola
advertiserIds[]

string (int64 format)

Identyfikatory reklamodawców.

Metody

create

 Tworzy nowe źródło zasobów reklamowych.

editInventorySourceReadWriteAccessors

 Edytuje osoby mające uprawnienia do odczytu i zapisu w przypadku źródła zasobów reklamowych.

get

 Pobiera źródło zasobów reklamowych.

list

 Wyświetla listę źródeł zasobów reklamowych, do których ma dostęp bieżący użytkownik.

patch

 Aktualizuje dotychczasowe źródło zasobów reklamowych.