REST Resource: inventorySources

Tài nguyên: InventorySource

Nguồn khoảng không quảng cáo.

Biểu diễn dưới dạng 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
  ]
}
Trường
name

string

Chỉ có đầu ra. Tên tài nguyên của nguồn khoảng không quảng cáo.
inventorySourceId

string (int64 format)

Chỉ có đầu ra. Mã nhận dạng duy nhất của nguồn khoảng không quảng cáo. Do hệ thống chỉ định.
displayName

string

Tên hiển thị của nguồn khoảng không quảng cáo.

Phải được mã hoá UTF-8 với kích thước tối đa là 240 byte.
inventorySourceType

enum (InventorySourceType)

Cho biết loại nguồn khoảng không quảng cáo.
inventorySourceProductType

enum (InventorySourceProductType)

Chỉ có đầu ra. Loại sản phẩm của nguồn khoảng không quảng cáo, cho biết cách thức bán khoảng không quảng cáo.
commitment

enum (InventorySourceCommitment)

Liệu nguồn khoảng không quảng cáo có phân phối được đảm bảo hay không được đảm bảo.
deliveryMethod

enum (InventorySourceDeliveryMethod)

Cách phân phối của nguồn khoảng không quảng cáo.

  • Đối với các nguồn khoảng không quảng cáo không bảo đảm, giá trị duy nhất được chấp nhận là INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
  • Đối với các nguồn khoảng không quảng cáo được đảm bảo, các giá trị chấp nhận được là INVENTORY_SOURCE_DELIVERY_METHOD_TAG và INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
dealId

string

Mã nhận dạng trong không gian trao đổi giúp xác định duy nhất nguồn khoảng không quảng cáo.

Phải là duy nhất giữa những người mua trong mỗi trao đổi nhưng không nhất thiết là duy nhất giữa các trao đổi.
status

object (InventorySourceStatus)

Chế độ cài đặt trạng thái của nguồn khoảng không quảng cáo.
exchange

enum (Exchange)

Trao đổi mà nguồn khoảng không quảng cáo thuộc về.
updateTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian khi nguồn khoảng không quảng cáo được cập nhật lần gần đây nhất. Do hệ thống chỉ định.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
rateDetails

object (RateDetails)

Bắt buộc. Chi tiết giá của nguồn khoảng không quảng cáo.
publisherName

string

Tên nhà xuất bản/người bán của nguồn khoảng không quảng cáo.
timeRange

object (TimeRange)

Khoảng thời gian khi nguồn khoảng không quảng cáo này bắt đầu và ngừng phân phát.
creativeConfigs[]

object (CreativeConfig)

Các yêu cầu đối với mẫu quảng cáo của nguồn khoảng không quảng cáo.

Không áp dụng cho các gói đấu giá.
guaranteedOrderId

string

Không thể thay đổi. Mã của đơn đặt hàng được đảm bảo chứa nguồn khoảng không quảng cáo này.

Chỉ áp dụng khi commitment là INVENTORY_SOURCE_COMMITMENT_GUARANTEED.
readWriteAccessors

object (InventorySourceAccessors)

Đối tác hoặc nhà quảng cáo có quyền đọc/ghi đối với nguồn khoảng không quảng cáo.

Chỉ xuất khi commitment là INVENTORY_SOURCE_COMMITMENT_GUARANTEED, trong trường hợp đó, trình truy cập đọc/ghi được kế thừa từ thứ tự được bảo đảm gốc.

Bắt buộc khi commitment là INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED.

Nếu commitment là INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED và đã thiết lập một đối tác trong trường này, thì tất cả các nhà quảng cáo thuộc đối tác này sẽ tự động có quyền chỉ có thể đọc đối với nguồn khoảng không quảng cáo. Những nhà quảng cáo này sẽ không được đưa vào readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Chỉ có đầu ra. Mã nhận dạng của nhà quảng cáo có quyền chỉ có thể đọc đối với nguồn khoảng không quảng cáo.
readPartnerIds[]

string (int64 format)

Chỉ có đầu ra. Mã nhận dạng của các đối tác có quyền truy cập chỉ có thể đọc vào nguồn khoảng không quảng cáo.

