AdGroupExcludedAudienceSelector

除外された広告グループのリストをフィルター処理して並べ替える方法が含まれます。 セレクターの詳細については、「 セレクター」を参照してください。

使用例:

    // Gets the iterator that iterates all ad group excluded audiences
    // in the account.
    var iterator = AdsApp.adGroups().get();

    // Loops through all ad groups in the account.
    while (iterator.hasNext()) {
        var adGroup = iterator.next();

        // Gets the iterator that iterates all ad group excluded audiences
        // in the ad group excluded audience.
        var audienceIterator = adGroup.targeting().audiences()
            .withLimit(10)
            .withIds("123456789")
            .get();
    
        // Loops through all ad group excluded audiences in the ad group excluded audience.
        while (audienceIterator.hasNext()) {
            var audience = audienceIterator.next();
        }
    }

メソッド

メソッド名	戻り値の型	説明
get	AdGroupExcludedAudienceIterator	広告グループの除外対象ユーザーの一覧を反復処理するために使用される反復子を取得します。
orderBy(string orderBy)	AdGroupExcludedAudienceSelector	指定した順序を、選択した広告グループの除外対象ユーザーに適用します。
withCondition(string condition)	AdGroupExcludedAudienceSelector	除外された広告グループの対象ユーザーにフィルター条件を適用します。
withIds(string[] ids)	AdGroupExcludedAudienceSelector	指定した ID を持つ広告グループ除外対象ユーザーを取得します。
withLimit(int limit)	AdGroupExcludedAudienceSelector	選択条件に一致する上位 n 個の広告グループ除外対象ユーザーを取得します。

取得

広告グループの除外対象ユーザーの一覧を反復処理するために使用される 反復子 を取得します。

戻り値

型	説明
AdGroupExcludedAudienceIterator	選択した広告グループの除外対象ユーザーを反復処理するために使用される反復子。

orderBy(String orderBy)

指定した順序を、選択した広告グループの除外対象ユーザーに適用します。

"columnName orderDirection" という形式で orderBy パラメーターを指定します。

• columnName は、 サポートされている列の 1 つです。
• orderDirection は、結果を並べ替える順序です。 結果を昇順に並べ替える場合は ASC に、結果を降順に並べ替える場合は DESC に設定します。 既定値は ASC です。

たとえば、次の呼び出しでは、除外された広告グループの対象ユーザーを AverageCpc の昇順で返します。

selector = selector.orderBy("AverageCpc");

セレクターでは、1 つのフィールドによるエンティティの並べ替えのみがサポートされます。 フィールド x、x 内のエンティティの一覧をフィールド y ごとに並べ替えすることはできません。 チェーンまたは個別のセレクター呼び出しで複数 orderBy() の呼び出しを指定した場合、スクリプトは最後 orderBy() の呼び出しで指定されたフィールドを使用してエンティティの一覧を並べ替えます。 

引数

名前	型	説明
Orderby	string	適用する順序。

戻り値

型	説明
AdGroupExcludedAudienceSelector	順序付けが適用されたセレクター。

withCondition(String condition)

除外された広告グループの対象ユーザーにフィルター条件を適用します。

"columnName 演算子値" という形式で condition パラメーターを指定します。

• columnName は、 サポートされている列の 1 つです。
• operator は、サポートされている演算子の 1 つです。

演算子

使用する演算子は、列の型によって異なります。 演算子では大文字と小文字が区別されます。 たとえば、starts_withの代わりに STARTS_WITH を使用します。

整数と長い値を含む列の演算子:

<
<=
>
>=
=
!=

二重値を含む列の演算子:

<
>

文字列値を含む列の演算子:

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

列挙値を含む列の演算子:

=
!=
IN []
NOT_IN []

文字列の配列を含む列の演算子:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

サポートされる列

広告グループの除外対象ユーザーのフィルター処理でサポートされている列。 名前では大文字と小文字が区別されます。

指定できるエンティティ プロパティを次に示します。

Column	型	例
AdGroupName	文字列	関連付けの広告グループの名前。 withCondition("AdGroupName CONTAINS_IGNORE_CASE 'truck'")
AdGroupStatus	列挙	関連付けの広告グループの状態。 大文字と小文字を区別する値は次のとおりです。 有効 一時 停止 削除 次の使用例は、親広告グループが一時停止されている広告グループ除外対象ユーザーのみを返します。 withCondition("AdGroupStatus = PAUSED")
AudienceId	long	関連付けられている対象ユーザーの ID。 withCondition("AudienceId = 123456789")
CampaignName	string	関連付けの広告グループを含むキャンペーンの名前。 withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
CampaignStatus	列挙	関連付けの広告グループを含むキャンペーンの状態。 大文字と小文字を区別する値は次のとおりです。 有効 一時 停止 削除 次の使用例は、親キャンペーンが一時停止されている広告グループ除外対象ユーザーのみを返します。 withCondition("CampaignStatus = PAUSED")
状態	列挙	関連付けの状態。 大文字と小文字を区別する値は次のとおりです。 有効 一時 停止 削除 次の使用例は、有効な広告グループ除外対象ユーザーのみを返します。 withCondition("Status = ENABLED")
UserListName	string	関連付けられている対象ユーザーの名前。 withCondition("UserListName = 'foo'")

引数

名前	型	説明
condition	string	セレクターに適用する条件。

戻り値

型	説明
AdGroupExcludedAudienceSelector	条件が適用されたセレクター。

withIds(string[] ids)

指定した ID を持つ広告グループ除外対象ユーザーを取得します。

セレクターに 1 つ以上の条件を適用できます。 条件のチェーンは AND 演算と見なされます。 たとえば、条件 A が true の場合にのみエンティティが選択され、条件 B が true です。 たとえば、次の呼び出しでは、広告グループ除外対象ユーザー 33333 のみが選択されます。

var selector = AdsApp.adGroups()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

引数

名前	型	説明
ids	string[]	広告グループから除外された対象ユーザー ID の配列。 制限については、「スクリプトの 実行制限」を参照してください。

戻り値

型	説明
AdGroupExcludedAudienceSelector	ID が適用されたセレクター。

withLimit(int limit)

選択条件に一致する上位 n 個の広告グループ除外対象ユーザーを取得します。

引数

名前	型	説明
limit	int	返される対象ユーザーを除外した広告グループの数。 実際の数値が小さい場合があります。

戻り値

型	説明
AdGroupExcludedAudienceSelector	制限が適用されたセレクター。