หน้านี้มีบันทึกประจำรุ่นสำหรับ AdSense Management API
เวอร์ชัน 2
เวอร์ชันนี้มีการเปลี่ยนแปลงต่อไปนี้เพื่อนำฟังก์ชันที่เลิกใช้งานแล้วออกและเพื่อปรับ AdSense Management API ให้สอดคล้องกับมาตรฐาน Google API ปัจจุบัน ตามรูปแบบการกำหนดเวอร์ชัน Google API เวอร์ชันนี้จะอัปเดตเมื่อเวลาผ่านไปให้มีฟังก์ชันการทำงานเพิ่มเติม (ที่เข้ากันได้แบบย้อนหลัง) แทนฟังก์ชันการทำงานใหม่ที่เผยแพร่ในเวอร์ชันย่อยที่แยกต่างหาก
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 เท่านั้น
- เพิ่มฟิลด์ที่ใช้งานอยู่ในทรัพยากร
บัญชี
- เพิ่มเมธอด getAdBlockedRecoveryTag แล้ว
2022-08-25
รายงาน
- เพิ่มมิติข้อมูล
HOSTED_AD_CLIENT_ID
ซึ่งช่วยให้ผู้เผยแพร่โฆษณาที่เป็นโฮสต์และแพลตฟอร์มสามารถแจกแจงเมตริกตามบัญชีของผู้เผยแพร่โฆษณา (ผู้เผยแพร่โฆษณาที่โฮสต์) และตามบัญชีย่อย (ผู้เผยแพร่โฆษณาในแพลตฟอร์ม)
2022-05-03
AdClient
- เพิ่มเมธอด Get แล้ว
รายงาน
- เพิ่มเมธอด getSaved แล้ว
UrlChannels
- เพิ่มเมธอด Get แล้ว
2022-03-31
บัญชี
- ตอนนี้ API จะส่งคืนบัญชีที่ไม่ใช้งาน โดยมีช่อง
state
ระบุสถานะของบัญชี
AdClient
- ตอนนี้ API จะส่งคืนไคลเอ็นต์โฆษณาที่ไม่มีการใช้งานด้วยช่อง
state
ซึ่งระบุสถานะของไคลเอ็นต์โฆษณา เช่นเดียวกับการเปลี่ยนแปลงในบัญชีด้านบน
2022-02-24
การชำระเงิน
-
เราได้ขยายรูปแบบชื่อทรัพยากรเพื่อรองรับทรัพยากรแยกต่างหากสำหรับรายได้จาก YouTube การเปลี่ยนแปลงนี้เกิดขึ้นก่อนการเปิดตัวประสบการณ์การใช้งาน AdSense ที่ปรับปรุงใหม่สำหรับครีเอเตอร์ 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}
นอกจากนี้ ในเวอร์ชัน 1.4 ได้มีการใช้รหัสทรัพยากรเป็นมิติข้อมูลการรายงาน แต่ใน v2 ค่านั้นพร้อมใช้งานแล้วผ่านช่องreporting_dimension_id
สำหรับทรัพยากรหลายรายการ - นำฟิลด์
kind
ออกจากทรัพยากรทั้งหมดแล้ว
บัญชี
- ช่อง
name
ได้เปลี่ยนเป็นdisplay_name
- ช่อง
timezone
เปลี่ยนจากสตริงเป็นgoogle.type.TimeZone
แล้ว - ช่อง
creation_time
(type int64) มีการเปลี่ยนแปลงเป็นcreate_time
(ประเภทgoogle.protobuf.Timestamp
) - เพิ่มช่อง
pending_tasks
ซึ่งเป็นรายการงานที่ต้องทำให้เสร็จในขั้นตอนลงชื่อสมัครใช้สำหรับบัญชีใหม่ เช่น งานอาจเกี่ยวข้องกับโปรไฟล์การเรียกเก็บเงินหรือการยืนยันทางโทรศัพท์ - นำช่อง
sub_accounts
ออกแล้ว ผู้ใช้จะใช้ฟังก์ชันที่คล้ายกันนี้ใน v2 ได้โดยใช้เมธอดที่กำหนดเองของ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")
รายงาน
- เมื่อใช้ v2 ข้อมูลการรายงาน 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
ในรายงานในรุ่นนี้