Tất cả các nhà quảng cáo của đối tác trong trường này đều kế thừa quyền chỉ có thể đọc vào nguồn khoảng không quảng cáo.

InventorySourceType

Các loại nguồn khoảng không quảng cáo có thể có.

Enum
INVENTORY_SOURCE_TYPE_UNSPECIFIED Loại nguồn khoảng không quảng cáo chưa được chỉ định hoặc không xác định trong phiên bản này.
INVENTORY_SOURCE_TYPE_PRIVATE Nguồn khoảng không quảng cáo riêng tư.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Gói đấu giá.

InventorySourceProductType

Các loại sản phẩm có thể có của nguồn khoảng không quảng cáo.

Enum
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED Loại sản phẩm chưa được chỉ định hoặc không xác định trong phiên bản này. API không hỗ trợ sửa đổi nguồn khoảng không quảng cáo của loại sản phẩm này.
PREFERRED_DEAL Nguồn khoảng không quảng cáo bán khoảng không quảng cáo thông qua Giao dịch ưu tiên.
PRIVATE_AUCTION Nguồn khoảng không quảng cáo bán khoảng không quảng cáo thông qua Phiên đấu giá kín.
PROGRAMMATIC_GUARANTEED Nguồn khoảng không quảng cáo bán khoảng không quảng cáo thông qua giao dịch Đảm bảo có lập trình.
TAG_GUARANTEED Nguồn khoảng không quảng cáo bán khoảng không quảng cáo thông qua giao dịch Đảm bảo bằng thẻ.
YOUTUBE_RESERVE Nguồn khoảng không quảng cáo bán khoảng không quảng cáo thông qua Dành riêng trên YouTube.
INSTANT_RESERVE Nguồn khoảng không quảng cáo bán khoảng không quảng cáo thông qua tính năng Đặt trước nhanh. API không hỗ trợ sửa đổi nguồn khoảng không quảng cáo của loại sản phẩm này.
GUARANTEED_PACKAGE Nguồn khoảng không quảng cáo bán khoảng không quảng cáo thông qua Gói được bảo đảm. API không hỗ trợ sửa đổi nguồn khoảng không quảng cáo của loại sản phẩm này.
PROGRAMMATIC_TV Nguồn khoảng không quảng cáo bán khoảng không quảng cáo thông qua Programmtic TV. API không hỗ trợ sửa đổi nguồn khoảng không quảng cáo của loại sản phẩm này.
AUCTION_PACKAGE Nguồn khoảng không quảng cáo bán khoảng không quảng cáo thông qua Gói đấu giá. API không hỗ trợ sửa đổi nguồn khoảng không quảng cáo của loại sản phẩm này.

InventorySourceCommitment

Các loại cam kết có thể có cho một nguồn khoảng không quảng cáo.

Enum
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED Cam kết chưa được chỉ định hoặc không xác định trong phiên bản này.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED Cam kết đảm bảo giao hàng.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED Cam kết là phân phối không bảo đảm.

InventorySourceDeliveryMethod

Các phương thức phân phối có thể có cho một nguồn khoảng không quảng cáo.

Enum
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED Phương pháp phân phối không được chỉ định hoặc không xác định trong phiên bản này.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC Phương pháp phân phối là có lập trình.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG Phương pháp phân phối là gắn thẻ.

InventorySourceStatus

Các chế độ cài đặt liên quan đến trạng thái của nguồn khoảng không quảng cáo.

Biểu diễn dưới dạng JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "sellerStatus": enum (EntityStatus),
  "sellerPauseReason": string,
  "configStatus": enum (InventorySourceConfigStatus)
}
Trường
entityStatus

enum (EntityStatus)

Nguồn khoảng không quảng cáo có thể phân phát được hay không.

Các giá trị được chấp nhận là ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED và ENTITY_STATUS_PAUSED. Giá trị mặc định là ENTITY_STATUS_ACTIVE.
entityPauseReason

string

Lý do do người dùng cung cấp để tạm dừng nguồn khoảng không quảng cáo này.

Không được vượt quá 100 ký tự.

Chỉ áp dụng khi entityStatus được đặt thành ENTITY_STATUS_PAUSED.
sellerStatus

