Method: adEvents.ingest

Tải danh sách tài nguyên AdEvent lên Google Analytics.

Tính năng này chỉ dành cho những tài khoản có trong danh sách cho phép.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
Trường
adEvents[]

object (AdEvent)

Bắt buộc. Bắt buộc (ít nhất 1). Danh sách các sự kiện quảng cáo.
encryptionInfo

object (EncryptionInfo)

Không bắt buộc. Thông tin về các khoá mã hoá dùng để mã hoá dữ liệu.
validateOnly

boolean

Không bắt buộc. Nếu đúng, yêu cầu sẽ được xác thực nhưng không được thực thi.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ trống.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

AdEvent

Một sự kiện quảng cáo.

Biểu diễn dưới dạng 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
}
Trường
advertiserId

string

Bắt buộc. Mã nhận dạng của nhà quảng cáo cho sự kiện quảng cáo.

Mã này phải khớp với mã được gửi trong quy trình liên kết.
eventType

enum (EventType)

Bắt buộc. Loại sự kiện.
timestamp

string (Timestamp format)

Bắt buộc. Thời gian xảy ra sự kiện.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
eventId

string

Không bắt buộc. Mã do người gọi tạo và quản lý, dùng để xác định riêng sự kiện này.

Bắt buộc nếu bạn muốn loại bỏ sự kiện quảng cáo trùng lặp có trong nhiều yêu cầu. Nếu không, bạn không bắt buộc phải điền vào trường này.
userData

object (UserData)

Không bắt buộc. Nhiều phần dữ liệu do người dùng cung cấp, thể hiện người dùng mà sự kiện được liên kết.

Bạn có thể cung cấp nhiều thực thể của cùng một loại dữ liệu (ví dụ: địa chỉ email). Bạn cung cấp càng nhiều dữ liệu thì khả năng tìm thấy kết quả trùng khớp càng cao.
deviceInfo

object (DeviceInfo)

Không bắt buộc. Thông tin được thu thập về thiết bị đang được sử dụng khi sự kiện quảng cáo xảy ra.
mobileDeviceId

string

Không bắt buộc. Mã nhận dạng thiết bị của thiết bị mà quảng cáo được phân phát.
campaignId

string

Bắt buộc. Mã của chiến dịch được liên kết.
campaignName

string

Bắt buộc. Tên của chiến dịch được liên kết.
adGroupId

string

Không bắt buộc. Mã của nhóm quảng cáo được liên kết.
adId

string

Không bắt buộc. Mã nhận dạng của quảng cáo được liên kết trong nhóm.
adHeight

integer

Không bắt buộc. Chiều cao của quảng cáo tính bằng pixel.
adWidth

integer

Không bắt buộc. Chiều rộng của quảng cáo tính bằng pixel.
regionCode

string

Bắt buộc. Quốc gia và tiểu bang theo tiêu chuẩn ISO 3166-2.
source

string

Bắt buộc. Nguồn nền tảng của quảng cáo, tương tự như nguồn của Google Analytics.
medium

string

Bắt buộc. Phương tiện của quảng cáo, tương tự như phương tiện của Google Analytics.
attributionHint

enum (AttributionHint)

Không bắt buộc. Trạng thái phân bổ do đối tác giả định cho sự kiện quảng cáo này.

Đây chỉ là một tín hiệu cho biết cách đối tác giả định mô hình phân bổ đã diễn ra và không bắt buộc phải có kết quả cuối cùng trong báo cáo cuối cùng.
viewabilityInfo

object (ViewabilityInfo)

Bắt buộc. Thông tin chi tiết về khả năng xem của quảng cáo được phân phát.

Trường nhóm event_subtype_oneof. Không bắt buộc. Thông tin phân loại bổ sung về loại sự kiện quảng cáo.

Một chuỗi thô được chấp nhận để xử lý các giá trị khác ngoài enum thuần tuý. Enum được ưu tiên nếu có thể. event_subtype_oneof chỉ có thể là một trong những giá trị sau:
eventSubtype

enum (EventSubtype)

Giá trị enum cho loại sự kiện cụ thể.
eventSubtypeString

