CampaignAudienceBuilder

キャンペーン対象ユーザーの関連付けを定義および作成するためのメソッドが含まれています。 ビルダーの詳細については、「 ビルダー」を参照してください。

使用例:

    // Gets the iterator that iterates all campaigns
    // in the account.
    var shoppingCampaign = AdsApp.shoppingCampaigns().withIds(["123456789"]).get();

    // Loops through all campaigns in the account.
    while (iterator.hasNext()) {
        var campaign = iterator.next();

        // Get the campaign audience's builder.
        var operation = campaign.targeting().newUserListBuilder()
            .withAudienceId("AUDIENCE ID GOES HERE")
            .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`);
            }
        }
    }

メソッド

メソッド名	戻り値の型	説明
build	CampaignAudienceOperation	キャンペーン対象ユーザーの関連付けを作成し、キャンペーン対象ユーザーの関連付けが正常に追加されたかどうかをチェックするために使用される操作オブジェクトを返します。
Exclude	CampaignExcludedAudienceOperation	指定された対象ユーザーをこのキャンペーンから除外し、除外されたキャンペーン対象ユーザーが正常に追加されたかどうかをチェックするために使用される操作オブジェクトを返します。
withAudience(Object userList)	CampaignAudienceBuilder	関連付けられているユーザーの一覧を設定します。
withAudienceId(string audienceId)	CampaignAudienceBuilder	関連付けられたオーディエンスの ID を設定します。
withAudienceType(string, audienceType)	CampaignAudienceBuilder	関連付けられたオーディエンスのタイプを設定します。
withBidModifier(double modifier)	CampaignAudienceBuilder	関連付けの入札単価調整子を設定します。

ビルド

キャンペーン対象ユーザーを作成し、キャンペーン対象ユーザーが正常に追加されたかどうかをチェックするために使用される操作オブジェクトを返します。

戻り値

型	説明
CampaignAudienceOperation	キャンペーンの対象ユーザーが正常に追加されたかどうかをチェックするために使用される操作オブジェクト。

Exclude

指定された対象ユーザーをこのキャンペーンから除外し、除外されたキャンペーン対象ユーザーが正常に追加されたかどうかをチェックするために使用される操作オブジェクトを返します。

戻り値

型	説明
CampaignExcludedAudienceOperation	除外されたキャンペーン オーディエンスが正常に追加されたかどうかをチェックするために使用される操作オブジェクト。

withAudience(Object userList)

関連付けられているユーザーの一覧を設定します。

引数

名前	型	説明
userList	string	関連付けられているユーザーの一覧。

withAudienceId(string audienceId)

関連付けられたオーディエンスの ID を設定します。

引数

名前	型	説明
audienceId	string	関連付けられたオーディエンスの ID。

withAudienceType(string, audienceType)

関連付けられたオーディエンスのタイプを設定します。

引数

名前	型	説明
audienceId	string	関連付けられているオーディエンスのタイプ。

withBidModifier(double modifier)

関連付けの入札単価調整子を設定します。

引数

名前	型	説明
修飾子	double	アソシエーションの入札単価調整子。

戻り値

型	説明
CampaignAudienceBuilder	入札単価調整子が適用されたキャンペーン対象ユーザー ビルダー。

戻り値

型	説明
CampaignAudienceBuilder	名前が適用されたキャンペーン対象ユーザー ビルダー。