Method: sdfdownloadtasks.create

SDF 다운로드 태스크를 만듭니다. Operation을 반환합니다.

SDF 다운로드 작업은 장기 실행 비동기 작업입니다. 이 작업의 metadata 유형은 SdfDownloadTaskMetadata입니다. 요청이 성공하면 작업의 response 유형이 SdfDownloadTask입니다. 응답에는 다운로드 파일이 포함되지 않으며 media.download로 가져와야 합니다. 작업 상태는 sdfdownloadtask.operations.get를 사용하여 가져올 수 있습니다.

모든 오류는 error.message에서 찾을 수 있습니다. error.details는 비어 있어야 합니다.

HTTP 요청

POST https://displayvideo.googleapis.com/v3/sdfdownloadtasks

URL은 gRPC 트랜스코딩 구문을 사용합니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "version": enum (SdfVersion),

  // Union field root_id can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field root_id.

  // Union field filtering_option can be only one of the following:
  "parentEntityFilter": {
    object (ParentEntityFilter)
  },
  "idFilter": {
    object (IdFilter)
  },
  "inventorySourceFilter": {
    object (InventorySourceFilter)
  }
  // End of list of possible types for union field filtering_option.
}
필드
version

enum (SdfVersion)

필수 항목입니다. 다운로드한 파일의 SDF 버전입니다. SDF_VERSION_UNSPECIFIED로 설정하면 root_id로 식별된 광고주 또는 파트너가 지정한 버전으로 기본 설정됩니다. 광고주는 달리 구성하지 않는 한 파트너로부터 SDF 버전을 상속합니다.
통합 필드 root_id. 필수 항목입니다. 루트 ID는 다운로드 요청의 컨텍스트를 결정합니다. 정확히 1개의 필드를 설정해야 합니다. root_id은 다음 중 하나여야 합니다.
partnerId

string (int64 format)

SDF를 다운로드할 파트너의 ID입니다.
advertiserId

string (int64 format)

SDF를 다운로드할 광고주의 ID입니다.
통합 필드 filtering_option. 필수 항목입니다. 다운로드할 항목 유형 및 범위를 지정하는 옵션입니다. 정확히 하나의 필드를 설정해야 합니다. filtering_option은 다음 중 하나여야 합니다.
parentEntityFilter

object (ParentEntityFilter)

선택한 파일 형식을 필터링합니다. 각 파일의 항목은 선택한 필터 항목 집합에 따라 필터링됩니다. 필터 항목은 선택한 파일 형식과 동일한 유형이거나 상위 유형이어야 합니다.
idFilter

object (IdFilter)

항목 ID를 기준으로 항목을 필터링합니다.
inventorySourceFilter

object (InventorySourceFilter)

인벤토리 소스의 ID를 기준으로 필터링합니다.

응답 본문

성공한 경우 응답 본문에 새로 생성된 Operation의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/display-video

자세한 내용은 OAuth 2.0 개요를 참고하세요.

ParentEntityFilter

선택한 필터 항목 집합에 속하는 선택한 파일 유형을 필터링하는 필터링 옵션입니다.

JSON 표현 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
필드
fileType[]

enum (FileType)

필수 항목입니다. 반환되는 파일 형식입니다.
filterType

enum (FilterType)

필수 항목입니다. 가져온 항목을 필터링하는 데 사용되는 필터 유형입니다.
filterIds[]

string (int64 format)

지정된 필터 유형의 ID입니다. 가져올 항목을 필터링하는 데 사용됩니다. 필터 유형이 FILTER_TYPE_NONE이 아닌 경우 ID를 하나 이상 지정해야 합니다.

FileType

다운로드할 수 있는 파일의 가능한 형식입니다.

열거형
FILE_TYPE_UNSPECIFIED 이 버전에서 유형이 지정되지 않았거나 알 수 없는 경우의 기본값입니다.
FILE_TYPE_CAMPAIGN 캠페인
FILE_TYPE_MEDIA_PRODUCT 미디어 제품
FILE_TYPE_INSERTION_ORDER 게재 신청서
FILE_TYPE_LINE_ITEM 광고 항목
FILE_TYPE_AD_GROUP YouTube 광고 그룹
FILE_TYPE_AD YouTube 광고
FILE_TYPE_LINE_ITEM_QA 광고 항목 - 품질 보증 형식
FILE_TYPE_AD_GROUP_QA YouTube 광고 그룹 - QA 형식

FilterType

필터링할 수 있는 유형입니다.

