Phương thức: 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.

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

Tham 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:

Trình bày dưới dạng JSON

{
  "reportSpec": {
    object (NetworkReportSpec)
  }
}
Trường
reportSpec

đối tượng ( NetworkReportSpec )

Nội dung đặc tả báo cáo mạng.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

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': 30}
    }
    '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': {'decimal_value': 1.3247467524491825}
    }
  }
},
...
{
  'footer': {'matchingRowCount': 5}
}]
Trình bày 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 loại sau đây:
header

object (ReportHeader)

Tùy chọn cài đặt tạo báo cáo mô tả nội dung báo cáo, chẳng hạn như cài đặt phạm vi ngày báo cáo và bản địa hóa.

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 ủy quyền

Yêu cầu về phạm vi OAuth như sau:

  • 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

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': 2018, 'month': 9, 'day': 1},
    'endDate': {'year': 2018, '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 >= '2018-09-01' AND DATE <= '2018-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;
Trình bày dưới dạng JSON

{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": number
}
Trường
dateRange

object (DateRange)

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

dimensions[]

enum (Dimension)

Danh sách thứ nguyên của báo cáo. Việc kết hợp giá trị của các thứ nguyên này sẽ xác định hàng của báo cáo. Nếu bạn không chỉ định thứ nguyê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ị thứ nguyê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 sắp xếp 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 chỉ định điều kiện sắp xếp, thì thứ tự hàng không được xác định.

localizationSettings

object (LocalizationSettings)

Tùy chọn cài đặt bản địa hóa của báo cáo.

maxReportRows

number

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à 100000 hàng. Giá trị có thể chấp nhận là tất cả các số từ 1 đến 100000. Mọi giá trị khác đều được coi là 100000.

DateRange

Nội dung đặc tả của một phạm vi ngày duy nhất, có bao gồm cả hai mốc ngày.

Trình bày dưới dạng JSON

{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Trường
startDate

object (Date)

Ngày bắt đầu của phạm vi ngày, bao gồm toàn bộ. Phải nhỏ hơn hoặc bằng ngày kết thúc.

endDate

object (Date)

Ngày kết thúc của phạm vi ngày, bao gồm toàn bộ. Phải lớn hơn hoặc bằng ngày bắt đầu.

Ngày

Đại diện cho toàn bộ hoặc một phần ngày theo lịch, ví dụ như ngày sinh nhật. 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ó liên quan đến Lịch Gregorian Proleptic. Nội dung đặc tả này có thể xuất hiện dưới dạng:

  • Một ngày đầy đủ, với các giá trị năm, tháng và ngày khác 0
  • Giá trị tháng và ngày, giá trị năm bằng 0, ví dụ: ngày kỷ niệm
  • Chỉ riêng giá trị năm, với giá trị tháng và ngày bằng 0
  • Giá trị năm và tháng, với giá trị ngày bằng 0, ví dụ: ngày hết hạn thẻ tín dụng

Các loại liên quan là google.type.TimeOfDaygoogle.protobuf.Timestamp.

Trình bày dưới dạng JSON

{
  "year": number,
  "month": number,
  "day": number
}
Trường
year

number

Năm của ngày. Giá trị phải từ 1 đến 9999 hoặc bằng 0 nếu chỉ định ngày không có năm.

month

number

Tháng trong năm. Giá trị phải từ 1 đến 12 hoặc bằng 0 nếu chỉ định một năm không có tháng và ngày.

day

number

Ngày trong tháng. Giá trị phải từ 1 đến 31 và có giá trị trong năm và tháng, hoặc bằng 0 nếu chỉ chỉ định giá trị năm, hoặc một năm và tháng, trong đó ngày là không quan trọng.

Thứ nguyên

Các thứ nguyên của báo cáo mạng. Thứ nguyê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.

Liệt kê
DIMENSION_UNSPECIFIED Giá trị mặc định cho một trường chưa được đặt. Không sử dụng.
DATE Một ngày ở định dạng YYYY-MM-DD (ví dụ: "2018-12-21"). Các yêu cầu có thể chỉ định tối đa một thứ nguyên thời gian.
MONTH Một tháng ở định dạng YYYY-MM (ví dụ: "2018-12"). Các yêu cầu có thể chỉ định tối đa một thứ nguyên thời gian.
WEEK Ngày của ngày đầu tiên trong tuần ở định dạng YYYY-MM-DD (ví dụ: "2018-12-21"). Các yêu cầu có thể chỉ định tối đa một thứ nguyê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 thứ nguyê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").
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 thứ nguyên địa lý.
FORMAT Định dạng của đơn vị quảng cáo (ví dụ: "biểu ngữ", "gốc"), thứ nguyê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").

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 thứ nguyê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).

Liệt kê
METRIC_UNSPECIFIED Giá trị mặc định cho một trường chưa được đặt. Không sử dụng.
AD_REQUESTS Số lượng yêu cầu quảng cáo. Giá trị là một số nguyên.
CLICKS Số lượt 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 tùy chọn cài đặt bản địa hóa cho đơn vị tiền tệ. Số lượng được trình bày dưới dạ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 được 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 trình bày dưới dạng phần triệu. Ví dụ: $1,03 sẽ được trình bày là 1030000.
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).
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ị thứ nguyên của hàng.

