REST Resource: exchanges.orders.products

리소스: Product

제품

JSON 표현 
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "etag": string
}
필드
name

string

제품의 상대 경로 이름입니다. 서버에서 생성됩니다. 예: 'exchanges/1234/orders/5678/products/abc' 출력 전용입니다.
displayName

string

제품의 표시 이름입니다.

최대 크기가 240바이트인 UTF-8로 인코딩되어야 합니다. 필수 항목입니다.
externalDealId

string

외부 ID입니다. 거래소 시스템의 거래 ID입니다. 영문 기준 최대 100자 허용되는 문자는 영숫자, 밑줄, 대시, 마침표입니다. 모든 제품에서 고유해야 합니다. 필수 항목입니다.
transactionType

enum (TransactionType)

제품 거래 유형입니다. 필수 항목입니다.
pricingType

enum (PricingType)

제품의 가격 유형입니다. 필수 항목입니다.
updateTime
(deprecated)

string (Timestamp format)

제품이 마지막으로 업데이트된 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
startTime

string (Timestamp format)

이 제품이 활성화되는 시간입니다. endTime보다 이전이어야 합니다. 시작 시간은 현재로부터 1년을 초과할 수 없습니다. 필수 항목입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
endTime

string (Timestamp format)

이 제품이 비활성화되는 시간입니다. 현재 2036년 이후일 수 없습니다. 필수 항목입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
rateDetails

object (RateDetails)

요금 세부정보 필수 항목입니다.
creativeConfig[]

object (CreativeConfig)

제품의 광고 소재 요구사항입니다. 예약된 거래 유형 제품에 필요합니다.
makegood
(deprecated)

boolean

제품이 메이크업 제품인지 여부를 나타냅니다.
makegoodDetails
(deprecated)

object (MakegoodDetails)

제품의 광고 보상 세부정보입니다. 제품이 보상인 경우 필수입니다.
creativeSource

enum (CreativeSource)

제품의 광고 소재 소스입니다. 선택사항이며 기본값은 CREATIVE_SOURCE_ADVERTISER입니다. 상품 생성 후에는 변경할 수 없습니다.
mediumType

enum (MediumType)

제품의 미디어 유형입니다. 이전 버전과의 호환성을 위해 지정하지 않으면 기본값은 DIGITAL입니다. 상품 생성 후에는 변경할 수 없습니다.
audienceTargetingConfig

object (AudienceTargetingConfig)

선택사항입니다. 선택된 잠재고객 타겟팅 구성이 거래소의 거래 수준에 적용됩니다.
targetingCriteria

object (TargetingCriteria)

출력 전용입니다. 제품 타겟팅 기준 참조입니다. 즉시 할인 시나리오에만 적용됩니다.
forecastResult

object (ForecastResult)

제품 예측 결과입니다. 타겟팅 기준이 비어 있지 않고 예측이 제공되지 않는 경우 필수입니다. 즉시 할인 시나리오에만 적용됩니다.
errorDetails

object (ErrorDetails)

특정 제품 필드를 업데이트할 수 없는 경우 오류 세부정보를 지정해야 합니다. 타겟팅 기준 때문에 예측 결과를 제공할 수 없거나 제품을 업데이트할 수 없는 경우 필요합니다. 즉시 할인 시나리오에만 적용됩니다.
frequencyCap

object (FrequencyCap)

출력 전용입니다. 구매자가 선택한 최대 게재빈도입니다. 즉시 할인 시나리오에만 적용됩니다.
etag

string

제품을 업데이트할 때 지정해야 하는 etag입니다. etag 필드가 비어 있지 않은 경우 업데이트에만 지정하면 됩니다. 즉시 할인 시나리오에만 적용됩니다.

CreativeConfig

제품의 광고 소재 요구사항 구성입니다.

JSON 표현 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
필드
creativeType

enum (CreativeType)

광고 소재 유형입니다. 필수 항목입니다.
dimensionCreativeConfig

object (DimensionCreativeConfig)

디스플레이 광고 소재의 구성입니다.

이 필드는 네이티브 광고 소재 (CREATIVE_TYPE_NATIVE)에서 지원되지 않습니다.
durationCreativeConfig

object (DurationCreativeConfig)

동영상 광고 소재의 구성입니다.

CreativeType

가능한 광고 소재 유형입니다.

