หน้านี้มีบันทึกประจำรุ่นของ AdSense Management API
เวอร์ชัน 2
เวอร์ชันนี้จะมีการเปลี่ยนแปลงต่อไปนี้เพื่อนำฟังก์ชันการทำงานที่เลิกใช้งานแล้วออก และเพื่อปรับ AdSense Management API ให้สอดคล้องกับมาตรฐานปัจจุบันของ Google API ตามรูปแบบการกำหนดเวอร์ชันของ Google API เวอร์ชันนี้จะได้รับการอัปเดตเมื่อเวลาผ่านไปเพื่อรวมฟังก์ชันการทำงานเพิ่มเติม (เข้ากันได้แบบย้อนหลัง) แทนที่จะเปิดตัวฟังก์ชันการทำงานใหม่ในเวอร์ชันย่อยแยกต่างหาก
2025-02-24
PolicyIssues
- เพิ่มช่อง
policyTopics[].type
เพื่อระบุว่าหัวข้อนโยบายแสดงถึงปัญหาเกี่ยวกับนโยบาย ปัญหาเกี่ยวกับกฎระเบียบ หรือค่ากำหนดของผู้ลงโฆษณาหรือไม่ ช่องนี้จะแทนที่policyTopics[].must_fix
ซึ่งตอนนี้มีสถานะเป็นช่องที่เลิกใช้งานแล้ว
2024-04-03
PolicyIssues
- เพิ่มคอลเล็กชันใหม่เพื่อรายงานการละเมิดนโยบายและคำเตือนปัจจุบันที่มีอยู่ในบัญชี
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 เท่านั้นที่จะใช้วิธีการเหล่านี้ได้
- เพิ่มช่อง "ใช้งานอยู่" ลงในทรัพยากร
บัญชี
- เพิ่มเมธอด getAdBlockingRecoveryTag
2022-08-25
รายงาน
- เพิ่มมิติข้อมูล
HOSTED_AD_CLIENT_ID
ซึ่งช่วยให้ผู้เผยแพร่โฆษณาที่เป็นโฮสต์และผู้เผยแพร่โฆษณาที่เป็นแพลตฟอร์มสามารถแจกแจงเมตริกตามบัญชีของผู้เผยแพร่โฆษณา (ผู้เผยแพร่โฆษณาที่เป็นโฮสต์) และตามบัญชีย่อย (ผู้เผยแพร่โฆษณาที่เป็นแพลตฟอร์ม)
2022-05-03
AdClient
- เพิ่มวิธีการเรียกข้อมูล
รายงาน
- เพิ่มเมธอด getSaved
UrlChannels
- เพิ่มวิธีการเรียกข้อมูล
2022-03-31
บัญชี
- ตอนนี้ API จะแสดงบัญชีที่ไม่ได้ใช้งานพร้อมช่อง
state
ซึ่งระบุสถานะของบัญชี
AdClient
- ตอนนี้ API จะแสดงผลลูกค้าที่ใช้งานอยู่ไม่ได้พร้อมกับช่อง
state
ที่มีสถานะของลูกค้าโฆษณา ซึ่งคล้ายกับการเปลี่ยนแปลงบัญชีข้างต้น
2022-02-24
การชำระเงิน
-
เราได้ขยายรูปแบบชื่อทรัพยากรเพื่อรองรับทรัพยากรแยกต่างหากสำหรับรายได้จาก YouTube การเปลี่ยนแปลงนี้เกิดขึ้นก่อนการเปิดตัวประสบการณ์การใช้งาน AdSense ที่ปรับปรุงใหม่สำหรับครีเอเตอร์ YouTube ซึ่งรายได้จาก YouTube จะแยกเป็นบัญชีการชำระเงินของตนเอง ระบบจะแสดงข้อมูลการชำระเงินของ YouTube จากวิธีการแสดงรายการการชำระเงินด้วย เมื่อคุณมีบัญชีการชำระเงินโดยเฉพาะสำหรับรายได้จาก YouTube
รายได้จาก YouTube จะมีรูปแบบชื่อทรัพยากรดังต่อไปนี้
- accounts/{account}/payments/youtube-unpaid สำหรับรายได้จาก YouTube (ปัจจุบัน) ที่ยังไม่ได้ชำระ
- accounts/{account}/payments/youtube-yyyy-MM-dd สำหรับรายได้จาก YouTube แบบชำระเงิน
หมายเหตุ: ชื่อแหล่งข้อมูลของรายได้จาก AdSense จะยังคงเหมือนเดิม ดังนี้- accounts/{account}/payments/unpaid สำหรับรายได้จาก 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
ออกแล้ว ฟังก์ชันการทำงานที่คล้ายกันนี้ทำได้ใน v2 ด้วยlistChildAccounts
วิธีที่กำหนดเอง คุณสามารถสร้างต้นไม้บัญชีย่อยแบบสมบูรณ์ใน v2 ได้โดยเรียกใช้listChildAccounts
แบบซ้ำ
AdClient
- นําช่อง
arc_opt_in
ออกแล้วเนื่องจากนําออกจาก UI ของ AdSense แล้ว - ระบบจะแทนที่ช่อง
supports_reporting
ด้วยช่องreporting_dimension_id
ซึ่งแสดงรหัสที่ไม่ซ้ำกันของไคลเอ็นต์โฆษณาตามที่ใช้ในมิติข้อมูลการรายงานAD_CLIENT_ID
หากreporting_dimension_id
ว่างเปล่า แสดงว่า AdClient ไม่รองรับการรายงาน
AdUnit
- เปลี่ยนชื่อช่อง
status
เป็นstate
แล้ว นอกจากนี้ สถานะACTIVE
จะไม่ระบุว่ามีกิจกรรมในหน่วยโฆษณานี้ในช่วง 7 วันที่ผ่านมาหรือไม่อีกต่อไป ใน v2 สถานะนี้หมายความว่าผู้ใช้ได้เปิดใช้งานหน่วยโฆษณาแล้วและสามารถแสดงโฆษณาได้ - นําช่อง
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-Encoding: 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
method ที่จะซ่อนการแจ้งเตือนใน API และเว็บอินเทอร์เฟซของ AdSense - ตอนนี้การตอบกลับรายงานจะมีวันที่เริ่มต้นและวันที่สิ้นสุด การดำเนินการนี้สำคัญอย่างยิ่งหากคุณใช้วันที่แบบสัมพัทธ์เมื่อสร้างรายงาน (เช่น
today
,yesterday
,firstDayOfMonth-1m
) ตอนนี้การตอบกลับจะมีช่วงวันที่ที่คุณขอ
ปัญหาที่ทราบ
เวอร์ชันนี้ไม่รองรับฟิลด์ currency
ในรายงาน
เวอร์ชัน 1.3
เวอร์ชันนี้เปิดตัวฟังก์ชันต่อไปนี้
- ความสามารถในการเรียกข้อมูลการแจ้งเตือน
- ความสามารถในการดึงข้อมูลเมตาของเมตริกและมิติข้อมูล
- ความสามารถในการเรียกใช้รายงานในเขตเวลาท้องถิ่นของบัญชี
ปัญหาที่ทราบ
เวอร์ชันนี้ไม่รองรับฟิลด์ currency
ในรายงาน
เวอร์ชัน 1.2
เวอร์ชันนี้เปิดตัวฟังก์ชันต่อไปนี้
- ความสามารถในการเรียกข้อมูลสไตล์โฆษณา
- ความสามารถในการเรียกข้อมูลและเรียกใช้รายงานที่บันทึกไว้ซึ่งกำหนดไว้ในหน้าเว็บ
ปัญหาที่ทราบ
เวอร์ชันนี้ไม่รองรับฟิลด์ currency
ในรายงาน
เวอร์ชัน 1.1
เวอร์ชันนี้เปิดตัวฟังก์ชันต่อไปนี้
- ความสามารถในการแสดงรายการบัญชีที่ผู้ใช้มีสิทธิ์เข้าถึง
- ความสามารถในการเรียก GET ในบัญชีที่เฉพาะเจาะจง
- ความสามารถในการเรียก GET ในหน่วยโฆษณาและแชแนลที่กำหนดเอง
- ความสามารถในการกำหนดการเชื่อมต่อระหว่างหน่วยโฆษณากับแชแนลที่กำหนดเอง
- แชแนลที่กำหนดเองมีข้อมูลเกี่ยวกับการกําหนดเป้าหมายมากกว่า
นอกจากนี้ ตอนนี้คุณยังเข้าถึงข้อมูลภายใต้บัญชีเริ่มต้นหรือบัญชีที่เฉพาะเจาะจงได้ด้วย
ปัญหาที่ทราบ
เวอร์ชันนี้ไม่รองรับฟิลด์ currency
ในรายงาน
เวอร์ชัน 1
นี่คือรุ่นแรกของ API ซึ่งรวมถึงการรองรับการเรียกข้อมูลลูกค้าโฆษณา หน่วยโฆษณา แชแนลที่กําหนดเอง แชแนล URL ตลอดจนการเรียกใช้รายงาน
ปัญหาที่ทราบ
เวอร์ชันนี้ไม่รองรับฟิลด์ currency
ในรายงาน