แหล่งอ้างอิง

พารามิเตอร์

คำอธิบายพารามิเตอร์ระดับหน้าเว็บ

ระบุพารามิเตอร์เหล่านี้เพียงครั้งเดียวต่อหน้า ซึ่งจะมีผลต่อหน่วยโฆษณาทั้งหมดบนหน้าเว็บ

จำเป็น

พารามิเตอร์ คำอธิบายและตัวอย่าง
adPage ต้องระบุเมื่อผู้ใช้ไปที่หน้าผลลัพธ์ถัดไปหรือหน้าผลการค้นหาก่อนหน้า

พารามิเตอร์ adPage จะระบุหน้าผลลัพธ์ที่แสดงโฆษณา พารามิเตอร์นี้ใช้เมื่อผู้ใช้ผ่านหน้าแรกของผลการค้นหาไป ตัวอย่างเช่น หากมีการขอโฆษณา 5 รายการและตั้งค่าพารามิเตอร์ adPage เป็น 2 โฆษณาที่แสดงจะเป็นหน้าที่ 2 ของโฆษณา 5 รายการ

pubId ต้องระบุ
นี่คือ Client-ID AdSense ของคุณ pubId เป็นส่วนหนึ่งของ Client-ID ที่อยู่หลัง "partner-" ตัวอย่างเช่น หาก client-ID คือ "partner-test-property" pubId ของคุณจะเป็น "test-property" นี่คือโปรโตคอลมาตรฐานสำหรับ CSA

ตัวอย่างเช่น

'pubId' : 'test-property'

query ต้องระบุ
นี่คือคำค้นหาที่ผู้ใช้ป้อน ค่าของพารามิเตอร์การค้นหาไม่ควรมีการเข้ารหัส

ตัวอย่าง:

'query' : 'flowers'
'query' : 'black & decker'
'query' : myQuery // myQuery is a variable containing the search query

resultsPageBaseUrl ต้องระบุเมื่อมีหน่วยการค้นหาที่เกี่ยวข้องในหน้า
ระบุ URL ของหน้าผลการค้นหาที่คำค้นหาเป็นข้อความค้นหาที่เกี่ยวข้องซึ่งผู้ใช้คลิก resultsPageBaseUrl อาจมีพารามิเตอร์ของตัวเอง ยกเว้นคําค้นหาที่จะต่อท้ายโดยอัตโนมัติ

ตัวอย่างเช่น

'resultsPageBaseUrl' : 'http://www.example.com/search?a=v1&b=v2'

styleId ต้องระบุ
ระบุรหัสของสไตล์โฆษณาที่กำหนดเองในเครือข่ายการค้นหาที่จะใช้กับโฆษณาหรือหน่วยการค้นหาที่เกี่ยวข้องในหน้า ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้สไตล์โฆษณาที่กำหนดเองในเครือข่ายการค้นหา โปรดทราบว่าเมื่อมีการตั้งค่า styleId สําหรับคําขอ โฆษณาหรือการค้นหาที่เกี่ยวข้องจะแสดงผลด้วยสไตล์นี้ และระบบจะไม่สนใจพารามิเตอร์สไตล์เดิม หากไม่ได้ระบุ styleId ในคําขอ ระบบจะแสดงสไตล์เริ่มต้นของระบบ

ตัวอย่างเช่น

'styleId': '1234567890'

ไม่บังคับ

พารามิเตอร์ คำอธิบายและตัวอย่าง
linkTarget ไม่บังคับ
ระบุว่าการคลิกโฆษณาจะเปิดในหน้าต่างเดียวกันหรือหน้าต่างใหม่ ค่าเริ่มต้นคือ "_top" ใช้พารามิเตอร์นี้ในระดับหน่วยได้ด้วย
  • '_top' เปิดในหน้าต่างเดียวกัน
  • '_blank' เปิดในหน้าต่างใหม่

ตัวอย่างเช่น

'linkTarget' : '_blank'

maxTermLength ไม่บังคับ
ระบุจำนวนอักขระสูงสุดของข้อความค้นหาที่เกี่ยวข้องซึ่งรวมการเว้นวรรคด้วย ไม่จํากัดหากไม่ได้ตั้งค่า

