AdGroupBuilder
[アーティクル] 11/13/2024
3 人の共同作成者
フィードバック
この記事の内容
広告グループの定義と追加に使用されるメソッドが含まれます。 ビルダーの詳細については、「 Builders 」を参照してください。
使用例:
// 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)
広告グループのクリック単価を設定します。
キーワードがユーザーの検索語句と一致し、広告グループの入札戦略がMANUAL_CPCされたときに使用する入札金額を指定します。 この入札は、キーワードなどの下位レベルのエンティティがオーバーライドしない場合に使用されます。
引数
名前
型
説明
クリック 単価
double
広告グループの上限クリック単価。 アカウントの通貨によって、最小入札値と最大入札額が決まります。 詳細については、「 入札通貨と予算通貨 」を参照してください。
戻り値
withCpm(double cpm)
広告グループの CPM 入札を設定します。
表示回数 1,000 回あたりの入札金額を指定し、広告グループの入札戦略がMANUAL_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)
広告グループのトラッキング テンプレートを設定します。
トラッキング テンプレートは、キーワードの FinalUrl と共に使用され、広告で使用される宛先 URL を作成します。 詳細については、「 使用できる追跡パラメーターまたは URL パラメーター」を参照してください。
引数
名前
型
説明
trackingTemplate
string
広告グループで使用する追跡テンプレート。
戻り値
関連項目
Campaign.newAdGroupBuilder()