หน้านี้มีบันทึกประจำรุ่นสำหรับ AdSense Management API
เวอร์ชัน 2
เวอร์ชันนี้มีการเปลี่ยนแปลงต่อไปนี้เพื่อนำฟังก์ชันที่เลิกใช้งานแล้วออกและเพื่อให้ AdSense Management API สอดคล้องกับมาตรฐาน Google API ปัจจุบัน ตามรูปแบบการกำหนดเวอร์ชัน Google API เวอร์ชันนี้จะอัปเดตเมื่อเวลาผ่านไปเพื่อรวมฟังก์ชันเพิ่มเติม (ที่เข้ากันได้แบบย้อนหลัง) แทนฟังก์ชันการทำงานใหม่ที่เผยแพร่ในเวอร์ชันย่อยที่แยกต่างหาก
2023-06-19
การชำระเงิน
- ขณะนี้ payments.list จะแสดงรายละเอียดการชำระเงินสำหรับผู้เผยแพร่โฆษณาระดับพรีเมียม
2023-06-13
รายงาน
- เพิ่มเมตริก
FUNNEL_REQUESTS
,FUNNEL_IMPRESSIONS
,FUNNEL_CLICKS
และFUNNEL_RPM
ซึ่งให้ข้อมูลเกี่ยวกับประสิทธิภาพของหน่วยโฆษณาที่ไม่ใช่หน่วยโฆษณา (เช่น หน่วยการค้นหาที่เกี่ยวข้อง)
2023-03-30
รายงาน
- เพิ่มมิติข้อมูล
PAGE_URL
ซึ่งทำให้ระบบแจกแจงเมตริกตาม URL ของหน้าเว็บได้ (ที่มีคำเตือนบางประการ โปรดดูรายละเอียด URL ของหน้าเว็บ)
2022-09-21
AdUnits
- เพิ่มวิธีสร้างและแพตช์แล้ว โปรดทราบว่าโปรเจ็กต์ที่เปิดใช้สำหรับผลิตภัณฑ์ AdSense for Platforms จะใช้วิธีการเหล่านี้ได้เท่านั้น
CustomChannels
- เพิ่มวิธีสร้าง แพตช์ และอัปเดต โปรดทราบว่าโปรเจ็กต์ที่เปิดใช้สำหรับผลิตภัณฑ์ AdSense for Platforms จะใช้วิธีการเหล่านี้ได้เท่านั้น
- เพิ่มช่องที่ใช้งานอยู่ลงในทรัพยากรแล้ว
บัญชี
- เพิ่มเมธอด getAdBlockedRecoveryTag แล้ว
2022-08-25
รายงาน
- เพิ่มมิติข้อมูล
HOSTED_AD_CLIENT_ID
ซึ่งช่วยให้ผู้เผยแพร่โฆษณาที่เป็นโฮสต์และแพลตฟอร์มสามารถแจกแจงเมตริกตามบัญชีของผู้เผยแพร่โฆษณาของตน (ผู้เผยแพร่โฆษณาที่โฮสต์) และตามบัญชีย่อย (ผู้เผยแพร่โฆษณาบนแพลตฟอร์ม)
2022-05-03
AdClient
- เพิ่มเมธอด Get แล้ว
รายงาน
- เพิ่มวิธีการ get Saved แล้ว
UrlChannels
- เพิ่มเมธอด Get แล้ว
2022-03-31
บัญชี
- ตอนนี้บัญชีที่ไม่ได้ใช้งานจะส่งคืนโดย API โดยมีช่อง
state
ซึ่งระบุสถานะของบัญชี
AdClient
- เช่นเดียวกับการเปลี่ยนแปลงในบัญชีข้างต้น ตอนนี้ API จะส่งคืนไคลเอ็นต์โฆษณาที่ไม่มีการใช้งานโดยมีช่อง
state
บ่งบอกถึงสถานะของไคลเอ็นต์โฆษณา
2022-02-24
การชำระเงิน
-
เราได้ขยายรูปแบบชื่อทรัพยากรเพื่อรองรับทรัพยากรที่แยกกันสำหรับรายได้จาก YouTube การเปลี่ยนแปลงนี้มีการเปิดตัวเป็นช่วงๆ สำหรับประสบการณ์การใช้งาน AdSense ที่ปรับปรุงใหม่สำหรับครีเอเตอร์ YouTube โดยจะมีการแยกรายได้จาก YouTube เป็นบัญชีการชำระเงินของ YouTube เอง ระบบจะส่งข้อมูลการชำระเงินของ YouTube กลับมาจากวิธีการชำระเงินตามรายการการชำระเงินเมื่อคุณมีบัญชีการชำระเงินสำหรับรายได้จาก YouTube โดยเฉพาะ
รายได้จาก YouTube จะมีรูปแบบชื่อทรัพยากรดังต่อไปนี้
- บัญชี/{account}/payments/youtube-unpaid สำหรับรายได้ที่ยังไม่ได้ชำระ (ปัจจุบัน) จาก YouTube
- accounts/{account}/payments/youtube-yyyy-MM-dd สำหรับรายได้จาก YouTube ที่ชำระแล้ว
หมายเหตุ: ชื่อแหล่งข้อมูลสำหรับรายได้จาก AdSense จะไม่เปลี่ยนแปลง- บัญชี/{account}/การชำระเงิน/การชำระเงินที่ยังไม่ได้ชำระสำหรับรายได้ AdSense (ปัจจุบัน) ที่ยังไม่ได้ชำระ
- accounts/{account}/payments/yyyy-MM-dd สำหรับรายได้จาก AdSense ที่ชำระแล้ว
2021-06-30
รายงาน
- เพิ่มมิติข้อมูล
AD_FORMAT_NAME
และAD_FORMAT_CODE
ซึ่งระบุวิธีที่โฆษณาแสดงต่อผู้ใช้บนเว็บไซต์ (ในหน้าเว็บ วิกเน็ตต์ ฯลฯ) โปรดทราบว่า v1.4 มีมิติข้อมูล (เลิกใช้งานแล้ว) ที่มีชื่อเหมือนกันแต่มีสมาชิกต่างกัน มิติข้อมูล 2 รายการที่เพิ่มเข้ามาใน v2 แตกต่างจากมิติข้อมูลที่แสดงใน v1.4
19-04-2021 (รุ่นแรก)
ทั่วไป
- นำเมธอดที่เลิกใช้งานแล้วทั้งหมดใน v1.4 ออกแล้ว ซึ่งรวมถึงเมธอดทรัพยากรที่ไม่ต้องใช้
accountId
ใน v2 จะมีการระบุaccountId
ในช่องparent
- ตอนนี้ระบบระบุทรัพยากรด้วยช่อง
name
แล้วตามมาตรฐาน Google API เช่น ชื่อของ AdClient อาจมีลักษณะดังนี้accounts/{accountId}/adclients/{adClientId}
นอกจากนี้ ใน v1.4 มีการใช้รหัสทรัพยากรเป็นมิติข้อมูลการรายงาน แต่ใน v2 ค่านั้นพร้อมใช้งานผ่านช่องreporting_dimension_id
ในทรัพยากรหลายรายการแล้ว - นำช่อง
kind
ออกจากทรัพยากรทั้งหมดแล้ว
บัญชี
- ช่อง
name
ได้เปลี่ยนเป็นdisplay_name
- ช่อง
timezone
เปลี่ยนจากสตริงเป็นgoogle.type.TimeZone
แล้ว - ช่อง
creation_time
(ประเภท int64) มีการเปลี่ยนแปลงเป็นcreate_time
(ประเภทgoogle.protobuf.Timestamp
) - เพิ่มช่อง
pending_tasks
ซึ่งเป็นรายการงานคงค้างที่ต้องดำเนินการให้เสร็จในขั้นตอนลงชื่อสมัครใช้สำหรับบัญชีใหม่ เช่น งานอาจเกี่ยวข้องกับโปรไฟล์การเรียกเก็บเงินหรือการยืนยันทางโทรศัพท์ - นำช่อง
sub_accounts
ออกแล้ว โดยจะมีฟังก์ชันการทำงานที่คล้ายกันในเวอร์ชัน 2 ได้โดยใช้เมธอดlistChildAccounts
ที่กำหนดเอง คุณสร้างโครงสร้างบัญชีย่อยแบบเต็มในเวอร์ชัน 2 ได้โดยเรียกใช้listChildAccounts
ซ้ำๆ
AdClient
- นำช่อง
arc_opt_in
ออกเนื่องจากนำออกจาก UI ของ AdSense แล้ว - ระบบจะแทนที่ช่อง
supports_reporting
ด้วยช่องreporting_dimension_id
ซึ่งแสดงรหัสที่ไม่ซ้ำกันของไคลเอ็นต์โฆษณาตามที่ใช้ในมิติข้อมูลการรายงานAD_CLIENT_ID
หากreporting_dimension_id
ว่างเปล่า AdClient ไม่รองรับการรายงาน
AdUnit
- ช่อง
status
เปลี่ยนชื่อเป็นstate
แล้ว นอกจากนี้ สถานะACTIVE
ไม่ได้ระบุว่ามีกิจกรรมในหน่วยโฆษณานี้ในช่วง 7 วันที่ผ่านมาหรือไม่ ในเวอร์ชัน 2 หมายความว่าผู้ใช้เปิดใช้งานหน่วยโฆษณาแล้วและสามารถแสดงโฆษณาได้ - นำช่อง
code
ออกแล้ว คุณจะยังดูค่านี้ได้ที่ส่วนท้ายของช่องname
(หลังเครื่องหมายทับตัวสุดท้าย) - นำช่อง
contentAdsSettings.backupOption
ออกแล้ว - ช่อง
type
ถูกจำกัดสำหรับค่าTYPE_UNSPECIFIED
,DISPLAY
,FEED
,ARTICLE
,MATCHED_CONTENT
และLINK
- ช่องอื่นๆ ที่ถูกนําออกใน UI ของ AdSense แล้ว
ก็ถูกนำออกเช่นกัน ได้แก่
custom_style
,saved_style_id
,mobile_content_ads_settings
,feed_ads_settings
การแจ้งเตือน
- นำเมธอด
delete
ออกแล้ว - นำช่อง
is_dismissible
ออกแล้ว - ช่อง
locale
เปลี่ยนชื่อเป็นlanguage_code
แล้ว
CustomChannel
- นำช่อง
code
ออกแล้ว คุณจะยังดูค่านี้ได้ที่ส่วนท้ายของช่องname
(หลังเครื่องหมายทับตัวสุดท้าย) - ระบบนำช่อง
targeting_info
ออกแล้วเนื่องจากถูกนำออกจาก UI ของ AdSense แล้ว
การชำระเงิน
- ช่อง
payment_date
เปลี่ยนชื่อเป็นdate
และเปลี่ยนจากสตริงประเภทเป็นประเภทgoogle.type.Date
แล้ว - ช่อง
payment_amount
และช่องpayment_amount_currency_code
รวมกันเป็นช่องpayment
ช่องเดียว (เช่น "¥1,235 JPY", "$1,234.57", "£87.65")
รายงาน
- เมื่อใช้เวอร์ชัน 2 ข้อมูลการรายงาน AdSense Management API จะสอดคล้องกับ UI ของ AdSense แล้ว ซึ่งหมายความว่าระบบจะไม่รองรับพร็อพเพอร์ตี้ AdMob และ YouTube อีกต่อไป นอกจากนี้ API จะรองรับเฉพาะข้อมูลรายงานย้อนหลังไป 3 ปี
- นำทรัพยากร
Metadata.dimensions
และทรัพยากรMetadata.metrics
ออกแล้ว - มีการเพิ่มเมธอดใหม่เพื่อสร้างรายงานเวอร์ชัน CSV ที่จะมาแทนที่พารามิเตอร์การค้นหาใน v1.4 หมายเหตุ: สำหรับการบีบอัด คุณยังใช้ส่วนหัว HTTP เป็น "accept-Encrypting: gzip" ได้
-
ช่องบางช่องมีการเปลี่ยนแปลงในการสร้างรายงานเฉพาะกิจ
- ช่อง
account_id
เปลี่ยนชื่อเป็นaccount
แล้ว - ช่อง
dimension
เปลี่ยนชื่อเป็นdimensions
แล้ว - ช่อง
metric
เปลี่ยนชื่อเป็นmetrics
แล้ว - ช่อง
filter
เปลี่ยนชื่อเป็นfilters
แล้ว - ช่อง
sort
เปลี่ยนชื่อเป็นorder_by
แล้ว - ช่อง
locale
เปลี่ยนชื่อเป็นlanguage_code
แล้ว - ช่อง
currency
เปลี่ยนชื่อเป็นcurrency_code
แล้ว - ตอนนี้คุณระบุช่วงทั่วไปหลายช่วงได้ด้วย
date_range
(เช่นTODAY
,YESTERDAY
,MONTH_TO_DATE
,YEAR_TO_DATE
,LAST_7_DAYS
และLAST_30_DAYS
) หรือจะระบุstart_date
และend_date
ก็ได้โดยการตั้งค่าdate_range
เป็นCUSTOM
- ช่อง
start_date
และend_date
เปลี่ยนจากสตริงประเภทเป็นประเภทgoogle.type.Date
แล้ว หมายเหตุ: ดังนั้น คีย์เวิร์ดวันที่สัมพัทธ์ (เช่น ไม่รองรับ "today-6d") อีกต่อไป - ระบบได้แทนที่ช่องบูลีน
use_timezone_reporting
ด้วยreporting_time_zone
แล้ว ซึ่งมีค่าใดค่าหนึ่งจาก 2 ค่า ได้แก่ACCOUNT_TIME_ZONE
หรือGOOGLE_TIME_ZONE
(ซึ่งหมายถึง PST/PDT) ค่าเริ่มต้นใน v2 คือACCOUNT_TIME_ZONE
ซึ่งต่างจากค่าเริ่มต้นใน v1.4 - นำช่อง
start_index
ออกแล้ว - ช่อง
max_results
เปลี่ยนชื่อเป็นlimit
แล้ว
- ช่อง
-
มีการเปลี่ยนแปลงบางช่องในการสร้างรายงานที่บันทึกไว้
- เพิ่มช่องวันที่ (
date_range
,start_date
,end_date
,reporting_time_zone
) - เพิ่มช่อง
currency_code
แล้ว - ช่อง
locale
เปลี่ยนชื่อเป็นlanguage_code
แล้ว - นำช่อง
start_index
ออกแล้ว - นำช่อง
max_results
ออกแล้ว
- เพิ่มช่องวันที่ (
SavedAdStyle
SavedAdStyle
ถูกนำออกแล้ว เนื่องจากถูกนำออกจาก UI ของ AdSense แล้ว
เว็บไซต์
-
ระบบได้เพิ่ม
Sites
เพื่อดึงข้อมูลเกี่ยวกับเว็บไซต์ที่คุณเพิ่มไปยังบัญชี AdSense แล้ว - ช่อง
state
แสดงให้เห็นว่าเว็บไซต์มีสถานะใดๆ ต่อไปนี้หรือไม่:REQUIRES_REVIEW
,GETTING_READY
,READY
,NEEDS_ATTENTION
- ช่อง
auto_ads_enabled
เป็นบูลีนที่แสดงว่ามีการเปิดใช้โฆษณาอัตโนมัติในเว็บไซต์หนึ่งๆ หรือไม่
เวอร์ชัน 1.4
เวอร์ชันนี้มีฟังก์ชันการทำงานต่อไปนี้
- ตอนนี้คุณแสดงรายการการชำระเงินในบัญชี AdSense ในสกุลเงินที่เกี่ยวข้องได้แล้ว
- ตอนนี้คุณปิดการแจ้งเตือนได้โดยเรียกใช้เมธอด
delete
ซึ่งจะซ่อนการแจ้งเตือนใน API และอินเทอร์เฟซเว็บของ AdSense - ตอนนี้การตอบกลับรายงานจะรวมวันที่เริ่มต้นและวันที่สิ้นสุด ซึ่งมีความสำคัญหากคุณใช้วันที่สัมพัทธ์เมื่อสร้างรายงาน (เช่น
today
,yesterday
,firstDayOfMonth-1m
) ตอนนี้คำตอบจะรวมช่วงวันที่ที่คุณขอแล้ว
ปัญหาที่ทราบ
เวอร์ชันนี้ไม่รองรับช่อง currency
ในรายงาน
เวอร์ชัน 1.3
เวอร์ชันนี้มีฟังก์ชันการทำงานต่อไปนี้
- ความสามารถในการเรียกดูการแจ้งเตือน
- ความสามารถในการดึงเมตริกและข้อมูลเมตาของมิติข้อมูล
- สามารถเรียกใช้รายงานในเขตเวลาท้องถิ่นของบัญชี
ปัญหาที่ทราบ
เวอร์ชันนี้ไม่รองรับช่อง currency
ในรายงาน
เวอร์ชัน 1.2
เวอร์ชันนี้มีฟังก์ชันการทำงานต่อไปนี้
- ความสามารถในการเรียกดูสไตล์โฆษณา
- ความสามารถในการเรียกและเรียกใช้รายงานที่บันทึกไว้ซึ่งกำหนดไว้ในฟรอนท์เอนด์
ปัญหาที่ทราบ
เวอร์ชันนี้ไม่รองรับช่อง currency
ในรายงาน
เวอร์ชัน 1.1
เวอร์ชันนี้มีฟังก์ชันการทำงานต่อไปนี้
- ความสามารถในการแสดงรายการบัญชีที่ผู้ใช้มีสิทธิ์เข้าถึง
- ความสามารถในการโทร GET ในบัญชีเฉพาะ
- ความสามารถในการ "รับการเรียก" บนหน่วยโฆษณาและแชแนลที่กำหนดเอง
- ความสามารถในการกำหนดการเชื่อมต่อระหว่างหน่วยโฆษณากับแชแนลที่กำหนดเอง
- แชแนลที่กำหนดเองมีข้อมูลเพิ่มเติมเกี่ยวกับข้อมูลการกำหนดเป้าหมาย
นอกจากนี้ คุณยังสามารถเข้าถึงข้อมูลได้ในบัญชีเริ่มต้นของคุณหรือในบัญชีที่ต้องการ
ปัญหาที่ทราบ
เวอร์ชันนี้ไม่รองรับช่อง currency
ในรายงาน
เวอร์ชัน 1
นี่คือ API รุ่นแรก เครื่องมือนี้มีการสนับสนุนสำหรับการเรียกไคลเอ็นต์โฆษณา หน่วยโฆษณา, แชแนลที่กำหนดเอง, แชแนล URL รวมทั้งการเรียกใช้รายงาน
ปัญหาที่ทราบ
เวอร์ชันนี้ไม่รองรับช่อง currency
ในรายงาน