Method: accounts.campaignReport.generate

Tạo Báo cáo chiến dịch dựa trên các quy cách được cung cấp.

Yêu cầu HTTP

POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport: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 (CampaignReportSpec)
  }
}
Trường
reportSpec

object (CampaignReportSpec)

Quy cách báo cáo chiến dịch.

Nội dung phản hồi

Phản hồi Campaign Report API.

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 
{
  "rows": [
    {
      object (ReportRow)
    }
  ]
}
Trường
rows[]

object (ReportRow)

Dữ liệu báo cáo chiến dịch của nhà xuất bản được chỉ định. API sẽ trả về tối đa 100.000 hàng.

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.

CampaignReportSpec

Nội dung đặc tả để tạo báo cáo Chiến dịch. Ví dụ: nội dung đặc tả để nhận số LƯỢT HIỂN THỊ và số LƯỢT NHẤP được phân chia theo CAMPAIGN_ID có thể có dạng như ví dụ sau:

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 12, "day": 1},
    "endDate": {"year": 2021, "month": 12, "day": 30}
  },
  "dimensions": ["CAMPAIGN_ID"],
  "metrics": ["IMPRESSIONS", "CLICKS"],
}
Biểu diễn dưới dạng JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "languageCode": string
}
Trường
dateRange

object (DateRange)

Phạm vi ngày tạo báo cáo. Phạm vi tối đa là 30 ngày.
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ố.
languageCode

string

Ngôn ngữ được dùng cho mọi văn bản bản địa hoá, chẳng hạn như một số giá trị phương diện có thể áp dụng. 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 hoặc chỉ định không hợp lệ.

Phương diện

Các phương diện của báo cáo chiến dịch.

Enum
DIMENSION_UNSPECIFIED Giá trị mặc định của một phương diện không được chỉ định. Không được dùng.
DATE Một ngày ở định dạng YYYYMMDD (ví dụ: "20210701").
CAMPAIGN_ID Mã nhận dạng duy nhất của chiến dịch, ví dụ: "123456789", mã này nhất quán với mã chiến dịch trong API danh sách chiến dịch.
CAMPAIGN_NAME Tên của chiến dịch.
AD_ID Mã nhận dạng riêng biệt của quảng cáo, ví dụ: "123456789".
AD_NAME Tên của quảng cáo (không nhất thiết phải là tên riêng biệt).
PLACEMENT_ID Mã nhận dạng duy nhất dành riêng cho nhà cung cấp của ứng dụng nơi đặt quảng cáo. Ví dụ: com.goog.bar cho ứng dụng Android và 123456789 cho ứng dụng iOS.
PLACEMENT_NAME Tên của ứng dụng nơi quảng cáo được đặt.
PLACEMENT_PLATFORM Nền tảng của ứng dụng nơi quảng cáo được đặt.
COUNTRY Tên của quốc gia mục tiêu.
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.

Chỉ số

Các chỉ số của báo cáo chiến dịch.

Enum
METRIC_UNSPECIFIED Giá trị mặc định cho một trường chưa được đặt. Không được dùng.
IMPRESSIONS Số lần một quảng cáo xuất hiện cho người dùng.
CLICKS Số lần người dùng nhấp vào một quảng cáo.
CLICK_THROUGH_RATE Số lượt nhấp mà một quảng cáo nhận được chia cho số lượt hiển thị quảng cáo.
INSTALLS Số lần ứng dụng được tải xuống thiết bị.
ESTIMATED_COST Chi phí ước tính để phân phát một quảng cáo trong chiến dịch thay vì một quảng cáo kiếm được doanh thu. Đơn vị tiền tệ là đơn vị tiền tệ báo cáo cho chiến dịch.
AVERAGE_CPI Chi phí trung bình cho mỗi lượt cài đặt. Đây là số tiền trung bình bạn đã chi tiêu để thu nạp một người dùng mới. Đơn vị tiền tệ là đơn vị tiền tệ báo cáo cho chiến dịch.
INTERACTIONS Số lần người dùng tương tác với một quảng cáo. Số liệu này bao gồm cả số lượt nhấp và số lượt tương tác.