Method: events.ingest

Tải danh sách Event tài nguyên 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 có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "consent": {
    object (Consent)
  },
  "validateOnly": boolean,
  "encoding": enum (Encoding),
  "encryptionInfo": {
    object (EncryptionInfo)
  }
}
Trường
destinations[]

object (Destination)

Bắt buộc. Danh sách đích đến để gửi sự kiện đến.
events[]

object (Event)

Bắt buộc. Danh sách các sự kiện cần gửi đến những đích đến được chỉ định. Bạn có thể gửi tối đa 2.000 tài nguyên Event trong một yêu cầu.
consent

object (Consent)

Không bắt buộc. Sự đồng ý ở cấp yêu cầu sẽ á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 Event.
validateOnly

boolean

Không bắt buộc. Chỉ dùng cho mục đích kiểm thử. Nếu true, yêu cầu sẽ được xác thực nhưng không được thực thi. Chỉ trả về lỗi, không trả về kết quả.
encoding

enum (Encoding)

Không bắt buộc. Bắt buộc đối với tệp tải lên UserData. Loại mã hoá của giá trị nhận dạng người dùng. Đối với giá trị nhận dạng người dùng đã băm, đây là loại mã hoá của chuỗi đã băm. Đối với mã nhận dạng người dùng được băm đã mã hoá, đây là loại mã hoá của chuỗi được mã hoá bên ngoài, nhưng không nhất thiết phải là chuỗi được băm bên trong. Tức là chuỗi được băm bên trong có thể được mã hoá theo cách khác với chuỗi được mã hoá bên ngoài. Đối với các tệp tải lên không phải UserData, trường này sẽ bị bỏ qua.
encryptionInfo

object (EncryptionInfo)

Không bắt buộc. Thông tin mã hoá cho tệp UserData tải lên. Nếu bạn không đặt, thì hệ thống sẽ giả định rằng thông tin nhận dạng được tải lên đã được băm nhưng chưa được mã hoá. Đối với các tệp tải lên không phải UserData, trường này sẽ bị bỏ qua.

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
}
Trường
requestId

string

Mã nhận dạng được tạo tự động của yêu cầu.

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 đại diện cho 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 (UserData)
  },
  "consent": {
    object (Consent)
  },
  "adIdentifiers": {
    object (AdIdentifiers)
  },
  "currency": string,
  "conversionValue": number,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  }
}
Trường
destinationReferences[]

string

Không bắt buộc. Chuỗi tham chiếu dùng để xác định đích đến. Nếu trống, sự kiện sẽ được gửi đến tất cả destinations trong yêu cầu.
transactionId

string

Bắt buộc. Giá trị nhận dạng riêng biệt của sự kiện này.
eventTimestamp

string (Timestamp format)

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

Sử dụng RFC 3339, trong đó đầ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 độ 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".
lastUpdatedTimestamp

string (Timestamp format)

Không bắt buộc. Lần gần đây nhất sự kiện được cập nhật.

Sử dụng RFC 3339, trong đó đầ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 độ 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".
userData

object (UserData)

Không bắt buộc. Các 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.
consent

object (Consent)

Không bắt buộc. Thông tin về việc người dùng được liên kết có đồng ý với các loại đồng ý khác nhau hay không.
adIdentifiers

object (AdIdentifiers)

Không bắt buộc. Giá trị nhận dạng và thông tin khác được dùng để so khớp sự kiện chuyển đổi với hoạt động khác trên mạng (chẳng hạn như lượt nhấp vào quảng cáo).
currency

string

Không bắt buộc. Mã đơn vị tiền tệ được liên kết với tất cả giá trị bằng tiền trong sự kiện này.
conversionValue

number

Không bắt buộc. Giá trị lượt chuyển đổi được liên kết với sự kiện, đối với lượt chuyển đổi dựa trên giá trị.
eventSource

enum (EventSource)

Không bắt buộc. Tín hiệu cho biết nơi xảy ra sự kiện (trên web, ứng dụng, tại cửa hàng, v.v.).
eventDeviceInfo

object (DeviceInfo)

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