ตัวอย่างเช่น

'maxTermLength' : 50

referrerAdCreative ไม่บังคับ
หากผู้ใช้เข้ามาที่หน้าเนื้อหาซึ่งมีหน่วยการค้นหาที่เกี่ยวข้องกับเนื้อหาด้วยการคลิกโฆษณาหรือลิงก์ในเว็บไซต์อื่น และโฆษณาหรือลิงก์นั้นอยู่ภายใต้การควบคุมของคุณ ควรตั้งค่าพารามิเตอร์นี้เป็นข้อความครีเอทีฟโฆษณาของโฆษณาหรือลิงก์นั้นให้คำต่อคำ

การใช้พารามิเตอร์นี้ต้องเป็นไปตามหลักเกณฑ์ต่อไปนี้

  • ควรระบุพารามิเตอร์นี้ในการค้นหาที่เกี่ยวข้องกับคำขอเนื้อหาเท่านั้น และไม่สนใจคำขออื่นๆ ทั้งหมด
  • ควรใช้กับการเข้าชมที่คุณตั้งใจมาจากเว็บไซต์อื่นๆ เท่านั้น และไม่ควรใช้กับการเข้าชมจากการค้นหาทั่วไป
  • อาจมีบรรทัดชื่อและ/หรือคําอธิบายของโฆษณาหรือลิงก์ครีเอทีฟโฆษณา
  • ไม่คำนึงถึงตัวพิมพ์เล็กหรือใหญ่
  • ยอมรับการเข้ารหัส UTF-8 ที่ถูกต้อง รองรับอักขระ Unicode / เครื่องหมายกำกับการออกเสียง
  • Google อาจใช้หรือไม่สนใจพารามิเตอร์ที่คุณส่งก็ได้ เมื่อมีการนำไปใช้ อาจส่งผลต่อการเลือกและการจัดอันดับคำดังกล่าว

ตัวอย่าง:

'referrerAdCreative': 'search for ads related to dental implants'

'referrerAdCreative': 'The Early Signs of Psoriatic Arthritis'

resultsPageQueryParam ไม่บังคับ
ระบุชื่อของพารามิเตอร์ของ URL สําหรับคําค้นหาในหน้าผลการค้นหา ค่าเริ่มต้นจะเป็น "q" หากไม่ได้ระบุไว้

ตัวอย่างเช่น

'resultsPageQueryParam' : 'query'

terms ไม่บังคับ
พารามิเตอร์นี้ช่วยให้คุณระบุรายการที่คั่นด้วยคอมมาของข้อความค้นหาที่เกี่ยวข้องของคุณเองให้แสดงพร้อมกับคําขอการค้นหาที่เกี่ยวข้อง แม้ว่า Google อาจใช้หรือไม่ใช้ข้อความดังกล่าวก็ได้

ตัวอย่าง:

'terms' : 'cars rental, flight ticket'

การตั้งค่า

พารามิเตอร์ คำอธิบายและตัวอย่าง
adsafe ไม่บังคับ
ระบุกฎการกรองที่ Google ควรใช้กับโฆษณาที่ตรงกับคำค้นหา ต่อไปนี้คือการตั้งค่าที่ถูกต้องสำหรับ adsafe และผลที่แต่ละค่ามีต่อโฆษณาที่แสดง
  • 'high' แสดงโฆษณาที่เหมาะสำหรับเยาวชน ไม่แสดงโฆษณาที่ไม่เหมาะสำหรับเยาวชนหรือโฆษณาที่มีเนื้อหาเกี่ยวกับเรื่องเพศ
  • 'medium' แสดงโฆษณาที่เหมาะและไม่เหมาะสำหรับเยาวชน ไม่แสดงโฆษณาที่มีเนื้อหาเกี่ยวกับเรื่องเพศสำหรับผู้ใหญ่
  • 'low' แสดงโฆษณาทุกประเภท

Adsafe จะตั้งค่าเป็น "สูง" โดยค่าเริ่มต้น

ตัวอย่างเช่น

'adsafe': 'medium'

