- Tài nguyên: Báo cáo
- ReportDefinition
- Kích thước
- Chỉ số
- Bộ lọc
- FieldFilter
- Trường
- Thao tác
- ReportValue
- IntList
- StringList
- DoubleList
- FilterList
- TimeZoneSource
- DateRange
- FixedDateRange
- Ngày
- RelativeDateRange
- Sắp xếp
- Phương thức
Tài nguyên: Báo cáo
Tài nguyên Report.
| Biểu diễn dưới dạng JSON |
|---|
{
"name": string,
"reportId": string,
"reportDefinition": {
object ( |
| Trường | |
|---|---|
name |
Giá trị nhận dạng. Tên tài nguyên của báo cáo. Tên tài nguyên báo cáo có dạng: |
reportId |
Chỉ có đầu ra. Mã báo cáo. |
reportDefinition |
Bắt buộc. Định nghĩa báo cáo của báo cáo. |
displayName |
Không bắt buộc. Tên hiển thị của báo cáo. |
updateTime |
Chỉ có đầu ra. Thời điểm báo cáo này được sửa đổi gần đây 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ụ: |
createTime |
Chỉ có đầu ra. Thời điểm tạo báo cáo 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ụ: |
locale |
Chỉ có đầu ra. Ngôn ngữ của báo cáo này. Ngôn ngữ được đặt theo ngôn ngữ của người dùng tại thời điểm yêu cầu. Không thể sửa đổi ngôn ngữ. |
ReportDefinition
Định nghĩa về cách chạy báo cáo.
| Biểu diễn dưới dạng JSON |
|---|
{ "dimensions": [ enum ( |
| Trường | |
|---|---|
dimensions[] |
Bắt buộc. Danh sách các phương diện cần báo cáo. Nếu để trống, báo cáo sẽ không có phương diện và mọi chỉ số sẽ là tổng số. |
metrics[] |
Bắt buộc. Danh sách các chỉ số cần báo cáo. Nếu trống, báo cáo sẽ không có chỉ số. |
filters[] |
Không bắt buộc. Bộ lọc cho báo cáo này. |
timeZoneSource |
Không bắt buộc. Nơi lấy múi giờ cho báo cáo này. Mặc định sử dụng múi giờ Thái Bình Dương (PT). Nếu nguồn là PROVIDED, thì trường timeZone trong định nghĩa báo cáo cũng phải đặt múi giờ. |
timeZone |
Không bắt buộc. Nếu timeZoneSource là PROVIDED, thì đây là múi giờ được sử dụng cho báo cáo này. Để trống nếu bạn muốn sử dụng nguồn múi giờ khác. Múi giờ theo định dạng IANA. Ví dụ: "America/New_York". |
currencyCode |
Không bắt buộc. Mã tiền tệ ISO 4217 cho báo cáo này. Mặc định là mã tiền tệ của tài khoản nếu không được chỉ định. |
dateRange |
Bắt buộc. Phạm vi ngày chính của báo cáo này. |
sorts[] |
Không bắt buộc. Cách sắp xếp mặc định để áp dụng cho báo cáo này. |
Phương diện
Phương diện báo cáo.
| Enum | |
|---|---|
DIMENSION_UNSPECIFIED |
Giá trị mặc định. Giá trị này không được sử dụng. |
ADVERTISER_DOMAIN |
Miền của nhà quảng cáo. |
COUNTRY |
Tên hiển thị của một quốc gia. |
CURATION_DATA_SEGMENT_ID |
Mã nhận dạng của phân khúc dữ liệu do một nhà tuyển chọn tạo. |
CURATION_DATA_SEGMENT_RESPONSE_STATUS |
Trạng thái phản hồi của các yêu cầu phân khúc dữ liệu trong tính năng Chọn lọc theo thời gian thực. Hãy tham khảo https://developers.google.com/authorized-buyers/curation/get-started/start để biết thông tin chi tiết. |
CURATION_DATA_SEGMENT_RESPONSE_STATUS_NAME |
Tên hiển thị được bản địa hoá của trạng thái phản hồi cho các yêu cầu về phân khúc dữ liệu trong tính năng Chọn lọc theo thời gian thực. Hãy tham khảo https://developers.google.com/authorized-buyers/curation/get-started/start để biết thông tin chi tiết. |
CURATOR_FEE_TYPE |
Loại dịch vụ tuyển chọn (ví dụ: gói hoặc phân khúc dữ liệu). |
DATE |
Ngày. |
DEAL_ID |
Mã giao dịch. |
DEAL_NAME |
Tên thoả thuận. |
DETECTED_ADVERTISER_NAME |
Tên hiển thị của nhà quảng cáo được phát hiện. |
DSP_NAME |
Tên hiển thị của DSP. |
DSP_SEAT_ID |
Mã giấy phép DSP. |
ENVIRONMENT |
Thiết bị của người dùng và môi trường vùng chứa nơi lượt hiển thị bắt nguồn. Các giá trị được hỗ trợ là "app" và "web". |
ENVIRONMENT_NAME |
Tên hiển thị đã bản địa hoá của thiết bị người dùng và môi trường vùng chứa nơi lượt hiển thị bắt nguồn. Các giá trị được hỗ trợ là "app" và "web". |
HOLDING_COMPANY_NAME |
Tên hiển thị của công ty cổ phần. |
HOUR |
Giờ. |
MOBILE_APP_ID |
Mã ứng dụng di động. |
MOBILE_APP_NAME |
Tên ứng dụng di động. |
MOBILE_OS |
Hệ điều hành di động. |
MONTH |
Tháng. |
PACKAGE_FEE_VISIBILITY |
Chế độ hiển thị phí gói (ví dụ: được công bố hoặc không được công bố). |
PLATFORM |
Nền tảng, ví dụ: "máy tính" so với "thiết bị di động". |
PUBLISHER_DOMAIN |
Miền của nhà xuất bản. |
PUBLISHER_ID |
Giá trị nhận dạng nhà xuất bản. |
PUBLISHER_NAME |
Tên nhà xuất bản. |
WEEK |
Tuần. |
Chỉ số
Chỉ số báo cáo.
| Enum | |
|---|---|
METRIC_UNSPECIFIED |
Giá trị mặc định. Giá trị này không được sử dụng. |
ACTIVE_VIEW_MEASURABILITY_RATE |
Tỷ lệ có thể đo lường bằng Active View. |
ACTIVE_VIEW_MEASURABLE |
Có thể đo lường bằng Active View. |
ACTIVE_VIEW_VIEWABILITY_RATE |
Tỷ lệ có thể xem trong Chế độ xem đang kích hoạt. |
ACTIVE_VIEW_VIEWABLE |
Số lượt hiển thị có thể xem được theo Active View |
AUCTIONS_WON |
Phiên đấu giá đã thắng. |
BIDS |
Giá thầu. |
BIDS_IN_AUCTION |
Số giá thầu trong phiên đấu giá. |
BID_REQUESTS |
Yêu cầu giá thầu. |
CLICKS |
Số lượt nhấp. |
CURATION_PARTNER_FEE |
Phí của người giám tuyển. Giá trị này sẽ được điều chỉnh thành 0 nếu chế độ hiển thị của gói được đặt thành không công khai. Sử dụng phương diện PACKAGE_FEE_VISIBILITY để kiểm tra xem phí của gói có được công bố hay không. |
DATA_SEGMENT_REQUESTS |
Số lượng yêu cầu phân khúc dữ liệu được gửi trong tính năng Chọn lọc theo thời gian thực. |
IMPRESSIONS |
Số lượt hiển thị. |
SPEND |
Mức chi tiêu theo đơn vị tiền tệ dùng cho báo cáo được chỉ định trong yêu cầu. Mặc định là USD. |
Bộ lọc
Bộ lọc trên một hoặc nhiều trường.
| Biểu diễn dưới dạng JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "fieldFilter": { object ( |
| Trường | |
|---|---|
| Loại này xác định cách kết hợp các bộ lọc cơ bản. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi: | |
fieldFilter |
Bộ lọc trên một trường. |
notFilter |
Một bộ lọc có kết quả bị phủ định. |
andFilter |
Danh sách các bộ lọc có kết quả được kết hợp bằng toán tử AND. |
orFilter |
Danh sách các bộ lọc có kết quả được kết hợp bằng toán tử OR. |
| Kết thúc các trường loại trừ lẫn nhau. | |
FieldFilter
Bộ lọc trên một trường cụ thể.
| Biểu diễn dưới dạng JSON |
|---|
{ "field": { object ( |
| Trường | |
|---|---|
field |
Bắt buộc. Trường cần lọc. |
operation |
Bắt buộc. Toán tử của bộ lọc này. |
values[] |
Bắt buộc. Giá trị để lọc. |
Trường
Một phương diện hoặc chỉ số trong báo cáo.
| Biểu diễn dưới dạng JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "dimension": enum ( |
| Trường | |
|---|---|
| Phương diện hoặc chỉ số. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi: | |
dimension |
Phương diện mà trường này đại diện. |
metric |
Chỉ số mà trường này đại diện. |
| Kết thúc các trường loại trừ lẫn nhau. | |
Hoạt động
Các toán tử lọc được hỗ trợ.
| Enum | |
|---|---|
IN |
Đối với toán hạng vô hướng, hãy kiểm tra xem toán hạng có nằm trong tập hợp các giá trị bộ lọc được cung cấp hay không. Đối với toán hạng danh sách, hãy kiểm tra xem có phần tử nào trong toán hạng nằm trong tập hợp các giá trị bộ lọc được cung cấp hay không. Giá trị mặc định. |
NOT_IN |
Đối với toán hạng vô hướng, hãy kiểm tra để đảm bảo toán hạng không nằm trong tập hợp các giá trị bộ lọc được cung cấp. Đối với toán hạng danh sách, hãy kiểm tra để đảm bảo không có phần tử nào trong toán hạng nằm trong tập hợp các giá trị bộ lọc được cung cấp. |
CONTAINS |
Đối với toán hạng chuỗi vô hướng, hãy kiểm tra xem toán hạng có chứa bất kỳ chuỗi con nào của bộ lọc được cung cấp hay không. Đối với toán hạng danh sách chuỗi, hãy kiểm tra xem có chuỗi nào trong toán hạng chứa bất kỳ chuỗi con nào của bộ lọc được cung cấp hay không. |
NOT_CONTAINS |
Đối với toán hạng chuỗi vô hướng, hãy kiểm tra để đảm bảo toán hạng không chứa chuỗi con nào của bộ lọc được cung cấp. Đối với toán hạng danh sách chuỗi, hãy kiểm tra để đảm bảo rằng không có chuỗi nào trong toán hạng chứa chuỗi con của bộ lọc được cung cấp. |
LESS_THAN |
Toán hạng nhỏ hơn giá trị bộ lọc được cung cấp. |
LESS_THAN_EQUALS |
Toán hạng nhỏ hơn hoặc bằng giá trị bộ lọc đã cung cấp. |
GREATER_THAN |
Toán hạng lớn hơn giá trị bộ lọc được cung cấp. |
GREATER_THAN_EQUALS |
Toán hạng lớn hơn hoặc bằng giá trị bộ lọc được cung cấp. |
BETWEEN |
Toán hạng nằm giữa các giá trị bộ lọc được cung cấp. |
MATCHES |
Toán hạng khớp với một biểu thức chính quy hoặc một tập hợp biểu thức chính quy (một biểu thức phải khớp). |
NOT_MATCHES |
Toán hạng không khớp với một biểu thức chính quy hoặc một tập hợp biểu thức chính quy (không có biểu thức nào khớp). |
ReportValue
Đại diện cho một giá trị duy nhất trong báo cáo.
| Biểu diễn dưới dạng JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "intValue": string, "doubleValue": number, "stringValue": string, "boolValue": boolean, "intListValue": { object ( |
| Trường | |
|---|---|
| Giá trị của trường, phụ thuộc vào định dạng dữ liệu của trường. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi: | |
intValue |
Đối với các giá trị số nguyên. |
doubleValue |
Đối với giá trị kiểu double. |
stringValue |
Đối với các giá trị chuỗi. |
boolValue |
Đối với giá trị boolean. |
intListValue |
Đối với danh sách các giá trị số nguyên. |
stringListValue |
Đối với danh sách các giá trị chuỗi. |
doubleListValue |
Đối với danh sách các giá trị double. |
bytesValue |
Đối với giá trị byte. Một chuỗi được mã hoá base64. |
| Kết thúc các trường loại trừ lẫn nhau. | |
IntList
Danh sách các giá trị số nguyên.
| Biểu diễn dưới dạng JSON |
|---|
{ "values": [ string ] } |
| Trường | |
|---|---|
values[] |
Giá trị |
StringList
Danh sách các giá trị chuỗi.
| Biểu diễn dưới dạng JSON |
|---|
{ "values": [ string ] } |
| Trường | |
|---|---|
values[] |
Giá trị |
DoubleList
Danh sách các giá trị kiểu double.
| Biểu diễn dưới dạng JSON |
|---|
{ "values": [ number ] } |
| Trường | |
|---|---|
values[] |
Giá trị |
FilterList
Danh sách bộ lọc.
| Biểu diễn dưới dạng JSON |
|---|
{
"filters": [
{
object ( |
| Trường | |
|---|---|
filters[] |
Bắt buộc. Danh sách bộ lọc. |
TimeZoneSource
Nguồn để xác định múi giờ cho báo cáo.
| Enum | |
|---|---|
TIME_ZONE_SOURCE_UNSPECIFIED |
Giá trị mặc định chưa xác định. |
AD_EXCHANGE |
Sử dụng múi giờ Thái Bình Dương(PT). |
UTC |
Sử dụng múi giờ UTC. |
PROVIDED |
Sử dụng múi giờ được cung cấp trong trường ReportDefinition.time_zone. Báo cáo có thể mất nhiều thời gian hơn để chạy vì ngày được tính toán linh động tại thời điểm yêu cầu. |
CURATOR |
Sử dụng múi giờ trong phần cài đặt tài khoản của người quản lý. |
DateRange
Phạm vi ngày cho báo cáo.
| Biểu diễn dưới dạng JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "fixed": { object ( |
| Trường | |
|---|---|
| Phạm vi ngày cố định hoặc tương đối. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi: | |
fixed |
Phạm vi ngày cố định. |
relative |
Phạm vi ngày tương đối. |
| Kết thúc các trường loại trừ lẫn nhau. | |
FixedDateRange
Phạm vi ngày giữa hai ngày cố định (bao gồm cả ngày kết thúc).
| Biểu diễn dưới dạng JSON |
|---|
{ "startDate": { object ( |
| Trường | |
|---|---|
startDate |
Bắt buộc. Ngày bắt đầu của phạm vi ngày này. |
endDate |
Bắt buộc. Ngày kết thúc (bao gồm cả ngày này) của phạm vi ngày này. |
Ngày
Biểu thị một ngày dương lịch đầy đủ hoặc một phần, chẳng hạn như ngày sinh. Thời gian trong ngày và múi giờ được chỉ định ở nơi khác hoặc không quan trọng. Ngày này được tính theo Dương lịch. Điều này có thể đại diện cho một trong những trường hợp sau:
- Ngày đầy đủ, có giá trị năm, tháng và ngày khác 0.
- Tháng và ngày, với năm bằng 0 (ví dụ: ngày kỷ niệm).
- Chỉ có năm, tháng và ngày bằng 0.
- Năm và tháng, với ngày bằng 0 (ví dụ: ngày hết hạn của thẻ tín dụng).
Các loại liên quan:
google.type.TimeOfDaygoogle.type.DateTimegoogle.protobuf.Timestamp
| Biểu diễn dưới dạng JSON |
|---|
{ "year": integer, "month": integer, "day": integer } |
| Trường | |
|---|---|
year |
Năm của ngày. Phải từ 1 đến 9999 hoặc 0 để chỉ định ngày không có năm. |
month |
Tháng trong năm. Phải từ 1 đến 12 hoặc 0 để chỉ định một năm không có tháng và ngày. |
day |
Ngày trong tháng. Phải từ 1 đến 31 và hợp lệ cho năm và tháng, hoặc 0 để chỉ định một năm hoặc một năm và tháng mà ngày không quan trọng. |
RelativeDateRange
Các lựa chọn cho phạm vi ngày tương đối.
| Enum | |
|---|---|
RELATIVE_DATE_RANGE_UNSPECIFIED |
Giá trị mặc định. Giá trị này không được sử dụng. |
TODAY |
Ngày chạy báo cáo. |
YESTERDAY |
Ngày trước ngày chạy báo cáo. |
THIS_WEEK_TO_DATE |
Từ đầu tuần theo lịch cho đến ngày chạy báo cáo. |
THIS_WEEK_TO_YESTERDAY |
Từ đầu tuần theo lịch mà báo cáo được chạy, cho đến và bao gồm cả ngày trước khi báo cáo được chạy. |
THIS_MONTH_TO_DATE |
Từ đầu tháng dương lịch mà báo cáo được chạy, cho đến ngày báo cáo được chạy. |
THIS_MONTH_TO_YESTERDAY |
Từ đầu tháng dương lịch mà báo cáo được chạy, cho đến và bao gồm cả ngày trước khi báo cáo được chạy. |
THIS_QUARTER_TO_DATE |
Từ đầu quý dương lịch mà báo cáo được chạy, cho đến ngày chạy báo cáo (bao gồm cả ngày đó). |
THIS_QUARTER_TO_YESTERDAY |
Từ đầu quý dương lịch mà báo cáo được chạy, cho đến và bao gồm cả ngày trước khi báo cáo được chạy. |
THIS_YEAR_TO_DATE |
Từ đầu năm dương lịch mà báo cáo được chạy, cho đến và bao gồm cả ngày báo cáo được chạy. |
THIS_YEAR_TO_YESTERDAY |
Từ đầu năm dương lịch mà báo cáo được chạy, cho đến và bao gồm cả ngày trước khi báo cáo được chạy. |
LAST_WEEK |
Toàn bộ tuần trước đó trên lịch, từ thứ Hai đến Chủ Nhật (bao gồm cả hai ngày này), trước tuần trên lịch mà báo cáo được chạy. |
LAST_WEEK_STARTING_SUNDAY |
Toàn bộ tuần trước đó trên lịch, từ Chủ Nhật đến hết thứ Bảy, trước tuần trên lịch mà báo cáo được chạy. |
LAST_MONTH |
Toàn bộ tháng dương lịch trước tháng dương lịch mà báo cáo được chạy. |
LAST_QUARTER |
Toàn bộ quý dương lịch trước quý dương lịch mà báo cáo được chạy. |
LAST_YEAR |
Toàn bộ năm dương lịch trước năm dương lịch mà báo cáo được chạy. |
LAST_7_DAYS |
7 ngày trước ngày chạy báo cáo. |
LAST_30_DAYS |
30 ngày trước ngày chạy báo cáo. |
LAST_60_DAYS |
60 ngày trước ngày chạy báo cáo. |
LAST_90_DAYS |
90 ngày trước ngày chạy báo cáo. |
LAST_93_DAYS |
93 ngày trước ngày chạy báo cáo. |
LAST_180_DAYS |
180 ngày trước ngày chạy báo cáo. |
LAST_360_DAYS |
360 ngày trước ngày chạy báo cáo. |
LAST_365_DAYS |
365 ngày trước ngày chạy báo cáo. |
LAST_3_MONTHS |
Toàn bộ 3 tháng dương lịch trước tháng dương lịch mà báo cáo được chạy. |
LAST_6_MONTHS |
Toàn bộ 6 tháng dương lịch trước tháng dương lịch mà báo cáo được chạy. |
LAST_12_MONTHS |
Toàn bộ 12 tháng dương lịch trước tháng dương lịch mà báo cáo được chạy. |
ALL_AVAILABLE |
Từ 3 năm trước khi chạy báo cáo đến ngày trước khi chạy báo cáo (bao gồm cả ngày đó). |
Sắp xếp
Đại diện cho một cách sắp xếp trong báo cáo.
| Biểu diễn dưới dạng JSON |
|---|
{
"field": {
object ( |
| Trường | |
|---|---|
field |
Bắt buộc. Một trường (phương diện hoặc chỉ số) để sắp xếp. |
descending |
Không bắt buộc. Thứ tự sắp xếp. Nếu đúng, thứ tự sắp xếp sẽ là giảm dần. |
Phương thức |
|
|---|---|
|
Tạo đối tượng Report. |
|
Xoá đối tượng Report. |
|
Truy xuất đối tượng Report. |
|
Liệt kê Report đối tượng. |
|
Cập nhật đối tượng Report. |
|
Bắt đầu thực thi một báo cáo hiện có theo cách không đồng bộ. |