enum (EntityStatus)

Chỉ có đầu ra. Trạng thái do người bán đặt cho nguồn khoảng không quảng cáo.

Chỉ áp dụng cho nguồn khoảng không quảng cáo được đồng bộ hoá trực tiếp từ nhà xuất bản. Các giá trị được chấp nhận là ENTITY_STATUS_ACTIVE và ENTITY_STATUS_PAUSED.
sellerPauseReason

string

Chỉ có đầu ra. Lý do do người bán đưa ra để tạm dừng nguồn khoảng không quảng cáo này.

Chỉ áp dụng cho nguồn khoảng không quảng cáo được đồng bộ hoá trực tiếp từ nhà xuất bản và khi sellerStatus được đặt thành ENTITY_STATUS_PAUSED.
configStatus

enum (InventorySourceConfigStatus)

Chỉ có đầu ra. Trạng thái cấu hình của nguồn khoảng không quảng cáo.

Chỉ áp dụng cho các nguồn khoảng không quảng cáo được đảm bảo. Các giá trị được chấp nhận là INVENTORY_SOURCE_CONFIG_STATUS_PENDING và INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

Bạn phải định cấu hình nguồn khoảng không quảng cáo (điền vào các trường bắt buộc, chọn mẫu quảng cáo và chọn chiến dịch mặc định) trước khi nguồn khoảng không quảng cáo đó có thể phân phát.

InventorySourceConfigStatus

Các trạng thái cấu hình có thể có cho nguồn khoảng không quảng cáo được đảm bảo.

Enum
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED Trạng thái phê duyệt không được chỉ định hoặc không xác định trong phiên bản này.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING Trạng thái bắt đầu của nguồn khoảng không quảng cáo được đảm bảo. Nguồn khoảng không quảng cáo ở trạng thái này cần được định cấu hình.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED Trạng thái sau khi người mua định cấu hình nguồn khoảng không quảng cáo được đảm bảo.

RateDetails

Chế độ cài đặt liên quan đến giá của nguồn khoảng không quảng cáo.

Biểu diễn dưới dạng JSON 
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
Trường
inventorySourceRateType

enum (InventorySourceRateType)

Loại giá.

Các giá trị được chấp nhận là INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED, INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR và INVENTORY_SOURCE_RATE_TYPE_CPD.
rate

object (Money)

Giá cho nguồn khoảng không quảng cáo.
unitsPurchased

string (int64 format)

Bắt buộc đối với nguồn khoảng không quảng cáo được đảm bảo. Số lượt hiển thị được người bán đảm bảo.
minimumSpend

object (Money)

Chỉ có đầu ra. Số tiền mà người mua đã cam kết chi tiêu cho nguồn khoảng không quảng cáo trước.

Chỉ áp dụng cho các nguồn khoảng không quảng cáo được đảm bảo.

InventorySourceRateType

Các loại giá có thể có cho một nguồn khoảng không quảng cáo.

Enum
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED Loại giá chưa được chỉ định hoặc không xác định trong phiên bản này.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED Loại giá là CPM (Cố định).
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR Loại giá là CPM (Giá sàn).
INVENTORY_SOURCE_RATE_TYPE_CPD Loại giá là Chi phí mỗi ngày.
INVENTORY_SOURCE_RATE_TYPE_FLAT Loại giá là Cố định.

Tiền

Thể hiện số tiền kèm theo loại đơn vị tiền tệ.

Biểu diễn dưới dạng JSON 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Trường
currencyCode

string

Mã đơn vị tiền tệ gồm ba chữ cái được xác định trong ISO 4217.
units

string (int64 format)

Toàn bộ đơn vị của số tiền. Ví dụ: nếu currencyCode là "USD", thì 1 đơn vị là một đô la Mỹ.
nanos

integer

Số đơn vị nano (10^-9) của lượng. Giá trị phải nằm trong khoảng từ -999.999.999 đến +999.999.999. Nếu units là số dương, thì nanos phải là số dương hoặc bằng 0. Nếu units bằng 0, nanos có thể là số dương, 0 hoặc âm. Nếu units là số âm, thì nanos phải là số âm hoặc 0. Ví dụ: $-1,75 được biểu diễn dưới dạng units=-1 và nanos=-750.000.000.

