REST Resource: advertisers.adGroupAds

리소스: AdGroupAd

광고 그룹과 연결된 단일 광고입니다.

JSON 표현 
{
  "name": string,
  "advertiserId": string,
  "adGroupAdId": string,
  "adGroupId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "adUrls": [
    {
      object (AdUrl)
    }
  ],

  // Union field ad_details can be only one of the following:
  "displayVideoSourceAd": {
    object (DisplayVideoSourceAd)
  },
  "mastheadAd": {
    object (MastheadAd)
  },
  "inStreamAd": {
    object (InStreamAd)
  },
  "nonSkippableAd": {
    object (NonSkippableAd)
  },
  "bumperAd": {
    object (BumperAd)
  },
  "audioAd": {
    object (AudioAd)
  },
  "videoDiscoverAd": {
    object (VideoDiscoveryAd)
  },
  "videoPerformanceAd": {
    object (VideoPerformanceAd)
  }
  // End of list of possible types for union field ad_details.
}
필드
name

string

광고의 리소스 이름입니다.
advertiserId

string (int64 format)

광고가 속한 광고주의 고유 ID입니다.
adGroupAdId

string (int64 format)

광고의 고유 ID입니다. 시스템에서 할당합니다.
adGroupId

string (int64 format)

광고가 속한 광고 그룹의 고유 ID입니다.
displayName

string

광고의 표시 이름입니다.

최대 크기가 255바이트인 UTF-8로 인코딩되어야 합니다.
entityStatus

enum (EntityStatus)

광고의 항목 상태입니다.
adUrls[]

object (AdUrl)

광고에서 사용되는 URL 목록입니다.
통합 필드 ad_details. 광고 세부정보입니다. ad_details은 다음 중 하나여야 합니다.
displayVideoSourceAd

object (DisplayVideoSourceAd)

Display & Video 360 광고 소재에서 가져온 광고의 세부정보입니다.
mastheadAd

object (MastheadAd)

YouTube 홈 피드에 게재되는 광고의 세부정보입니다.
inStreamAd

object (InStreamAd)

브랜드 인지도 또는 도달범위 마케팅 목표에 사용되는 5초 후에 건너뛸 수 있는 인스트림 광고의 세부정보입니다.
nonSkippableAd

object (NonSkippableAd)

도달범위 마케팅 목표에 사용되는 6~15초 길이의 건너뛸 수 없는 짧은 인스트림 동영상 광고의 세부정보입니다.
bumperAd

object (BumperAd)

도달범위에 사용되며 길이가 6초 이하인 건너뛸 수 없는 짧은 동영상 광고의 세부정보입니다.
audioAd

object (AudioAd)

도달범위 마케팅 목표에 사용되는 오디오 광고의 세부정보입니다.
videoDiscoverAd

object (VideoDiscoveryAd)

디스커버리 위치에 표시되는 동영상을 홍보하는 광고의 세부정보입니다.
videoPerformanceAd

object (VideoPerformanceAd)

비즈니스, 서비스 또는 제품에 대한 액션을 유도하기 위해 동영상 액션 캠페인에 사용되는 광고의 세부정보입니다.

DisplayVideoSourceAd

DV360 광고 소재에서 가져온 광고입니다.

JSON 표현 
{
  "creativeId": string
}
필드
creativeId

string (int64 format)

소스 광고 소재의 ID입니다.

MastheadAd

마스트헤드 광고의 세부정보입니다.

JSON 표현 
{
  "video": {
    object (YoutubeVideoDetails)
  },
  "headline": string,
  "description": string,
  "videoAspectRatio": enum (VideoAspectRatio),
  "autoplayVideoStartMillisecond": string,
  "autoplayVideoDuration": string,
  "callToActionButtonLabel": string,
  "callToActionFinalUrl": string,
  "callToActionTrackingUrl": string,
  "showChannelArt": boolean,
  "companionYoutubeVideos": [
    {
      object (YoutubeVideoDetails)
    }
  ]
}
필드
video

object (YoutubeVideoDetails)

광고에서 사용되는 YouTube 동영상입니다.
headline

string

광고의 제목입니다.
description

string

광고 설명입니다.
videoAspectRatio

enum (VideoAspectRatio)

