Method: adEvents.ingest

AdEvent 리소스 목록을 Google 애널리틱스에 업로드합니다.

이 기능은 허용 목록에 추가된 계정에서만 사용할 수 있습니다.

HTTP 요청

POST https://datamanager.googleapis.com/v1/adEvents:ingest

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

요청 본문

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

JSON 표현
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
필드
adEvents[]

object (AdEvent)

필수 항목입니다. 필수 (1개 이상) 광고 이벤트 목록입니다.

encryptionInfo

object (EncryptionInfo)

선택사항입니다. 데이터를 암호화하는 데 사용되는 암호화 키에 관한 정보입니다.

validateOnly

boolean

선택사항입니다. true인 경우 요청이 검증되지만 실행되지는 않습니다.

응답 본문

성공한 경우 응답 본문은 비어 있습니다.

승인 범위

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

  • https://www.googleapis.com/auth/datamanager

AdEvent

광고 이벤트입니다.

JSON 표현
{
  "advertiserId": string,
  "eventType": enum (EventType),
  "timestamp": string,
  "eventId": string,
  "userData": {
    object (UserData)
  },
  "deviceInfo": {
    object (DeviceInfo)
  },
  "mobileDeviceId": string,
  "campaignId": string,
  "campaignName": string,
  "adGroupId": string,
  "adId": string,
  "adHeight": integer,
  "adWidth": integer,
  "regionCode": string,
  "source": string,
  "medium": string,
  "attributionHint": enum (AttributionHint),
  "viewabilityInfo": {
    object (ViewabilityInfo)
  },

  // Union field event_subtype_oneof can be only one of the following:
  "eventSubtype": enum (EventSubtype),
  "eventSubtypeString": string
  // End of list of possible types for union field event_subtype_oneof.

  // Union field ad_type_oneof can be only one of the following:
  "adType": enum (AdType),
  "adTypeString": string
  // End of list of possible types for union field ad_type_oneof.

  // Union field ad_format_oneof can be only one of the following:
  "adFormat": enum (AdFormat),
  "adFormatString": string
  // End of list of possible types for union field ad_format_oneof.

  // Union field ad_placement_oneof can be only one of the following:
  "adPlacement": enum (AdPlacement),
  "adPlacementString": string
  // End of list of possible types for union field ad_placement_oneof.

  // Union field targeting_type_oneof can be only one of the following:
  "targetingType": enum (TargetingType),
  "targetingTypeString": string
  // End of list of possible types for union field targeting_type_oneof.

  // Union field platform_type_oneof can be only one of the following:
  "platformType": enum (PlatformType),
  "platformTypeString": string
  // End of list of possible types for union field platform_type_oneof.

  // Union field platform_oneof can be only one of the following:
  "platform": enum (Platform),
  "platformString": string
  // End of list of possible types for union field platform_oneof.
  "measurementAllowed": boolean
}
필드
advertiserId

string

필수 항목입니다. 광고 이벤트의 광고주 ID입니다.

이 ID는 연결 흐름에서 전송된 ID와 일치해야 합니다.

eventType

enum (EventType)

필수 항목입니다. 이벤트 유형입니다.

timestamp

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"입니다.

eventId

string

선택사항입니다. 호출자가 생성하고 관리하며 이 이벤트를 고유하게 식별하는 ID입니다.

여러 요청에 포함된 광고 이벤트를 중복 삭제하려면 필수입니다. 그렇지 않으면 이 필드는 선택사항입니다.

userData

object (UserData)

선택사항입니다. 이벤트와 연결된 사용자를 나타내는 여러 사용자 제공 데이터입니다.

동일한 유형의 데이터 (예: 이메일 주소)를 여러 개 제공할 수 있습니다. 데이터를 많이 제공할수록 일치 항목을 찾을 가능성이 높아집니다.

deviceInfo

object (DeviceInfo)

선택사항입니다. 광고 이벤트가 발생했을 때 사용 중인 기기에 관해 수집된 정보입니다.

mobileDeviceId

string

선택사항입니다. 광고가 게재된 기기의 기기 ID입니다.

campaignId

string

필수 항목입니다. 연결된 캠페인의 ID입니다.

campaignName

string

