リファレンス

パラメータ

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

これらのパラメータは、ページごとに 1 回のみ指定します。指定されたパラメータはページ上のすべてのユニットに影響します。

必須

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

adPage パラメータは、広告が表示されている結果ページを指定します。このパラメータは、ユーザーが検索結果の最初のページから移動するときに使われます。たとえば、5 つの広告がリクエストされ、adPage パラメータが 2 に設定されている場合、返される広告は検索結果の 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'
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 のコンテンツ クロール システムを使用してページをインデックス化し、関連する検索語句を生成します。トラッキング変数、ユーザー ID、セッション ID やその他の動的識別子などのクエリ パラメータを含むコンテンツ ページの URL は、クローラーがページのコア コンテンツを評価する機能を妨げる可能性があり、関連する検索語句が不正確または関連性が低くなる可能性があります。このページ パラメータは、これらの不要なパラメータを無視するよう 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 省略可
検索クエリと一致する広告に Google が適用するフィルタリング ルールを指定します。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 バルト語（エストニア語、ラトビア語、リトアニア語）
cyrillic ISO-8859-5 ブルガリア語、ロシア語
arabic ISO-8859-6  
ギリシャ語 ISO-8859-7 ギリシャ語
ヘブライ暦 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 ギリシャ語
ヘブライ暦 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 省略可
このパラメータでは、同意ありのトラフィックと同意なしのトラフィックの両方で、無効なトラフィック検出専用の Cookie とローカル ストレージを使用する広告を許可することを Google に通知するブール値を指定できます。
  • true このパラメータが指定されていない場合、または「true」に設定されている場合、無効なトラフィック検出専用の Cookie が設定され、同意済みのトラフィックでのみローカル ストレージが使用されます。
  • false このパラメータを「false」に設定すると、同意済みのトラフィックと同意のないトラフィックの両方で、無効なトラフィック検出専用 Cookie が設定され、ローカル ストレージが使用されます。

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

例:

'ivt': false

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

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

必須

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

例: 

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

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

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

例:

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

例: 

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

設定

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

このコールバック関数には次のパラメータを使用できます。

containerName 広告または関連する検索ユニットのコンテナ名。
adsLoaded 表示する広告または関連する検索語句が 1 つ以上ある場合は true に設定し、広告または関連する検索が返されない場合は false に設定します。
isExperimentVariant カスタム スタイルのテストを実施中で、広告を表示するのにテストのパターンを選択している場合は、true に設定します。
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