參考資料

參數

網頁層級參數說明

這些參數只需在每個網頁中指定一次。 會影響網頁上所有單元。

必填

參數 說明和範例
adPage 當使用者前往下一個或上一個結果頁面時,即為必要項目。

adPage 參數會指定要顯示廣告的結果頁面。當使用者已經離開搜尋結果的第一頁時,即會使用此參數。舉例來說,如果廣告請求數量為 5 則廣告,且 adPage 參數設為 2,則傳回的廣告會是第 5 則廣告的第二頁。

pubId 必要
這是您的 AdSense 客戶 ID。您的 pubId 是客戶 ID 的一部分,即「partner-」後方的字串。例如,如果您的用戶端 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 如果網頁上有相關搜尋單元,則為必填。
指定搜尋查詢所在的搜尋結果網頁網址 使用者所點擊的相關搜尋字詞。resultPageBaseUrl 可能包含本身的 參數,但會自動附加的搜尋查詢。

範例:

'resultsPageBaseUrl' : 'http://www.example.com/search?a=v1&b=v2'
relatedSearchTargeting 如果網頁上有相關搜尋單元,則為必填。
如要請求相關搜尋單元,就必須使用這個參數。控制項可控制 系統會根據網頁內容顯示相關搜尋體驗:
  • 'content' 這個選項適用於內容網頁上的相關搜尋 (例如文章、 網誌文章)。
  • 'query'這個選項必須專門用於相關搜尋 搜尋結果網頁

注意:relatedSearchTarget 網頁參數會自動設為 「query」根據預設。不過請注意,特別指定這個預設值 供搜尋結果網頁使用 (「Google 搜尋上的相關搜尋」)。如果您是 在任何其他類型網頁 (例如文章、網誌文章) 使用相關搜尋時,您必須遵守 明確將參數設為「content」

注意:使用這個參數時必須遵守下列規範:

  • 特定相關的搜尋功能是否可能會啟用或停用,具體取決於 網頁參數。
  • 不實陳述網頁類型或依賴預設的「查詢」調整 非搜尋結果網頁上的相關搜尋指定參數視為違反 這些書面指示
  • 無論這個值是否設定,Google 都會定期驗證這個值的準確度 您可以手動或使用預設設定

範例:

'relatedSearchTargeting' : 'content'
'relatedSearchTargeting' : 'query'
styleId 必要
指定要套用到廣告或相關搜尋單元的自訂搜尋樣式 ID 該網頁。 進一步瞭解如何使用自訂搜尋樣式。請注意,如果已為要求設定 styleId, 廣告或相關搜尋將以樣式顯示,而舊版樣式參數則會 已忽略。如未在要求中指定 styleId,則會顯示系統預設樣式。

範例:

'styleId': '1234567890'

選用

參數 說明和範例
linkTarget 選填
指定點擊廣告會在同一個視窗開啟,還是另外開啟 視窗。預設值為「_top」。您也可以在單元層級使用這項參數。
  • '_top' 會在同一個視窗中開啟,
  • '_blank' (在新視窗中開啟)。

範例:

'linkTarget' : '_blank'
maxTermLength 選填
指定相關搜尋字詞的字元數上限 (含空格)。 如未設定,則無上限。

範例:

'maxTermLength' : 50
referrerAdCreative 選填
使用者到達的內容網頁包含「內容相關搜尋」單元時 或點擊其他網站中的廣告或連結,而您則可掌控 此參數應設為廣告或連結的廣告素材文字。

使用這個參數時必須遵守下列規範:

  • 這個參數只應在「內容相關搜尋」要求中提供,且 將忽略其他要求
  • 只能用於您刻意從其他來源取得的流量 而非自然流量
  • 這項指令應包含廣告的標題行、說明和/或任何其他字詞。 連結廣告素材。
  • 省略廣告或連結廣告素材中的值 (或加入其他值), 違反這些書面指示。
  • 不須區分大小寫。
  • 接受有效的 UTF-8 編碼。支援萬國碼 (Unicode) 字元 / 變音符號。
  • Google 可能會使用或忽略您提交的參數。使用時可能會影響所選項目 搜尋字詞和排名

注意:使用 terms 參數。

範例:

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

'referrerAdCreative': 'The Early Signs of Psoriatic Arthritis'
resultsPageQueryParam 選填
為搜尋結果網頁上的搜尋查詢指定網址參數名稱。 如未指定,預設為「q」。

範例:

'resultsPageQueryParam' : 'query'
terms 選填
這個參數可讓您提供一份以半形逗號分隔的相關搜尋字詞清單 與相關搜尋要求一併傳回,但 Google 不一定會使用 條款。

注意:使用這個參數時,referrerAdCreative必要relatedSearchTargeting 是必要項目,必須設定 「content」

範例:

'terms' : 'cars rental, flight ticket'
ignoredPageParams 選填
為含有內容相關搜尋的內容網頁指定網址參數清單 單元可在不影響核心內容或使用者體驗的情況下,放心忽略。

注意:Google 必須先 檢索網頁,確保字詞與內容相關。尚未載入網頁時 遭到檢索或禁止檢索 (例如遭到 robots.txt 封鎖), AdSense 檢索器 我們不會顯示您提供給 Google 的建議相關搜尋字詞。

