Method: accounts.campaignReport.generate

สร้างรายงานแคมเปญตามข้อกำหนดที่ระบุ

คำขอ HTTP

POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport:generate

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
parent

string

ชื่อทรัพยากรของบัญชีที่จะสร้างรายงาน ตัวอย่าง: accounts/pub-9876543210987654

เนื้อความของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "reportSpec": {
    object (CampaignReportSpec)
  }
}
ช่อง
reportSpec

object (CampaignReportSpec)

ข้อกําหนดรายงานแคมเปญ

เนื้อหาการตอบกลับ

การตอบกลับจาก API รายงานแคมเปญ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "rows": [
    {
      object (ReportRow)
    }
  ]
}
ช่อง
rows[]

object (ReportRow)

ข้อมูลรายงานแคมเปญจากผู้เผยแพร่โฆษณาที่ระบุ API จะแสดงผลแถวสูงสุด 100,000 แถว

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/admob.readonly
  • https://www.googleapis.com/auth/admob.report

ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview

CampaignReportSpec

ข้อกําหนดสําหรับการสร้างรายงานแคมเปญ ตัวอย่างเช่น ข้อกำหนดในการรับการแสดงผลและการคลิกที่แบ่งตาม CAMPAIGN_ID อาจมีลักษณะดังตัวอย่างต่อไปนี้

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 12, "day": 1},
    "endDate": {"year": 2021, "month": 12, "day": 30}
  },
  "dimensions": ["CAMPAIGN_ID"],
  "metrics": ["IMPRESSIONS", "CLICKS"],
}
การแสดง JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "languageCode": string
}
ช่อง
dateRange

object (DateRange)

ช่วงวันที่ที่สร้างรายงาน ช่วงสูงสุดคือ 30 วัน
dimensions[]

enum (Dimension)

รายการมิติข้อมูลของรายงาน ชุดค่าผสมของมิติข้อมูลเหล่านี้จะเป็นตัวกำหนดแถวของรายงาน หากไม่ได้ระบุมิติข้อมูล รายงานจะแสดงเมตริกที่ขอในแถวเดียวสำหรับทั้งบัญชี
metrics[]

enum (Metric)

รายการเมตริกของรายงาน รายงานต้องระบุเมตริกอย่างน้อย 1 รายการ
languageCode

string

ภาษาที่ใช้สำหรับข้อความที่แปลแล้ว เช่น ค่ามิติข้อมูลที่เกี่ยวข้องบางอย่าง แท็กภาษาจะกำหนดไว้ใน IETF BCP47 ค่าเริ่มต้นจะเป็น "en-US" หากไม่ได้ระบุไว้หรือค่าไม่ถูกต้อง

มิติข้อมูล

มิติข้อมูลของรายงานแคมเปญ

Enum
DIMENSION_UNSPECIFIED ค่าเริ่มต้นของมิติข้อมูลที่ไม่ได้ระบุ โปรดอย่าใช้
DATE วันที่ในรูปแบบ ปปปปดดวว (เช่น "20210701")
CAMPAIGN_ID รหัสที่ไม่ซ้ำกันของแคมเปญ เช่น "123456789" ซึ่งสอดคล้องกับรหัสแคมเปญจาก Campaign List API
CAMPAIGN_NAME ชื่อแคมเปญ
AD_ID รหัสที่ไม่ซ้ำกันของโฆษณา เช่น "123456789"
AD_NAME ชื่อของโฆษณา ซึ่งอาจไม่ซ้ำกัน
PLACEMENT_ID รหัสที่ไม่ซ้ำกันของแอปที่เฉพาะเจาะจงผู้ให้บริการซึ่งมีการแสดงโฆษณา เช่น com.goog.bar สำหรับแอป Android และ 123456789 สำหรับแอป iOS
PLACEMENT_NAME ชื่อแอปที่มีการแสดงโฆษณา
PLACEMENT_PLATFORM แพลตฟอร์มของแอปที่วางโฆษณา
COUNTRY ชื่อประเทศเป้าหมาย
FORMAT รูปแบบของหน่วยโฆษณา (เช่น "แบนเนอร์" "เนทีฟ") ซึ่งเป็นมิติข้อมูลการแสดงโฆษณา

เมตริก

เมตริกของรายงานแคมเปญ

Enum
METRIC_UNSPECIFIED ค่าเริ่มต้นสำหรับช่องที่ไม่ได้ตั้งค่า โปรดอย่าใช้
IMPRESSIONS จำนวนครั้งที่โฆษณาแสดงต่อผู้ใช้
CLICKS จำนวนครั้งที่ผู้ใช้คลิกโฆษณา
CLICK_THROUGH_RATE จำนวนคลิกที่โฆษณาได้รับหารด้วยจำนวนครั้งที่โฆษณาแสดง
INSTALLS จำนวนครั้งที่มีการดาวน์โหลดแอปไปยังอุปกรณ์
ESTIMATED_COST ค่าใช้จ่ายโดยประมาณของการแสดงโฆษณาแคมเปญแทนโฆษณาที่สร้างรายได้ สกุลเงินคือสกุลเงินการรายงานสำหรับแคมเปญ
AVERAGE_CPI ต้นทุนต่อการติดตั้งโดยเฉลี่ย หมายถึงจํานวนเงินเฉลี่ยที่ใช้จ่ายไปเพื่อให้ได้ผู้ใช้ใหม่ สกุลเงินคือสกุลเงินการรายงานสำหรับแคมเปญ
INTERACTIONS จำนวนครั้งที่ผู้ใช้โต้ตอบกับโฆษณา ซึ่งประกอบด้วยการคลิกและการมีส่วนร่วม