TimeRange

Phạm vi thời gian.

Biểu diễn dưới dạng JSON 
{
  "startTime": string,
  "endTime": string
}
Trường
startTime

string (Timestamp format)

Bắt buộc. Giới hạn dưới của một khoảng thời gian, bao gồm cả hai giá trị này.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Bắt buộc. Giới hạn trên của một khoảng thời gian, bao gồm cả hai giá trị này.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

CreativeConfig

Cấu hình các yêu cầu về mẫu quảng cáo cho nguồn khoảng không quảng cáo.

Biểu diễn dưới dạng 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.
}
Trường
creativeType

enum (CreativeType)

Loại mẫu quảng cáo có thể được chỉ định cho nguồn khoảng không quảng cáo. Chỉ hỗ trợ các loại sau:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Trường hợp creative_config_scheme. Áp dụng khi creative_type là một trong những:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Cấu hình cho các mẫu quảng cáo có thể được chỉ định cho nguồn khoảng không quảng cáo. creative_config_scheme chỉ có thể là một trong những trạng thái sau:
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

Cấu hình cho mẫu quảng cáo hiển thị. Áp dụng khi creativeType là CREATIVE_TYPE_STANDARD.
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

Cấu hình cho mẫu quảng cáo video. Áp dụng khi creativeType là CREATIVE_TYPE_VIDEO.

InventorySourceDisplayCreativeConfig

Cấu hình cho mẫu quảng cáo hiển thị.

Biểu diễn dưới dạng JSON 
{
  "creativeSize": {
    object (Dimensions)
  }
}
Trường
creativeSize

object (Dimensions)

Các yêu cầu về kích thước đối với mẫu quảng cáo hiển thị có thể được chỉ định cho nguồn khoảng không quảng cáo.

InventorySourceVideoCreativeConfig

Cấu hình cho mẫu quảng cáo video.

Biểu diễn dưới dạng JSON 
{
  "duration": string
}
Trường
duration

string (Duration format)

Yêu cầu về thời lượng cho quảng cáo video có thể được chỉ định cho nguồn khoảng không quảng cáo.

Thời lượng tính bằng giây với tối đa 9 chữ số thập phân, kết thúc bằng "s". Ví dụ: "3.5s".

InventorySourceAccessors

Đối tác hoặc các nhà quảng cáo có quyền truy cập vào nguồn khoảng không quảng cáo.

Biểu diễn dưới dạng 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.
}
Trường
Trường hợp accessors. Đối tác hoặc các nhà quảng cáo có quyền truy cập vào nguồn khoảng không quảng cáo. accessors chỉ có thể là một trong những trạng thái sau:
partner

object (PartnerAccessor)

Đối tác có quyền truy cập vào nguồn khoảng không quảng cáo.
advertisers

object (AdvertiserAccessors)

Nhà quảng cáo có quyền truy cập vào nguồn khoảng không quảng cáo. Tất cả các nhà quảng cáo phải thuộc cùng một đối tác.

PartnerAccessor

Đối tác có quyền truy cập vào nguồn khoảng không quảng cáo.

Biểu diễn dưới dạng JSON 
{
  "partnerId": string
}
Trường
partnerId

string (int64 format)

Mã của đối tác.

AdvertiserAccessors

Nhà quảng cáo có quyền truy cập vào nguồn khoảng không quảng cáo.

Biểu diễn dưới dạng JSON 
{
  "advertiserIds": [
    string
  ]
}
Trường
advertiserIds[]

string (int64 format)

Mã nhận dạng của nhà quảng cáo.

Phương thức

create

 Tạo nguồn khoảng không quảng cáo mới.

editInventorySourceReadWriteAccessors

 Chỉnh sửa trình truy cập đọc/ghi của nguồn khoảng không quảng cáo.

get

 Nhận nguồn khoảng không quảng cáo.

list

 Liệt kê các nguồn khoảng không quảng cáo mà người dùng hiện tại có thể truy cập.

patch

 Cập nhật nguồn khoảng không quảng cáo hiện có.