adtest ไม่บังคับ
พารามิเตอร์ adtest ใช้เพื่อระบุว่าคำขอโฆษณาเป็นการทดสอบ เมื่อพารามิเตอร์ adtest มีค่าเป็น on Google จะถือว่าคำขอนั้นเป็นการทดสอบและไม่นับการแสดงโฆษณาหรือติดตามผลลัพธ์การคลิกผ่าน

เมื่อพารามิเตอร์ adtest ตั้งค่าไว้เป็น on คุณจะไม่สร้างรายได้ใดๆ

ใช้พารามิเตอร์นี้เมื่อทำการทดสอบ แต่อย่าใช้ในระบบที่ใช้งานจริง มิฉะนั้นคุณจะไม่ได้รับรายได้จากโฆษณาที่คุณแสดง

ค่า adtest เริ่มต้นปิดอยู่

ตัวอย่างเช่น

'adtest' : 'on'

channel ไม่บังคับ
คุณอาจรวมแชแนลของ AdSense สําหรับ Search เพื่อติดตามประสิทธิภาพของหน้าเว็บต่างๆ ใช้รหัสแชแนลที่ไม่ซ้ำกันซึ่งสร้างขึ้นในบัญชี AdSense หรือโดยผู้จัดการลูกค้าด้านเทคนิคของคุณ ดูข้อมูลเพิ่มเติมเกี่ยวกับแชแนลที่นี่

หากมีหลายแชแนล ควรคั่นด้วยเครื่องหมาย "+"

ตัวอย่าง:

'channel' :  'testA'  
'channel' :  'testA+testB'  

hl ไม่บังคับ
พารามิเตอร์นี้เป็นตัวระบุภาษาที่โฆษณาที่ขอหรือการค้นหาที่เกี่ยวข้องควรกำหนดเป้าหมาย ค่าเริ่มต้นคือ en

Google รองรับรหัสภาษา AdWords API ทั้งหมด

หมายเหตุ: ผู้ลงโฆษณาเป็นผู้กำหนดภาษาที่โฆษณาของตนกำหนดเป้าหมาย หากคุณใส่พารามิเตอร์นี้ในคำขอของคุณ Google จะแสดงเฉพาะโฆษณาที่กำหนดเป้าหมายสำหรับภาษานั้นหรือที่กำหนดเป้าหมายสำหรับทุกภาษาเท่านั้น แต่จะไม่รับประกันว่าข้อความโฆษณาจะอยู่ในภาษาที่ระบุ

โดยปกติคุณควรตั้งค่าพารามิเตอร์ hl เป็นภาษาหลักของหน้าเว็บที่มีการส่งพารามิเตอร์นี้

ตัวอย่าง:

'hl' : 'es'

ie ไม่บังคับ

พารามิเตอร์ ie กำหนดรูปแบบการเข้ารหัสอักขระที่ควรใช้เพื่อตีความสตริงคำค้นหา

ค่าเริ่มต้นของ ie คือ utf-8

ค่า ชื่อมาตรฐาน ภาษาที่รองรับที่เกี่ยวข้อง
latin1 ISO-8859-1 ยุโรปตะวันตก (คาตาลัน เดนมาร์ก ดัตช์ อังกฤษ ฟินแลนด์ ฝรั่งเศส เยอรมัน อินโดนีเซีย อิตาลี นอร์เวย์ โปรตุเกส สเปน สวีเดน)
latin2 ISO-8859-2 ยุโรปตะวันออก (โครเอเชีย เช็ก ฮังการี โปแลนด์ โรมาเนีย เซอร์เบีย สโลวัก สโลวีเนีย)
latin3 ISO-8859-3  
latin4 ISO-8859-4 บอลติก (เอสโตเนีย ลัตเวีย ลิทัวเนีย)
ซีริลลิก ISO-8859-5 บัลแกเรีย รัสเซีย
arabic ISO-8859-6  
กรีก ISO-8859-7 กรีก
hebrew ISO-8859-8 ฮีบรู
latin5 ISO-8859-9  
latin6 ISO-8859-10 ไอซ์แลนด์
euc-jp EUC-ญี่ปุ่น ญี่ปุ่น
euc-kr เขตเวลา EUC-KR เกาหลี
Sji Shift_JIS ญี่ปุ่น
big5 Big5 จีนตัวเต็ม
gb GB2312 จีนตัวย่อ
utf-8 UTF-8 ทั้งหมด
oe ไม่บังคับ