마스트헤드에서 자동 재생되는 YouTube 동영상의 가로세로 비율입니다.
autoplayVideoStartMillisecond

string (int64 format)

동영상 재생이 시작되기까지의 시간(밀리초)입니다.
autoplayVideoDuration

string (Duration format)

동영상이 자동 재생되는 시간입니다.

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

string

클릭 유도 문구 버튼의 텍스트입니다.
callToActionFinalUrl

string

클릭 유도 문구 버튼의 도착 URL입니다.
callToActionTrackingUrl

string

클릭 유도 문구 버튼의 추적 URL입니다.
showChannelArt

boolean

YouTube 페이지 상단에 표시되는 배경 또는 배너를 표시할지 여부입니다.
companionYoutubeVideos[]

object (YoutubeVideoDetails)

데스크톱에서 마스트헤드 광고 옆에 표시되는 동영상입니다. 두 개 이하로 지정해야 합니다.

YoutubeVideoDetails

YouTube 동영상의 세부정보입니다.

JSON 표현 
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
필드
id

string

YouTube 웹페이지에서 검색할 수 있는 YouTube 동영상 ID입니다.
unavailableReason

enum (VideoUnavailableReason)

동영상 데이터를 사용할 수 없는 이유입니다.

VideoUnavailableReason

동영상을 사용할 수 없는 이유

열거형
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED 알 수 없거나 지정되지 않았습니다.
VIDEO_UNAVAILABLE_REASON_PRIVATE 비공개 동영상입니다.
VIDEO_UNAVAILABLE_REASON_DELETED 동영상이 삭제되었습니다.

VideoAspectRatio

YouTube 동영상의 가능한 가로세로 비율입니다.

열거형
VIDEO_ASPECT_RATIO_UNSPECIFIED 지정되지 않았거나 알 수 없습니다.
VIDEO_ASPECT_RATIO_WIDESCREEN 동영상이 늘어나고 상단과 하단이 잘립니다.
VIDEO_ASPECT_RATIO_FIXED_16_9 동영상은 고정된 16:9 가로세로 비율을 사용합니다.

InStreamAd

인스트림 광고의 세부정보입니다.

JSON 표현 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
필드
commonInStreamAttribute

object (CommonInStreamAttribute)

일반적인 광고 속성입니다.
customParameters

map (key: string, value: string)

추적 URL 템플릿에 맞춤 값을 전달하는 맞춤 매개변수입니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }

CommonInStreamAttribute

인스트림 광고, 건너뛸 수 없는 광고, 범퍼 광고의 공통 속성입니다.

JSON 표현 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
필드
displayUrl

string

광고와 함께 표시되는 웹페이지 주소입니다.
finalUrl

string

사용자가 광고를 클릭하면 연결되는 웹페이지의 URL 주소입니다.
trackingUrl

string

추적 목적으로 백그라운드에서 로드되는 URL 주소입니다.
actionButtonLabel

string

클릭 유도 문구 버튼의 텍스트입니다.
actionHeadline

string

클릭 유도 문구 배너의 광고 제목입니다.
video

object (YoutubeVideoDetails)

광고의 YouTube 동영상입니다.
companionBanner

object (ImageAsset)

동영상 광고 옆에 표시되는 이미지입니다.

ImageAsset

이미지 확장 소재의 메타데이터입니다.

JSON 표현 
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
필드
mimeType

string

이미지 애셋의 MIME 유형입니다.
fullSize

object (Dimensions)

원본 크기의 이 이미지에 대한 메타데이터입니다.
fileSize

string (int64 format)

이미지 애셋의 파일 크기(바이트)입니다.

NonSkippableAd

건너뛸 수 없는 광고의 세부정보입니다.

JSON 표현 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
필드
commonInStreamAttribute

object (CommonInStreamAttribute)

일반적인 광고 속성입니다.
customParameters

map (key: string, value: string)

추적 URL 템플릿에 맞춤 값을 전달하는 맞춤 매개변수입니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }

BumperAd

범퍼 광고의 세부정보입니다.

JSON 표현 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
필드
commonInStreamAttribute

object (CommonInStreamAttribute)

일반적인 광고 속성입니다.

AudioAd

오디오 광고의 세부정보입니다.