object (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[]

object (CustomVariable)

Không bắt buộc. Thông tin bổ sung về cặp khoá/giá trị để gửi đến các vùng chứa lượt chuyển đổi (hành động chuyển đổi hoặc hoạt động FL).
experimentalFields[]

object (ExperimentalField)

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 nâng cấp để trở thành một phần của API.
userProperties

object (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 xảy ra sự kiện.

AdIdentifiers

Giá trị nhận dạng và thông tin khác được dùng để so khớp sự kiện chuyển đổi với hoạt động khác trên mạng (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 (DeviceInfo)
  }
}
Trường
sessionAttributes

string

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

string

Không bắt buộc. Mã lượt nhấp của Google (gclid) được liên kết với sự kiện này.
gbraid

string

Không bắt buộc. Giá trị nhận dạng lượt nhấp cho các lượt nhấp được liên kết với sự kiện trong ứng dụng và bắt nguồn từ các thiết bị iOS bắt đầu từ iOS14.
wbraid

string

Không bắt buộc. Giá trị nhận dạng 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

object (DeviceInfo)

Không bắt buộc. Thông tin được thu thập về thiết bị đang được sử dụng (nếu có) tại thời điểm người dùng 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.

DeviceInfo

Thông tin về thiết bị đang được sử dụng (nếu có) khi sự kiện xảy ra.

Biểu diễn dưới dạng JSON 
{
  "userAgent": string,
  "ipAddress": string
}
Trường
userAgent

string

Không bắt buộc. Chuỗi tác nhân người dùng của thiết bị cho ngữ cảnh đã cho.
ipAddress

string

Không bắt buộc. Địa chỉ IP của thiết bị cho ngữ cảnh đã cho.

Lưu ý: Google Ads không hỗ trợ tính năng so khớp địa chỉ IP cho người dùng cuối ở Khu vực kinh tế Châu Âu (EEA), Vương quốc Anh (UK) hoặc Thuỵ Sĩ (CH). Thêm logic để loại trừ có điều kiện việc chia sẻ địa chỉ IP của người dùng ở những khu vực này và đảm bảo rằng bạn cung cấp cho người dùng thông tin rõ ràng và đầy đủ về dữ liệu mà bạn thu thập trên các trang web, ứng dụng và tài sản khác của mình, đồng thời nhận được sự đồng ý khi pháp luật hoặc bất kỳ chính sách nào hiện hành của Google yêu cầu. Hãy xem trang Giới thiệu về tính năng nhập lượt chuyển đổi ngoại tuyến để biết thêm thông tin chi tiết.

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 thực tế.
PHONE Sự kiện này được tạo từ một cuộc gọi điện thoại.
OTHER Sự kiện này được tạo từ các nguồn khác.

CartData

Dữ liệu giỏ hàng được 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 (Item)
    }
  ]
}
Trường
merchantId

string

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

string

Không bắt buộc. Nhãn nguồn cấp dữ liệu Merchant Center được liên kết với nguồn cấp dữ liệu của các mặt hàng.
merchantFeedLanguageCode

string

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

number

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[]

object (Item)

Không bắt buộc. Danh sách các mặt hàng liên kết với sự kiện.

Mục

Biểu thị một mặt hàng trong giỏ hàng được liên kết với sự kiện.

Biểu diễn dưới dạng JSON 
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number
}
Trường
merchantProductId

string

Không bắt buộc. Mã sản phẩm trong tài khoản Merchant Center.
quantity

string (int64 format)

Không bắt buộc. Số lượng mặt hàng này được liên kết với sự kiện.
unitPrice

number

Không bắt buộc. Giá của từng đơn vị hàng, 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.

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

string

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

string

Không bắt buộc. Giá trị cần lưu trữ cho biến tuỳ chỉnh.
destinationReferences[]

string

Không bắt buộc. Chuỗi tham chiếu dùng để xác định Event.destination_references nào mà biến tuỳ chỉnh sẽ được gửi đến. Nếu trống, Event.destination_references sẽ được dùng.

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

string

Không bắt buộc. Tên của trường cần sử dụng.
value

string

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 xảy ra sự kiện. 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 (CustomerType),
  "customerValueBucket": enum (CustomerValueBucket)
}
Trường
customerType

enum (CustomerType)

Không bắt buộc. Loại khách hàng liên kết với sự kiện.
customerValueBucket

enum (CustomerValueBucket)

Không bắt buộc. Giá trị do nhà quảng cáo đánh giá về khách hàng.

CustomerType

Loại khách hàng liên kết với sự kiện.

Enum
CUSTOMER_TYPE_UNSPECIFIED CustomerType chưa được chỉ định. Không bao giờ được sử dụng.
NEW Khách hàng đó là khách hàng mới của nhà quảng cáo.
RETURNING Khách hàng đang quay lại 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ị do nhà quảng cáo đánh giá về khách hàng.

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.