- Yêu cầu HTTP
- Tham số đường dẫn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- NetworkReportSpec (Thông số kỹ thuật mạng)
- Kích thước
- Chỉ số
- DimensionFilter
- SortCondition (Điều kiện sắp xếp)
- Ví dụ
- Hãy làm thử!
Tạo báo cáo Mạng AdMob dựa trên bản đặc tả báo cáo được cung cấp. Trả về kết quả của RPC truyền trực tuyến phía máy chủ. Kết quả được trả về theo một chuỗi phản hồi.
Yêu cầu HTTP
POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/networkReport:generate
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Các tham số | |
---|---|
parent |
Tên tài nguyên của tài khoản để tạo báo cáo. Ví dụ: accounts/pub-9876543210987654 |
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 |
---|
{
"reportSpec": {
object ( |
Các trường | |
---|---|
reportSpec |
Quy cách báo cáo mạng. |
Nội dung phản hồi
Phản hồi theo luồng cho báo cáo Mạng AdMob, trong đó phản hồi đầu tiên chứa tiêu đề báo cáo, sau đó là luồng phản hồi theo hàng và cuối cùng là chân trang làm tin nhắn phản hồi cuối cùng.
Ví dụ:
[{
"header": {
"dateRange": {
"startDate": {"year": 2018, "month": 9, "day": 1},
"endDate": {"year": 2018, "month": 9, "day": 1}
},
"localizationSettings": {
"currencyCode": "USD",
"languageCode": "en-US"
}
}
},
{
"row": {
"dimensionValues": {
"DATE": {"value": "20180918"},
"APP": {
"value": "ca-app-pub-8123415297019784~1001342552",
displayLabel: "My app name!"
}
},
"metricValues": {
"ESTIMATED_EARNINGS": {"microsValue": 6500000}
}
}
},
{
"footer": {"matchingRowCount": 1}
}]
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 |
---|
{ // Union field |
Các trường | |
---|---|
Trường nhóm payload . Mỗi thông báo phản hồi theo luồng chứa một loại tải trọng. payload chỉ có thể là một trong những trạng thái sau đây: |
|
header |
Chế độ cài đặt tạo báo cáo mô tả nội dung báo cáo, chẳng hạn như phạm vi ngày báo cáo và chế độ cài đặt bản địa hoá. |
row |
Dữ liệu báo cáo thực tế. |
footer |
Thông tin bổ sung về báo cáo đã tạo, chẳng hạn như cảnh báo về dữ liệu. |
Phạm vi uỷ quyền
Yêu cầu một trong các phạm vi OAuth sau:
https://www.googleapis.com/auth/admob.readonly
https://www.googleapis.com/auth/admob.report
Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.
NetworkReportSpec
Thông số kỹ thuật để tạo báo cáo Mạng AdMob. Ví dụ: nội dung đặc tả để nhận số lượt nhấp và thu nhập ước tính chỉ dành cho các quốc gia "Hoa Kỳ" và "Trung Quốc" có thể có dạng như ví dụ sau:
{
'dateRange': {
'startDate': {'year': 2021, 'month': 9, 'day': 1},
'endDate': {'year': 2021, 'month': 9, 'day': 30}
},
'dimensions': ['DATE', 'APP', 'COUNTRY'],
'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],
'dimensionFilters': [
{
'dimension': 'COUNTRY',
'matchesAny': {'values': [{'value': 'US', 'value': 'CN'}]}
}
],
'sortConditions': [
{'dimension':'APP', order: 'ASCENDING'},
{'metric':'CLICKS', order: 'DESCENDING'}
],
'localizationSettings': {
'currencyCode': 'USD',
'languageCode': 'en-US'
}
}
Để hiểu rõ hơn, bạn có thể xem quy cách trước đó như SQL giả sau đây:
SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
FROM NETWORK_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;
Biểu diễn dưới dạng JSON |
---|
{ "dateRange": { object ( |
Các trường | |
---|---|
dateRange |
Phạm vi ngày tạo báo cáo. |
dimensions[] |
Danh sách các phương diện của báo cáo. Tổ hợp giá trị của các phương diện này sẽ xác định hàng của báo cáo. Nếu bạn không chỉ định phương diện nào, báo cáo sẽ trả về một hàng chỉ số được yêu cầu cho toàn bộ tài khoản. |
metrics[] |
Danh sách các chỉ số của báo cáo. Một báo cáo phải chỉ định ít nhất một chỉ số. |
dimensionFilters[] |
Mô tả những hàng báo cáo cần so khớp dựa trên giá trị phương diện. |
sortConditions[] |
Mô tả cách sắp xếp các hàng trong báo cáo. Thứ tự của điều kiện trong danh sách sẽ xác định mức độ ưu tiên của điều kiện đó; điều kiện càng sớm thì mức độ ưu tiên càng cao. Nếu bạn không chỉ định điều kiện sắp xếp, thì thứ tự hàng không được xác định. |
localizationSettings |
Chế độ cài đặt bản địa hoá của báo cáo. |
maxReportRows |
Số hàng dữ liệu báo cáo tối đa cần trả về. Nếu bạn không đặt giá trị, API sẽ trả về nhiều hàng nhất có thể, tối đa là 100.000 hàng. Các giá trị được chấp nhận là toàn bộ các giá trị từ 1 đến 100.000. Các giá trị lớn hơn 100000 sẽ trả về lỗi. |
timeZone |
Múi giờ báo cáo. Chấp nhận các giá trị tên TZ của IANA, chẳng hạn như "America/Los_Angeles". Nếu bạn không xác định múi giờ, chế độ mặc định của tài khoản sẽ có hiệu lực. Hãy kiểm tra giá trị mặc định bằng thao tác lấy tài khoản. Cảnh báo: "Châu Mỹ/Los_Angeles" là giá trị duy nhất hiện được hỗ trợ. |
Phương diện
Các phương diện của báo cáo mạng. Phương diện là các thuộc tính dữ liệu để phân tích hoặc tinh chỉnh các số liệu đo lường định lượng (chỉ số) theo một số thuộc tính nhất định, chẳng hạn như định dạng quảng cáo hoặc nền tảng mà người dùng đã xem quảng cáo.
Enum | |
---|---|
DIMENSION_UNSPECIFIED |
Giá trị mặc định cho trường chưa được đặt. Không được dùng. |
DATE |
Ngày ở định dạng YYYYMMDD (ví dụ: "20210701"). Các yêu cầu có thể chỉ định tối đa một phương diện thời gian. |
MONTH |
Một tháng ở định dạng YYYYMM (ví dụ: "202107"). Các yêu cầu có thể chỉ định tối đa một phương diện thời gian. |
WEEK |
Ngày đầu tiên trong tuần ở định dạng YYYYMMDD (ví dụ: "20210701"). Các yêu cầu có thể chỉ định tối đa một phương diện thời gian. |
AD_UNIT |
Mã nhận dạng duy nhất của đơn vị quảng cáo (ví dụ: "ca-app-pub-1234/1234"). Nếu bạn chỉ định phương diện AD_UNIT, thì APP sẽ tự động được đưa vào. |
APP |
Mã nhận dạng duy nhất của ứng dụng dành cho thiết bị di động (ví dụ: "ca-app-pub-1234~1234"). |
AD_TYPE |
Loại quảng cáo (ví dụ: "văn bản" hoặc "hình ảnh"), thứ nguyên phân phối quảng cáo. Cảnh báo: Phương diện không tương thích với các chỉ số AD_REQUESTS, MATCH_RATE và IMPRESSION_RPM. |
COUNTRY |
Mã quốc gia CLDR của nơi diễn ra lượt xem/lượt nhấp vào quảng cáo (ví dụ: "US" hoặc "FR"). Đây là phương diện địa lý. |
FORMAT |
Định dạng của đơn vị quảng cáo (ví dụ: "biểu ngữ", "gốc"), phương diện phân phối quảng cáo. |
PLATFORM |
Nền tảng hệ điều hành thiết bị di động của ứng dụng (ví dụ: "Android" hoặc "iOS"). |
MOBILE_OS_VERSION |
Phiên bản hệ điều hành trên thiết bị di động, ví dụ: "iOS 13.5.1". |
GMA_SDK_VERSION |
Phiên bản SDK GMA, ví dụ: "iOS 7.62.0". |
APP_VERSION_NAME |
Đối với Android, tên phiên bản ứng dụng có trong versionName của PackageInfo. Đối với iOS, bạn có thể tìm thấy tên phiên bản ứng dụng trong CFBundleShortVersionString. |
SERVING_RESTRICTION |
Chế độ hạn chế phân phát quảng cáo (ví dụ: "Quảng cáo không được cá nhân hoá"). |
Chỉ số
Chỉ số của báo cáo mạng. Chỉ số là các phép đo định lượng cho biết hiệu quả hoạt động của doanh nghiệp của nhà xuất bản. Hệ thống sẽ tổng hợp các chỉ số này từ các sự kiện quảng cáo riêng lẻ và nhóm theo phương diện báo cáo. Giá trị chỉ số là số nguyên hoặc số thập phân (không làm tròn).
Enum | |
---|---|
METRIC_UNSPECIFIED |
Giá trị mặc định cho trường chưa được đặt. Không được dùng. |
AD_REQUESTS |
Số lượng yêu cầu quảng cáo. Giá trị là một số nguyên. Cảnh báo: Chỉ số này không tương thích với phương diện AD_TYPE. |
CLICKS |
Số lần người dùng nhấp vào một quảng cáo. Giá trị là một số nguyên. |
ESTIMATED_EARNINGS |
Thu nhập ước tính của nhà xuất bản AdMob. Đơn vị tiền tệ (USD, EUR hoặc đơn vị tiền tệ khác) của các chỉ số thu nhập được xác định theo chế độ bản địa hoá cho đơn vị tiền tệ. Số tiền được trình bày dưới dạng phần triệu. Ví dụ: $6, 5 sẽ được trình bày là 6500000. |
IMPRESSIONS |
Tổng số quảng cáo đã hiển thị cho người dùng. Giá trị là một số nguyên. |
IMPRESSION_CTR |
Tỷ lệ số lượt nhấp so với số lượt hiển thị. Giá trị này là số thập phân có độ chính xác kép (gần đúng). |
IMPRESSION_RPM |
Thu nhập ước tính trên mỗi nghìn lượt hiển thị quảng cáo. Giá trị được trình bày dưới dạng phần triệu. Ví dụ: $1, 03 sẽ được trình bày là 1030000. Tương đương với eCPM trong giao diện người dùng AdMob. Cảnh báo: Chỉ số này không tương thích với phương diện AD_TYPE. |
MATCHED_REQUESTS |
Số lần quảng cáo được trả về theo yêu cầu. Giá trị là một số nguyên. |
MATCH_RATE |
Tỷ lệ yêu cầu quảng cáo được so khớp trên tổng số yêu cầu quảng cáo. Giá trị này là số thập phân có độ chính xác kép (gần đúng). Cảnh báo: Chỉ số này không tương thích với phương diện AD_TYPE. |
SHOW_RATE |
Tỷ lệ quảng cáo được hiển thị trên số quảng cáo được trả về, được xác định bằng số lượt hiển thị / số yêu cầu đã so khớp. Giá trị này là số thập phân có độ chính xác kép (gần đúng). |
DimensionFilter
Mô tả những hàng báo cáo cần so khớp dựa trên giá trị phương diện.
Biểu diễn dưới dạng JSON |
---|
{ "dimension": enum ( |
Các trường | |
---|---|
dimension |
Áp dụng tiêu chí lọc cho phương diện đã chỉ định. |
Trường nhóm operator . Toán tử bộ lọc sẽ được áp dụng. operator chỉ có thể là một trong những trạng thái sau đây: |
|
matchesAny |
So khớp một hàng nếu giá trị của hàng đó cho phương diện được chỉ định thuộc một trong các giá trị được chỉ định trong điều kiện này. |
SortCondition
Hướng sắp xếp sẽ được áp dụng cho một phương diện hoặc một chỉ số.
Biểu diễn dưới dạng JSON |
---|
{ "order": enum ( |
Các trường | |
---|---|
order |
Thứ tự sắp xếp của phương diện hoặc chỉ số. |
Trường nhóm sort_on . Xác định những giá trị cần sắp xếp. sort_on chỉ có thể là một trong những trạng thái sau đây: |
|
dimension |
Sắp xếp theo phương diện đã chỉ định. |
metric |
Sắp xếp theo chỉ số được chỉ định. |