広告グループの定義や追加に使われるメソッドが含まれています。 ビルダーの詳細については、「 ビルダー」を参照してください。
使用例:
// Get a campaign to add the ad group to.
var iterator = AdsApp.campaigns()
.withIds(['CAMPAIGN ID GOES HERE'])
.get();
while (iterator.hasNext()) {
var campaign = iterator.next();
// Get the campaign's ad group builder and add an ad group.
var operation = campaign.newAdGroupBuilder()
.withName("AD GROUP NAME GOES HERE")
.withStatus("ENABLED")
.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`);
}
}
}
メソッド
ビルド
広告グループを作成し、広告グループが正常に追加されたかどうかをチェックするために使用される操作オブジェクトを返します。
戻り値
withBiddingStrategy(string biddingStrategy)
広告グループの入札戦略を設定します。
引数
| 名前 |
型 |
説明 |
| biddingStrategy |
string |
広告グループに適用する入札戦略。 大文字と小文字を区別する値の例を次に示します。- MANUAL_CPC
- MANUAL_CPM
- MANUAL_CPV
これらの戦略の詳細については、「 入札戦略の種類」を参照してください。 |
戻り値
withCpc(double cpc)
広告グループの CPC 入札単価を設定します。
キーワード (keyword)がユーザーの検索語句と一致し、広告グループの入札戦略がMANUAL_CPCである場合に使用する入札単価を指定します。 この入札単価は、キーワード (keyword) などの下位レベルのエンティティが上書きしない場合に使用されます。
引数
| 名前 |
型 |
説明 |
| cpc |
double |
広告グループの上限 CPC 入札単価。 最小と最大入札額はアカウントの通貨によって決まります。 詳細については、「 入札単価と予算通貨」を参照してください。 |
戻り値
withCpm(double cpm)
広告グループの CPM 入札単価を設定します。
表示された 1,000 インプレッションあたりの入札額と、広告グループの入札戦略がMANUAL_CPMされるときに使用する入札単価を指定します。
引数
| 名前 |
型 |
説明 |
| cpm |
double |
広告グループの上限 CPM 入札単価。 最小と最大入札額はアカウントの通貨によって決まります。 詳細については、「 入札単価と予算通貨」を参照してください。 |
戻り値
withCpv(double cpv)
広告グループの CPV 入札単価を設定します。
動画広告の表示ごとまたはクリックごとに、広告グループの入札戦略がMANUAL_CPVされるときに使用する入札単価を指定します。
引数
| 名前 |
型 |
説明 |
| cpv |
double |
広告グループの上限 CPV 入札単価。 最小と最大入札額はアカウントの通貨によって決まります。 詳細については、「 入札単価と予算通貨」を参照してください。 |
戻り値
withCustomParameters(Object customParameters)
最終ページ URL またはトラッキング テンプレートで使用する広告グループのカスタム パラメーターを設定します。
カスタム パラメーターは、複数の URL で動的な情報を共有する場合に役立ちます。 使用方法の詳細については、「 カスタム パラメーター」を参照してください。
引数
| 名前 |
型 |
説明 |
| customParameters |
オブジェクト |
広告グループに適用する最大 3 つのカスタム パラメーターのマップ。 たとえば、 {key1: 'value1', key2: 'value2', key3: 'value3'} などです。ここで、key はカスタム パラメーターの名前で、値はパラメーターの値です。 名前には最大 16 個の 8 バイト文字を含めることができ、値は最大 200 個の 8 バイト文字を含めることができます。 |
戻り値
withEndDate(string, endDate)
広告グループ内の広告の配信が終了する日付を設定します。 グループ内の広告が特定の日に配信を停止する場合にのみ、このメソッドを呼び出します。
引数
| 名前 |
型 |
説明 |
| endDate |
string |
広告の配信を停止する日付。 フォーム YYYYMMDD で日付を指定します。 |
戻り値
withEndDate(Object endDate)
広告グループ内の広告の配信が終了する日付を設定します。 グループ内の広告が特定の日に配信を停止する場合にのみ、このメソッドを呼び出します。
引数
| 名前 |
型 |
説明 |
| endDate |
オブジェクト |
広告の配信を停止する日付。 次のフィールドを持つオブジェクトを使用して日付を指定します。
例: var date = {year: 2018, month: 5, day: 13};
月は 1 ベースで、1 は 1 月、12 は 12 月です。 |
戻り値
withLanguage(string language)
この広告グループの広告で使用される言語を設定します。
既定では、広告グループは親キャンペーンから言語を継承します。 キャンペーン レベルで指定された言語をオーバーライドするには、またはキャンペーンで言語が指定されていない場合 (言語はキャンペーンレベルや広告グループ レベルで指定する必要があります)、広告グループ レベルで言語を指定します。
引数
| 名前 |
型 |
説明 |
| language |
string |
広告グループの広告で使用される言語。 たとえば、英語などです。 文字列では大文字と小文字は区別されません。 2 文字の言語コードは使用しないでください。 サポートされている言語の一覧については、「 広告の言語」を参照してください。 |
戻り値
withName(string name)
広告グループの名前を設定します。
引数
| 名前 |
型 |
説明 |
| name |
string |
広告グループ名。 名前は必須です。 名前は最大 256 文字で、キャンペーン内のすべてのアクティブな広告グループの中で一意である必要があります。 |
戻り値
withStartDate(string, startDate)
広告グループ内の広告の配信が開始される日付を設定します。 グループ内の広告が特定の日に配信を開始する場合にのみ、このメソッドを呼び出します。それ以外の場合は、広告の配信がすぐに開始されます。
引数
| 名前 |
型 |
説明 |
| endDate |
string |
広告配信を開始する日付。 フォーム YYYYMMDD で日付を指定します。 |
戻り値
withStartDate(Object startDate)
広告グループ内の広告の配信が開始される日付を設定します。 グループ内の広告が特定の日に配信を開始する場合にのみ、このメソッドを呼び出します。それ以外の場合は、広告の配信がすぐに開始されます。
引数
| 名前 |
型 |
説明 |
| endDate |
オブジェクト |
広告配信を開始する日付。 次のフィールドを持つオブジェクトを使用して日付を指定します。
例: var date = {year: 2018, month: 5, day: 13};
月は 1 ベースで、1 は 1 月、12 は 12 月です。 |
戻り値
withStatus(string status)
広告グループのステータスを設定します。
引数
| 名前 |
型 |
説明 |
| status |
String |
広告グループのステータス。 大文字と小文字を区別する値の例を次に示します。
既定値は PAUSED です。 |
戻り値
withTrackingTemplate(string trackingTemplate)
広告グループのトラッキング テンプレートを設定します。
トラッキング テンプレートは、キーワード (keyword) の FinalUrl と共に使用され、広告で使用されるリンク先 URL が作成されます。 詳細については、どの トラッキングまたは URL パラメーターを使用できるかをご覧ください。
引数
| 名前 |
型 |
説明 |
| trackingTemplate |
string |
広告グループで使用するトラッキング テンプレート。 |
戻り値
関連項目
Campaign.newAdGroupBuilder()