広告
拡張テキスト広告などの広告の派生元となる基本オブジェクト。
このオブジェクトは、標準のテキスト広告も表します。 標準テキスト広告を作成することはできなくなりましたが、取得、一時停止、削除、有効化することができます。 次のメソッドは派生オブジェクトには適用されず、呼び出すべきではありません。
- getDestinationUrl()
- getDisplayUrl()
- getHeadline()
- isMobilePreferred()
注:
- 拡張テキスト広告を、2023 年 2 月 1 日までにレスポンシブ検索広告にアップグレードします。 この日付を過ぎると、新しいテキスト広告を作成したり、既存の拡張テキスト広告を編集したりできなくなります。 詳細については、「 レスポンシブ検索広告について」を参照してください。
- 既存の拡張テキスト広告は引き続き配信され、そのパフォーマンスに関するレポートを表示できます。
- 拡張テキスト広告は引き続き一時停止、有効化、または削除できます。 そうしないと、拡張テキスト広告を追加または更新しようとすると、エラーが発生
CampaignServiceAdTypeInvalidします。 - この変更の詳細については、こちらをご覧ください。
メソッド
| メソッド名 | 戻り値の型 | 説明 |
|---|---|---|
| applyLabel(string name) | void | この広告にラベルを適用します。 |
| asType | AdViewSpace | この広告を特定の広告の種類にキャストするために使用されるメソッドが含まれています。 |
| 有効 | void | この広告を有効にします。 |
| getAdGroup | AdGroup | この広告が属する広告グループを取得します。 |
| getCampaign | キャンペーン | この広告が属するキャンペーンを取得します。 |
| getDescription | string | この広告のコピー テキストを取得します。 |
| getDestinationUrl | string | ユーザーが広告をクリックしたときに取得される Web ページの URL を取得します。 |
| getDisplayUrl | string | 広告に表示される URL を取得します。 |
| getEntityType | string | このエンティティの型を取得します。 |
| getHeadline | string | この広告のタイトルを取得します。 |
| getId | string | この広告を一意に識別する ID を取得します。 |
| getPolicyApprovalStatus | string | この広告の編集承認状態を取得します。 |
| getStats | 統計 | この広告のパフォーマンス データを取得します。 |
| Gettype | string | この広告の派生型を取得します。 |
| Isenabled | ブール値 | この広告が有効かどうかを示すブール値を取得します。 |
| isMobilePreferred | ブール値 | この広告がモバイル デバイスまたはすべてのデバイスに表示される設定かどうかを示すブール値を取得します。 |
| isPaused | ブール型 | この広告が一時停止されているかどうかを示すブール値を取得します。 |
| isType | AdTypeSpace | 広告が指定した種類であるかどうかをテストするために使用されるメソッドが含まれます。 |
| ラベル | LabelSelector | この広告に関連付けられているラベルの一覧をフィルター処理するために使用する セレクター を取得します。 |
| 一時 停止 | void | この広告を一時停止します。 |
| remove | void | この広告を削除します。 |
| removeLabel(string name) | void | この広告からラベルを削除します。 |
| Url | AdUrls | この広告の最終的な URL、追跡テンプレート、カスタム パラメーターを取得するために使用されるメソッドが含まれています。 |
applyLabel(string name)
ラベルを広告に適用します。
広告には最大 50 個のラベルを適用できます。 エンティティにラベルを追加する例については、「 ラベルの使用」を参照してください。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| name | string | ラベルの大文字と小文字を区別する名前。 このアカウントで適用できるラベルの一覧を取得するには、「 AdsApp.labels」を参照してください。 |
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
asType
この広告を特定の広告の種類にキャストするために使用されるメソッドが含まれています。
戻り値
| 型 | 説明 |
|---|---|
| AdViewSpace | この広告を特定の広告の種類にキャストするために使用されるメソッドが含まれています。 |
有効
この広告を有効にします。
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
getAdGroup
この広告が属する広告グループを取得します。
戻り値
| 型 | 説明 |
|---|---|
| AdGroup | この広告が属する広告グループ。 |
getCampaign
この広告が属するキャンペーンを取得します。
戻り値
| 型 | 説明 |
|---|---|
| キャンペーン | この広告が属するキャンペーン。 |
getDescription
この広告のコピー テキストを取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | 広告のコピー テキスト。 |
getDestinationUrl
ユーザーが広告をクリックしたときに取得される Web ページの URL を取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | ユーザーが広告をクリックしたときに取得される Web ページの URL。 派生オブジェクトから呼び出された場合は null を返します。 |
getDisplayUrl
広告に表示される URL を取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | 広告に表示される URL。 派生オブジェクトから呼び出された場合は null を返します。 |
getEntityType
このエンティティの型を取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | このエンティティの種類 。 これは Ad です。 |
getHeadline
この広告のタイトルを取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | 広告のタイトル。 派生オブジェクトから呼び出された場合は null を返します。 |
getId
この広告を一意に識別する ID を取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | この広告を一意に識別する ID。 |
getPolicyApprovalStatus
この広告の編集承認状態を取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | 広告の編集承認の状態。 使用可能な値を次に示します。
|
getStats
この広告のパフォーマンス データを取得します。
このメソッドを呼び出すには、広告セレクターのforDateRangeチェーンにいずれかのメソッドを含める必要があります。
戻り値
| 型 | 説明 |
|---|---|
| 統計 | 広告のパフォーマンス データ。 |
Gettype
この広告の派生型を取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | この広告の派生型。 可能な型を次に示します。
|
isEnabled
この広告が有効かどうかを示すブール値を取得します。
戻り値
| 型 | 説明 |
|---|---|
| ブール値 | この広告が有効になっている場合は true です。それ以外の場合は false。 |
isMobilePreferred
この広告がモバイル デバイスまたはすべてのデバイスに表示される設定かどうかを示すブール値を取得します。
戻り値
| 型 | 説明 |
|---|---|
| ブール値 | この広告がモバイル デバイスに表示されるように設定されている場合は true です 。 false の場合、この広告がすべてのデバイスに表示されるように設定されます。 |
isPaused
この広告が一時停止されているかどうかを示すブール値を取得します。
戻り値
| 型 | 説明 |
|---|---|
| ブール型 | この広告が一時停止されている場合は true です。それ以外の場合は false。 |
isType
広告が指定した種類であるかどうかをテストするために使用されるメソッドが含まれます。
戻り値
| 型 | 説明 |
|---|---|
| AdTypeSpace | 広告が指定した種類であるかどうかをテストするために使用されるメソッドが含まれます。 |
ラベル
この広告に関連付けられているラベルの一覧をフィルター処理するために使用する セレクター を取得します。
戻り値
| 型 | 説明 |
|---|---|
| LabelSelector | この広告に関連付けられているラベルの一覧をフィルター処理するために使用されるセレクター。 |
一時 停止
この広告を一時停止します。
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
削除
この広告を削除します。
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
removeLabel(string name)
広告からラベルを削除します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| name | string | ラベルの大文字と小文字を区別する名前。 この広告に関連付けられているラベルの一覧を取得するには、「 ラベル」を参照してください。 |
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
urls
この広告の最終的な URL、追跡テンプレート、カスタム パラメーターを取得するために使用されるメソッドが含まれています。
戻り値
| 型 | 説明 |
|---|---|
| AdUrls | この広告の最終的な URL、追跡テンプレート、およびカスタム パラメーターを取得するために使用されるオブジェクト。 |