- Yêu cầu HTTP
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- Sự kiện
- AdIdentifiers
- EncryptedUserId
- EncryptionEntityType
- EncryptionSource
- EventSource
- CartData
- Item
- ItemParameter
- ItemCustomVariable
- CustomVariable
- ExperimentalField
- UserProperties
- CustomerType
- CustomerValueBucket
- UserProperty
- EventParameter
- EventLocation
- CallInfo
- Hãy làm thử!
Tải danh sách tài nguyên Event lên từ Destination được cung cấp.
Yêu cầu HTTP
POST https://datamanager.googleapis.com/v1/events: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 |
|---|
{ "destinations": [ { object ( |
| Trường | |
|---|---|
destinations[] |
Bắt buộc. Danh sách đích đến để gửi sự kiện. |
events[] |
Bắt buộc. Danh sách sự kiện cần gửi đến các đích đến được chỉ định. Bạn có thể gửi tối đa 2.000 tài nguyên |
consent |
Không bắt buộc. Sự đồng ý ở cấp yêu cầu để áp dụng cho tất cả người dùng trong yêu cầu. Sự đồng ý ở cấp người dùng sẽ ghi đè sự đồng ý ở cấp yêu cầu và có thể được chỉ định trong mỗi |
validateOnly |
Không bắt buộc. Dành cho mục đích thử nghiệm. Nếu |
encoding |
Không bắt buộc. Phải được cung cấp khi tải |
encryptionInfo |
Không bắt buộc. Thông tin mã hoá cho các tệp tải lên của |
Nội dung phản hồi
Câu trả lời của IngestEventsRequest.
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
| Biểu diễn dưới dạng JSON |
|---|
{
"requestId": string,
"fieldWarnings": [
{
object ( |
| Trường | |
|---|---|
requestId |
Mã được tạo tự động của yêu cầu. |
fieldWarnings[] |
Cảnh báo chi tiết ở cấp hàng kèm theo đường dẫn trường. |
Phạm vi uỷ quyền
Yêu cầu phạm vi OAuth sau:
https://www.googleapis.com/auth/datamanager
Sự kiện
Một sự kiện thể hiện hoạt động tương tác của người dùng với trang web hoặc ứng dụng của nhà quảng cáo.
| Biểu diễn dưới dạng JSON |
|---|
{ "destinationReferences": [ string ], "transactionId": string, "eventTimestamp": string, "lastUpdatedTimestamp": string, "userData": { object ( |
| Trường | |
|---|---|
destinationReferences[] |
Không bắt buộc. Chuỗi tham chiếu dùng để xác định đích đến. Nếu bạn để trống, sự kiện sẽ được gửi đến tất cả |
transactionId |
Không bắt buộc. Giá trị nhận dạng riêng biệt của sự kiện này. Bắt buộc đối với các sự kiện được gửi dưới dạng nguồn dữ liệu bổ sung cho lượt chuyển đổi được thẻ ghi lại. |
eventTimestamp |
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ụ: |
lastUpdatedTimestamp |
Không bắt buộc. Lần gần đây nhất sự kiện được cập nhật. 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ụ: |
userData |
Không bắt buộc. Các phần dữ liệu do người dùng cung cấp, đại diện cho người dùng liên kết với sự kiện. |
consent |
Không bắt buộc. Thông tin về việc người dùng liên kết đã cung cấp các loại sự đồng ý khác nhau hay chưa. |
adIdentifiers |
Không bắt buộc. Giá trị nhận dạng và thông tin khác dùng để so khớp sự kiện chuyển đổi với hoạt động trực tuyến khác (chẳng hạn như lượt nhấp vào quảng cáo). |
currency |
Không bắt buộc. Mã tiền tệ liên kết với tất cả giá trị bằng tiền trong sự kiện này. |
eventSource |
Không bắt buộc. Tín hiệu cho biết nơi sự kiện xảy ra (web, ứng dụng, tại cửa hàng, v.v.). |
eventDeviceInfo |
Không bắt buộc. Thông tin thu thập được về thiết bị đang được sử dụng (nếu có) khi sự kiện xảy ra. |
cartData |
Không bắt buộc. Thông tin về giao dịch và các mặt hàng liên quan đến sự kiện. |
customVariables[] |
Không bắt buộc. Thông tin bổ sung về cặp khoá-giá trị để gửi đến vùng chứa lượt chuyển đổi (hành động chuyển đổi hoặc hoạt động Floodlight). |
experimentalFields[] |
Không bắt buộc. Danh sách các cặp khoá/giá trị cho các trường thử nghiệm có thể được đưa vào API. |
userProperties |
Không bắt buộc. Thông tin do nhà quảng cáo đánh giá về người dùng tại thời điểm sự kiện xảy ra. |
eventName |
Không bắt buộc. Tên của sự kiện. Bắt buộc đối với sự kiện GA4. |
clientId |
Không bắt buộc. Giá trị nhận dạng riêng biệt cho phiên bản người dùng của một ứng dụng web cho luồng dữ liệu web GA4 này. |
userId |
Không bắt buộc. Giá trị nhận dạng riêng biệt cho một người dùng, do nhà quảng cáo xác định. |
additionalEventParameters[] |
Không bắt buộc. Một nhóm gồm mọi thông số sự kiện cần đưa vào sự kiện mà chưa được chỉ định bằng các trường có cấu trúc khác. |
thirdPartyUserData |
Không bắt buộc. Cùng một loại dữ liệu được cung cấp trong userData, nhưng được gắn cờ rõ ràng là do bên thứ ba cung cấp và không phải là dữ liệu của nhà quảng cáo bên thứ nhất. |
eventLocation |
Không bắt buộc. Thông tin thu thập được về vị trí của người dùng khi sự kiện này xảy ra. |
appInstanceId |
Không bắt buộc. Giá trị nhận dạng riêng biệt cho phiên bản người dùng của một ứng dụng khách cho luồng ứng dụng GA4 này. |
callInfo |
Không bắt buộc. Thông tin thu thập được về cuộc gọi (nếu có) dẫn đến sự kiện này. |
conversionValue |
Không bắt buộc. Giá trị lượt chuyển đổi liên kết với sự kiện, đối với lượt chuyển đổi dựa trên giá trị. |
conversionCount |
Không bắt buộc. Số lượng lượt chuyển đổi liên quan đến sự kiện, đối với lượt chuyển đổi dựa trên số lượt chuyển đổi. |
AdIdentifiers
Giá trị nhận dạng và thông tin khác dùng để so khớp sự kiện chuyển đổi với hoạt động trực tuyến khác (chẳng hạn như lượt nhấp vào quảng cáo).
| Biểu diễn dưới dạng JSON |
|---|
{ "sessionAttributes": string, "gclid": string, "gbraid": string, "wbraid": string, "landingPageDeviceInfo": { object ( |
| Trường | |
|---|---|
sessionAttributes |
Không bắt buộc. Thuộc tính của phiên để phân bổ và lập mô hình sự kiện. |
gclid |
Không bắt buộc. Mã lượt nhấp của Google (gclid) liên kết với sự kiện này. |
gbraid |
Không bắt buộc. Mã lượt nhấp cho các lượt nhấp được liên kết với sự kiện ứng dụng và bắt nguồn từ các thiết bị iOS bắt đầu từ iOS14. |
wbraid |
Không bắt buộc. Mã lượt nhấp cho các lượt nhấp được liên kết với sự kiện trên web và bắt nguồn từ các thiết bị iOS bắt đầu từ iOS14. |
landingPageDeviceInfo |
Không bắt buộc. Thông tin thu thập được về thiết bị đang được sử dụng (nếu có) tại thời điểm truy cập vào trang web của nhà quảng cáo sau khi tương tác với quảng cáo. |
mobileDeviceId |
Không bắt buộc. Mã nhận dạng thiết bị di động cho nhà quảng cáo. Đây sẽ là IDFA trên iOS, AdID trên Android hoặc giá trị nhận dạng của các nền tảng khác dành cho nhà quảng cáo. |
dclid |
Không bắt buộc. Mã lượt nhấp trên quảng cáo hiển thị liên kết với sự kiện này. |
impressionId |
Không bắt buộc. Mã lượt hiển thị liên kết với sự kiện này. |
matchId |
Không bắt buộc. Trường mã nhận dạng để so khớp dùng để kết hợp sự kiện này với một sự kiện trước đó. |
encryptedUserIds[] |
Không bắt buộc. Số lượng mã nhận dạng người dùng đã mã hoá bất kỳ. |
ppid |
Không bắt buộc. Giá trị nhận dạng riêng biệt cho người dùng đã xác thực (đã đăng nhập), do nhà xuất bản xác định. |
visitorPpid |
Không bắt buộc. Giá trị nhận dạng riêng biệt cho người dùng chưa được xác thực (người dùng chưa đăng nhập), do nhà xuất bản xác định. |
leadId |
Không bắt buộc. Mã nhận dạng do Google tạo và cấp khi người dùng gửi biểu mẫu khách hàng tiềm năng. |
EncryptedUserId
Giá trị nhận dạng người dùng được cấp để dùng cho hoạt động phân bổ. Bạn phải điền thông tin vào tất cả các trường nếu sử dụng trường này.
| Biểu diễn dưới dạng JSON |
|---|
{ "encryptedId": string, "entityType": enum ( |
| Trường | |
|---|---|
encryptedId |
Bắt buộc. Mã nhận dạng đã mã hoá gồm chữ và số. |
entityType |
Bắt buộc. Loại thực thể mã hoá. Giá trị này phải khớp với cấu hình mã hoá cho hoạt động phân phát quảng cáo hoặc Chuyển dữ liệu. |
entityId |
Bắt buộc. Mã nhận dạng thực thể mã hoá. Giá trị này phải khớp với cấu hình mã hoá cho hoạt động phân phát quảng cáo hoặc Chuyển dữ liệu. |
source |
Bắt buộc. Mô tả liệu cookie đã mã hoá được nhận từ hoạt động phân phát quảng cáo (macro %m) hay từ tính năng Chuyển dữ liệu. |
EncryptionEntityType
Loại thực thể mã hoá.
| Enum | |
|---|---|
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED |
Loại thực thể mã hoá không xác định. |
CAMPAIGN_MANAGER_ACCOUNT |
Tài khoản Campaign Manager 360. |
CAMPAIGN_MANAGER_ADVERTISER |
nhà quảng cáo Campaign Manager 360. |
DISPLAY_VIDEO_PARTNER |
Đối tác Display & Video 360. |
DISPLAY_VIDEO_ADVERTISER |
Nhà quảng cáo Display & Video 360. |
GOOGLE_ADS_CUSTOMER |
khách hàng Google Ads. |
GOOGLE_AD_MANAGER_NETWORK_CODE |
Mã mạng Google Ad Manager. |
EncryptionSource
Nguồn mã hoá.
| Enum | |
|---|---|
ENCRYPTION_SOURCE_UNSPECIFIED |
Nguồn mã hoá không xác định. |
AD_SERVING |
Nguồn mã hoá phân phát quảng cáo. |
DATA_TRANSFER |
Nguồn mã hoá khi chuyển dữ liệu. |
EventSource
Nguồn của sự kiện.
| Enum | |
|---|---|
EVENT_SOURCE_UNSPECIFIED |
EventSource chưa được chỉ định. Không bao giờ được sử dụng. |
WEB |
Sự kiện này được tạo từ một trình duyệt web. |
APP |
Sự kiện này được tạo từ một ứng dụng. |
IN_STORE |
Sự kiện này được tạo từ một giao dịch tại cửa hàng. |
PHONE |
Sự kiện này được tạo từ một cuộc gọi điện thoại. |
MESSAGE |
Sự kiện này được tạo từ một tin nhắn. |
OTHER |
Sự kiện này được tạo từ các nguồn khác. |
CartData
Dữ liệu giỏ hàng liên kết với sự kiện.
| Biểu diễn dưới dạng JSON |
|---|
{
"merchantId": string,
"merchantFeedLabel": string,
"merchantFeedLanguageCode": string,
"transactionDiscount": number,
"items": [
{
object ( |
| Trường | |
|---|---|
merchantId |
Không bắt buộc. Mã truy cập Merchant Center được liên kết với các mặt hàng. |
merchantFeedLabel |
Không bắt buộc. Nhãn nguồn cấp dữ liệu Merchant Center liên kết với nguồn cấp dữ liệu của các mặt hàng. |
merchantFeedLanguageCode |
Không bắt buộc. Mã ngôn ngữ theo tiêu chuẩn ISO 639-1 liên kết với nguồn cấp dữ liệu Merchant Center của các mặt hàng mà bạn đã tải lên. |
transactionDiscount |
Không bắt buộc. Tổng tất cả các khoản chiết khấu liên quan đến giao dịch. |
items[] |
Không bắt buộc. Danh sách các mặt hàng liên kết với sự kiện. |
couponCodes[] |
Không bắt buộc. Danh sách mã giảm giá đã được áp dụng cho giỏ hàng. Mã giảm giá ở cấp giỏ hàng và cấp mặt hàng là độc lập với nhau. Nếu sự kiện dành cho một đích đến Google Analytics, hãy chỉ cung cấp một mã giảm giá. Google Analytics sẽ bỏ qua các mã giảm giá khác. |
Mục
Đại diện cho một mặt hàng trong giỏ hàng liên quan đến sự kiện.
| Biểu diễn dưới dạng JSON |
|---|
{ "merchantProductId": string, "quantity": string, "unitPrice": number, "itemId": string, "additionalItemParameters": [ { object ( |
| Trường | |
|---|---|
merchantProductId |
Không bắt buộc. Mã sản phẩm trong tài khoản Merchant Center. |
quantity |
Không bắt buộc. Số lượng mặt hàng này liên quan đến sự kiện. |
unitPrice |
Không bắt buộc. Đơn giá chưa bao gồm thuế, phí vận chuyển và mọi khoản chiết khấu ở cấp giao dịch. |
itemId |
Không bắt buộc. Giá trị nhận dạng riêng biệt để tham chiếu đến mặt hàng. |
additionalItemParameters[] |
Không bắt buộc. Một nhóm gồm mọi thông số sự kiện liên quan đến một mặt hàng cần được đưa vào sự kiện chưa được chỉ định bằng các trường có cấu trúc khác. |
merchantId |
Không bắt buộc. Mã truy cập Merchant Center được liên kết với mặt hàng. Đối với sự kiện bán hàng tại cửa hàng thực tế, giá trị này sẽ ghi đè giá trị được đặt ở cấp giỏ hàng. Trường này bị bỏ qua đối với các sự kiện khác. |
merchantFeedLabel |
Không bắt buộc. Nhãn nguồn cấp dữ liệu của nguồn cấp dữ liệu Merchant Center. Nếu vẫn sử dụng quốc gia, bạn có thể dùng mã quốc gia gồm 2 chữ cái theo chuẩn ISO-3166-1 alpha-2. Đối với sự kiện bán hàng tại cửa hàng thực tế, giá trị này sẽ ghi đè giá trị được đặt ở cấp giỏ hàng. Trường này bị bỏ qua đối với các sự kiện khác. |
merchantFeedLanguageCode |
Không bắt buộc. Mã ngôn ngữ theo tiêu chuẩn ISO 639-1 liên kết với nguồn cấp dữ liệu Merchant Center chứa những mặt hàng mà bạn đã tải lên. |
customVariables[] |
Không bắt buộc. Thông tin bổ sung về cặp khoá-giá trị để gửi đến vùng chứa lượt chuyển đổi (hành động chuyển đổi hoặc hoạt động Floodlight) khi theo dõi lượt chuyển đổi theo từng mặt hàng. |
conversionValue |
Không bắt buộc. Giá trị chuyển đổi liên kết với mục này trong sự kiện, đối với những trường hợp giá trị chuyển đổi khác nhau cho mỗi mục. |
ItemParameter
Một nhóm gồm mọi thông số sự kiện liên quan đến một mặt hàng cần được đưa vào sự kiện chưa được chỉ định bằng các trường có cấu trúc khác.
| Biểu diễn dưới dạng JSON |
|---|
{ "parameterName": string, "value": string } |
| Trường | |
|---|---|
parameterName |
Bắt buộc. Tên của tham số cần sử dụng. |
value |
Bắt buộc. Biểu thị chuỗi của giá trị tham số cần đặt. |
ItemCustomVariable
Biến tuỳ chỉnh ở cấp mặt hàng cho lượt chuyển đổi từ quảng cáo.
| Biểu diễn dưới dạng JSON |
|---|
{ "variable": string, "value": string, "destinationReferences": [ string ] } |
| Trường | |
|---|---|
variable |
Không bắt buộc. Tên của biến tuỳ chỉnh cần đặt. Nếu không tìm thấy biến cho đích đến đã cho, biến đó sẽ bị bỏ qua. |
value |
Không bắt buộc. Giá trị cần lưu trữ cho biến tuỳ chỉnh. |
destinationReferences[] |
Không bắt buộc. Chuỗi tham chiếu dùng để xác định |
CustomVariable
Biến tuỳ chỉnh cho lượt chuyển đổi từ quảng cáo.
| Biểu diễn dưới dạng JSON |
|---|
{ "variable": string, "value": string, "destinationReferences": [ string ] } |
| Trường | |
|---|---|
variable |
Không bắt buộc. Tên của biến tuỳ chỉnh cần đặt. Nếu không tìm thấy biến cho đích đến đã cho, biến đó sẽ bị bỏ qua. |
value |
Không bắt buộc. Giá trị cần lưu trữ cho biến tuỳ chỉnh. |
destinationReferences[] |
Không bắt buộc. Chuỗi tham chiếu dùng để xác định |
ExperimentalField
Trường thử nghiệm đại diện cho các trường không chính thức.
| Biểu diễn dưới dạng JSON |
|---|
{ "field": string, "value": string } |
| Trường | |
|---|---|
field |
Không bắt buộc. Tên của trường cần sử dụng. |
value |
Không bắt buộc. Giá trị của trường cần đặt. |
UserProperties
Thông tin do nhà quảng cáo đánh giá về người dùng tại thời điểm sự kiện xảy ra. Hãy xem https://support.google.com/google-ads/answer/14007601 để biết thêm thông tin.
| Biểu diễn dưới dạng JSON |
|---|
{ "customerType": enum ( |
| Trường | |
|---|---|
customerType |
Không bắt buộc. Loại khách hàng liên kết với sự kiện. |
customerValueBucket |
Không bắt buộc. Giá trị của khách hàng do nhà quảng cáo đánh giá. |
additionalUserProperties[] |
Không bắt buộc. Một nhóm chứa mọi thuộc tính người dùng bổ sung cho người dùng liên kết với sự kiện này. |
CustomerType
Loại khách hàng liên kết với sự kiện.
| Enum | |
|---|---|
CUSTOMER_TYPE_UNSPECIFIED |
CustomerType không xác định. Không bao giờ được sử dụng. |
NEW |
Khách hàng mới đối với nhà quảng cáo. |
RETURNING |
Khách hàng đang quay lại trang web của nhà quảng cáo. |
REENGAGED |
Khách hàng đã tương tác lại với nhà quảng cáo. |
CustomerValueBucket
Giá trị của khách hàng do nhà quảng cáo đánh giá.
| Enum | |
|---|---|
CUSTOMER_VALUE_BUCKET_UNSPECIFIED |
CustomerValueBucket chưa xác định. Không bao giờ được sử dụng. |
LOW |
Khách hàng có giá trị thấp. |
MEDIUM |
Khách hàng có giá trị trung bình. |
HIGH |
Khách hàng có giá trị cao. |
UserProperty
Một nhóm chứa mọi thuộc tính người dùng bổ sung cho người dùng liên kết với sự kiện này.
| Biểu diễn dưới dạng JSON |
|---|
{ "propertyName": string, "value": string } |
| Trường | |
|---|---|
propertyName |
Bắt buộc. Tên của thuộc tính người dùng cần sử dụng. |
value |
Bắt buộc. Chuỗi biểu thị giá trị của thuộc tính người dùng cần sử dụng. |
EventParameter
Thông số sự kiện cho các sự kiện GA4.
| Biểu diễn dưới dạng JSON |
|---|
{ "parameterName": string, "value": string } |
| Trường | |
|---|---|
parameterName |
Bắt buộc. Tên của tham số cần sử dụng. |
value |
Bắt buộc. Biểu thị chuỗi của giá trị tham số cần đặt. |
EventLocation
Vị trí diễn ra sự kiện.
| Biểu diễn dưới dạng JSON |
|---|
{ "storeId": string, "city": string, "subdivisionCode": string, "regionCode": string, "subcontinentCode": string, "continentCode": string } |
| Trường | |
|---|---|
storeId |
Không bắt buộc. Bắt buộc đối với lượt bán hàng tại cửa hàng thực tế. Giá trị nhận dạng đại diện cho một cửa hàng thực tế nơi sự kiện diễn ra. |
city |
Không bắt buộc. Tên thành phố nơi sự kiện xảy ra. |
subdivisionCode |
Không bắt buộc. Mã phân khu theo ISO 3166-2 nơi sự kiện xảy ra. |
regionCode |
Không bắt buộc. Mã vùng CLDR gồm 2 chữ cái trong địa chỉ của người dùng. |
subcontinentCode |
Không bắt buộc. Mã tiểu lục địa theo định dạng UN M49 nơi sự kiện xảy ra. |
continentCode |
Không bắt buộc. Mã châu lục theo định dạng UN M49 nơi xảy ra sự kiện. |
CallInfo
Thông tin thu thập được về cuộc gọi (nếu có) dẫn đến sự kiện này.
| Biểu diễn dưới dạng JSON |
|---|
{ "startTimestamp": string } |
| Trường | |
|---|---|
startTimestamp |
Bắt buộc. Thời gian bắt đầu cuộc gọi điện thoại dẫn đến sự kiện này. 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ụ: |