上級ユーザー向けに、現在サポートされている検索スタイルのパラメータのリストを作成しました。AdSense で生成されるコードには、一般的に使用されるパラメータ設定がすべて含まれています。必須パラメータには、pubId
と query
の 2 つがあります。AdSense では pubId が提供されていますが、コードを編集し、query
パラメータの値を渡す必要があります。その他のパラメータはすべて省略可能で、詳細については以下に説明します。
パラメータ タイプ
パラメータには次の 2 種類があります。
- ページ上のすべての広告ユニットに適用されるページ単位のパラメータ
- 個別の広告ユニットに適用されるユニット単位のパラメータ
以下に、2 つの広告ブロックを持つ、コード生成ツールの出力例を示します。このコードを設定するには、pageOptions
マップで必要な query
パラメータを設定する必要があります(例: “query”: myQuery
)。広告掲載を開始するのに必要な作業は以上ですが、ページ単位のブロックでページ単位のパラメータを、また、adblock1
および adblock2
マップで個別のユニット単位のパラメータを任意で設定することもできます。
<div id="afscontainer2"></div>
<script type="text/javascript" charset="utf-8">
// ページ単位のパラメータ
var pageOptions = {
"pubId": "partner-pub-1234567891234567",
"styleId": "1234567890",
"query": myQuery,
};
// ユニット単位のパラメータ
var adblock1 = {
"container": "afscontainer1"
};
var adblock2 = {
"container": "afscontainer2"
};
_googCsa('ads', pageOptions, adblock1, adblock2);
</script>
ページ単位のパラメータの説明
これらのパラメータは、ページごとに 1 回のみ指定します。指定されたパラメータはページ上のすべてのユニットに影響します。
必須
パラメータ | 説明と例 |
---|---|
adPage |
ユーザーが次の結果ページまたは前の結果ページに移動するときに必須
|
pubId |
必須 AdSense クライアント ID です。pubId はクライアント ID の一部で、'partner-' の後に続きます。たとえば、クライアント ID が 'partner-test-property' の場合、pubId は 'test-property' になります。これは CSA の標準プロトコルです。 例: 'pubId' : 'test-property' |
query |
必須 ユーザーが入力した検索クエリです。クエリ パラメータの値はデコードされている必要があります。 例:
|
resultsPageBaseUrl |
関連する検索ユニットがページにある場合は必須 検索クエリの入力内容が、ユーザーがクリックした検索語句と関連する場合に表示される検索結果ページの URL を指定します。 resultsPageBaseUr には独自のパラメータを設定できます(自動的に追加される検索クエリを除く)。
例:
|
styleId |
必須 ページ内の広告または関連する検索ユニットに適用される検索スタイルの ID を指定します。詳しくは、検索スタイルを使ってみるをご覧ください。なお、リクエストに styleId を設定すると、広告または関連する検索にそのスタイルが適用され、以前のスタイル設定パラメータは無視されます。リクエストで styleId が指定されていない場合、システムのデフォルトのスタイルが適用されます。 例
|
省略可
パラメータ | 説明と例 |
---|---|
linkTarget |
省略可 クリックされた広告が同じウィンドウで開くか、新しいウィンドウで開くかを指定します。デフォルトは '_top' です。このパラメータはユニット単位で使用することもできます。
例: 'linkTarget' : '_blank' |
maxTermLength |
省略可 関連する検索語句の最大文字数(スペースを含む)を指定します。設定されていない場合、文字数の上限はありません。 例: 'maxTermLength' : 50 |
referrerAdCreative |
省略可 ユーザーが別のウェブサイトで広告かリンクをクリックしたことによって関連する検索ユニットを含むコンテンツ ページがユーザーに表示されていて、かつ、お客様がその広告またはリンクを管理している場合、このパラメータをその広告のクリエイティブ テキストまたはリンクテキストに設定する必要があります。 このパラメータを使用する際は、次のガイドラインが適用されます。
例: '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 の有効な設定と、返される広告にそれぞれの値が与える影響は、以下のとおりです。
注: デフォルトでは、
adsafe は 'high' に設定されています。例: 'adsafe': 'medium' |
|||||||||||||||||||||||||||||||||||||||||||||||||||
adtest |
省略可adtest パラメータは、広告のリクエストがテストであることを示すために使われます。adtest パラメータの値が 'on' の場合、Google はそのリクエストをテストとして扱い、広告の表示をカウントしたり、クリックスルーの結果をトラッキングしたりしません。
注:
adtest のデフォルト値は 'off' です。 例: 'adtest' : 'on' |
|||||||||||||||||||||||||||||||||||||||||||||||||||
channel |
省略可 さまざまなページのパフォーマンスを追跡するために、検索向け AdSense のチャネルを含めることができます。AdSense アカウントで作成した固有のチャネル ID を使用します。詳しくは、カスタム チャネルで広告ユニットのパフォーマンスをトラッキングするをご覧ください。 複数のチャネルは '+' 記号で区切る必要があります。 例: 'channel' : 'testA' 'channel' : 'testA+testB' |
|||||||||||||||||||||||||||||||||||||||||||||||||||
hl |
省略可 このパラメータは、リクエストされた広告のターゲット言語を示します。デフォルト値は 'en' です。 Google では、Google Ads API の言語コードのすべてをサポートしています。 注: 広告のターゲット言語は広告主が指定します。このパラメータをリクエストに含めると、Google ではその言語の広告またはすべての言語をターゲットにしている広告のみを配信しますが、広告文が指定された言語で記述されているとは限りません。
通常、 例: 'hl' : 'es' |
|||||||||||||||||||||||||||||||||||||||||||||||||||
ie |
省略可
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
oe |
省略可
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
personalizedAds |
省略可 パブリッシャーがパーソナライズド広告での使用を目的として個人情報を Google と共有することに、ユーザーが同意しているかどうかを示します。
注: デフォルトでは、
personalizedAds は 'true' に設定されています。例: 'personalizedAds': false |
広告ユニット単位のパラメータの説明
これらのパラメータは、ページ上の個別の広告ユニットをユーザーに表示する方法に影響します。各パラメータは、広告ユニットごとに個別に設定できます。
必須
パラメータ | 説明と例 |
---|---|
container |
必須 広告を表示する空の広告コンテナ( <div id='afscontainer1'></div> )の ID です。
例:
|
設定
パラメータ | 説明と例 | ||||||||
---|---|---|---|---|---|---|---|---|---|
adLoadedCallback |
省略可 広告または関連する検索が読み込まれたとき、あるいは広告または関連する検索が表示されなかったときに呼び出される JavaScript 関数を指定します。このパラメータは、広告呼び出しの完了時に操作が行われるように、実際に実装する JavaScript コールバック関数に設定する必要があります。 このコールバック関数には次のパラメータを使用できます。
注: コールバック関数をテストして、エラーが発生しないか確認してください。特にページの読み込みを妨げる可能性があるコールバック関数については、テストすることを強くおすすめします。
JavaScript コールバックの例: var adblock1 = {
'container' : 'adblock1_div_id', 'adLoadedCallback' : function(containerName, adsLoaded, isExperimentVariant, callbackOptions) { if (adsLoaded) { try { // 対応が必要になる可能性は低い } catch (e) { alert ("コールバック関数でエラーが発生しました"); // エラーを適切に処理するための対応を行ってください } } else { // Google で広告が掲載されない場合の通常の対応 } } }; |
||||||||
maxTop |
省略可
このパラメータでは、ページ上部の広告ユニットに表示する広告の数を指定します。 注: このパラメータは、
number パラメータの代わりに使われます。この広告ユニットでは、広告の 1 行目が折り返さないように、十分に幅を持たす必要があります。ページの他のプレースメントで maxTop パラメータを使うことは、ポリシー違反に該当します。例:
|
||||||||
number |
省略可 この広告ユニットに表示される広告の数です。デフォルト値は '2' です。 例:
|
||||||||
relatedSearches |
省略可 このユニットに表示される関連する検索の数です。このパラメータは、0 に設定されていない限り、関連する検索を少なくとも 3 つ返します。指定しない場合、デフォルトは 0 です。 例: 'relatedSearches' : 4 |
||||||||
width |
省略可 広告ユニットまたは関連する検索ユニットの幅をピクセル単位で指定します。 例: 'width' : '700px' 'width' : 700 |