CampaignSelector
Contiene i metodi per filtrare e ordinare un elenco di campagne. Per informazioni sui selettori, vedere Selettori.
Utilizzo di esempio:
var iterator = AdsApp.campaigns()
.withCondition("ClickConversionRate > 0.3")
.forDateRange("LAST_WEEK")
.orderBy("Clicks DESC")
.get();
while (iterator.hasNext()) {
var campaign = iterator.next();
var metrics = campaign.getStats();
}
Metodi
Nome metodo | Tipo restituito | Descrizione |
---|---|---|
forDateRange(Object dateFrom, Object dateTo) | CampaignSelector | Applica le date di inizio e fine per la selezione delle metriche delle prestazioni. |
forDateRange(string dateRange) | CampaignSelector | Applica l'intervallo di date predefinito per la selezione delle metriche delle prestazioni. |
Ottieni | CampaignIterator | Ottiene un iteratore utilizzato per scorrere l'elenco di campagne. |
orderBy(string orderBy) | CampaignSelector | Applica l'ordinamento specificato alle campagne selezionate. |
withCondition(string condition) | CampaignSelector | Applica il filtro all'elenco di campagne. |
withIds(string[] ids) | CampaignSelector | Ottiene le campagne con gli ID specificati. |
withLimit(int limit) | CampaignSelector | Ottiene le prime n campagne 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. |
dateTo | Oggetto | Data di fine dell'intervallo di date che specifica i dati sulle prestazioni da includere nel selettore. |
Restituisce
Tipo | Descrizione |
---|---|
CampaignSelector | Selettore con intervallo di date applicato. |
forDateRange(string dateRange)
Applica l'intervallo di date predefinito per la selezione delle metriche delle prestazioni.
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
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.
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. |
Restituisce
Tipo | Descrizione |
---|---|
CampaignSelector | Selettore con intervallo di date applicato. |
Ottieni
Ottiene un iteratore utilizzato per scorrere l'elenco di campagne.
Restituisce
Tipo | Descrizione |
---|---|
CampaignIterator | Iteratore usato per scorrere le campagne selezionate. |
orderBy(string orderBy)
Applica l'ordinamento specificato alle campagne selezionate.
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 le campagne 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 |
---|---|
CampaignSelector | Selettore con ordinamento applicato. |
withCondition(string condition)
Applica il filtro all'elenco delle campagne.
Specificare il parametro condition nel formato "columnName operator value" dove:
- columnName è una delle colonne supportate. Se columName è impostato su un nome di colonna della metrica delle prestazioni, è necessario specificare un intervallo di date usando forDateRange(String dateRange) o forDateRange(Object dateFrom, Object dateTo).
- operator è uno degli operatori supportati.
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 per il filtro campagna. Ai nomi delle colonne viene applicata la 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 |
---|---|---|
Stato | Enumerazione | Stato della campagna. I possibili valori con distinzione tra maiuscole e minuscole sono:
withCondition("Status = ENABLED") |
Nome | stringa | Il nome della campagna.withCondition("Name CONTAINS_IGNORE_CASE 'clearance'") |
Bilancio | Doppia | Il budget della campagna.withCondition("Budget > 500.0") |
BudgetType | Enumerazione | Tipo di budget della campagna. I possibili valori con distinzione tra maiuscole e minuscole sono:
withCondition("BudgetType = 'STANDARD'") |
DeliveryStatus | Enumerazione | Stato di recapito della campagna. I possibili valori con distinzione tra maiuscole e minuscole sono:
withCondition("DeliveryStatus NOT_IN ['LIMITED_BY_BUDGET', 'HOLD', 'CAMPAIGN_OUT_OF_BUDGET']") |
LabelNames | set di stringhe | Elenco di uno o più nomi di etichette con distinzione tra maiuscole e minuscole. Usare per ottenere le campagne associate alle etichette denominate.withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']") |
Tipo | Enumerazione | Tipo della campagna. I possibili valori con distinzione tra maiuscole e minuscole sono:
withCondition("CampaignType = SHOPPING") |
Argomenti
Nome | Tipo | Descrizione |
---|---|---|
Condizione | stringa | Condizione da applicare al selettore. |
Restituisce
Tipo | Descrizione |
---|---|
CampaignSelector | Selettore con la condizione applicata. |
withIds(string[] ids)
Ottiene le campagne 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 la campagna 33333.
AdsApp.campaigns()
.withIds(['11111', '22222', '33333'])
.withIds(['33333', '44444', '55555']);
Argomenti
Nome | Tipo | Descrizione |
---|---|---|
Id | string[] | Matrice di ID campagna. Per i limiti, vedere Limiti di esecuzione dello script. |
Restituisce
Tipo | Descrizione |
---|---|
CampaignSelector | Selettore con gli ID applicati. |
withLimit(int limit)
Ottiene le prime n campagne che corrispondono ai criteri di selezione.
Argomenti
Nome | Tipo | Descrizione |
---|---|---|
Limite | int | Numero di campagne da restituire. Il numero effettivo può essere minore. |
Restituisce
Tipo | Descrizione |
---|---|
CampaignSelector | Selettore con limite applicato. |