リファレンス

パラメータ

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

これらのパラメータは、ページごとに 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'

styleId 必須
ページ上の広告または関連する検索ユニットに適用するカスタム検索スタイルの ID を指定します。 カスタム検索スタイルの使用に関する詳細リクエストに 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 のデフォルト値は off です。

例:

'adtest' : 'on'

channel 省略可
検索向け AdSense のチャネルを追加して、さまざまなページのパフォーマンスを追跡できます。AdSense アカウントまたは担当のテクニカル アカウント マネージャーが作成した一意のチャンネル ID を使用します。 チャネルについて詳しくは、こちらをご覧ください。

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

例:

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

hl 省略可
このパラメータには、リクエストされた広告または関連する検索のターゲット言語を指定します。デフォルト値は en です。

Google では、すべての AdWords API 言語コードをサポートしています。

注: 広告のターゲット言語は広告主が指定します。このパラメータをリクエストに含めると、その言語またはすべての言語をターゲットとする広告のみが返されますが、広告文が指定された言語で表示されることが保証されるわけではありません。

通常、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-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 バルト語(エストニア語、ラトビア語、リトアニア語)
キリル文字 ISO-8859-5 ブルガリア語、ロシア語
アラビア語 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