キーワード (keyword)を管理するためのメソッドが含まれています。 キーワードの詳細については、「 キーワード」を参照してください。
メソッド
| メソッド名 | 戻り値の型 | 説明 |
|---|---|---|
| adParams | AdParamSelector | このキーワード (keyword) の広告で使用されているすべての置換パラメーターを取得するために使用されるセレクターを取得します。 |
| applyLabel(string name) | void | このキーワード (keyword)にラベルを適用します。 |
| 入札 | KeywordBidding | このキーワード (keyword) の入札額を管理するために使用される方法を取得します。 |
| clearDestinationUrl | void | このキーワード (keyword) のリンク先 URL を削除します。 |
| enable | void | このキーワード (keyword) を有効にします。 |
| getAdGroup | AdGroup | このキーワード (keyword) が属する広告グループを取得します。 |
| getApprovalStatus | string | このキーワード (keyword) の編集承認ステータスを取得します。 |
| getCampaign | Campaign | このキーワード (keyword) が属するキャンペーンを取得します。 |
| getEntityType | string | このエンティティの型を取得します。 |
| getFirstPageCpc | double | 検索結果の最初のページに掲載するために必要な推定入札単価を取得します。 |
| getId | string | このキーワード (keyword) を一意に識別する ID を取得します。 |
| getMatchType | string | このキーワード (keyword) のマッチタイプを取得します。 |
| getQualityScore | integer | この キーワード (keyword) の品質スコアを取得します。 |
| getStats | 統計情報 | このキーワード (keyword) のパフォーマンス データを取得します。 |
| getText | string | キーワード (keyword) のテキストを取得します。 |
| getTopOfPageCpc | double | 検索結果の一番上に表示されるために必要な推定入札単価を取得します。 |
| isEnabled | ブール型 | このキーワード (keyword)が有効かどうかを示すブール値を取得します。 |
| isPaused | ブール型 | このキーワード (keyword)が一時停止されているかどうかを示すブール値を取得します。 |
| labels | LabelSelector | このキーワード (keyword)に関連付けられているラベルのリストをフィルタリングするために使用されるセレクターを取得します。 |
| 一時停止 | void | このキーワード (keyword) を一時停止します。 |
| remove | void | このキーワード (keyword) を削除します。 |
| removeLabel(string name) | void | このキーワード (keyword) からラベルを削除します。 |
| setAdParam(int index, string insertionText) | void | 置換パラメーターを追加して、その値を指定されたテキストに設定します。 |
| urls | KeywordUrls | このキーワードの最終ページ URL、トラッキング テンプレート、カスタム パラメーターを管理するために使用するメソッドを取得します。 |
adParams
このキーワード (keyword) の広告で使用されているすべての置換パラメーターのセレクターを取得します。
広告のタイトル、テキスト、表示 URL、リンク先 URL に {Param1}、{Param2}、または {Param3} 動的置換文字列が含まれている場合、広告で置換値が使用されます。
戻り値
| 型 | 説明 |
|---|---|
| AdParamSelector | このキーワード (keyword) の置換パラメーターのリストを含むセレクター。 |
applyLabel(string name)
キーワード (keyword) にラベルを適用します。
1 つのキーワード (keyword)に最大 50 個のラベルを適用できます。 キーワード (keyword) にラベルを追加する例については、「ラベルの使用」を参照してください。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| name | string | ラベルの大文字と小文字を区別する名前。 適用できるこのアカウントのラベルの一覧を取得するには、 AdsApp.labels を参照してください。 |
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
入札
このキーワード (keyword) の入札額を管理するために使用される方法を取得します。
戻り値
| 型 | 説明 |
|---|---|
| KeywordBidding | この キーワード (keyword) の入札金額を管理するために使用される方法が含まれます。 |
clearDestinationUrl
このキーワード (keyword) のリンク先 URL を削除します。
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
enable
このキーワード (keyword) を有効にします。
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
getAdGroup
このキーワード (keyword) が属する広告グループを取得します。
戻り値
| 型 | 説明 |
|---|---|
| AdGroup | このキーワード (keyword) が属する広告グループ。 |
getApprovalStatus
このキーワード (keyword) の編集承認ステータスを取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | キーワード (keyword) の編集承認ステータス。 ステータスには、キーワード (keyword) がレビュー中か、承認済みか、許可されないかが示されます。 使用可能な値は次のとおりです。
|
getCampaign
このキーワード (keyword) が属するキャンペーンを取得します。
戻り値
| 型 | 説明 |
|---|---|
| Campaign | このキーワード (keyword) が属するキャンペーン。 |
getEntityType
このエンティティの型を返します。
戻り値
| 型 | 説明 |
|---|---|
| string | このエンティティの型。キーワード。 |
getId
このキーワード (keyword) を一意に識別する ID を取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | このキーワード (keyword)を一意に識別する ID。 |
getFirstPageCpc
広告をサイドバーに表示するために必要な推定入札単価を取得します。
戻り値
| 型 | 説明 |
|---|---|
| double | 広告をサイド バーに表示するために必要な推定入札単価。 |
getMatchType
このキーワード (keyword) のマッチタイプを取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | キーワード (keyword)のマッチタイプ。 使用可能な値は次のとおりです。
|
getQualityScore
この キーワード (keyword) の品質スコアを取得します。
戻り値
| 型 | 説明 |
|---|---|
| integer | キーワード (keyword) の品質スコア。 スコアは 1 から 10 (最高) の範囲です。 キーワード (keyword) の品質スコアを計算できない場合、このメソッドは NULL を返します。 このスコアは、キーワードとランディング ページが顧客の検索語句とどの程度関連しているかを測定することで、マーケットプレースでの広告の競争力を示します。 詳細については、「 キーワード パフォーマンス レポート」を参照してください。 |
getStats
このキーワードのパフォーマンス データを取得します。
このメソッドを呼び出すには、キーワード (keyword) セレクターのチェーンにいずれかのforDateRange メソッドを含める必要があります。
戻り値
| 型 | 説明 |
|---|---|
| 統計情報 | キーワード (keyword) のパフォーマンス データ。 たとえば、クリック数やインプレッション数などです。 |
getText
キーワード (keyword) のテキストを取得します。 テキストには、キーワード (keyword) のマッチ タイプ構文 (存在する場合) が含まれます。 例:
- キーワード (keyword) は、マッチ タイプが広範な場合は books です。キーワード (keyword) が広範なタイプ修飾子を使用している場合は +books です
- マッチ タイプがフレーズの場合、キーワード (keyword) は「書籍」です
- 一致の種類が正確な場合、キーワード (keyword) は [ハードカバー書籍] になります
これらのタイプの詳細については、「キーワード (keyword) マッチ タイプとは、およびその使用方法」を参照してください。
戻り値
| 型 | 説明 |
|---|---|
| string | キーワード (keyword) のテキスト。 |
getTopOfPageCpc
オーガニック検索結果の上に広告を表示するために必要な推定入札単価を取得します。
戻り値
| 型 | 説明 |
|---|---|
| double | オーガニック検索結果の上に広告を表示するために必要な推定入札単価。 |
isEnabled
このキーワード (keyword)が有効かどうかを示すブール値を取得します。
戻り値
| 型 | 説明 |
|---|---|
| ブール型 | このキーワード (keyword) が有効な場合は true、それ以外の場合は false。 |
isPaused
このキーワード (keyword)が一時停止されているかどうかを示すブール値を取得します。
戻り値
| 型 | 説明 |
|---|---|
| ブール型 | このキーワード (keyword) が一時停止されている場合は true、それ以外の場合は false。 |
labels
このキーワード (keyword)に関連付けられているラベルのリストをフィルタリングするために使用されるセレクターを取得します。
戻り値
| 型 | 説明 |
|---|---|
| LabelSelector | このキーワード (keyword)に関連付けられているラベルのリストをフィルタリングするために使用されるセレクター。 |
一時停止
このキーワード (keyword) を一時停止します。
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
remove
このキーワード (keyword) を削除します。
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
removeLabel(string name)
キーワード (keyword) からラベルを削除します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| name | string | ラベルの大文字と小文字を区別する名前。 このキーワード (keyword)に関連付けられているラベルの一覧を取得するには、「ラベル」を参照してください。 |
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
setAdParam(int index, string insertionText)
置換パラメーターを追加して、その値を指定されたテキストに設定します。 置換パラメーターが存在する場合は、そのテキストが上書きされます。
広告のタイトル、テキスト、表示 URL、または最終ページ URL に {Param1}、{Param2}、または {Param3} の動的置換文字列が含まれている場合、置換値は広告で使用されます。 これらのパラメーターの使用に関する制限事項と情報については、「 Param1」、「 Param2」、 および「Param3」を参照してください。
テンプレートで {param1:default}、{param2:default}、または {param3:default} プレースホルダーが指定されている場合、トラッキング テンプレートでも置換値が使用されます。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| index | int | 設定する置換パラメーターのインデックス。 有効なインデックス値は 1 から 3 です。 Param1 には 1、Param2 には 2、Param3 には 3 を使用します。 |
| insertionText | string | 置換パラメーターを設定するテキスト。 |
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
urls
このキーワードの最終ページ URL、トラッキング テンプレート、カスタム パラメーターを管理するために使用するメソッドを取得します。
戻り値
| 型 | 説明 |
|---|---|
| KeywordUrls | 使用されたメソッド (キーワード (keyword) の最終ページ URL、トラッキング テンプレート、カスタム パラメーターを含みます。 |