「內容的相關搜尋」產品依賴 Google 的內容檢索系統來建立索引 產生相關的搜尋字詞包含查詢參數的內容網頁網址 因為追蹤變數、User-ID、工作階段 ID 或其他動態 ID 檢索器評估網頁核心內容的能力,可能造成錯誤 不相關的相關搜尋字詞。這個網頁參數會指示 Google 檢索器忽略 這些非必要參數,確保內容索引正確,並減少不必要的檢索 載入。這種做法可讓 Google 更準確地辨識已檢索並啟動的網頁 顯示 Google 和合作夥伴的建議字詞 (如果符合資格)。

使用這個參數時必須遵守下列規範:

  • 這個參數只應在「內容相關搜尋」要求中提供,且 將忽略其他要求
  • 這個參數的值應該是以半形逗號分隔的網址參數清單, 會在使用者瀏覽內容頁面時顯示。
  • 須區分大小寫。
  • 將這份清單中的網址參數從內容網頁網址中移除後, 而不影響網頁的內容、外觀或使用者體驗。
  • 加入對網頁內容、外觀或 使用者體驗視同違反這些書面指示。
  • Google 可能會定期驗證忽略提供的網址參數是否影響。

範例:
使用者造訪內容網頁,且網址為:

http://example.com/content?utm_medium=social&page_id=123&click_id=456
敬上 提供下列可略過的網址參數:
'ignoredPageParams' : 'utm_medium,click_id,session_ref'
敬上 將內容頁面的網址視為:
http://example.com/content?page_id=123

配置設定

參數 說明和範例
adsafe 選填
用來指定 Google 應對符合搜尋查詢的廣告套用的篩選規則。下列是 Adsafe 的有效設定,以及每個值對傳回廣告的影響:
  • 'high' 傳回闔家適用廣告,不會傳回非闔家皆宜或成人色情內容的廣告。
  • 'medium' 傳回闔家適用和非闔家適用的廣告,不會傳回成人色情內容的廣告。
  • 'low' 傳回所有類型的廣告。

adsafe 預設為「高」。

範例:

'adsafe': 'medium'
adtest 選填
adtest 參數表示廣告請求為測試性質。如果 adtest 參數的值是 on,Google 會將該請求視為測試,且不會計算廣告曝光次數或追蹤點閱結果。

如果 adtest 參數的值設為 on,您不會獲得任何收益。

如果廣告請求的 adtest 參數設為 on,而且來自尚未 在「網站」分頁中獲得核准的網域,則會傳回顯示「測試廣告」的廣告而且無法點擊

這個參數僅供測試,不得用於正式系統,否則就算刊登了廣告也不會為您帶來任何收益。

adtest 預設值是 off。

範例:

'adtest' : 'on'
channel 選填
您可以加上 AdSense 搜尋廣告頻道來追蹤不同網頁的成效。請使用不重複的頻道 ID 透過 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 波羅的海 (愛沙尼亞文、拉脫維亞文、立陶宛文)
cyrillic 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-JP 日文
euc-kr EUC-KR 韓文
sjis 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 波羅的海 (愛沙尼亞文、拉脫維亞文、立陶宛文)
cyrillic 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-JP 日文
euc-kr EUC-KR 韓文
sjis Shift_JIS 日文
gb GB2312 簡體中文
utf-8 UTF-8 全部
ivt 選填
您可以透過這個參數提供布林值,告知 Google 您要允許廣告使用僅無效流量的 Cookie,本機儲存空間 (不論已同意和未同意的流量)。
  • true如果這個參數不存在,或是您設為「true」我們會設定偵測無效流量專用的 Cookie,並只針對已取得同意聲明的流量使用本機儲存空間。
  • false 如果您將這個參數設為「false」我們會設定偵測無效流量專用的 Cookie,並將本機儲存空間用於已同意和未同意的流量。

無效流量預設為 true

範例:

'ivt': false

廣告單元層級參數說明

這些參數會影響網頁上的個別廣告單元向使用者呈現的方式,您可以針對每個廣告單元分別設定各項參數。

必填

參數 說明和範例
container 必要
要顯示廣告的空白廣告容器 <div> 編號。

範例:

'container' : 'afscontainer1'
maxTop 如果廣告單元位於搜尋結果上方,則為必填。

使用這個參數來指定要在頂端廣告單元顯示的廣告數量。

注意:此參數用於取代「number」參數。這個廣告單元 應夠寬,這樣廣告第一行就不會換行。使用 maxTop 參數都違反政策。

範例:

'maxTop' : 4
width 必要
用來指定廣告或相關搜尋單元的寬度 (以像素為單位)。

範例:

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

配置設定

參數 說明和範例
adLoadedCallback 選填
指定當廣告或相關搜尋在 或是完全沒有放送廣告或相關搜尋時,就觸發了這類廣告。參數應設為 您實作的 JavaScript 回呼函式,會在 廣告呼叫完成。

回呼函式採用下列參數:

containerName 廣告或相關搜尋單元的容器名稱。
adsLoaded 有至少一個廣告或相關搜尋字詞可顯示時,設為 true 或 false 表示沒有傳回任何廣告或相關搜尋時。
isExperimentVariant 如果正在執行自訂樣式實驗,以及 進行實驗
callbackOptions 包含下列欄位的 JSON 物件:
termPositions: 如果是相關搜尋區塊,則包含 map<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