Method: accounts.networkReport.generate

Tạo báo cáo Mạng AdMob dựa trên nội dung đặc tả báo cáo đã cung cấp. Trả về kết quả của một 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/v1/{parent=accounts/*}/networkReport:generate

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

Tham số đường dẫn

Thông số
parent

string

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 với cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "reportSpec": {
    object (NetworkReportSpec)
  }
}
Trường
reportSpec

object (NetworkReportSpec)

Nội dung đặc tả 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 thông báo 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 payload can be only one of the following:
  "header": {
    object (ReportHeader)
  },
  "row": {
    object (ReportRow)
  },
  "footer": {
    object (ReportFooter)
  }
  // End of list of possible types for union field payload.
}
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:
header

object (ReportHeader)

Chế độ cài đặt tạo báo cáo mô tả nội dung báo cáo, chẳng hạn như chế độ cài đặt phạm vi ngày báo cáo và bản địa hoá.
row

object (ReportRow)

Dữ liệu báo cáo thực tế.
footer

object (ReportFooter)

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 OAuth 2.0 Overview.

NetworkReportSpec

Nội dung đặc tả để tạo báo cáo Mạng AdMob. Ví dụ: nội dung đặc tả báo cáo mạng để có được số lượt nhấp và thu nhập ước tính chỉ 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ể coi nội dung đặc tả báo cáo mạng 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 (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
Trường
dateRange

object (DateRange)

Phạm vi ngày tạo báo cáo.
dimensions[]

enum (Dimension)

Danh sách phương diện của báo cáo. Việc kế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 thì 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[]

enum (Metric)

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

object (DimensionFilter)

Mô tả hàng báo cáo để so khớp dựa trên giá trị phương diện của hàng.
sortConditions[]

object (SortCondition)

Mô tả việc sắp xếp các hàng 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

object (LocalizationSettings)

Chế độ cài đặt bản địa hoá của báo cáo.
maxReportRows

integer

Số lượng 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ị, thì API sẽ trả về nhiều hàng nhất có thể, tối đa là 100.000 hàng. Giá trị có thể chấp nhận là tất cả các số từ 1 đến 100000. Các giá trị lớn hơn 100000 sẽ trả về lỗi.
timeZone

string

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ờ, thì múi giờ mặc định của tài khoản sẽ có hiệu lực. Kiểm tra giá trị mặc định bằng thao tác nhận tài khoản.

Cảnh báo: "America/Los_Angeles" là giá trị duy nhất được hỗ trợ hiện tại.

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 giá trị đo lường định lượng (chỉ số) theo các 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 đã sử dụng để xem quảng cáo.

Enum
DIMENSION_UNSPECIFIED Giá trị mặc định cho một trường chưa được đặt. Không được dùng.
DATE Một 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 của 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 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"), một phương diện phân phối quảng cáo.

Cảnh báo: Phương diện này 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 mà người dùng thực hiện lượt xem/lượt nhấp vào quảng cáo (ví dụ: "Hoa Kỳ" hoặc "Pháp"). Đây là một 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"), một phương diện phân phối quảng cáo.
PLATFORM Nền tảng hệ điều hành 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 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, bạn có thể tìm thấy tên phiên bản ứng dụng trong versionName trong 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ố

Các chỉ số của báo cáo mạng. Chỉ số là số liệu đo lường định lượng cho biết mức độ hiệu quả hoạt động trong công việc của nhà xuất bản. Hệ thống tổng hợp các chỉ số 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 một 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 dựa trên chế độ cài đặt bản địa hoá cho đơn vị tiền tệ. Số tiền được tính bằng phần triệu. Ví dụ: $6, 50 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ị 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ột nghìn lượt hiển thị quảng cáo. Giá trị được tính bằ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ả lại để phản hồi một yêu cầu. Giá trị là một số nguyên.
MATCH_RATE

Tỷ lệ của các yêu cầu quảng cáo phù hợp trên tổng số yêu cầu quảng cáo. Giá trị 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 là lượt hiển thị / yêu cầu đã đối sánh. Giá trị là số thập phân có độ chính xác kép (gần đúng).

DimensionFilter

Mô tả hàng báo cáo để so khớp dựa trên giá trị phương diện của hàng.

Biểu diễn dưới dạng JSON 
{
  "dimension": enum (Dimension),

  // Union field operator can be only one of the following:
  "matchesAny": {
    object (StringList)
  }
  // End of list of possible types for union field operator.
}
Trường
dimension

enum (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:
matchesAny

object (StringList)

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 trong 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 trên một phương diện hoặc chỉ số.

Biểu diễn dưới dạng JSON 
{
  "order": enum (SortOrder),

  // Union field sort_on can be only one of the following:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of list of possible types for union field sort_on.
}
Trường
order

enum (SortOrder)

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 các giá trị để sắp xếp trên. sort_on chỉ có thể là một trong những trạng thái sau:
dimension

enum (Dimension)

Sắp xếp theo phương diện đã chỉ định.
metric

enum (Metric)

Sắp xếp theo chỉ số đã chỉ định.