KeywordBuilder

キーワード (keyword)を定義および作成するためのメソッドが含まれています。 ビルダーの詳細については、「 ビルダー」を参照してください。

注:

検索広告のすべての部分一致修飾子キーワードが、フレーズ一致ではなく部分一致キーワードとして機能するようになりました。 キーワード (keyword) の一致の種類について詳しくは、こちらをご覧ください。

使用例:

    var operation = adGroup.newKeywordBuilder()
        .withText("KEYWORD TEXT GOES HERE")
        .withCpc(0.5)
        .withFinalUrl("http://www.contoso.com")
        .build();

    // See the Builders topic for performance considerations
    // when using the operation object's methods.
    if (!operation.isSuccessful()) {
        for (var error of operation.getErrors()) {
            Logger.log(`${error}\n`);
        }
    }

メソッド

メソッド名 戻り値の型 説明
build KeywordOperation キーワード (keyword)を作成し、キーワード (keyword)が正常に追加されたかどうかをチェックするために使用する操作オブジェクトを返します。
withCpc(double cpc) KeywordBuilder キーワード (keyword) の上限 CPC 入札単価を設定します。
withCustomParameters(Object customParameters) KeywordBuilder キーワード (keyword) のカスタム パラメーターを設定します。
withFinalUrl(string finalUrl) KeywordBuilder キーワード (keyword) の最終ページ URL を設定します。
withMobileFinalUrl(string mobileFinalUrl) KeywordBuilder モバイル デバイス向けのキーワード (keyword) の最終ページ URL を設定します。
withText(string text) KeywordBuilder キーワード (keyword) のテキストを設定します。
withTrackingTemplate(string trackingTemplate) KeywordBuilder キーワード (keyword) のトラッキング テンプレートを設定します。

ビルド

キーワード (keyword)を作成し、キーワード (keyword)が正常に追加されたかどうかをチェックするために使用する操作オブジェクトを返します。

戻り値

説明
KeywordOperation キーワード (keyword)が正常に追加されたかどうかをチェックするために使用される操作オブジェクト。

withCpc(double cpc)

キーワード (keyword) の上限 CPC 入札単価を設定します。

キーワード (keyword) がユーザーの検索語句と一致したときに使用する入札単価を指定します。 広告グループの入札戦略が MANUAL_CPC に設定されている場合にのみ適用されます。

広告グループ レベルで指定された入札単価を使用するには、このメソッドを呼び出さないでください。

入札金額の詳細については、「 入札」「BiddingScheme」を参照してください。

引数

名前 説明
cpc double キーワード (keyword) に適用する上限 CPC 入札単価。 最小と最大入札額はアカウントの通貨によって決まります。 詳細については、「 入札単価と予算通貨」を参照してください。

戻り値

説明
KeywordBuilder CPC 入札単価が適用されたキーワード ビルダー。

withCustomParameters(Object customParameters)

キーワード (keyword) のカスタム パラメーターを設定します。

カスタム パラメーターは、複数の URL で動的な情報を共有する場合に役立ちます。 使用方法の詳細については、「 カスタム パラメーター」を参照してください。

引数

名前 説明
customParameters オブジェクト キーワード (keyword) の最終ページ URL に適用する最大カスタム パラメーターのマップ。 たとえば、 {key1: 'value1', key2: 'value2', key3: 'value3'} などです。ここで、key はカスタム パラメーターの名前で、値はパラメーターの値です。 名前には最大 16 個の 8 バイト文字を含めることができ、値は最大 200 個の 8 バイト文字を含めることができます。

戻り値

説明
KeywordBuilder カスタム パラメーターが適用されたキーワード ビルダー。

withFinalUrl(string finalUrl)

キーワード (keyword) の最終ページ URL を設定します。

最終ページ URL はユーザーが広告をクリックした際に誘導される Web ページを識別します。 指定しない場合、エンティティは親エンティティから最終ページ URL を継承します。 たとえば、キーワード (keyword) エンティティは広告の最終ページ URL を継承します。 広告の最終ページ URL を上書きするには、キーワード (keyword) の最終ページ URL を指定します。

詳細については、どの トラッキングまたは URL パラメーターを使用できるかをご覧ください。

引数

名前 説明
finalUrl string ユーザーが広告をクリックした際に誘導される Web ページを識別する最終ページ URL。

戻り値

説明
KeywordBuilder 最終ページ URL が適用されたキーワード ビルダー。

withMobileFinalUrl(string mobileFinalUrl)

モバイル デバイス向けのキーワード (keyword) の最終ページ URL を設定します。

最終ページ URL はユーザーが広告をクリックした際に誘導される Web ページを識別します。 指定しない場合、エンティティは親エンティティから最終ページ URL を継承します。 たとえば、キーワード (keyword) エンティティは広告の最終ページ URL を継承します。 広告の最終ページ URL を上書きする場合は、キーワード (keyword) の最終ページ URL を指定します。

詳細については、どの トラッキングまたは URL パラメーターを使用できるかをご覧ください。

モバイル デバイス用の最終ページ URL を指定する場合は、まずモバイル以外のデバイス用の最終ページ URL を指定します ( withFinalUrl() を参照してください)。

引数

名前 説明
mobileFinalUrl string モバイル デバイスの最終ページ URL。

戻り値

説明
KeywordBuilder モバイル用の最終ページ URL が適用されたキーワード ビルダー。

withText(string text)

キーワード (keyword) のテキストを設定します。

キーワード (keyword) のマッチ タイプを指定するには、次の構文を使用します。

  • 部分一致の場合は、一致型構文 ( keywordBuilder.withText("books") など) を使います。
  • 部分一致修飾子の場合は、テキストの先頭にプラス記号 (+) を付けます (例: keywordBuilder.withText("+books"))。 : 新しい広範一致修飾子 (BMM) キーワードを作成しようとすると、キーワードが保存され、語句一致キーワードとして提供されます。 既存の BMM キーワードは、引き続きフレーズ一致動作で機能します。 キーワード (keyword) の一致の種類について詳しくは、こちらをご覧ください。
  • 語句の一致の場合は、テキストを引用符で囲みます (例: keywordBuilder.withText("\"books\""))。
  • 完全一致の場合は、テキストを角かっこで囲みます (例: keywordBuilder.withText("[hardcover books]"))。

引数

名前 説明
text string キーワード (keyword) のテキスト。 キーワード (keyword) のテキストは必須です。 テキストは最大 100 文字です。 広告グループの言語値のロケールでテキストを指定します。

戻り値

説明
KeywordBuilder キーワード (keyword) テキストが適用されたキーワード ビルダー。

withTrackingTemplate(string trackingTemplate)

キーワード (keyword) のトラッキング テンプレートを設定します。

トラッキング テンプレートは、キーワード (keyword) の FinalUrl と共に使用され、広告で使用されるリンク先 URL が作成されます。 詳細については、どの トラッキングまたは URL パラメーターを使用できるかをご覧ください。

引数

名前 説明
trackingTemplate string このキーワード (keyword)で使用するトラッキング テンプレート。

戻り値

説明
KeywordBuilder トラッキング テンプレートが適用されたキーワード ビルダー。