열거형
CREATIVE_TYPE_UNSPECIFIED 광고 소재 유형이 지정되지 않았습니다. 입력값이 잘못되었습니다.
CREATIVE_TYPE_DISPLAY 디스플레이의 광고 소재 유형입니다.
CREATIVE_TYPE_VIDEO 동영상의 광고 소재 유형입니다.
CREATIVE_TYPE_AUDIO 오디오의 광고 소재 유형입니다.
CREATIVE_TYPE_NATIVE 네이티브 광고의 광고 소재 유형입니다.

DimensionCreativeConfig

디스플레이 광고 소재 크기를 픽셀 단위로 표시합니다.

JSON 표현 
{
  "width": integer,
  "height": integer
}
필드
width

integer

디스플레이 광고 소재 너비입니다. 필수 항목입니다.
height

integer

디스플레이 광고 소재 높이입니다. 필수 항목입니다.

DurationCreativeConfig

재생 시간 내 광고 소재의 구성입니다.

JSON 표현 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
필드
duration

string (Duration format)

동영상 광고 소재의 길이(초)입니다. 필수

소수점 아래가 최대 9자리까지이고 's'로 끝나는 초 단위 기간입니다. 예를 들면 "3.5s"입니다.
durationMatchType

enum (DurationMatchType)

기간 일치 기준입니다.
skippableMatchType

enum (SkippableMatchType)

동영상 광고 소재의 건너뛸 수 있는 유형입니다.

DurationMatchType

기간 일치 기준의 가능한 형식입니다.

열거형
DURATION_MATCH_TYPE_UNSPECIFIED 이 버전에서는 재생 시간 일치 기준이 지정되지 않았거나 알 수 없습니다. 입력값이 잘못되었습니다.
DURATION_MATCH_TYPE_EQUAL_TO 광고 소재 재생 시간은 필수 재생 시간과 동일해야 합니다.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO 광고 소재 재생 시간은 필수 재생 시간과 같거나 짧아야 합니다.

SkippableMatchType

제품의 가능한 형식입니다.

열거형
SKIPPABLE_MATCH_TYPE_UNSPECIFIED 이 버전에서 건너뛸 수 있는 유형이 지정되지 않았거나 알 수 없습니다. 입력값이 잘못되었습니다.
SKIPPABLE_MATCH_TYPE_SKIPPABLE 광고 소재는 건너뛸 수 있어야 합니다.
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE 광고 소재는 건너뛸 수 없어야 합니다.
SKIPPABLE_MATCH_TYPE_ANY 광고 소재는 건너뛸 수 있거나 건너뛸 수 없습니다.

MakegoodDetails

광고효과 보상 세부정보의 구성입니다.

JSON 표현 
{
  "originalExternalDealId": string,
  "reason": string
}
필드
originalExternalDealId

string

보상 게재를 요청하는 원래 외부 거래 ID입니다. 영문 기준 최대 100자 허용되는 문자는 영숫자, 밑줄, 대시, 마침표입니다. 필수 항목입니다.
reason

string

판매자가 시작한 보상 게재 이유입니다. 최대 250자(영문 기준) 필수 항목입니다.

CreativeSource

광고 소재 소스입니다. 광고 소재가 게재되는 위치입니다.

열거형
CREATIVE_SOURCE_UNSPECIFIED 이 버전에서는 광고 소재 소스가 지정되지 않았거나 알 수 없습니다. 입력값이 잘못되었습니다.
CREATIVE_SOURCE_ADVERTISER 광고 소재는 DV3에서 게재됩니다.
CREATIVE_SOURCE_PUBLISHER 광고 소재는 게시자가 게재합니다. 현재 게시자 호스팅 광고 소재는 지원되지 않으며 광고 소재 소스를 CREATIVE_SOURCE_PUBLISHER로 설정하려는 요청은 실패합니다.

AudienceTargetingConfig

잠재고객 타겟팅의 구성입니다.

JSON 표현 
{
  "audienceType": enum (AudienceType)
}
필드
audienceType

enum (AudienceType)

잠재고객 유형입니다. 필수 항목입니다.

AudienceType

잠재고객 유형입니다.

열거형
AUDIENCE_TYPE_UNSPECIFIED 지정되지 않은 잠재고객 유형입니다. 입력에 사용할 수 없습니다.
AUDIENCE_TYPE_COMMERCE 커머스 잠재고객 유형입니다.

TargetingCriteria

타겟팅 기준이 지정되었습니다.

JSON 표현 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
필드
selectedTargetingOptions[]

