CampaignAudienceSelector

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

Esempio di utilizzo:

    // 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(Oggetto dateFrom, Oggetto dateTo) CampaignAudienceSelector Applica le date di inizio e di fine per la selezione delle metriche del rendimento.
forDateRange(stringa dateRange) CampaignAudienceSelector Applica l'intervallo di date predefinito per la selezione delle metriche del rendimento.
Ottieni CampaignAudienceIterator Ottiene un iteratore utilizzato per scorrere l'elenco dei gruppi di destinatari della campagna.
orderBy(stringa orderBy) CampaignAudienceSelector Applica l'ordinamento specificato ai gruppi di destinatari della campagna selezionati.
withCondition(condizione stringa) CampaignAudienceSelector Applica i 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 soddisfano i criteri di selezione.

forDateRange(Oggetto dateFrom, Oggetto dateTo)

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

Specificare un intervallo di date solo se:

  • Applichi condizioni o ordini che fanno riferimento ai campi delle metriche delle prestazioni.
  • Si desidera ottenere dati sulle prestazioni per gli oggetti selezionati. Ad esempio, se si prevede di chiamare il getStats() metodo.

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

  • anno
  • mese
  • giorno

Ad esempio:

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

Il mese è a base unica, 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 usando 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 del rendimento.

Specificare un intervallo di date solo se:

  • Applichi condizioni o ordini che fanno riferimento ai campi delle metriche delle prestazioni.
  • Si desidera ottenere dati sulle prestazioni per gli oggetti selezionati. 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 supportato:

  • 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 dell'intervallo di date predefinito che specifica i dati sul rendimento da includere nel selettore. Per la stringa dell'intervallo di date predefinita viene fatta distinzione tra maiuscole e minuscole. I valori possibili con distinzione tra maiuscole e minuscole sono: 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.

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 eseguire l'iterazione tra i gruppi di destinatari della campagna selezionati.

orderBy(stringa orderBy)

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

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

  • columnName è una delle colonne supportate.
  • orderDirection è l'ordine in cui ordinare i risultati. Impostate su ASC per ordinare i risultati in ordine crescente o DESC per ordinare i risultati in ordine decrescente. L'impostazione predefinita è ASC.

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

selector = selector.orderBy("AverageCpc");

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

Argomenti

Nome Tipo Descrizione
orderBy stringa Ordine da applicare.

Restituisce

Tipo Descrizione
CampaignAudienceSelector Selettore con ordinamento applicato.

withCondition(condizione stringa)

Applica i criteri di filtro ai gruppi di destinatari della campagna.

Specificare il parametro condizione nel formato "valore operatore columnName" dove:

Operatori

L'operatore da usare dipende dal tipo di colonna. Negli operatori viene fatta distinzione tra maiuscole e minuscole. Ad esempio, usare STARTS_WITH invece di starts_with.

Operatori per le colonne che contengono numeri interi e 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 del gruppo di destinatari della campagna. Nei nomi viene fatta 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 dell'account.
CTR doppia withCondition("Ctr > 0.05")

Il CTR è nell'intervallo 0..1, quindi usa 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 Il nome della campagna dell'associazione.

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
CampaignStatus Enumerazione Lo stato della campagna dell'associazione. I valori possibili con distinzione tra maiuscole e minuscole sono:
  • ABILITATO
  • Pausa
  • RIMOSSO
Questo esempio restituisce solo i gruppi di destinatari la cui campagna padre è sospesa.

withCondition("CampaignStatus = PAUSED")
Stato Enumerazione Lo stato dell'associazione. I valori possibili con distinzione tra maiuscole e minuscole sono:
  • ABILITATO
  • Pausa
  • RIMOSSO
Questo esempio restituisce 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.

Puoi 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 è vera E la condizione B è vera. Ad esempio, la chiamata seguente seleziona solo i destinatari della campagna 33333.

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

Argomenti

Nome Tipo Descrizione
ID stringa[] Matrice di ID gruppo di destinatari della campagna. Per i limiti, vedere Limiti di esecuzione degli script.

Restituisce

Tipo Descrizione
CampaignAudienceSelector Selettore con gli ID applicati.

withLimit(int limit)

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

Argomenti

Nome Tipo Descrizione
Limite int Numero di gruppi di destinatari della campagna da restituire. Il numero effettivo potrebbe essere inferiore.

Restituisce

Tipo Descrizione
CampaignAudienceSelector Selettore con limite applicato.
  • Ultimo aggiornamento: