Condividi tramite


CampaignAudienceSelector

Contiene i metodi per filtrare e ordinare un elenco di gruppi di destinatari della campagna. Per informazioni sui selettori, vedere Selettori.

Utilizzo di esempio:

    // 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 audiences
        // in the campaign audience.
        var audienceIterator = campaign.targeting().audiences()
            .withLimit(10)
            .withIds("123456789")
            .get();
    
        // Loops through all campaign audiences in the campaign audience.
        while (audienceIterator.hasNext()) {
            var audience = audienceIterator.next();
        }
    }

Metodi

Nome metodo Tipo restituito Descrizione
forDateRange(Object dateFrom, Object dateTo) CampaignAudienceSelector Applica le date di inizio e fine per la selezione delle metriche delle prestazioni.
forDateRange(string dateRange) CampaignAudienceSelector Applica l'intervallo di date predefinito per la selezione delle metriche delle prestazioni.
Ottieni CampaignAudienceIterator Ottiene un iteratore utilizzato per scorrere l'elenco dei gruppi di destinatari della campagna.
orderBy(string orderBy) CampaignAudienceSelector Applica l'ordinamento specificato ai gruppi di destinatari della campagna selezionati.
withCondition(string condition) CampaignAudienceSelector Applica criteri di filtro ai gruppi di destinatari della campagna.
withIds(string[] ids) CampaignAudienceSelector Ottiene i gruppi di destinatari della campagna con gli ID specificati.
withLimit(int limit) CampaignAudienceSelector Ottiene i primi n gruppi di destinatari della campagna che corrispondono ai criteri di selezione.

forDateRange(Object dateFrom, Object dateTo)

Applica le date di inizio e fine per la selezione delle metriche delle prestazioni.

Specificare un intervallo di date solo se:

  • Si applicano condizioni o si ordinano i campi delle metriche delle prestazioni di riferimento.
  • Si vogliono ottenere i dati sulle prestazioni per gli oggetti da selezionare. Ad esempio, se si prevede di chiamare il getStats() metodo .

È possibile specificare i parametri di data usando stringhe o oggetti . Per utilizzare le stringhe, specificare la data nel formato AAAAMMGG. Se si usano oggetti , creare un oggetto con i campi seguenti:

  • Anno
  • Mese
  • Giorno

Ad esempio:

var date = {year: 2018, month: 5, day: 13};

Il mese è in base uno, dove 1 è gennaio e 12 dicembre.

L'intervallo di date è inclusivo. Se si specificano più intervalli di date, viene usato solo l'ultimo intervallo di date.

Argomenti

Nome Tipo Descrizione
dateFrom Oggetto Data di inizio dell'intervallo di date che specifica i dati sulle prestazioni da includere nel selettore. Specificare la data usando una stringa nel formato, AAAAMMGG o un oggetto nel formato {anno: 2020, mese: 12, giorno: 31}.
dateTo Oggetto Data di fine dell'intervallo di date che specifica i dati sulle prestazioni da includere nel selettore. Specificare la data utilizzando una stringa nel formato, AAAAMMGG o un oggetto nel formato {anno: 2020, mese: 12, giorno: 1}.

Restituisce

Tipo Descrizione
CampaignAudienceSelector Selettore con intervallo di date applicato.

forDateRange(String dateRange)

Applica l'intervallo di date predefinito per la selezione delle metriche delle prestazioni.

Specificare un intervallo di date solo se:

  • Si applicano condizioni o si ordinano i campi delle metriche delle prestazioni di riferimento.
  • Si vogliono ottenere i dati sulle prestazioni per gli oggetti da selezionare. Ad esempio, se si prevede di chiamare il getStats() metodo .

Se si specificano più intervalli di date, viene usato solo l'ultimo intervallo di date.

Valori dell'intervallo di date supportati:

  • OGGI
  • IERI
  • LAST_WEEK
  • LAST_BUSINESS_WEEK
  • LAST_7_DAYS
  • THIS_WEEK_SUN_TODAY
  • LAST_14_DAYS
  • LAST_30_DAYS
  • LAST_WEEK_SUN_SAT
  • THIS_MONTH
  • LAST_MONTH
  • ALL_TIME

Argomenti

Nome Tipo Descrizione
dateRange Stringa Stringa di intervallo di date predefinita che specifica i dati sulle prestazioni da includere nel selettore. La stringa di intervallo di date predefinita fa distinzione tra maiuscole e minuscole. I possibili valori con distinzione tra maiuscole e minuscole sono: TODAY, YESTERDAY, LAST_WEEK, LAST_BUSINESS_WEEK, LAST_7_DAYS, THIS_WEEK_SUN_TODAY, LAST_14_DAYS, LAST_30_DAYS, LAST_WEEK_SUN_SAT, THIS_MONTH, LAST_MONTH, ALL_TIME.

Restituisce

Tipo Descrizione
CampaignAudienceSelector Selettore con intervallo di date applicato.

Ottieni

Ottiene un iteratore utilizzato per scorrere l'elenco dei gruppi di destinatari della campagna.

Restituisce

Tipo Descrizione
CampaignAudienceIterator Iteratore usato per scorrere i gruppi di destinatari della campagna selezionati.

orderBy(String orderBy)