พารามิเตอร์ oe กำหนดรูปแบบการเข้ารหัสอักขระที่ Google ควรใช้เพื่อเข้ารหัสข้อความของโฆษณา ในทางเทคนิคอาจไม่บังคับ แต่การใช้พารามิเตอร์นี้เป็นวิธีที่ดี

ค่าเริ่มต้นของ oe คือ utf-8

ค่า ชื่อมาตรฐาน ภาษาที่รองรับที่เกี่ยวข้อง
latin1 ISO-8859-1 ยุโรปตะวันตก (คาตาลัน เดนมาร์ก ดัตช์ อังกฤษ ฟินแลนด์ ฝรั่งเศส เยอรมัน อินโดนีเซีย อิตาลี นอร์เวย์ โปรตุเกส สเปน สวีเดน)
latin2 ISO-8859-2 ยุโรปตะวันออก (โครเอเชีย เช็ก ฮังการี โปแลนด์ โรมาเนีย เซอร์เบีย สโลวัก สโลวีเนีย)
latin3 ISO-8859-3  
latin4 ISO-8859-4 บอลติก (เอสโตเนีย ลัตเวีย ลิทัวเนีย)
ซีริลลิก ISO-8859-5 บัลแกเรีย รัสเซีย
arabic ISO-8859-6  
กรีก ISO-8859-7 กรีก
hebrew ISO-8859-8 ฮีบรู
latin5 ISO-8859-9  
latin6 ISO-8859-10 ไอซ์แลนด์
euc-jp EUC-ญี่ปุ่น ญี่ปุ่น
euc-kr เขตเวลา EUC-KR เกาหลี
Sji Shift_JIS ญี่ปุ่น
gb GB2312 จีนตัวย่อ
utf-8 UTF-8 ทั้งหมด
ivt ไม่บังคับ
พารามิเตอร์นี้ให้คุณระบุบูลีนที่แจ้งให้ Google ทราบว่าคุณต้องการอนุญาตโฆษณาที่ใช้คุกกี้และพื้นที่เก็บข้อมูลในเครื่องที่มีไว้เพื่อตรวจจับการเข้าชมที่ไม่ถูกต้องเท่านั้นกับทั้งการเข้าชมที่ได้รับความยินยอมและไม่ยินยอม
  • true เมื่อพารามิเตอร์นี้ไม่แสดงหรือคุณตั้งค่าเป็น "จริง" เราจะตั้งค่าคุกกี้ที่มีไว้เพื่อตรวจจับการเข้าชมที่ไม่ถูกต้องเท่านั้น และใช้พื้นที่เก็บข้อมูลในเครื่องกับการเข้าชมที่ได้รับความยินยอมเท่านั้น
  • false เมื่อคุณตั้งค่าพารามิเตอร์นี้เป็น "false" เราจะตั้งค่าคุกกี้ที่มีไว้เพื่อตรวจจับการเข้าชมที่ไม่ถูกต้องเท่านั้น และใช้พื้นที่เก็บข้อมูลในเครื่องกับทั้งการเข้าชมที่ได้รับความยินยอมและไม่ได้รับความยินยอม

IVT จะตั้งค่าเป็นจริงโดยค่าเริ่มต้น

ตัวอย่างเช่น

'ivt': false

คำอธิบายพารามิเตอร์ระดับหน่วยโฆษณา

พารามิเตอร์เหล่านี้ส่งผลต่อวิธีที่แต่ละหน่วยโฆษณาบนหน้าเว็บปรากฏต่อผู้ใช้ แต่ละพารามิเตอร์จะตั้งค่าให้แตกต่างกันได้สำหรับแต่ละหน่วยโฆษณา

จำเป็น

พารามิเตอร์ คำอธิบายและตัวอย่าง
container ต้องระบุ
รหัสของคอนเทนเนอร์โฆษณาว่างเปล่า <div> ที่โฆษณาควรปรากฏ

ตัวอย่างเช่น

'container' : 'afscontainer1'

maxTop ต้องระบุเมื่อหน่วยโฆษณาอยู่เหนือผลการค้นหา

