REST Resource: customBiddingAlgorithms

리소스: CustomBiddingAlgorithm

단일 맞춤 입찰 알고리즘

JSON 표현 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "customBiddingAlgorithmType": enum (CustomBiddingAlgorithmType),
  "sharedAdvertiserIds": [
    string
  ],
  "modelDetails": [
    {
      object (CustomBiddingModelDetails)
    }
  ],

  // Union field owner can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field owner.
}
필드
name

string

출력 전용입니다. 맞춤 입찰 알고리즘의 리소스 이름입니다.
customBiddingAlgorithmId

string (int64 format)

출력 전용입니다. 맞춤 입찰 알고리즘의 고유 ID입니다. 시스템에서 할당합니다.
displayName

string

필수 항목입니다. 맞춤 입찰 알고리즘의 표시 이름입니다.

UTF-8로 인코딩되어야 하며 최대 크기는 240바이트여야 합니다.
entityStatus

enum (EntityStatus)

맞춤 입찰 알고리즘을 입찰 전략으로 사용할 수 있는지 여부를 제어합니다.

허용되는 값은 다음과 같습니다.

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

필수 항목입니다. 변경할 수 없습니다. 맞춤 입찰 알고리즘 유형입니다.
sharedAdvertiserIds[]

string (int64 format)

이 알고리즘에 액세스할 수 있는 광고주의 ID입니다. advertiserId가 설정되면 이 필드는 해당 값으로만 구성됩니다.

owner 알고리즘이 파트너이고 광고주 accessor를 사용하여 검색되는 경우 이 필드가 설정되지 않습니다.
modelDetails[]

object (CustomBiddingModelDetails)

출력 전용입니다. 액세스 권한이 있는 각 광고주의 맞춤 입찰 모델에 대한 세부정보입니다.

owner 알고리즘이 파트너이고 광고주 accessor를 사용하여 검색되고 있는 경우 이 필드에는 쿼리된 광고주의 세부정보만 포함될 수 있습니다.
통합 필드 owner. 맞춤 입찰 알고리즘을 소유한 DV360 항목을 식별합니다. 파트너 또는 광고주일 수 있습니다. owner은 다음 중 하나여야 합니다.
partnerId

string (int64 format)

변경할 수 없습니다. 맞춤 입찰 알고리즘을 소유한 파트너의 고유 ID입니다.
advertiserId

string (int64 format)

변경할 수 없습니다. 맞춤 입찰 알고리즘을 소유한 광고주의 고유 ID입니다.

CustomBiddingAlgorithmType

맞춤 입찰 알고리즘의 가능한 유형입니다.

열거형
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED 이 버전에서 알고리즘 유형이 지정되지 않았거나 알 수 없습니다.
SCRIPT_BASED 고객이 업로드한 맞춤 입찰 스크립트 파일을 통해 생성된 알고리즘입니다.
ADS_DATA_HUB_BASED Ads Data Hub 제품을 통해 생성된 알고리즘입니다.
GOAL_BUILDER_BASED DV3 UI의 목표 생성 도구를 통해 생성된 알고리즘입니다.
RULE_BASED

정의된 규칙을 기반으로 하는 알고리즘 이러한 규칙은 API에서 AlgorithmRules 객체를 사용하여 정의됩니다.

이 알고리즘 유형은 허용 목록에 포함된 고객에게만 제공됩니다. 이 유형을 사용하려는 다른 고객에게는 오류가 표시됩니다.

CustomBiddingModelDetails

공유된 단일 광고주의 맞춤 입찰 알고리즘 모델에 관한 세부정보입니다.

JSON 표현 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
필드
advertiserId

string (int64 format)

관련 광고주의 고유 ID입니다.
readinessState

enum (ReadinessState)

맞춤 입찰 모델의 준비 상태입니다.
suspensionState

enum (SuspensionState)

출력 전용입니다. 맞춤 입찰 모델의 정지 상태입니다.

ReadinessState

모델 준비 상태의 가능한 상태입니다.

열거형
READINESS_STATE_UNSPECIFIED 이 버전에서 상태가 지정되지 않았거나 알 수 없습니다.
READINESS_STATE_ACTIVE 모델이 학습되고 제공할 준비가 되었습니다.
READINESS_STATE_INSUFFICIENT_DATA 데이터가 충분하지 않아 서빙 모델을 학습시킬 수 없습니다.
READINESS_STATE_TRAINING 모델이 학습 중이며 서빙할 준비가 되지 않았습니다.
READINESS_STATE_NO_VALID_SCRIPT 모델을 학습하는 데 사용할 유효한 맞춤 입찰 스크립트가 제공되지 않았습니다. 이 상태는 customBiddingAlgorithmType이 SCRIPT_BASED인 알고리즘에만 적용됩니다.
READINESS_STATE_EVALUATION_FAILURE 유효한 스크립트가 제공되었지만 평가에 실패했습니다. 할당된 시간 내에 평가할 수 없는 스크립트에 적용됩니다.

SuspensionState

맞춤 입찰 모델의 가능한 정지 상태입니다.

열거형
SUSPENSION_STATE_UNSPECIFIED 이 버전에서 상태가 지정되지 않았거나 알 수 없습니다.
SUSPENSION_STATE_ENABLED 모델이 사용 설정되어 있거나 최근에 사용되었거나 현재 사용 중이거나 사용이 예약되어 있습니다. 알고리즘에서 이 광고주의 노출을 적극적으로 평가하고 있습니다.
SUSPENSION_STATE_DORMANT 모델이 최근에 사용되지 않았습니다. 모델은 여전히 ENABLED로 작동하지만 사용되지 않으면 결국 정지됩니다.
SUSPENSION_STATE_SUSPENDED 모델이 노출 점수 산정에서 정지되어 게재할 수 없습니다. 이 광고주의 광고 항목에 알고리즘이 할당되거나 다른 방식으로 업데이트되면 ENABLED 상태로 다시 전환되며 게재 모델을 다시 준비하는 데 시간이 걸립니다.

메서드

create

 새 맞춤 입찰 알고리즘을 만듭니다.

get

 맞춤 입찰 알고리즘을 가져옵니다.

list

 현재 사용자가 액세스할 수 있고 입찰 전략에 사용할 수 있는 맞춤 입찰 알고리즘을 나열합니다.

patch

 기존 맞춤 입찰 알고리즘을 업데이트합니다.

uploadRules

 AlgorithmRules 파일에 대한 규칙 참조 객체를 만듭니다.

uploadScript

 스크립트 파일의 맞춤 입찰 스크립트 참조 객체를 만듭니다.