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. Przypisana przez system.
displayName

string

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

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

enum (InventorySourceType)

Wskazuje typ źródła zasobów reklamowych.
inventorySourceProductType

enum (InventorySourceProductType)

Tylko dane wyjściowe. Typ produktu ze źródła zasobów reklamowych, określający sposób sprzedaży zasobów reklamowych.
commitment

enum (InventorySourceCommitment)

Wskazuje, czy źródło zasobów reklamowych ma gwarantowane czy niegwarantowane wyświetlanie.
deliveryMethod

enum (InventorySourceDeliveryMethod)

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

  • W przypadku niegwarantowanych źródeł zasobów reklamowych jedyną akceptowaną 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

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

Muszą być unikalne dla wszystkich kupujących w obrębie poszczególnych giełd, ale nie zawsze muszą być unikalne 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. 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".
rateDetails

object (RateDetails)

To pole jest wymagane. Szczegółowe informacje o stawce źródła zasobów reklamowych.
publisherName

string

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

object (TimeRange)

Zakres czasowy, w którym to źródło zasobów reklamowych ma zacząć i przestać wyświetlać reklamy.
creativeConfigs[]

object (CreativeConfig)

Wymagania dotyczące kreacji związane ze źródłem zasobów reklamowych.

Nie dotyczy pakietów aukcji.
guaranteedOrderId

string

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

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

object (InventorySourceAccessors)

Partner lub reklamodawcy z uprawnieniami do odczytu i zapisu w źródle zasobów reklamowych.

Dane wyjściowe są generowane tylko wtedy, gdy commitment ma wartość INVENTORY_SOURCE_COMMITMENT_GUARANTEED. W takim przypadku akcesory do odczytu i zapisu są dziedziczone z nadrzędnej kolejności gwarantowanej.

Wymagane, gdy commitment ma wartość INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED.

Jeśli commitment ma wartość INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED, a w tym polu jest określony partner, wszyscy reklamodawcy należący do tego partnera automatycznie uzyskają dostęp do źródła zasobów reklamowych tylko do odczytu. Ci reklamodawcy nie zostaną uwzględnieni w kampanii 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 partnerzy 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 w tej wersji nieznany.
INVENTORY_SOURCE_TYPE_PRIVATE Źródło prywatnych zasobów reklamowych.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Pakiet aukcji.

InventorySourceProductType

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

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

InventorySourceCommitment

Możliwe typy zobowiązań dla ź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 jest gwarantowane.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED Zobowiązanie nie jest gwarantowane.

InventorySourceDeliveryMethod

Możliwe metody wyświetlania w przypadku źródła 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 jest zautomatyzowana.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG Metoda wyświetlania to tag.

InventorySourceStatus

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

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

enum (EntityStatus)

Wskazuje, czy źródło zasobów reklamowych może być wyświetlane.

Akceptowane wartości to ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED i ENTITY_STATUS_PAUSED. Wartość domyślna to 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.

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

enum (EntityStatus)

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

Dotyczy tylko źródeł zasobów reklamowych synchronizowanych bezpośrednio od wydawców. 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ł zasobów reklamowych zsynchronizowanych bezpośrednio z wydawcami i gdy sellerStatus ma wartość 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 się wyświetlać, musisz je skonfigurować (wypełnij wymagane pola, wybierz kreacje i wybierz kampanię domyślną).

InventorySourceConfigStatus

Możliwe stany konfiguracji gwarantowanych źródeł zasobów reklamowych.

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

RateDetails

Ustawienia źródła zasobów reklamowych związane z ceną.

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 dla źródła zasobów reklamowych.
unitsPurchased

string (int64 format)

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

object (Money)

Tylko dane wyjściowe. Kwota, którą kupujący zobowiązał się do wydania 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 w tej wersji nieznany.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED Typ stawki to CPM (stała).
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_FLAT Typ stawki to Płaska.

Pieniądze

Reprezentuje kwotę pieniędzy z typem waluty.

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

string

Trzyliterowy kod waluty zgodny z normą ISO 4217.
units

string (int64 format)

Całkowite jednostki kwoty. Jeśli np. currencyCode to "USD", to 1 jednostka to 1 dolar amerykański.
nanos

integer

Liczba nano (10^-9) jednostek danej ilości. Wartość musi mieścić się w przedziale od -999 999 999 do +999 999 999 włącznie. Jeśli units jest liczbą dodatnią, nanos musi być liczbą dodatnią lub zerową. Jeśli units wynosi 0, nanos może być liczbą dodatnią, 0 lub ujemną. Jeśli units jest ujemny, nanos musi być ujemny lub wynosić zero. Na przykład wartość -1,75 USD jest obliczana jako units=-1 i nanos=-750 000 000.

TimeRange

Zakres czasowy.

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

string (Timestamp format)

To pole jest wymagane. Dolna granica zakresu czasowego włącznie.

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

string (Timestamp format)

To pole jest wymagane. Górna granica zakresu czasowego włącznie.

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

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 sumy creative_config_scheme. Ma zastosowanie, gdy creative_type należy do:

  • 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 jedną z tych wartości:
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

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

object (InventorySourceVideoCreativeConfig)

Konfiguracja kreacji wideo. Ma zastosowanie, 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 trwania w sekundach z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „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 sumy accessors. Partner lub reklamodawcy z dostępem do źródła zasobów reklamowych. accessors może być tylko jedną z tych wartości:
partner

object (PartnerAccessor)

Partner z dostępem 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 z dostępem 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

 Umożliwia edytowanie akcesorów do odczytu i zapisu w przypadku źródła zasobów reklamowych.

get

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

list

 Zawiera listę źródeł zasobów reklamowych, które są dostępne dla bieżącego użytkownika.

patch

 Aktualizuje istniejące źródło zasobów reklamowych.