열거형
FILTER_TYPE_UNSPECIFIED 유형이 지정되지 않았거나 이 버전에서 알 수 없는 경우의 기본값입니다.
FILTER_TYPE_NONE 선택하면 다운로드에 필터가 적용되지 않습니다. CreateSdfDownloadTaskRequest에 Advertiser가 지정된 경우에만 사용할 수 있습니다.
FILTER_TYPE_ADVERTISER_ID 광고주 ID 이 옵션을 선택하면 모든 필터 ID가 CreateSdfDownloadTaskRequest에 지정된 Partner에 속한 광고주 ID여야 합니다.
FILTER_TYPE_CAMPAIGN_ID 캠페인 ID입니다. 이 옵션을 선택하면 모든 필터 ID는 CreateSdfDownloadTaskRequest에 지정된 Advertiser 또는 Partner에 속한 캠페인 ID여야 합니다.
FILTER_TYPE_MEDIA_PRODUCT_ID 미디어 제품 ID입니다. 선택한 경우 모든 필터 ID는 CreateSdfDownloadTaskRequest에 지정된 Advertiser 또는 Partner에 속한 미디어 제품 ID여야 합니다. FILE_TYPE_MEDIA_PRODUCT 다운로드에만 사용할 수 있습니다.
FILTER_TYPE_INSERTION_ORDER_ID 게재 신청서 ID 이 옵션을 선택하면 모든 필터 ID가 CreateSdfDownloadTaskRequest에 지정된 Advertiser 또는 Partner에 속한 게재 신청서 ID여야 합니다. FILE_TYPE_INSERTION_ORDER, FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA, FILE_TYPE_AD를 다운로드하는 데만 사용할 수 있습니다.
FILTER_TYPE_LINE_ITEM_ID 광고 항목 ID입니다. 이 옵션을 선택하면 모든 필터 ID가 CreateSdfDownloadTaskRequest에 지정된 Advertiser 또는 Partner에 속한 광고 항목 ID여야 합니다. FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA,FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA, FILE_TYPE_AD 다운로드에만 사용할 수 있습니다.

IdFilter

엔티티 ID로 항목을 필터링하는 필터링 옵션입니다.

JSON 표현 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    string
  ],
  "lineItemQaIds": [
    string
  ],
  "adGroupQaIds": [
    string
  ]
}
필드
campaignIds[]

string (int64 format)

ID별로 다운로드할 캠페인 모든 ID는 CreateSdfDownloadTaskRequest에 지정된 동일한 Advertiser 또는 Partner에 속해야 합니다.
mediaProductIds[]

string (int64 format)

ID별로 다운로드할 미디어 제품입니다. 모든 ID는 CreateSdfDownloadTaskRequest에 지정된 동일한 Advertiser 또는 Partner에 속해야 합니다.
insertionOrderIds[]

string (int64 format)

ID로 다운로드할 게재 신청서입니다. 모든 ID는 CreateSdfDownloadTaskRequest에 지정된 동일한 Advertiser 또는 Partner에 속해야 합니다.
lineItemIds[]

string (int64 format)

ID별로 다운로드할 광고 항목입니다. 모든 ID는 CreateSdfDownloadTaskRequest에 지정된 동일한 Advertiser 또는 Partner에 속해야 합니다.
adGroupIds[]

string (int64 format)

ID별로 다운로드할 YouTube 광고 그룹 모든 ID는 CreateSdfDownloadTaskRequest에 지정된 동일한 Advertiser 또는 Partner에 속해야 합니다.
adGroupAdIds[]

string (int64 format)

ID별로 다운로드할 YouTube 광고 모든 ID는 CreateSdfDownloadTaskRequest에 지정된 동일한 Advertiser 또는 Partner에 속해야 합니다.
lineItemQaIds[]

string (int64 format)

선택사항입니다. 품질 보증 형식으로 다운로드할 광고 항목(ID별) 모든 ID는 CreateSdfDownloadTaskRequest에 지정된 동일한 Advertiser 또는 Partner에 속해야 합니다.
adGroupQaIds[]

string (int64 format)

선택사항입니다. QA 형식으로 다운로드할 YouTube 광고 그룹(ID별) 모든 ID는 CreateSdfDownloadTaskRequest에 지정된 동일한 Advertiser 또는 Partner에 속해야 합니다.

InventorySourceFilter

인벤토리 소스 항목을 필터링하기 위한 필터링 옵션입니다.

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

string (int64 format)

ID별로 다운로드할 인벤토리 소스입니다. 모든 ID는 CreateSdfDownloadTaskRequest에 지정된 동일한 Advertiser 또는 Partner에 속해야 합니다. 선택한 광고주 또는 파트너의 모든 인벤토리 소스를 다운로드하려면 비워 둡니다.