Trình bày dưới dạng JSON

{
  "dimension": enum (Dimension),
  "matchesAny": {
    object (StringList)
  }
}
Trường
dimension

enum (Dimension)

Áp dụng tiêu chí lọc cho thứ nguyên đã chỉ định.

matchesAny

object (StringList)

So khớp một hàng nếu giá trị của hàng đó cho thứ nguyên được chỉ định thuộc trong một trong các giá trị được chỉ định trong điều kiện này.

StringList

Danh sách các giá trị chuỗi.

Trình bày dưới dạng JSON

{
  "values": [
    string
  ]
}
Trường
values[]

string

Các giá trị chuỗi.

SortCondition

Hướng sắp xếp sẽ được áp dụng trên một thứ nguyên hoặc chỉ số.

Trình bày 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 thứ nguyê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 có thể là một trong những loại sau đây:
dimension

enum ( Dimension )

Sắp xếp theo thứ nguyên đã chỉ định.

metric

enum ( Metric )

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

SortOrder

Thứ tự sắp xếp.

Liệt kê
SORT_ORDER_UNSPECIFIED Giá trị mặc định cho một trường chưa được đặt. Không sử dụng.
ASCENDING Sắp xếp giá trị thứ nguyên hoặc giá trị chỉ số theo thứ tự tăng dần.
DESCENDING Sắp xếp giá trị thứ nguyên hoặc giá trị chỉ số theo thứ tự giảm dần.

LocalizationSettings

Tùy chọn cài đặt bản địa hóa cho các báo cáo, chẳng hạn như đơn vị tiền tệ và ngôn ngữ. Những tùy chọn cài đặt này ảnh hưởng đến cách tính chỉ số.

Trình bày dưới dạng JSON

{
  "currencyCode": string,
  "languageCode": string
}
Trường
currencyCode

string

Mã tiền tệ của các chỉ số liên quan đến thu nhập. Mã này bao gồm 3 ký tự được xác định trong ISO 4217. Tỷ lệ trung bình hàng ngày được dùng để chuyển đổi tiền tệ. Mã tiền tệ của tài khoản được đặt theo mặc định nếu bạn không chỉ định.

languageCode

string

Ngôn ngữ được sử dụng cho mọi văn bản bản địa hóa, chẳng hạn như một số nhãn hiển thị giá trị thứ nguyên. Thẻ ngôn ngữ được xác định trong BCP47 của IETF. Mặc định là 'en-US' nếu bạn không chỉ định.

ReportHeader

Nhóm dữ liệu để giúp xử lý báo cáo đã tạo. Luôn được gửi dưới dạng tin nhắn đầu tiên trong phản hồi theo luồng.

Trình bày dưới dạng JSON

