REST Resource: inventorySources

Tài nguyên: InventorySource

Một 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 nguồn đó bán khoảng không quảng cáo.
commitment

enum (InventorySourceCommitment)

Nguồn khoảng không quảng cáo có chế độ phân phối được đảm bảo hay không được đảm bảo.
deliveryMethod

enum (InventorySourceDeliveryMethod)

Phương thức 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 được đảm bảo, 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, giá trị được chấp nhận là INVENTORY_SOURCE_DELIVERY_METHOD_TAG và INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
dealId

string

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

Phải là giá trị riêng biệt giữa các bên mua trong mỗi sàn giao dịch nhưng không nhất thiết phải là giá trị riêng biệt giữa các sàn giao dịch.
status

object (InventorySourceStatus)

Chế độ cài đặt trạng thái của nguồn kho hàng.
exchange

enum (Exchange)

Sàn giao dịch 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 cho biết lần cập nhật gần đây nhất của nguồn dữ liệu kho hàng. Do hệ thống chỉ định.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
rateDetails

object (RateDetails)

Bắt buộc. Thông tin chi tiết về giá của nguồn kho hàng.
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 mà 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)

Yêu cầu về mẫu quảng cáo của nguồn khoảng không quảng cáo.

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

string

Không thể thay đổi. Mã nhận dạng của đơn đặt hàng được đảm bảo mà nguồn khoảng không quảng cáo này thuộc về.

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 đó, các đối tượng truy cập đọc/ghi sẽ được kế thừa từ thứ tự được đảm bảo của đối tượng mẹ.

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

Nếu commitment là INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED và một đối tác được đặt trong trường này, thì tất cả nhà quảng cáo thuộc đối tác này sẽ tự động có quyền truy cập chỉ đọc vào 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ững nhà quảng cáo chỉ có quyền đọ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 những đối tác có quyền truy cập chỉ đọc vào nguồn khoảng không quảng cáo.

Tất cả nhà quảng cáo của đối tác trong trường này đều được kế thừa quyền truy cập chỉ đọ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 không đượ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 một nguồn khoảng không quảng cáo.

Enum
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED Loại sản phẩm không được chỉ định hoặc không xác định trong phiên bản này. API không hỗ trợ việc sửa đổi nguồn kho hàng 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 Tag Guaranteed.
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 YouTube Reserve.
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ợ việc sửa đổi nguồn kho hàng 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 đảm bảo. API không hỗ trợ việc sửa đổi nguồn kho hàng 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 TV có lập trình. API không hỗ trợ việc sửa đổi nguồn kho hàng 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ợ việc sửa đổi nguồn kho hàng 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 không được chỉ định hoặc không xác định trong phiên bản này.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED Cam kết này là đảm bảo giao hàng.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED Cam kết này không đảm bảo việc phân phối.

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 thức giao hàng 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 thức phân phối là có lập trình.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG Phương thức phân phối là 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ó 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 bạn đặt entityStatus 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 các nguồn khoảng không quảng cáo được đồng bộ hoá trực tiếp từ nhà xuất bản. Giá trị có thể 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 cung cấp để tạm dừng nguồn khoảng không quảng cáo này.

Chỉ áp dụng cho những 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 hàng.

Chỉ áp dụng cho các nguồn khoảng không quảng cáo được đảm bảo. Giá trị có thể 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 một 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 một chiến dịch mặc định) trước khi nguồn đó có thể phân phát.

InventorySourceConfigStatus

Các trạng thái cấu hình có thể có cho một 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 ban đầu của một nguồn khoảng không quảng cáo được đảm bảo. Bạn cần định cấu hình nguồn khoảng không quảng cáo ở trạng thái này.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED Trạng thái sau khi người mua định cấu hình một nguồn khoảng không quảng cáo được đảm bảo.

RateDetails

Các chế độ cài đặt liên quan đến mức 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)

Tỷ lệ của nguồn khoảng không quảng cáo.
unitsPurchased

string (int64 format)

Bắt buộc đối với các nguồn khoảng không quảng cáo được đảm bảo. Số lượt hiển thị mà 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 trước cho 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.

InventorySourceRateType

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

Enum
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED Bạn chưa chỉ định hoặc không xác định được loại giá 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 tỷ lệ là Chi phí mỗi ngày.
INVENTORY_SOURCE_RATE_TYPE_FLAT Loại tỷ lệ là Cố định.

Tiền

Biểu thị một số tiền cùng với 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 3 chữ cái được xác định trong ISO 4217.
units

string (int64 format)

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

integer

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

TimeRange

Một 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 phạm vi thời gian (bao gồm cả giá trị này).

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Bắt buộc. Giới hạn trên của một phạm vi thời gian (bao gồm cả giá trị này).

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

CreativeConfig

Cấu hình 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ỉ những loại sau đây được hỗ trợ:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Trường nhóm creative_config_scheme. Áp dụng khi creative_type là một trong những giá trị sau:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Cấu hình cho những 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 dạng 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 dạng video.

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

string (Duration format)

Các yêu cầu về thời lượng đối với mẫu quảng cáo dạng 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, có 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 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 nhóm accessors. Đối tác hoặ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ững 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ả 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ã nhận dạng của đối tác.

AdvertiserAccessors

Những 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 một nguồn khoảng không quảng cáo mới.

editInventorySourceReadWriteAccessors

 Chỉnh sửa các đối tượng hỗ trợ đọc/ghi của một nguồn khoảng không quảng cáo.

get

 Lấy một nguồn khoảng không quảng cáo.

list

 Liệt kê những 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 một nguồn kho hàng hiện có.