JSON 표현 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
필드
displayUrl

string

광고와 함께 표시되는 웹페이지 주소입니다.
finalUrl

string

사용자가 광고를 클릭하면 연결되는 웹페이지의 URL 주소입니다.
trackingUrl

string

추적 목적으로 백그라운드에서 로드되는 URL 주소입니다.
video

object (YoutubeVideoDetails)

광고의 YouTube 동영상입니다.

VideoDiscoveryAd

동영상 디스커버리 광고의 세부정보입니다.

JSON 표현 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
필드
headline

string

광고의 제목입니다.
description1

string

광고의 첫 번째 텍스트 줄입니다.
description2

string

광고의 두 번째 텍스트 줄입니다.
video

object (YoutubeVideoDetails)

광고에서 홍보하는 YouTube 동영상입니다.
thumbnail

enum (Thumbnail)

광고에 사용되는 썸네일 이미지입니다.

썸네일

동영상 디스커버리 광고에서 사용할 수 있는 썸네일 옵션입니다.

열거형
THUMBNAIL_UNSPECIFIED 알 수 없거나 지정되지 않았습니다.
THUMBNAIL_DEFAULT 기본 썸네일로, 자동 생성되거나 사용자가 업로드할 수 있습니다.
THUMBNAIL_1 동영상에서 생성된 썸네일 1
THUMBNAIL_2 동영상에서 생성된 썸네일 2
THUMBNAIL_3 동영상에서 생성된 썸네일 3

VideoPerformanceAd

동영상 실적 광고의 세부정보입니다.

JSON 표현 
{
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabels": [
    string
  ],
  "headlines": [
    string
  ],
  "longHeadlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string,
  "domain": string,
  "videos": [
    {
      object (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanners": [
    {
      object (ImageAsset)
    }
  ]
}
필드
finalUrl

string

사용자가 광고를 클릭하면 연결되는 웹페이지의 URL 주소입니다.
trackingUrl

string

추적 목적으로 백그라운드에서 로드되는 URL 주소입니다.
actionButtonLabels[]

string

클릭 유도 문구 버튼에 표시되는 텍스트 애셋 목록입니다.
headlines[]

string

클릭 유도문안 배너에 표시되는 광고 제목 목록입니다.
longHeadlines[]

string

클릭 유도문안 배너에 표시되는 단독 광고 제목 목록입니다.
descriptions[]

string

클릭 유도 문구 배너에 표시되는 설명 목록입니다.
displayUrlBreadcrumb1

string

표시 URL에서 도메인 뒤에 오는 첫 번째 부분입니다.
displayUrlBreadcrumb2

string

표시 URL에서 도메인 다음의 두 번째 부분입니다.
domain

string

표시 URL의 도메인입니다.
videos[]

object (YoutubeVideoDetails)

이 광고에서 사용되는 YouTube 동영상 애셋 목록입니다.
customParameters

map (key: string, value: string)

추적 URL 템플릿에 맞춤 값을 전달하는 맞춤 매개변수입니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }
companionBanners[]

object (ImageAsset)

이 광고에서 사용되는 컴패니언 배너 목록입니다.

AdUrl

비콘을 포함하여 광고와 관련된 추가 URL입니다.

JSON 표현 
{
  "type": enum (AdUrlType),
  "url": string
}
필드
type

enum (AdUrlType)

광고 URL의 유형입니다.
url

string

URL 문자열 값입니다.

AdUrlType

가능한 광고 URL 유형입니다.

열거형
AD_URL_TYPE_UNSPECIFIED 알 수 없거나 지정되지 않았습니다.
AD_URL_TYPE_BEACON_IMPRESSION 광고 소재의 노출이 게재될 때 핑할 1x1 추적 픽셀입니다.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION 확장형 DCM 노출 비콘입니다. 제공 시에는 여러 비콘으로 확장됩니다.
AD_URL_TYPE_BEACON_CLICK 클릭 이벤트가 트리거될 때 핑할 추적 URL입니다.
AD_URL_TYPE_BEACON_SKIP 건너뛰기 이벤트가 트리거될 때 핑할 추적 URL입니다.

메서드

get

 광고 그룹 광고를 가져옵니다.

list

 광고 그룹 광고를 나열합니다.