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)

Metoda wyświetlania ź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ć niepowtarzalny wśród kupujących na każdej giełdzie, ale niekoniecznie na wszystkich giełdach.
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 zaczyna i kończy wyświetlanie reklam.
creativeConfigs[]

object (CreativeConfig)

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

Nie dotyczy pakietów aukcji.
guaranteedOrderId

string

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

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

object (InventorySourceAccessors)

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

Dane wyjściowe tylko wtedy, gdy commitment ma wartość INVENTORY_SOURCE_COMMITMENT_GUARANTEED. W takim przypadku elementy do odczytu i zapisu są dziedziczone z gwarantowanej kolejności elementów nadrzędnych.

Wymagany, gdy wartość atrybutu commitment to INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED.

Jeśli commitment ma wartość 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 do źródła zasobów reklamowych tylko do odczytu. Ci reklamodawcy nie będą uwzględniani w readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

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

string (int64 format)

Tylko dane wyjściowe. Identyfikatory partnerów z dostępem 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ł zasobów reklamowych 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 za pomocą automatyzacji gwarantowanej.
TAG_GUARANTEED Źródło zasobów reklamowych sprzedaje zasoby reklamowe za pomocą umowy gwarancji tagu.
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 za pomocą Szybkiej rezerwacji. Modyfikowanie źródeł zasobów reklamowych 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ł zasobów reklamowych tego typu produktu nie jest obsługiwane przez interfejs API.
PROGRAMMATIC_TV Źródło zasobów reklamowych sprzedaje zasoby reklamowe w ramach automatyzacji telewizji. Modyfikowanie źródeł zasobów reklamowych 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ł zasobów reklamowych 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 gwarantowana liczba wyświetleń.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED Zobowiązanie to niegwarantowane wyświetlenia.

InventorySourceDeliveryMethod

Możliwe metody wyświetlania źródła zasobów reklamowych.

Wartości w polu enum
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED W tej wersji nie określono metody dostawy lub jest ona 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 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. Przyczyna wstrzymania tego źródła zasobów reklamowych podana przez sprzedawcę.

Dotyczy tylko źródeł asortymentu zsynchronizowanych bezpośrednio z wydawcami i gdy parametr sellerStatus jest ustawiony na ENTITY_STATUS_PAUSED.
configStatus

enum (InventorySourceConfigStatus)

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

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

Aby źródło zasobów reklamowych mogło wyświetlać reklamy, musisz je skonfigurować (wypełnić wymagane pola, wybrać kreacje i wybrać 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 w tej wersji nie jest określony lub jest nieznany.
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 stawki ź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 źródeł gwarantowanych 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 gwarantowanych źródeł 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 (minimalna).
INVENTORY_SOURCE_RATE_TYPE_CPD Typ stawki to Koszt dzienny.
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)

Całe jednostki 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 mieścić się w przedziale od -999 999 999 do +999 999 999 (włącznie). Jeśli wartość units jest dodatnia, wartość nanos musi być dodatnia lub wynosić zero. Jeśli units wynosi zero, nanos może być dodatnia, ujemna lub wynosić zero. Jeśli wartość units jest ujemna, wartość nanos musi być ujemna lub równa zero. Na przykład wartość $-1,75 jest przedstawiana jako units=-1 i nanos=-750 000 000.

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),

  // Union field creative_config_scheme can be only one of the following:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of list of possible types for union field creative_config_scheme.
}
Pola
creativeType

enum (CreativeType)

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

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Pole zbiorcze creative_config_scheme. Ma zastosowanie, 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. Pole creative_config_scheme może mieć tylko jedną z tych wartości:
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

Konfiguracja kreacji displayowych. Ma zastosowanie, gdy wartość parametru creativeType to CREATIVE_TYPE_STANDARD.
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

Konfiguracja kreacji wideo. Ma zastosowanie, gdy wartość parametru creativeType to CREATIVE_TYPE_VIDEO.

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 
{

  // Union field accessors can be only one of the following:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of list of possible types for union field accessors.
}
Pola
Pole zbiorcze accessors. Partnerzy lub reklamodawcy, którzy mają dostęp do źródła zasobów reklamowych. accessors może mieć tylko jedną z tych wartości:
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.

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 źródle zasobów reklamowych.

get

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

list

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

patch

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