CampaignExcludedAudienceSelector

キャンペーンで除外されたオーディエンスのリストをフィルタリングおよび並べ替えるためのメソッドが含まれています。 セレクターの詳細については、「 セレクター」を参照してください。

使用例:

    // 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();

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

メソッド

メソッド名 戻り値の型 説明
get CampaignExcludedAudienceIterator キャンペーンで除外されたオーディエンスのリストを反復処理するために使用される反復子を取得します。
orderBy(string, orderBy) CampaignExcludedAudienceSelector 選択したキャンペーンの除外されたオーディエンスに、指定された順序を適用します。
withCondition(string condition) CampaignExcludedAudienceSelector キャンペーンの除外されたオーディエンスにフィルター条件を適用します。
withIds(string[], ids) CampaignExcludedAudienceSelector 指定した ID のキャンペーン除外オーディエンスを取得します。
withLimit(int limit) CampaignExcludedAudienceSelector 選択条件に一致する上位 n 個のキャンペーンの除外されたオーディエンスを取得します。

get

キャンペーンで除外されたオーディエンスのリストを反復処理するために使用される 反復子 を取得します。

戻り値

型 説明
CampaignExcludedAudienceIterator 選択したキャンペーンの除外された対象ユーザーを反復処理するために使用される反復子。

orderBy(String orderBy)

選択したキャンペーンの除外されたオーディエンスに、指定された順序を適用します。

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

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

たとえば、次の呼び出しでは、キャンペーンの除外されたオーディエンスが AverageCPC の昇順で返されます。

selector = selector.orderBy("AverageCpc");

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

引数

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

戻り値

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

withCondition(String condition)

キャンペーンの除外されたオーディエンスにフィルター条件を適用します。

条件パラメーターを "columnName operator value" の形式で指定します。

演算子

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

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

<
<=
>
>=
=
!=

double 型の値を含む列の演算子:

<
>

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

=
!=
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

サポートされている列

キャンペーンの除外されたオーディエンス フィルタリングでサポートされている列。 名前の大文字と小文字は区別されます。

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

列 型 例
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 セレクターに適用する条件。

戻り値

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

withIds(string[], ids)

指定した ID のキャンペーン除外オーディエンスを取得します。

1 つのセレクターに 1 つ以上の条件を適用できます。 条件のチェーンは、AND 演算と見なされます。 たとえば、条件 A が True かつ条件 B が True の場合にのみエンティティが選択されます。 たとえば、次の呼び出しでは、キャンペーンで除外されたオーディエンス 33333 のみが選択されます。

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

引数

名前 型 説明
ids string[] キャンペーンで除外されたオーディエンス ID の配列。 制限については、「 スクリプト実行制限」を参照してください。

戻り値

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

withLimit(int limit)

選択条件に一致する上位 n 個のキャンペーンの除外されたオーディエンスを取得します。

引数

名前 型 説明
limit int 返されるキャンペーンの除外オーディエンスの数。 実際の数は少ない場合があります。

戻り値

型 説明
CampaignExcludedAudienceSelector 制限が適用されたセレクター。
  • Last updated on