リファレンス

パラメータ

ページ単位のパラメータの説明

これらのパラメータは、ページごとに 1 回だけ指定する必要があります。ページ上のすべての広告ユニットに影響します。

必須

パラメータ 説明と例
adPage ユーザーが次の結果ページまたは前の結果ページに移動するときに必須。

adPage パラメータは、広告が表示される検索結果ページを指定します。このパラメータは、ユーザーが検索結果の最初のページから移動する場合に使用します。たとえば、5 つの広告がリクエストされ、adPage パラメータが 2 に設定されている場合、返される広告は 5 つの広告のうち 2 ページ目になります。

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 関連する検索ユニットがページにある場合は必須です。
ユーザーがクリックした関連する検索語句が検索クエリである検索結果ページの URL を指定します。resultsPageBaseUrl には、自動的に追加される検索クエリを除き、独自のパラメータを含めることができます。

例:

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

relatedSearchTargeting 関連する検索ユニットがページにある場合は必須です。
関連する検索ユニットをリクエストする場合、このパラメータは必須です。ページのコンテキストに応じて、表示される関連する検索エクスペリエンスのタイプを制御します。
  • 'content'このオプションは、コンテンツ ページ(記事、ブログ投稿など)の関連する検索に使用します。
  • 'query'このオプションは、検索結果ページの関連する検索にのみ使用します。

注: relatedSearchTargeting ページ パラメータは、デフォルトで自動的に「query」に設定されます。ただし、このデフォルト値は検索結果ページのみ(検索の関連する検索)専用に設計されている点に注意してください。他の種類のページ(記事、ブログ投稿など)で関連する検索を使用する場合は、明示的にパラメータを「content」に設定する必要があります。

注: このパラメータの使用には、次のガイドラインが適用されます。

  • 一部の関連する検索機能は、このページ パラメータの値に応じて有効または無効にできます。
  • ページの種類を偽って表示したり、検索結果ページ以外のページで relatedSearchTargeting パラメータのデフォルトの「query」設定をそのまま利用したりすると、これらの手順に対する違反と見なされます。
  • 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 省略可
検索結果ページに表示される検索クエリの URL パラメータの名前を指定します。 指定しない場合のデフォルトは「q」です。

例:

'resultsPageQueryParam' : 'query'

terms 省略可
このパラメータを使用すると、関連する検索リクエストで返される、独自の関連検索キーワードのカンマ区切りリストを指定できます。ただし、ここで指定した語句は、Google が使用する場合もあれば、しない場合もあります。

注: このパラメータを使用する場合は、referrerAdCreative必須で、relatedSearchTargeting が必須であり、「content」に設定する必要があります。

例:

'terms' : 'cars rental, flight ticket'

ignoredPageParams 省略可
コア コンテンツやユーザー エクスペリエンスに影響を与えることなく無視しても問題ない、コンテンツの関連する検索ユニットを含むコンテンツ ページの URL パラメータ リストを指定します。

注: 関連する検索語句をサイトに表示する前に、Google はページをクロールして、語句がコンテンツと関連していることを確認する必要があります。AdSense クローラによってページがクロールされていない場合や、クロールが(robots.txt などによって)ブロックされている場合は、お客様が Google に提供した関連する検索語句の候補は表示されません。

「コンテンツ内の関連する検索」サービスは、Google のコンテンツ クロール システムを使用してページをインデックスに登録し、関連性の高い検索キーワードを生成します。コンテンツ ページの URL にトラッキング変数、ユーザー ID、セッション ID、その他の動的 ID などのクエリ パラメータが含まれていると、クローラがページのコア コンテンツを評価できなくなり、不正確または無関係な関連検索キーワードが表示される可能性があります。このページ パラメータは、こうした必須ではないパラメータを無視するよう Google のクローラに指示します。これにより、コンテンツのインデックス登録が適切に行われ、不要なクロールの読み込みが軽減されます。これにより、Google はページがすでにクロールされていると認識しやすくなり、キーワードの候補が表示されるようになります(Google と、該当する場合はパートナーの両方)。

このパラメータの使用には、次のガイドラインが適用されます。

  • このパラメータは、コンテンツ ページの関連する検索のリクエストでのみ指定してください。他のすべてのリクエストでは無視されます。
  • このパラメータの値は、ユーザーがコンテンツ ページにアクセスしたときに表示される URL パラメータのカンマ区切りのリストにする必要があります。
  • 大文字と小文字は区別されます。
  • このリストに含まれるいずれかの URL パラメータがコンテンツ ページの URL から削除されても、ページのコンテンツ、外観、ユーザー エクスペリエンスに大きな影響はありません。
  • ページのコンテンツ、デザイン、ユーザー エクスペリエンスに重大な影響を与える URL パラメータを含めると、これらの手順への違反と見なされます。
  • Google は、指定された URL パラメータを無視した場合の影響を定期的に検証することがあります。

例:
ユーザーがコンテンツ ページにアクセスし、URL が

http://example.com/content?utm_medium=social&page_id=123&click_id=456
次の無視できない URL パラメータを指定している:
'ignoredPageParams' : 'utm_medium,click_id,session_ref'
コンテンツ ページの URL は次のように処理されます。
http://example.com/content?page_id=123