Applica l'ordinamento specificato ai gruppi di destinatari della campagna selezionati.

Specificare il parametro orderBy nel formato "columnName orderDirection" dove:

  • columnName è una delle colonne supportate.
  • orderDirection è l'ordine in cui ordinare i risultati. Impostare su ASC per ordinare i risultati in ordine crescente o DESC per ordinare i risultati in ordine decrescente. Il valore predefinito è ASC.

Ad esempio, la chiamata seguente restituisce gruppi di destinatari della campagna in ordine crescente in base a AverageCpc.

selector = selector.orderBy("AverageCpc");

I selettori supportano l'ordinamento delle entità in base a un solo campo. Non è possibile ordinare l'elenco di entità per campo x e all'interno di x per campo y e così via. Se si specificano più chiamate orderBy() in una catena o in chiamate selettore separate, Script ordina l'elenco di entità usando il campo specificato nell'ultima orderBy() chiamata. 

Argomenti

Nome Tipo Descrizione
Orderby stringa Ordinamento da applicare.

Restituisce

Tipo Descrizione
CampaignAudienceSelector Selettore con ordinamento applicato.

withCondition(String condition)

Applica criteri di filtro ai gruppi di destinatari della campagna.

Specificare il parametro condition nel formato "columnName operator value" dove:

Operatori

L'operatore usato dipende dal tipo della colonna. Gli operatori fanno distinzione tra maiuscole e minuscole. Ad esempio, usare STARTS_WITH anziché starts_with.

Operatori per le colonne che contengono valori interi e valori lunghi:

<
<=
>
>=
=
!=

Operatori per le colonne che contengono valori double:

<
>

Operatori per le colonne che contengono valori stringa:

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

Operatori per le colonne che contengono valori di enumerazione:

=
!=
IN []
NOT_IN []

Operatori per le colonne che contengono una matrice di stringhe:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Colonne supportate

Colonne supportate per il filtro dei gruppi di destinatari della campagna. I nomi fanno distinzione tra maiuscole e minuscole.

Di seguito sono riportate le colonne delle metriche delle prestazioni che è possibile specificare.

Colonna Tipo Esempio
AbsoluteTopImpressionRate Doppia withCondition("AbsoluteTopImpressionRate > 0.25")
AverageCpc Doppia withCondition("AverageCpc < 2.75")
AverageCpm Doppia withCondition("AverageCpm > 0.65")
ClickConversionRate Doppia withCondition("ClickConversionRate > 0.25")
Clic long withCondition("Clicks >= 33")
ConvertedClicks long withCondition("ConvertedClicks >= 10")
Costo Doppia withCondition("Cost > 3.25")

Il costo è nella valuta del conto.
Ctr Doppia withCondition("Ctr > 0.05")

Il CTR è compreso nell'intervallo 0..1, quindi usare 0,05 per un CTR del 5%.
Impression long withCondition("Impressions > 10")
TopImpressionRate Doppia withCondition("TopImpressionRate > 0.25")

Di seguito sono riportate le proprietà dell'entità che è possibile specificare.

Colonna Tipo Esempio
AudienceId long ID del gruppo di destinatari associato.

withCondition("AudienceId = 123456789")
CampaignName stringa Nome della campagna dell'associazione.

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
CampaignStatus Enumerazione Stato della campagna dell'associazione. I possibili valori con distinzione tra maiuscole e minuscole sono:
  • ABILITATO
  • PAUSA
  • RIMOSSO
In questo esempio vengono restituiti solo i gruppi di destinatari della campagna la cui campagna padre è sospesa.

withCondition("CampaignStatus = PAUSED")
Stato Enumerazione Stato dell'associazione. I possibili valori con distinzione tra maiuscole e minuscole sono:
  • ABILITATO
  • PAUSA
  • RIMOSSO
In questo esempio vengono restituiti solo i gruppi di destinatari della campagna abilitati.

withCondition("Status = ENABLED")
UserListName stringa Nome del gruppo di destinatari associato.

withCondition("UserListName = 'foo'")

Argomenti

Nome Tipo Descrizione
Condizione stringa Condizione da applicare al selettore.

Restituisce

Tipo Descrizione
CampaignAudienceSelector Selettore con la condizione applicata.

withIds(string[] ids)

Ottiene i gruppi di destinatari della campagna con gli ID specificati.

È possibile applicare una o più condizioni a un selettore. Una catena di condizioni è considerata un'operazione AND. Ad esempio, l'entità viene selezionata solo se la condizione A è true E la condizione B è true. Ad esempio, la chiamata seguente seleziona solo il pubblico della campagna 33333.

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

Argomenti

Nome Tipo Descrizione
Id string[] Una matrice di ID del pubblico della campagna. Per i limiti, vedere Limiti di esecuzione dello script.

Restituisce

Tipo Descrizione
CampaignAudienceSelector Selettore con gli ID applicati.

withLimit(int limit)

Ottiene i primi n gruppi di destinatari della campagna che corrispondono ai criteri di selezione.

Argomenti

Nome Tipo Descrizione
Limite int Numero di destinatari della campagna da restituire. Il numero effettivo può essere minore.

Restituisce

Tipo Descrizione
CampaignAudienceSelector Selettore con limite applicato.