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