設定

パラメータ 説明と例
adsafe 省略可
検索クエリに一致する広告に適用されるフィルタリング ルールを指定します。adsafe の有効な設定と、返される広告に対する各値の影響は次のとおりです。
  • 'high': 一般向けの広告を返します。成人向け広告や、アダルト コンテンツの広告は返しません。
  • 'medium': 一般向け広告と成人向け広告を返します。アダルト コンテンツの広告は返しません。
  • 'low': すべてのタイプの広告を返します。

デフォルトでは、adsafe は高に設定されています。

例:

'adsafe': 'medium'

adtest 省略可
adtest パラメータは、広告のリクエストがテストであることを示すために使用します。adtest パラメータの値が on の場合、Google はリクエストをテストとして扱い、広告のインプレッションのカウントやクリックスルーの結果のトラッキングは行いません。

adtest パラメータの値が on の場合、収益は発生しません。

adtest パラメータが on に設定された広告リクエストが、 [サイト] タブで承認されていないドメインから送信されると、「テスト広告」オーバーレイが含まれ、クリックできない広告が返されます。

このパラメータはテスト時に使用しますが、本番用システムでは使用しないでください。使用すると、表示された広告に対して支払いが行われません。

デフォルトの adtest 値はオフです。

例:

'adtest' : 'on'

channel 省略可
さまざまなページのパフォーマンスをトラッキングするために、検索向け AdSense のチャネルを含めることができます。AdSense アカウントまたはテクニカル アカウント マネージャーによって作成された一意のチャンネル ID を使用します。 チャネルについて詳しくは、こちらをご覧ください。

チャンネルが複数ある場合は「+」記号で区切る必要があります。

例:

'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 ブルガリア語、ロシア語
アラビア語 ISO-8859-6  
ギリシャ人 ISO-8859-7 ギリシャ語
ヘブライ暦 ISO-8859-8 ヘブライ語
latin5 ISO-8859-9  
latin6 ISO-8859-10 アイスランド語
euc-jp EUC 日本 日本語
EUC EUC 韓国 韓国語
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 バルト語(エストニア語、ラトビア語、リトアニア語)
キリル文字 ISO-8859-5 ブルガリア語、ロシア語
アラビア語 ISO-8859-6  
ギリシャ人 ISO-8859-7 ギリシャ語
ヘブライ暦 ISO-8859-8 ヘブライ語
latin5 ISO-8859-9  
latin6 ISO-8859-10 アイスランド語
euc-jp EUC 日本 日本語
EUC EUC 韓国 韓国語
Sjis Shift_JIS 日本語
gb GB2312 簡体字中国語
utf-8 UTF-8 すべて
ivt 省略可
このパラメータを使用すると、同意済みのトラフィックと同意のないトラフィックの両方で、無効なトラフィック検出専用の Cookie とローカル ストレージを使用する広告を許可するよう Google に伝えるブール値を指定できます。
  • trueこのパラメータが存在しないか「true」に設定されている場合、無効なトラフィック専用の Cookie が設定され、同意済みのトラフィックでのみローカル ストレージが使用されます。
  • falseこのパラメータを「false」に設定すると、無効なトラフィック検出専用の Cookie が設定され、同意済みのトラフィックと同意のないトラフィックの両方でローカル ストレージが使用されます。

IVT はデフォルトで true に設定されています。

例:

'ivt': false

ユニット単位のパラメータの説明

これらのパラメータは、ページ上の個々の広告ユニットがユーザーに表示される方法に影響します。各パラメータは、広告ユニットごとに個別に設定できます。

必須

パラメータ 説明と例
container 必須
広告が表示される空の広告コンテナ <div> の ID。

例:

'container' : 'afscontainer1'

maxTop 広告ユニットが検索結果の上部にある場合は必須。

このパラメータを使用して、上部の広告ユニットに表示する広告の数を指定します。

注: このパラメータは「number」パラメータの代わりに使用されます。この広告ユニットでは、広告の最初の行が折り返されないように十分な幅を確保する必要があります。ページの他のプレースメントで maxTop パラメータを使用することは、ポリシー違反です。

例:

'maxTop' : 4
width 必須
広告または関連する検索ユニットの幅をピクセル単位で指定します。

例:

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

設定

パラメータ 説明と例
adLoadedCallback 省略可
広告または関連検索が読み込まれたとき、または広告または関連検索が配信されなかったときに呼び出される JavaScript 関数を指定します。このパラメータは、実装する JavaScript コールバック関数に設定する必要があります。これにより、広告の呼び出しが完了したときにアクションを実行できます。

このコールバック関数は次のパラメータを取ります。

containerName 広告または関連する検索ユニットのコンテナ名。
adsLoaded 表示する広告または関連する検索語句が 1 つ以上ある場合は true に設定し、広告または関連する検索が返されない場合は false に設定します。
isExperimentVariant カスタム スタイルのテストが実行中で、広告のレンダリングにテストのパターンが選択されている場合は、true に設定します。
callbackOptions 次のフィールドを含む JSON オブジェクト。
termPositions: 関連する検索ブロックの場合、パブリッシャーが提供する語句の、レスポンス内のこれらの語句の 0 インデックス位置への 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