ใช้พารามิเตอร์นี้เพื่อระบุจำนวนโฆษณาที่จะแสดงในหน่วยโฆษณาด้านบน

หมายเหตุ: พารามิเตอร์นี้ใช้แทนพารามิเตอร์ "number" หน่วยโฆษณานี้ควรกว้างพอเพื่อให้บรรทัดแรกของโฆษณาไม่มีการตัดขึ้นบรรทัดใหม่ การใช้พารามิเตอร์ maxTop ในตำแหน่งอื่นๆ บนหน้าเว็บเป็นการละเมิดนโยบาย

ตัวอย่าง

'maxTop' : 4
width ต้องระบุ
ระบุความกว้างของโฆษณาหรือหน่วยการค้นหาที่เกี่ยวข้องเป็นพิกเซล

ตัวอย่างเช่น

'width' : '700px'
'width' : 700

การตั้งค่า

พารามิเตอร์ คำอธิบายและตัวอย่าง
adLoadedCallback ไม่บังคับ
ระบุฟังก์ชัน JavaScript ที่จะเรียกใช้เมื่อโฆษณาหรือการค้นหาที่เกี่ยวข้องโหลดขึ้น หรือเมื่อไม่มีการแสดงโฆษณาหรือการค้นหาที่เกี่ยวข้อง ควรตั้งค่าพารามิเตอร์เป็นฟังก์ชันเรียกกลับของ JavaScript ที่คุณใช้ซึ่งจะช่วยให้ดำเนินการได้เมื่อการเรียกโฆษณาเสร็จสมบูรณ์

ฟังก์ชันเรียกกลับจะใช้พารามิเตอร์ต่อไปนี้

containerName ชื่อคอนเทนเนอร์ของโฆษณาหรือหน่วยการค้นหาที่เกี่ยวข้อง
adsLoaded ตั้งค่าเป็นจริงเมื่อมีโฆษณาหรือข้อความค้นหาที่เกี่ยวข้องอย่างน้อย 1 รายการที่จะแสดง ตั้งค่าเป็นเท็จเมื่อไม่มีโฆษณาหรือการค้นหาที่เกี่ยวข้องแสดง
isExperimentVariant ตั้งค่าเป็นจริงหากการทดสอบสไตล์ที่กําหนดเองทํางานอยู่และเลือกตัวแปรของการทดสอบเพื่อแสดงโฆษณา
callbackOptions ออบเจ็กต์ JSON ที่มีช่องต่อไปนี้
termPositions: สําหรับบล็อกการค้นหาที่เกี่ยวข้องจะมีการแมป<string,int> ของคําที่ผู้เผยแพร่โฆษณาระบุไว้กับตําแหน่งที่ไม่มีการจัดทำดัชนีของคําเหล่านี้ในคำตอบ หากมีการระบุคําแล้วแต่ไม่ได้ส่งคืน ก็จะไม่ปรากฏในแผนที่

หมายเหตุ: โปรดทดสอบฟังก์ชันเรียกกลับเพื่อให้แน่ใจว่าไม่มีข้อผิดพลาด โดยเฉพาะอย่างยิ่งข้อผิดพลาดที่อาจรบกวนการโหลดหน้าเว็บ

ตัวอย่างโค้ดเรียกกลับ JavaScript:

var adblock1 = {
  'container' : 'adblock1_div_id',
  'adLoadedCallback' : function(containerName, adsLoaded,
    isExperimentVariant, callbackOptions) {
    if (adsLoaded) {
       try {
         // most likely do nothing
       } catch (e) {
         alert ("Error in callback function");
         // Do something to handle error gracefully
       }
    } else {
       // as you always do when there is no ad coverage from Google
    }
  }
};
      

number ไม่บังคับ
จำนวนของโฆษณาที่ควรจะปรากฏในหน่วยโฆษณานี้ ค่าเริ่มต้นคือ 2

ตัวอย่างเช่น

'number' : 4

relatedSearches ไม่บังคับ
จำนวนการค้นหาที่เกี่ยวข้องที่ควรปรากฏในหน่วยนี้ ค่าเริ่มต้นจะเป็น 0 หากไม่ได้ระบุไว้

ตัวอย่างเช่น

'relatedSearches' : 4