string

Giá trị chuỗi cho loại sự kiện cụ thể.

Trường nhóm ad_type_oneof. Không bắt buộc. Loại quảng cáo được phân phát.

Một chuỗi thô được chấp nhận để xử lý các giá trị khác ngoài enum thuần tuý. Enum được ưu tiên nếu có thể. ad_type_oneof chỉ có thể là một trong những giá trị sau:
adType

enum (AdType)

Giá trị enum cho loại quảng cáo.
adTypeString

string

Giá trị chuỗi cho loại quảng cáo.

Trường nhóm ad_format_oneof. Không bắt buộc. Loại quảng cáo được phân phát.

Một chuỗi thô được chấp nhận để xử lý các giá trị khác ngoài enum thuần tuý. Enum được ưu tiên nếu có thể. ad_format_oneof chỉ có thể là một trong những giá trị sau:
adFormat

enum (AdFormat)

Giá trị enum cho định dạng quảng cáo.
adFormatString

string

Giá trị chuỗi cho định dạng quảng cáo.

Trường nhóm ad_placement_oneof. Không bắt buộc. Vị trí đặt quảng cáo được phân phát.

Một chuỗi thô được chấp nhận để xử lý các giá trị khác ngoài enum thuần tuý. Enum được ưu tiên nếu có thể. ad_placement_oneof chỉ có thể là một trong những giá trị sau:
adPlacement

enum (AdPlacement)

Giá trị enum cho vị trí đặt quảng cáo.
adPlacementString

string

Giá trị chuỗi cho vị trí đặt quảng cáo.

Trường nhóm targeting_type_oneof. Không bắt buộc. Loại tiêu chí nhắm mục tiêu được dùng để phân phát quảng cáo.

Một chuỗi thô được chấp nhận để xử lý các giá trị khác ngoài enum thuần tuý. Enum được ưu tiên nếu có thể. targeting_type_oneof chỉ có thể là một trong những giá trị sau:
targetingType

enum (TargetingType)

Giá trị enum cho loại tiêu chí nhắm mục tiêu.
targetingTypeString

string

Giá trị chuỗi cho loại tiêu chí nhắm mục tiêu.

Trường nhóm platform_type_oneof. Không bắt buộc. Loại nền tảng mà quảng cáo được phân phát trên đó.

Một chuỗi thô được chấp nhận để xử lý các giá trị khác ngoài enum thuần tuý. Enum được ưu tiên nếu có thể. platform_type_oneof chỉ có thể là một trong những giá trị sau:
platformType

enum (PlatformType)

Giá trị enum cho loại nền tảng.
platformTypeString

string

Giá trị chuỗi cho loại nền tảng.

Trường nhóm platform_oneof. Không bắt buộc. Thông tin chi tiết hơn về nền tảng mà quảng cáo được phân phát.

Một chuỗi thô được chấp nhận để xử lý các giá trị khác ngoài enum thuần tuý. Enum được ưu tiên nếu có thể. platform_oneof chỉ có thể là một trong những giá trị sau:
platform

enum (Platform)

Giá trị enum cho nền tảng.
platformString

string

Giá trị chuỗi cho nền tảng.
measurementAllowed

boolean

Không bắt buộc. Cho biết liệu hàng có được phép sử dụng cho mục đích đo lường hay không, chịu sự điều chỉnh của luật về quyền riêng tư hiện hành trong phạm vi khu vực tài phán.

EventType

Loại sự kiện.

Enum
EVENT_TYPE_UNSPECIFIED Loại sự kiện chưa được chỉ định.
EVENT_TYPE_VIEW Xem sự kiện.
EVENT_TYPE_CLICK Sự kiện nhấp chuột.

EventSubtype

Thông tin phân loại bổ sung về loại sự kiện quảng cáo.

Enum
EVENT_SUBTYPE_UNSPECIFIED Loại sự kiện cụ thể chưa được chỉ định.
EVENT_SUBTYPE_IMPRESSION Sự kiện lượt hiển thị.
EVENT_SUBTYPE_ENGAGED_VIEW Sự kiện lượt xem có chủ đích.
EVENT_SUBTYPE_ONSITE_CLICK Sự kiện nhấp chuột trên trang web.
EVENT_SUBTYPE_OUTBOUND_CLICK Sự kiện lượt nhấp vào đường liên kết ngoài.

