Method: accounts.networkReport.generate

สร้างรายงานเครือข่าย AdMob ตามข้อกำหนดของรายงานที่ระบุ แสดงผลลัพธ์ของ RPC การสตรีมฝั่งเซิร์ฟเวอร์ ระบบจะแสดงผลลัพธ์ในลำดับการตอบกลับ

คำขอ HTTP

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

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

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

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

string

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

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

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

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

object (NetworkReportSpec)

ข้อกำหนดรายงานเครือข่าย

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

การตอบกลับแบบสตรีมมิงสำหรับรายงานเครือข่าย AdMob ซึ่งการตอบกลับครั้งแรกจะมีส่วนหัวของรายงาน จากนั้นจะเป็นสตรีมของการตอบกลับแถว และสุดท้ายคือส่วนท้ายเป็นข้อความตอบกลับสุดท้าย

เช่น

[{
  "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}
}]

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

การแสดง 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.
}
ช่อง
ฟิลด์ Union payload ข้อความการตอบกลับของแต่ละสตรีมจะมีเพย์โหลดประเภทเดียว payload ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
header

object (ReportHeader)

การตั้งค่าการสร้างรายงานที่อธิบายเนื้อหาของรายงาน เช่น ช่วงวันที่ของรายงานและการตั้งค่าการแปล
row

object (ReportRow)

ข้อมูลรายงานจริง
footer

object (ReportFooter)

ข้อมูลเพิ่มเติมเกี่ยวกับรายงานที่สร้างขึ้น เช่น คำเตือนเกี่ยวกับข้อมูล

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

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

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

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

NetworkReportSpec

ข้อกำหนดสำหรับการสร้างรายงานเครือข่าย AdMob เช่น ข้อกำหนดในการรับคลิกและรายได้โดยประมาณสำหรับประเทศ "US" และ "CN" เท่านั้นอาจมีลักษณะดังตัวอย่างต่อไปนี้

{
  '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'
  }
}

คุณสามารถพิจารณาข้อกำหนดก่อนหน้าเป็นเหมือน SQL แบบจำลองต่อไปนี้เพื่อให้เข้าใจได้ดียิ่งขึ้น

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;
การแสดง JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
ช่อง
dateRange

object (DateRange)

ช่วงวันที่ที่สร้างรายงาน
dimensions[]

enum (Dimension)

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

enum (Metric)

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

object (DimensionFilter)

อธิบายแถวรายงานที่จะจับคู่ตามค่ามิติข้อมูล
sortConditions[]

object (SortCondition)

อธิบายการจัดเรียงแถวของรายงาน ลำดับของเงื่อนไขในรายการจะกำหนดลำดับความสำคัญ โดยเงื่อนไขที่อยู่ก่อนจะมีลำดับความสำคัญสูงกว่า หากไม่ได้ระบุเงื่อนไขการจัดเรียง ระบบจะไม่กำหนดลำดับแถว
localizationSettings

object (LocalizationSettings)

การตั้งค่าการแปลรายงาน
maxReportRows

integer

จำนวนแถวข้อมูลรายงานสูงสุดที่จะแสดงผล หากไม่ได้ตั้งค่า API จะแสดงผลแถวให้มากที่สุดเท่าที่จะเป็นไปได้ โดยสูงสุด 100,000 แถว ค่าที่ยอมรับได้คือ 1-100000 ค่าที่มากกว่า 100000 จะแสดงผลข้อผิดพลาด
timeZone

string

เขตเวลาของรายงาน ยอมรับค่าชื่อ TZ ของ IANA เช่น "America/Los_Angeles" หากไม่ได้กำหนดเขตเวลาไว้ ระบบจะใช้ค่าเริ่มต้นของบัญชี ตรวจสอบค่าเริ่มต้นโดยใช้การดำเนินการ get account

คำเตือน: ขณะนี้ระบบรองรับค่า "America/Los_Angeles" เท่านั้น

มิติข้อมูล

มิติข้อมูลของรายงานเครือข่าย มิติข้อมูลคือแอตทริบิวต์ข้อมูลที่ใช้ในการแบ่งหรือปรับการวัดเชิงปริมาณ (เมตริก) ตามแอตทริบิวต์บางอย่าง เช่น รูปแบบโฆษณาหรือแพลตฟอร์มที่ใช้ดูโฆษณา

Enum
DIMENSION_UNSPECIFIED ค่าเริ่มต้นสำหรับช่องที่ไม่ได้ตั้งค่า โปรดอย่าใช้
DATE วันที่ในรูปแบบ ปปปปดดวว (เช่น "20210701") คำขอระบุได้สูงสุด 1 มิติเวลา
MONTH เดือนในรูปแบบ YYYYMM (เช่น "202107") คำขอระบุได้สูงสุด 1 มิติเวลา
WEEK วันที่ของวันแรกของสัปดาห์ในรูปแบบ YYYYMMDD (เช่น "20210701") คำขอระบุได้สูงสุด 1 มิติเวลา
AD_UNIT รหัสที่ไม่ซ้ำกันของหน่วยโฆษณา (เช่น "ca-app-pub-1234/1234") หากระบุมิติข้อมูล AD_UNIT ระบบจะรวม APP โดยอัตโนมัติ
APP รหัสที่ไม่ซ้ำกันของแอปพลิเคชันบนอุปกรณ์เคลื่อนที่ (เช่น "ca-app-pub-1234~1234")
AD_TYPE

ประเภทของโฆษณา (เช่น "ข้อความ" หรือ "รูปภาพ") ซึ่งเป็นมิติข้อมูลการแสดงโฆษณา