{
  "dateRange": {
    object (DateRange)
  },
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "reportingTimeZone": string
}
Trường
dateRange

object (DateRange)

Phạm vi ngày tạo báo cáo. Phạm vi này giống hệt phạm vi đã chỉ định trong yêu cầu báo cáo.

localizationSettings

object (LocalizationSettings)

Tùy chọn cài đặt bản địa hóa của báo cáo. Tùy chọn này giống hệt với các tùy chọn cài đặt trong yêu cầu báo cáo.

reportingTimeZone

string

Múi giờ báo cáo. Giá trị là mã múi giờ theo quy định của dự án CLDR, ví dụ: "Hoa Kỳ/Los_Angeles".

ReportRow

Một hàng của báo cáo trả về.

Trình bày dưới dạng JSON

{
  "dimensionValues": {
    string: {
      object(DimensionValue)
    },
    ...
  },
  "metricValues": {
    string: {
      object(MetricValue)
    },
    ...
  }
}
Trường
dimensionValues

ánh xạ (khóa: chuỗi, giá trị: đối tượng ( DimensionValue ))

Bản đồ các giá trị thứ nguyên trong một hàng, trong đó các khóa là tên liệt kê của thứ nguyên.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

metricValues

map (key: string, value: object (MetricValue))

Bản đồ các giá trị chỉ số trong một hàng, trong đó các khóa là tên liệt kê của chỉ số. Nếu một chỉ số yêu cầu không có giá trị được trả về, thì liên kết này sẽ không bao gồm chỉ số đó.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ReportFooter

Nhóm dữ liệu có thể sử dụng sau quá trình tạo báo cáo, ví dụ: tính năng cảnh báo và đếm hàng. Luôn được gửi dưới dạng tin nhắn cuối cùng trong phản hồi theo luồng.

Trình bày dưới dạng JSON

{
  "warnings": [
    {
      object (ReportWarning)
    }
  ],
  "matchingRowCount": string
}
Trường
warnings[]

object (ReportWarning)

Cảnh báo liên quan đến việc tạo báo cáo.

matchingRowCount

string (int64 format)

Tổng số hàng trùng khớp với yêu cầu.

ReportWarning

Cảnh báo liên quan đến việc tạo báo cáo.

Trình bày dưới dạng JSON

{
  "type": enum (Type),
  "description": string
}
Trường
type

enum ( Type )

Loại cảnh báo.

description

string

Nội dung mô tả chi tiết của tin nhắn cảnh báo, bằng tiếng Anh.

Loại

Loại cảnh báo.

Liệt kê
TYPE_UNSPECIFIED Giá trị mặc định cho một trường chưa được đặt. Không sử dụng.
DATA_BEFORE_ACCOUNT_TIMEZONE_CHANGE Một số dữ liệu trong báo cáo này được tổng hợp dựa trên múi giờ khác với múi giờ được yêu cầu. Điều này có thể xảy ra nếu một báo cáo múi giờ địa phương có thời gian bắt đầu trước khi múi giờ này thay đổi lần gần nhất. Trường mô tả sẽ chứa ngày gần nhất thay đổi múi giờ.
DATA_DELAYED Có sự chậm trễ bất thường trong việc xử lý dữ liệu nguồn cho phạm vi ngày yêu cầu. Kết quả báo cáo có thể ít cập nhật hơn bình thường. AdMob đã biết về vấn đề này và đang tích cực làm việc để giải quyết.
OTHER Hệ thống đưa ra cảnh báo mà không phân loại cụ thể. Cảnh báo này có thể giúp ích cho bạn khi các loại cảnh báo mới được thêm nhưng API chưa thay đổi.
REPORT_CURRENCY_NOT_ACCOUNT_CURRENCY Đơn vị tiền tệ được yêu cầu không phải là đơn vị tiền tệ của tài khoản. Các chỉ số thu nhập sẽ được dựa trên loại tiền tệ yêu cầu, do đó, không còn là số liệu ước tính tốt về khoản thanh toán cuối cùng nữa, do biến động tỷ giá tiền tệ.