필수 항목입니다. 연결된 캠페인의 이름입니다.

adGroupId

string

선택사항입니다. 연결된 광고 그룹의 ID입니다.

adId

string

선택사항입니다. 그룹 내 연결된 광고의 ID입니다.

adHeight

integer

선택사항입니다. 광고의 높이(픽셀)입니다.

adWidth

integer

선택사항입니다. 광고의 너비(픽셀)입니다.

regionCode

string

필수 항목입니다. ISO 3166-2 국가 및 하위 지역입니다.

source

string

필수 항목입니다. Google 애널리틱스 소스와 유사한 광고의 플랫폼 소스입니다.

medium

string

필수 항목입니다. Google 애널리틱스 매체와 유사한 광고의 매체입니다.

attributionHint

enum (AttributionHint)

선택사항입니다. 이 광고 이벤트에 대해 파트너가 가정한 기여 분석 상태입니다.

이는 파트너가 기여 분석이 어떻게 이루어졌다고 가정했는지를 나타내는 신호로만 작용하며 최종 보고서의 최종 결과를 강제하지는 않습니다.

viewabilityInfo

object (ViewabilityInfo)

필수 항목입니다. 게재된 광고의 조회가능성에 관한 세부정보입니다.

통합 필드 event_subtype_oneof. 선택사항입니다. 광고 이벤트 유형에 관한 추가 분류입니다.

순수 열거형이 아닌 값을 처리하기 위해 원시 문자열이 허용됩니다. 가능하면 enum을 사용하는 것이 좋습니다. event_subtype_oneof는 다음 중 하나여야 합니다.

eventSubtype

enum (EventSubtype)

이벤트 하위 유형의 열거형 값입니다.

eventSubtypeString

string

이벤트 하위 유형의 문자열 값입니다.

통합 필드 ad_type_oneof. 선택사항입니다. 게재된 광고의 유형입니다.

순수 열거형이 아닌 값을 처리하기 위해 원시 문자열이 허용됩니다. 가능하면 enum을 사용하는 것이 좋습니다. ad_type_oneof는 다음 중 하나여야 합니다.

adType

enum (AdType)

광고 유형의 열거형 값입니다.

adTypeString

string

광고 유형의 문자열 값입니다.

통합 필드 ad_format_oneof. 선택사항입니다. 게재된 광고의 유형입니다.

순수 열거형이 아닌 값을 처리하기 위해 원시 문자열이 허용됩니다. 가능하면 enum을 사용하는 것이 좋습니다. ad_format_oneof는 다음 중 하나여야 합니다.

adFormat

enum (AdFormat)

광고 형식의 열거형 값입니다.

adFormatString

string

광고 형식의 문자열 값입니다.

통합 필드 ad_placement_oneof. 선택사항입니다. 게재된 광고의 게재위치입니다.

순수 열거형이 아닌 값을 처리하기 위해 원시 문자열이 허용됩니다. 가능하면 enum을 사용하는 것이 좋습니다. ad_placement_oneof는 다음 중 하나여야 합니다.

adPlacement

enum (AdPlacement)

광고 게재위치의 열거형 값입니다.

adPlacementString

string

광고 게재위치의 문자열 값입니다.

통합 필드 targeting_type_oneof. 선택사항입니다. 광고를 게재하는 데 사용된 타겟팅 유형입니다.

순수 열거형이 아닌 값을 처리하기 위해 원시 문자열이 허용됩니다. 가능하면 enum을 사용하는 것이 좋습니다. targeting_type_oneof는 다음 중 하나여야 합니다.

targetingType

enum (TargetingType)

타겟팅 유형의 열거형 값입니다.

targetingTypeString

string

타겟팅 유형의 문자열 값입니다.

통합 필드 platform_type_oneof. 선택사항입니다. 광고가 게재된 플랫폼의 유형입니다.

순수 열거형이 아닌 값을 처리하기 위해 원시 문자열이 허용됩니다. 가능하면 enum을 사용하는 것이 좋습니다. platform_type_oneof는 다음 중 하나여야 합니다.

platformType

enum (PlatformType)

플랫폼 유형의 열거형 값입니다.

platformTypeString

string

플랫폼 유형의 문자열 값입니다.