คำเตือน: มิติข้อมูลไม่เข้ากันกับเมตริก AD_REQUESTS, MATCH_RATE และ IMPRESSION_RPM
COUNTRY รหัสประเทศ CLDR ของสถานที่ที่เกิดการดู/คลิกโฆษณา (เช่น "US" หรือ "FR") นี่คือมิติข้อมูลทางภูมิศาสตร์
FORMAT รูปแบบของหน่วยโฆษณา (เช่น "แบนเนอร์" "เนทีฟ") ซึ่งเป็นมิติข้อมูลการแสดงโฆษณา
PLATFORM แพลตฟอร์มระบบปฏิบัติการบนอุปกรณ์เคลื่อนที่ของแอป (เช่น "Android" หรือ "iOS")
MOBILE_OS_VERSION เวอร์ชันระบบปฏิบัติการบนอุปกรณ์เคลื่อนที่ เช่น "iOS 13.5.1"
GMA_SDK_VERSION เวอร์ชัน GMA SDK เช่น "iOS 7.62.0"
APP_VERSION_NAME สําหรับ Android คุณจะดูชื่อเวอร์ชันของแอปได้ใน versionName ใน PackageInfo สำหรับ iOS คุณจะดูชื่อเวอร์ชันแอปได้ใน CFBundleShortVersionString
SERVING_RESTRICTION โหมดการจํากัดสําหรับการแสดงโฆษณา (เช่น "โฆษณาที่ไม่ได้ปรับตามโปรไฟล์ของผู้ใช้")

เมตริก

เมตริกของรายงานเครือข่าย เมตริกคือการวัดเชิงปริมาณที่บ่งบอกถึงประสิทธิภาพของธุรกิจผู้เผยแพร่โฆษณา โดยจะรวบรวมจากเหตุการณ์โฆษณาแต่ละรายการและจัดกลุ่มตามมิติข้อมูลรายงาน ค่าเมตริกเป็นจำนวนเต็มหรือทศนิยม (โดยไม่มีการปัดเศษ)

Enum
METRIC_UNSPECIFIED ค่าเริ่มต้นสำหรับช่องที่ไม่ได้ตั้งค่า โปรดอย่าใช้
AD_REQUESTS

จำนวนคำขอโฆษณา ค่านี้ต้องเป็นจำนวนเต็ม

คำเตือน: เมตริกใช้ร่วมกับมิติข้อมูล AD_TYPE ไม่ได้
CLICKS จำนวนครั้งที่ผู้ใช้คลิกโฆษณา ค่านี้ต้องเป็นจำนวนเต็ม
ESTIMATED_EARNINGS รายได้โดยประมาณของผู้เผยแพร่โฆษณา AdMob หน่วยสกุลเงิน (USD, EUR หรืออื่นๆ) ของเมตริกรายได้จะกำหนดโดยการตั้งค่าการแปลสกุลเงิน จำนวนเงินมีหน่วยเป็นไมโคร เช่น $6.50 จะแสดงเป็น 6500000
IMPRESSIONS จำนวนโฆษณาทั้งหมดที่แสดงต่อผู้ใช้ ค่านี้ต้องเป็นจำนวนเต็ม
IMPRESSION_CTR อัตราส่วนของการคลิกต่อการแสดงผล ค่านี้เป็นค่าทศนิยมที่มีความแม่นยำแบบ Double (โดยประมาณ)
IMPRESSION_RPM

รายได้โดยประมาณต่อการแสดงโฆษณา 1,000 ครั้ง ค่ามีหน่วยเป็นไมโคร เช่น $1.03 จะแสดงเป็น 1030000 เทียบเท่ากับ eCPM ใน UI ของ AdMob

คำเตือน: เมตริกใช้ร่วมกับมิติข้อมูล AD_TYPE ไม่ได้
MATCHED_REQUESTS จำนวนครั้งที่โฆษณาแสดงตามคำขอ ค่านี้ต้องเป็นจำนวนเต็ม
MATCH_RATE

อัตราส่วนของคำขอโฆษณาที่ตรงกันต่อคำขอโฆษณาทั้งหมด ค่านี้เป็นค่าทศนิยมที่มีความแม่นยำแบบ Double (โดยประมาณ)

คำเตือน: เมตริกใช้ร่วมกับมิติข้อมูล AD_TYPE ไม่ได้
SHOW_RATE อัตราส่วนของโฆษณาที่แสดงต่อโฆษณาที่ส่งกลับ ซึ่งกำหนดเป็นการแสดงผล / คำขอที่ตรงกัน ค่านี้เป็นค่าทศนิยมที่มีความแม่นยำแบบ Double (โดยประมาณ)

DimensionFilter

อธิบายแถวรายงานที่จะจับคู่ตามค่ามิติข้อมูล

การแสดง 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.
}
ช่อง
dimension

enum (Dimension)

ใช้เกณฑ์ตัวกรองกับมิติข้อมูลที่ระบุ
ฟิลด์ Union operator โอเปอเรเตอร์ตัวกรองที่จะใช้ operator ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
matchesAny

object (StringList)

จับคู่แถวหากค่าของมิติข้อมูลที่ระบุอยู่ในค่าใดค่าหนึ่งที่ระบุในเงื่อนไขนี้

SortCondition

ทิศทางการจัดเรียงที่จะใช้กับมิติข้อมูลหรือเมตริก

การแสดง 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.
}
ช่อง
order

enum (SortOrder)

ลําดับการจัดเรียงของมิติข้อมูลหรือเมตริก
ฟิลด์ Union sort_on ระบุค่าที่จะจัดเรียง sort_on ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
dimension

enum (Dimension)

จัดเรียงตามมิติข้อมูลที่ระบุ
metric

enum (Metric)

จัดเรียงตามเมตริกที่ระบุ