AdType

Loại quảng cáo được phân phát.

Enum
AD_TYPE_UNSPECIFIED Loại quảng cáo chưa được chỉ định.
AD_TYPE_DISPLAY Quảng cáo hiển thị.
AD_TYPE_TEXT Quảng cáo văn bản.
AD_TYPE_IMAGE Quảng cáo hình ảnh.
AD_TYPE_RICH_MEDIA Quảng cáo đa truyền thông.
AD_TYPE_HTML Quảng cáo HTML.
AD_TYPE_AUDIO Quảng cáo dạng âm thanh.
AD_TYPE_VIDEO Quảng cáo video.

AdFormat

Định dạng của quảng cáo được phân phát.

Enum
AD_FORMAT_UNSPECIFIED Định dạng quảng cáo không được chỉ định.
AD_FORMAT_AR Quảng cáo thực tế tăng cường.
AD_FORMAT_AUDIO Quảng cáo dạng âm thanh.
AD_FORMAT_BANNER Quảng cáo biểu ngữ.
AD_FORMAT_BUMPER Quảng cáo đệm.
AD_FORMAT_COLLECTION Quảng cáo bộ sưu tập.
AD_FORMAT_IMAGE Quảng cáo hình ảnh.
AD_FORMAT_INTERACTIVE Quảng cáo tương tác.
AD_FORMAT_INTERSTITIAL Quảng cáo xen kẽ.
AD_FORMAT_IN_FEED Quảng cáo trong nguồn cấp dữ liệu.
AD_FORMAT_IN_STREAM Quảng cáo trong luồng phát.
AD_FORMAT_IN_STREAM_SKIPPABLE Quảng cáo trong luồng phát có thể bỏ qua.
AD_FORMAT_IN_STREAM_NON_SKIPPABLE Quảng cáo trong luồng phát không thể bỏ qua.
AD_FORMAT_NATIVE Quảng cáo gốc.
AD_FORMAT_SHORTS Quảng cáo trên Shorts.
AD_FORMAT_STORY Quảng cáo câu chuyện.
AD_FORMAT_SPONSORED Quảng cáo được tài trợ.
AD_FORMAT_VIDEO Quảng cáo video.

AdPlacement

Vị trí đặt quảng cáo được phân phát.

Enum
AD_PLACEMENT_UNSPECIFIED Vị trí đặt quảng cáo chưa được chỉ định.
AD_PLACEMENT_DISCOVER Vị trí xuất hiện trên Discover.
AD_PLACEMENT_FEED Vị trí xuất hiện của nguồn cấp dữ liệu.
AD_PLACEMENT_HEADER Vị trí đầu trang.
AD_PLACEMENT_HOME Vị trí trên trang chủ.
AD_PLACEMENT_IN_CONTENT Vị trí trong nội dung.
AD_PLACEMENT_PROMOTED Vị trí được quảng bá.
AD_PLACEMENT_STORY Vị trí xuất hiện của câu chuyện.

TargetingType

Loại tiêu chí nhắm mục tiêu được dùng để phân phát quảng cáo.

Enum
TARGETING_TYPE_UNSPECIFIED Loại nhắm mục tiêu chưa được chỉ định.
TARGETING_TYPE_AUDIENCE Nhắm mục tiêu theo đối tượng.
TARGETING_TYPE_CONTEXTUAL Nhắm mục tiêu theo ngữ cảnh.
TARGETING_TYPE_DEMOGRAPHIC Nhắm mục tiêu theo nhân khẩu học.
TARGETING_TYPE_DEVICE Nhắm mục tiêu theo thiết bị.
TARGETING_TYPE_GEO Nhắm mục tiêu theo địa lý.
TARGETING_TYPE_INTEREST Nhắm mục tiêu theo mối quan tâm.
TARGETING_TYPE_PURCHASE_INTENT Nhắm mục tiêu theo ý định mua.
TARGETING_TYPE_REMARKETING Nhắm mục tiêu tái tiếp thị.

