SDF 다운로드 태스크를 만듭니다. Operation
을 반환합니다.
SDF 다운로드 작업은 장기 실행되는 비동기 작업입니다. 이 작업의 metadata
유형은 SdfDownloadTaskMetadata
입니다. 요청이 성공하면 작업의 response
유형은 SdfDownloadTask
입니다. 응답에는 다운로드 파일이 포함되지 않으며, 이 파일은 media.download
로 검색해야 합니다. 작업 상태는 sdfdownloadtask.operations.get
를 사용하여 가져올 수 있습니다.
모든 오류는 error.message
에서 찾을 수 있습니다. error.details
는 비어 있어야 합니다.
HTTP 요청
POST https://displayvideo.googleapis.com/v2/sdfdownloadtasks
URL은 gRPC 트랜스코딩 구문을 사용합니다.
요청 본문
요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{ "version": enum ( |
필드 | |
---|---|
version |
필수 항목입니다. 다운로드한 파일의 SDF 버전입니다. |
통합 필드 root_id . 필수 항목입니다. 루트 ID는 다운로드 요청의 컨텍스트를 결정합니다. 정확히 1개의 필드를 설정해야 합니다. root_id 은 다음 중 하나여야 합니다. |
|
partnerId |
SDF를 다운로드할 파트너의 ID입니다. |
advertiserId |
SDF를 다운로드할 광고주의 ID입니다. |
통합 필드 filtering_option . 필수 항목입니다. 다운로드할 항목 유형 및 범위를 지정하는 옵션입니다. 정확히 1개의 필드를 설정해야 합니다. filtering_option 은 다음 중 하나여야 합니다. |
|
parentEntityFilter |
선택한 파일 형식을 필터링합니다. 각 파일의 항목은 선택한 필터 항목 집합에 따라 필터링됩니다. 필터 항목은 선택한 파일 형식과 동일한 유형이거나 상위 유형이어야 합니다. |
idFilter |
항목 ID를 기준으로 항목을 필터링합니다. |
inventorySourceFilter |
ID로 인벤토리 소스를 필터링합니다. |
응답 본문
성공한 경우 응답 본문에 새로 생성된 Operation
의 인스턴스가 포함됩니다.
승인 범위
다음 OAuth 범위가 필요합니다.
https://www.googleapis.com/auth/display-video
자세한 내용은 OAuth 2.0 개요를 참고하세요.
ParentEntityFilter
선택한 필터 항목 집합에 속하는 선택된 파일 형식을 필터링하는 필터링 옵션입니다.
JSON 표현 |
---|
{ "fileType": [ enum ( |
필드 | |
---|---|
fileType[] |
필수 항목입니다. 반환될 파일 형식입니다. |
filterType |
필수 항목입니다. 가져온 항목을 필터링하는 데 사용되는 필터 유형입니다. |
filterIds[] |
지정된 필터 유형의 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 광고 |
FilterType
필터링할 수 있는 가능한 유형입니다.
열거형 | |
---|---|
FILTER_TYPE_UNSPECIFIED |
유형이 지정되지 않았거나 이 버전에서 알 수 없는 경우의 기본값입니다. |
FILTER_TYPE_NONE |
선택하면 다운로드에 필터가 적용되지 않습니다. Advertiser 가 CreateSdfDownloadTaskRequest 에 지정된 경우에만 사용할 수 있습니다. |
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_AD_GROUP , FILE_TYPE_AD 다운로드에만 사용할 수 있습니다. |
FILTER_TYPE_LINE_ITEM_ID |
광고 항목 ID입니다. 선택한 경우 모든 필터 ID는 CreateSdfDownloadTaskRequest 에 지정된 Advertiser 또는 Partner 에 속하는 광고 항목 ID여야 합니다. FILE_TYPE_LINE_ITEM , FILE_TYPE_AD_GROUP , FILE_TYPE_AD 다운로드에만 사용할 수 있습니다. |
IdFilter
엔티티 ID로 항목을 필터링하는 필터링 옵션입니다.
JSON 표현 |
---|
{ "campaignIds": [ string ], "mediaProductIds": [ string ], "insertionOrderIds": [ string ], "lineItemIds": [ string ], "adGroupIds": [ string ], "adGroupAdIds": [ string ] } |
필드 | |
---|---|
campaignIds[] |
ID별로 다운로드할 캠페인입니다. 모든 ID는 |
mediaProductIds[] |
ID로 다운로드할 미디어 제품 모든 ID는 |
insertionOrderIds[] |
ID로 다운로드할 게재 신청서입니다. 모든 ID는 |
lineItemIds[] |
ID별로 다운로드할 광고 항목입니다. 모든 ID는 |
adGroupIds[] |
ID별로 다운로드할 YouTube 광고그룹. 모든 ID는 |
adGroupAdIds[] |
ID별로 다운로드할 YouTube 광고 모든 ID는 |
InventorySourceFilter
인벤토리 소스 항목을 필터링하기 위한 필터링 옵션입니다.
JSON 표현 |
---|
{ "inventorySourceIds": [ string ] } |
필드 | |
---|---|
inventorySourceIds[] |
ID별로 다운로드할 인벤토리 소스입니다. 모든 ID는 |