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)

Wskazuje 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 zapewnia wyświetlenia w ramach gwarantowanej czy niegwarantowanej dostawy.
deliveryMethod

enum (InventorySourceDeliveryMethod)

Metoda wyświetlania źródła zasobów reklamowych.

  • W przypadku źródeł niegwarantowanych zasobów reklamowych jedyną akceptowalną wartością jest INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
  • W przypadku źródeł zasobów reklamowych gwarantowanych dopuszczalne 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ć niepowtarzalna w przypadku kupujących na każdej giełdzie, ale nie musi być niepowtarzalna 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 określająca, kiedy źródło zasobów reklamowych zostało ostatnio zaktualizowane. Przypisany przez system.

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
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)

Przedział czasu, w którym to źródło zasobów reklamowych zaczyna i przestaje wyświetlać reklamy.
creativeConfigs[]

object (CreativeConfig)

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

Nie dotyczy pakietów aukcji.
guaranteedOrderId

string

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

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

object (InventorySourceAccessors)

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

Wyjście tylko wtedy, gdy commitment jest INVENTORY_SOURCE_COMMITMENT_GUARANTEED, w którym przypadku akcesory odczytu/zapisu są dziedziczone z nadrzędnej kolejności gwarantowanej.

Wymagane, gdy commitment ma wartość INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED.

Jeśli commitment to INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED, a w tym polu ustawiony jest partner, wszyscy reklamodawcy należący do tego partnera będą automatycznie mieli dostęp tylko do odczytu do źródła zasobów reklamowych. Ci reklamodawcy nie zostaną uwzględnieni w grupie 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 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 W tej wersji nie podano lub nie określono typu źródła zasobów reklamowych.
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 za pomocą interfejsu API nie jest obsługiwane.
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 na 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 gwarancji.
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 za pomocą interfejsu API nie jest obsługiwane.
GUARANTEED_PACKAGE Źródło zasobów reklamowych sprzedaje zasoby reklamowe w ramach pakietu gwarantowanego. Modyfikowanie źródeł zasobów reklamowych tego typu produktu za pomocą interfejsu API nie jest obsługiwane.
PROGRAMMATIC_TV Źródło zasobów reklamowych sprzedaje zasoby reklamowe w ramach automatyzacji w telewizji. Modyfikowanie źródeł zasobów reklamowych tego typu produktu za pomocą interfejsu API nie jest obsługiwane.
AUCTION_PACKAGE Źródło zasobów reklamowych sprzedaje zasoby reklamowe za pomocą pakietu aukcji. Modyfikowanie źródeł zasobów reklamowych tego typu produktu za pomocą interfejsu API nie jest obsługiwane.

InventorySourceCommitment

Możliwe typy zobowiązań w źródle 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 dostawa.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED Zobowiązanie dotyczy niegwarantowanego wyświetlania.

InventorySourceDeliveryMethod

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

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

InventorySourceStatus

Ustawienia stanu ź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 jest dostępne do wyświetlania reklam.

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.

Nie może przekraczać 100 znaków.

Dotyczy tylko sytuacji, 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 tylko źródeł zasobów reklamowych synchronizowanych bezpośrednio z poziomu wydawców. Akceptowane wartości to ENTITY_STATUS_ACTIVE i ENTITY_STATUS_PAUSED.
sellerPauseReason

string

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

Dotyczy tylko źródeł asortymentu synchronizowanych bezpośrednio z wydawcami i gdy sellerStatus jest ustawione 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.

Zanim źródło zasobów reklamowych zacznie wyświetlać reklamy, musi zostać skonfigurowane (musisz 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 nie jest określony lub jest nieznany w tej wersji.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING Początkowy stan źródła zasobów reklamowych gwarantowanych. Źródło zasobów reklamowych w tym stanie wymaga skonfigurowania.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED Stan po skonfigurowaniu przez kupującego źródła zasobów reklamowych z gwarantemowanymi wyświetleniami.

RateDetails

Ustawienia stawek ź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 zasobu reklamowego.
unitsPurchased

string (int64 format)

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

object (Money)

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

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 W tej wersji nie podano lub nie określono typu stawki.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED Typ stawki to CPM (stała).
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łe.

Pieniądze

Reprezentuje kwotę pieniędzy z typu 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łkowita kwota. Jeśli na przykład currencyCode to "USD", to 1 jednostka to 1 dolar amerykański.
nanos

integer

Liczba nano (10^-9) jednostek kwoty. Wartość musi zawierać się w przedziale od -999 999 999 do +999 999 999. Jeśli units jest dodatnia, nanos musi być dodatnia lub równa zero. Jeśli units = 0, nanos może być dodatnia, równa 0 lub ujemna. Jeśli units jest ujemny, nanos musi być ujemny lub równy zero. Na przykład wartość -1,75 USD jest reprezentowana jako units=-1 i nanos=-750 000 000.

TimeRange

Zakres czasowy.

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

string (Timestamp format)

Wymagane. Dolna granica zakresu czasowego, włącznie.

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Wymagane. Górna granica zakresu czasowego, włącznie.

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

CreativeConfig

Konfiguracja wymagań dotyczących kreacji w źródle 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 unii creative_config_scheme. Dotyczy, gdy creative_type jest 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. creative_config_scheme może być tylko jednym z tych elementów:
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

Konfiguracja kreacji displayowych. Dotyczy to sytuacji, gdy creativeType ma wartość CREATIVE_TYPE_STANDARD.
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

Konfiguracja kreacji wideo. Dotyczy to sytuacji, gdy creativeType ma wartość 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 w sekundach z maksymalnie 9 miejscami po przecinku, zakończony literą „s”. Przykład: "3.5s".

InventorySourceAccessors

Partner lub reklamodawcy z dostępem 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 unii accessors. Partner lub reklamodawcy z dostępem do źródła zasobów reklamowych. accessors może być tylko jednym z tych elementów:
partner

object (PartnerAccessor)

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

object (AdvertiserAccessors)

Reklamodawcy z dostępem 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 z dostępem 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 metody dostępu do odczytu/zapisu źródła zasobów reklamowych.

get

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

list

 Wyświetla listę źródeł zasobów reklamowych dostępnych dla bieżącego użytkownika.

patch

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