PlatformType

Loại nền tảng mà quảng cáo được phân phát trên đó.

Enum
PLATFORM_TYPE_UNSPECIFIED Loại nền tảng chưa được chỉ định.
PLATFORM_TYPE_MOBILE Nền tảng di động.
PLATFORM_TYPE_DESKTOP Nền tảng máy tính.
PLATFORM_TYPE_CTV Nền tảng CTV.
PLATFORM_TYPE_PHONE Nền tảng điện thoại.
PLATFORM_TYPE_TABLET Nền tảng máy tính bảng.

Nền tảng

Thông tin chi tiết hơn về nền tảng mà quảng cáo được phân phát.

Enum
PLATFORM_UNSPECIFIED Nền tảng không xác định.
PLATFORM_IOS Nền tảng iOS.
PLATFORM_ANDROID Nền tảng Android.
PLATFORM_WEB Nền tảng web.

AttributionHint

Trạng thái phân bổ do đối tác giả định cho sự kiện quảng cáo này.

Enum
ATTRIBUTION_HINT_UNSPECIFIED Trạng thái phân bổ không xác định.
ATTRIBUTION_HINT_CONVERTED Trạng thái đã chuyển đổi.
ATTRIBUTION_HINT_NOT_CONVERTED Trạng thái chưa chuyển đổi.

ViewabilityInfo

Thông tin chi tiết về khả năng xem của quảng cáo được phân phát.

Biểu diễn dưới dạng JSON 
{
  "viewType": enum (ViewType),
  "viewablePercent": integer,
  "viewableDuration": string,
  "mediaSkippable": boolean,
  "mediaQuartile": enum (MediaQuartile),
  "mediaDuration": string,
  "mediaVolumePercent": integer,
  "playbackDuration": string
}
Trường
viewType

enum (ViewType)

Bắt buộc. Loại sự kiện.
viewablePercent

integer

Không bắt buộc. Tỷ lệ phần trăm bằng số (0-100) của số pixel có thể xem được.
viewableDuration

string (Duration format)

Không bắt buộc. Thời lượng quảng cáo có thể xem được.

Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân và kết thúc bằng "s". Ví dụ: "3.5s".
mediaSkippable

boolean

Không bắt buộc. Nội dung quảng cáo có thể bỏ qua hay không.
mediaQuartile

enum (MediaQuartile)

Không bắt buộc. Lượng nội dung nghe nhìn đã phát dưới dạng các phần tư riêng biệt.
mediaDuration

string (Duration format)

Không bắt buộc. Thời lượng của nội dung quảng cáo.

Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân và kết thúc bằng "s". Ví dụ: "3.5s".
mediaVolumePercent

integer

Không bắt buộc. Tỷ lệ phần trăm bằng số (0-100) của âm lượng phát nội dung nghe nhìn.
playbackDuration

string (Duration format)

Không bắt buộc. Thời lượng phát nội dung quảng cáo, bất kể nội dung đó có xem được hay không.

Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân và kết thúc bằng "s". Ví dụ: "3.5s".

ViewType

Loại sự kiện.

Enum
VIEW_TYPE_UNSPECIFIED Loại khung hiển thị chưa được chỉ định.
VIEW_TYPE_MRC_VIEWED MRC đã xem.
VIEW_TYPE_MRC_RENDERED MRC đã hiển thị.

MediaQuartile

Lượng nội dung nghe nhìn đã phát dưới dạng các phần tư riêng biệt.

Enum
MEDIA_QUARTILE_UNSPECIFIED Tứ phân vị nội dung nghe nhìn không xác định.
MEDIA_QUARTILE_START Bắt đầu.
MEDIA_QUARTILE_FIRST_QUARTILE Tứ phân vị thứ nhất.
MEDIA_QUARTILE_MIDPOINT Điểm giữa.
MEDIA_QUARTILE_THIRD_QUARTILE Tứ phân vị thứ ba.
MEDIA_QUARTILE_COMPLETE Hoàn tất.