object (SelectedTargetingOption)

선택한 옵션

SelectedTargetingOption

단일 타겟팅 유형에 대해 선택된 타겟팅 옵션입니다.

JSON 표현 
{
  "type": enum (TargetingType),

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
필드
type

enum (TargetingType)

선택한 옵션과 연결된 타겟팅 유형입니다.
통합 필드 value. 한 가지 유형의 선택만 포함할 수 있습니다. 선택한 값은 'type' 필드에 선택한 TargetingType과 일치해야 합니다. value은 다음 중 하나여야 합니다.
audienceSelection

object (AudienceSelection)

선택된 잠재고객입니다.
targetingSelection

object (TargetingSelection)

선택된 옵션 ID의 일반 집합입니다.

TargetingType

타겟팅 유형입니다.

열거형
TARGETING_TYPE_UNSPECIFIED 지정되지 않은 타겟팅 유형으로, 입력에 유효하지 않습니다.
TARGETING_TYPE_AUDIENCE 타겟팅 유형 잠재고객입니다.
TARGETING_TYPE_COUNTRY 타겟팅 유형 국가입니다.
TARGETING_TYPE_DMA 타겟팅 유형 dma입니다.
TARGETING_TYPE_PROGRAMMER 타겟팅 유형 프로그래머입니다.
TARGETING_TYPE_BRAND 타겟팅 유형 브랜드입니다.
TARGETING_TYPE_CONTENT_GENRE 타겟팅 유형 콘텐츠 장르입니다.
TARGETING_TYPE_DEVICE 타겟팅 유형 기기입니다.
TARGETING_TYPE_OPERATING_SYSTEM 타겟팅 유형 운영체제입니다.
TARGETING_TYPE_RATING 타겟팅 유형 등급입니다.
TARGETING_TYPE_ENVIRONMENT 타겟팅 유형 환경입니다.
TARGETING_TYPE_LANGUAGE 타겟팅 유형 언어입니다.
TARGETING_TYPE_GEO 타겟팅 유형 지역입니다.
TARGETING_TYPE_AGE 타겟팅 유형 연령입니다.
TARGETING_TYPE_GENDER 타겟팅 유형 성별입니다.
TARGETING_TYPE_CONTEXTUAL_SEGMENT 타겟팅 유형 문맥 세그먼트입니다.
TARGETING_TYPE_REQUEST_FORMAT 타겟팅 유형 요청 형식입니다.
TARGETING_TYPE_PUBLISHER 타겟팅 유형 게시자입니다.
TARGETING_TYPE_INVENTORY_SIZE 타겟팅 유형 크기입니다.
TARGETING_TYPE_NETWORK 타겟팅 유형 네트워크입니다.
TARGETING_TYPE_PLATFORM 타겟팅 유형 플랫폼입니다.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE 타겟팅 유형 동영상 게재 유형입니다.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE 타겟팅 유형 동영상 최소 플레이어 크기입니다.

AudienceSelection

선택된 잠재고객 타겟팅 옵션입니다.

JSON 표현 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
필드
includedOrGroups[]

object (OrGroup)

포함된 옵션은 AND로 연결되며, 각 포함된 옵션은 개별 옵션이거나 OR로 연결된 옵션 그룹일 수 있습니다.
excludedOptionIds[]

string (int64 format)

제외된 옵션은 OR로 연결됩니다.

OrGroup

OR로 연결된 선택된 옵션 그룹입니다.

JSON 표현 
{
  "optionIds": [
    string
  ]
}
필드
optionIds[]

string (int64 format)

선택된 옵션 ID입니다.

TargetingSelection

선택된 옵션 ID가 하나 이상 포함된 집합으로, 대부분의 타겟팅 유형에 적용됩니다.

JSON 표현 
{
  "optionIds": [
    string
  ]
}
필드
optionIds[]

string (int64 format)

선택된 옵션 ID입니다.

ForecastResult

예측 결과가 지정되었습니다.

JSON 표현 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
필드
forecasts[]

object (Forecast)

예측 'forecastCategory'는 지정된 각 요소에 대해 고유해야 합니다.

예측

지정된 예측 카테고리의 예측입니다.

JSON 표현 
{
  "forecastCategory": enum (ForecastCategory),

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
필드
forecastCategory

enum (ForecastCategory)

예측 통계가 나타내는 지정된 예측 카테고리입니다.
통합 필드 forecast_data. 통계 데이터는 한 가지 유형만 포함할 수 있습니다. 채워진 데이터는 'forecastCategory' 필드와 일치해야 합니다. forecast_data은 다음 중 하나여야 합니다.
number

string (int64 format)

숫자 데이터입니다.
percentage

integer

백분율 데이터입니다.
cpmPrice

object (Money)

CPM 가격 데이터입니다.
cpmRange

object (CpmRange)

CPM 가격 범위 데이터입니다.
forecastBreakdownData

object (ForecastBreakdownData)

예측 분류 데이터입니다.

ForecastCategory

예측 카테고리입니다.

열거형
FORECAST_CATEGORY_UNSPECIFIED 지정되지 않은 카테고리입니다. 입력에 사용할 수 없습니다.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES 총 기회 수입니다. 숫자 데이터입니다.
FORECAST_CATEGORY_TOTAL_AUDIENCE 전체 잠재고객 숫자 데이터입니다.
FORECAST_CATEGORY_DIGITAL_TRP 디지털 타겟 평점입니다. 백분율 데이터입니다.
FORECAST_CATEGORY_SUGGESTED_CPM 추천 CPM 가격입니다. CPM 범위 또는 CPM 가격 데이터입니다.
FORECAST_CATEGORY_UNIQUE_REACH 순 사용자 도달범위를 예측합니다. 숫자 데이터입니다.
FORECAST_CATEGORY_FORECAST_BREAKDOWN 예측 분류 예측 분류 데이터입니다.

CpmRange

CPM 범위에는 CPM의 최소값과 최대값이 포함됩니다.

JSON 표현 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
필드
minCpm

object (Money)

CPM 범위의 하한입니다.
maxCpm

object (Money)

CPM 범위의 상한입니다.

ForecastBreakdownData

예측 분류 데이터는 예측 분류 목록을 보유합니다.

JSON 표현 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
필드
forecastBreakdowns[]

object (ForecastBreakdown)

예측 분류 목록입니다.

ForecastBreakdown

선택한 타겟팅 옵션의 예측 분석입니다.

JSON 표현 
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
필드
selectedTargetingOption

object (SelectedTargetingOption)

단일 타겟팅 유형에 대해 선택된 타겟팅 옵션입니다.
통합 필드 breakdown_data. 한 가지 유형의 분류 데이터만 포함할 수 있습니다. breakdown_data은 다음 중 하나여야 합니다.
impressions

string (int64 format)

예상 노출수입니다.

ErrorDetails

업데이트에 오류가 있는 경우 지정된 오류 세부정보입니다.

JSON 표현 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
필드
message

string

업데이트에 오류가 있을 때 지정된 메시지입니다.
instantDealErrorStatus

enum (InstantDealErrorStatus)

업데이트에 즉석 할인 오류가 있는 경우 지정된 오류 상태입니다.

InstantDealErrorStatus

즉석 특가 업데이트에 오류가 있을 때 지정되는 오류 상태입니다.

열거형
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED 지정되지 않은 오류 상태입니다.
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE 오류 상태는 인벤토리를 사용할 수 없음을 나타냅니다.
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE 오류 상태는 일기 예보를 사용할 수 없음을 나타냅니다.
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT 오류 상태는 잘못된 입력 필드가 있음을 나타냅니다.

FrequencyCap

특정 기간 동안 사용자에게 동일한 광고가 표시될 수 있는 횟수

JSON 표현 
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
필드
timeUnit

enum (TimeUnit)

최대 게재빈도가 적용될 시간 단위입니다.
maxImpressions

string (int64 format)

이 기간 동안 사용자에게 동일한 광고가 표시될 수 있는 최대 횟수입니다.

TimeUnit

최대 게재빈도가 적용될 시간 단위입니다.

열거형
TIME_UNIT_UNSPECIFIED 지정되지 않은 시간 단위입니다.
TIME_UNIT_LIFETIME 최대 게재빈도는 전체 기간에 적용됩니다.
TIME_UNIT_MONTHS 최대 게재빈도는 여러 달에 적용됩니다.
TIME_UNIT_WEEKS 최대 게재빈도는 여러 주에 적용됩니다.
TIME_UNIT_DAYS 최대 게재빈도가 일수에 적용됩니다.

메서드

create

 제품을 만듭니다.

get

 제품을 가져옵니다.

list

 제품을 나열합니다.

patch

 제품을 업데이트합니다.