통합 필드 platform_oneof. 선택사항입니다. 광고가 게재된 플랫폼의 세부정보입니다.

순수 열거형이 아닌 값을 처리하기 위해 원시 문자열이 허용됩니다. 가능하면 enum을 사용하는 것이 좋습니다. platform_oneof는 다음 중 하나여야 합니다.

platform

enum (Platform)

플랫폼의 열거형 값입니다.

platformString

string

플랫폼의 문자열 값입니다.

measurementAllowed

boolean

선택사항입니다. 지역 관할권 내 관련 개인 정보 보호법에 의거하여 행을 측정 목적으로 사용할 수 있는지 여부를 나타냅니다.

EventType

이벤트 유형입니다.

열거형
EVENT_TYPE_UNSPECIFIED 지정되지 않은 이벤트 유형입니다.
EVENT_TYPE_VIEW 이벤트를 봅니다.
EVENT_TYPE_CLICK 클릭 이벤트.

EventSubtype

광고 이벤트 유형에 관한 추가 분류입니다.

열거형
EVENT_SUBTYPE_UNSPECIFIED 지정되지 않은 이벤트 하위 유형입니다.
EVENT_SUBTYPE_IMPRESSION 노출 이벤트입니다.
EVENT_SUBTYPE_ENGAGED_VIEW 유효 조회 이벤트입니다.
EVENT_SUBTYPE_ONSITE_CLICK 온사이트 클릭 이벤트입니다.
EVENT_SUBTYPE_OUTBOUND_CLICK 외부 연결 링크 클릭 이벤트입니다.

AdType

게재된 광고의 유형입니다.

열거형
AD_TYPE_UNSPECIFIED 지정되지 않은 광고 유형입니다.
AD_TYPE_DISPLAY 디스플레이 광고
AD_TYPE_TEXT 텍스트 광고를 선택합니다.
AD_TYPE_IMAGE 이미지 광고
AD_TYPE_RICH_MEDIA 리치 미디어 광고입니다.
AD_TYPE_HTML HTML 광고입니다.
AD_TYPE_AUDIO 오디오 광고입니다.
AD_TYPE_VIDEO 동영상 광고

AdFormat

게재된 광고의 형식입니다.

열거형
AD_FORMAT_UNSPECIFIED 지정되지 않은 광고 형식입니다.
AD_FORMAT_AR AR 광고
AD_FORMAT_AUDIO 오디오 광고입니다.
AD_FORMAT_BANNER 배너 광고
AD_FORMAT_BUMPER 범퍼 광고
AD_FORMAT_COLLECTION 컬렉션 광고
AD_FORMAT_IMAGE 이미지 광고
AD_FORMAT_INTERACTIVE 양방향 광고
AD_FORMAT_INTERSTITIAL 전면 광고
AD_FORMAT_IN_FEED 인피드 광고
AD_FORMAT_IN_STREAM 인스트림 광고
AD_FORMAT_IN_STREAM_SKIPPABLE 건너뛸 수 있는 인스트림 광고입니다.
AD_FORMAT_IN_STREAM_NON_SKIPPABLE 인스트림 건너뛸 수 없는 광고입니다.
AD_FORMAT_NATIVE 네이티브 광고
AD_FORMAT_SHORTS Shorts 광고
AD_FORMAT_STORY 스토리 광고
AD_FORMAT_SPONSORED 스폰서 광고입니다.
AD_FORMAT_VIDEO 동영상 광고

AdPlacement

게재된 광고의 게재위치입니다.

열거형
AD_PLACEMENT_UNSPECIFIED 지정되지 않은 광고 게재위치입니다.
AD_PLACEMENT_DISCOVER 게재위치를 검색합니다.
AD_PLACEMENT_FEED 피드 배치
AD_PLACEMENT_HEADER 헤더 배치입니다.
AD_PLACEMENT_HOME 홈 배치
AD_PLACEMENT_IN_CONTENT 인콘텐츠 게재위치
AD_PLACEMENT_PROMOTED 프로모션 게재위치입니다.
AD_PLACEMENT_STORY 스토리 배치

TargetingType

광고를 게재하는 데 사용된 타겟팅 유형입니다.

열거형
TARGETING_TYPE_UNSPECIFIED 지정되지 않은 타겟팅 유형입니다.
TARGETING_TYPE_AUDIENCE 잠재고객 타겟팅
TARGETING_TYPE_CONTEXTUAL 문맥 타겟팅
TARGETING_TYPE_DEMOGRAPHIC 인구통계학적 타겟팅
TARGETING_TYPE_DEVICE 기기 타겟팅
TARGETING_TYPE_GEO 지역 타겟팅
TARGETING_TYPE_INTEREST 관심분야 타겟팅
TARGETING_TYPE_PURCHASE_INTENT 구매 의도 타겟팅
TARGETING_TYPE_REMARKETING 리마케팅 타겟팅입니다.

PlatformType

광고가 게재된 플랫폼의 유형입니다.

열거형
PLATFORM_TYPE_UNSPECIFIED 지정되지 않은 플랫폼 유형입니다.
PLATFORM_TYPE_MOBILE 모바일 플랫폼입니다.
PLATFORM_TYPE_DESKTOP 데스크톱 플랫폼
PLATFORM_TYPE_CTV CTV 플랫폼
PLATFORM_TYPE_PHONE 휴대전화 플랫폼
PLATFORM_TYPE_TABLET 태블릿 플랫폼

플랫폼

광고가 게재된 플랫폼의 세부정보입니다.

열거형
PLATFORM_UNSPECIFIED 지정되지 않은 플랫폼입니다.
PLATFORM_IOS iOS 플랫폼
PLATFORM_ANDROID Android 플랫폼
PLATFORM_WEB 웹 플랫폼

AttributionHint

이 광고 이벤트에 대해 파트너가 가정한 기여 분석 상태입니다.

열거형
ATTRIBUTION_HINT_UNSPECIFIED 알 수 없는 기여 분석 상태입니다.
ATTRIBUTION_HINT_CONVERTED 변환된 상태입니다.
ATTRIBUTION_HINT_NOT_CONVERTED 변환되지 않음 상태입니다.

ViewabilityInfo

게재된 광고의 조회가능성에 관한 세부정보입니다.

JSON 표현
{
  "viewType": enum (ViewType),
  "viewablePercent": integer,
  "viewableDuration": string,
  "mediaSkippable": boolean,
  "mediaQuartile": enum (MediaQuartile),
  "mediaDuration": string,
  "mediaVolumePercent": integer,
  "playbackDuration": string
}
필드
viewType

enum (ViewType)

필수 항목입니다. 이벤트 유형입니다.

viewablePercent

integer

선택사항입니다. 조회 가능한 픽셀의 숫자 비율 (0~100)입니다.

viewableDuration

string (Duration format)

선택사항입니다. 광고가 조회 가능했던 시간입니다.

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

mediaSkippable

boolean

선택사항입니다. 광고 미디어를 건너뛸 수 있는지 여부입니다.

mediaQuartile

enum (MediaQuartile)

선택사항입니다. 재생된 미디어의 양을 개별 사분위수로 나타냅니다.

mediaDuration

string (Duration format)

선택사항입니다. 광고 미디어의 길이입니다.

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

mediaVolumePercent

integer

선택사항입니다. 미디어 재생 볼륨의 숫자 백분율 (0~100)입니다.

playbackDuration

string (Duration format)

선택사항입니다. 조회 가능 여부와 관계없이 광고 미디어의 재생 시간입니다.

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

ViewType

이벤트 유형입니다.

열거형
VIEW_TYPE_UNSPECIFIED 지정되지 않은 보기 유형입니다.
VIEW_TYPE_MRC_VIEWED MRC 조회됨
VIEW_TYPE_MRC_RENDERED MRC 렌더링됨

MediaQuartile

재생된 미디어의 양을 개별 사분위수로 나타냅니다.

열거형
MEDIA_QUARTILE_UNSPECIFIED 지정되지 않은 미디어 사분위수입니다.
MEDIA_QUARTILE_START 시작 버튼입니다.
MEDIA_QUARTILE_FIRST_QUARTILE 1분위
MEDIA_QUARTILE_MIDPOINT 중간 지점입니다.
MEDIA_QUARTILE_THIRD_QUARTILE 3분위
MEDIA_QUARTILE_COMPLETE COMPLETE