REST Resource: advertisers.campaigns

Risorsa: campagna

Una singola campagna.

Rappresentazione JSON 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "campaignBudgets": [
    {
      object (CampaignBudget)
    }
  ]
}
Campi
name

string

Solo output. Il nome della risorsa della campagna.
advertiserId

string (int64 format)

Solo output. L'ID univoco dell'inserzionista a cui appartiene la campagna.
campaignId

string (int64 format)

Solo output. L'ID univoco della campagna. Assegnato dal sistema.
displayName

string

Obbligatorio. Il nome visualizzato della campagna.

Deve essere codificata in UTF-8 con una dimensione massima di 240 byte.
entityStatus

enum (EntityStatus)

Obbligatorio. Controlla se gli ordini di inserzione di questa campagna possono spendere i budget e fare offerte per l'inventario.

  • I valori accettati sono ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED e ENTITY_STATUS_PAUSED.
  • Per il metodo campaigns.create, ENTITY_STATUS_ARCHIVED non è consentito.
updateTime

string (Timestamp format)

Solo output. Timestamp dell'ultimo aggiornamento della campagna. Assegnato dal sistema.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
campaignGoal

object (CampaignGoal)

Obbligatorio. L'obiettivo della campagna.
campaignFlight

object (CampaignFlight)

Obbligatorio. La spesa pianificata e la durata della campagna.
frequencyCap

object (FrequencyCap)

Obbligatorio. L'impostazione della quota limite della campagna.
campaignBudgets[]

object (CampaignBudget)

L'elenco dei budget disponibili per questa campagna.

Se questo campo non è impostato, la campagna utilizza un budget illimitato.

CampaignGoal

Impostazioni che controllano l'obiettivo di una campagna.

Rappresentazione JSON 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
Campi
campaignGoalType

enum (CampaignGoalType)

Obbligatorio. Il tipo di obiettivo della campagna.
performanceGoal

object (PerformanceGoal)

Obbligatorio. L'obiettivo di rendimento della campagna.

I valori accettabili per performanceGoalType sono:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_OTHER

CampaignGoalType

Possibili tipi di obiettivi della campagna.

Enum
CAMPAIGN_GOAL_TYPE_UNSPECIFIED Il valore dell'obiettivo non è specificato o è sconosciuto in questa versione.
CAMPAIGN_GOAL_TYPE_APP_INSTALL Genera installazioni di app o coinvolgimenti in app.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Aumentare la notorietà di un brand o prodotto.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Genera vendite offline o in negozio.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Genera azioni o visite online.

PerformanceGoal

Impostazioni che controllano l'obiettivo di rendimento di una campagna.

Rappresentazione JSON 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // Union field performance_goal_value can be only one of the following:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of list of possible types for union field performance_goal_value.
}
Campi
performanceGoalType

enum (PerformanceGoalType)

Obbligatorio. Il tipo di obiettivo di rendimento.
Campo unione performance_goal_value. Obbligatorio. Il valore dell'obiettivo di rendimento corrispondente a un determinato performance_goal_type. performance_goal_value può essere solo uno dei seguenti:
performanceGoalAmountMicros

string (int64 format)

L'importo dell'obiettivo, in micro della valuta dell'inserzionista.

Applicabile quando performanceGoalType è uno dei seguenti:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

Ad esempio, 1500000 rappresenta 1,5 unità standard della valuta.
performanceGoalPercentageMicros

string (int64 format)

La rappresentazione decimale della percentuale dell'obiettivo in micro.

Applicabile quando performanceGoalType è uno dei seguenti:

  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_CLICK_CVR
  • PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
  • PERFORMANCE_GOAL_TYPE_VTR
  • PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
  • PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

Ad esempio, 70000 rappresenta il 7% (decimale 0,07).
performanceGoalString

string

Una stringa di indicatori chiave di prestazione (KPI), che può essere vuota. Deve essere codificato in UTF-8 e non deve contenere più di 100 caratteri.

Applicabile quando performanceGoalType è impostato su PERFORMANCE_GOAL_TYPE_OTHER.

PerformanceGoalType

Possibili tipi di obiettivi di rendimento.

Enum
PERFORMANCE_GOAL_TYPE_UNSPECIFIED Il tipo di obiettivo di rendimento non è specificato o è sconosciuto in questa versione.
PERFORMANCE_GOAL_TYPE_CPM L'obiettivo di rendimento è impostato in CPM (costo per mille).
PERFORMANCE_GOAL_TYPE_CPC L'obiettivo di rendimento è impostato in CPC (costo per clic).
PERFORMANCE_GOAL_TYPE_CPA L'obiettivo di rendimento è impostato in CPA (costo per azione).
PERFORMANCE_GOAL_TYPE_CTR L'obiettivo di rendimento è impostato in percentuale di CTR (percentuale di clic).
PERFORMANCE_GOAL_TYPE_VIEWABILITY L'obiettivo di rendimento è impostato in Percentuale di visibilità.
PERFORMANCE_GOAL_TYPE_CPIAVC L'obiettivo di rendimento è impostato come CPIAVC (costo per impressione udibile e visibile al termine).
PERFORMANCE_GOAL_TYPE_CPE L'obiettivo di rendimento è impostato in CPE (costo per engagement).
PERFORMANCE_GOAL_TYPE_CPV L'obiettivo di rendimento è impostato in CPV (costo per visualizzazione).
PERFORMANCE_GOAL_TYPE_CLICK_CVR L'obiettivo di rendimento è impostato in percentuale del tasso di conversione dei clic (conversioni per clic).
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR L'obiettivo di rendimento è impostato in percentuale del tasso di conversione delle impressioni (conversioni per impressione).
PERFORMANCE_GOAL_TYPE_VCPM L'obiettivo di rendimento è impostato in VCPM (costo per mille impressioni visibili).
PERFORMANCE_GOAL_TYPE_VTR L'obiettivo di rendimento è impostato in percentuale di visualizzazione di YouTube (visualizzazioni di YouTube per impressione).
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE L'obiettivo di rendimento è impostato in percentuale di completamento audio (ascolti audio completi per impressione).
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE L'obiettivo di rendimento è impostato in percentuale di tasso di completamento video (visualizzazioni di video completate per impressione).
PERFORMANCE_GOAL_TYPE_OTHER L'obiettivo di rendimento è impostato su Altro.

CampaignFlight

Impostazioni che monitorano la spesa e la durata pianificate di una campagna.

Rappresentazione JSON 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
Campi
plannedSpendAmountMicros

string (int64 format)

L'importo che si prevede di spendere per la campagna per il plannedDates specificato. Questa spesa non limiterà la pubblicazione, ma verrà utilizzata per monitorare la spesa nell'interfaccia utente di DV360.

L'importo è in micro. Deve essere maggiore o uguale a 0. Ad esempio, 500000000 rappresenta 500 unità standard della valuta.
plannedDates

object (DateRange)

Obbligatorio. Le date previste per la pubblicazione della campagna. Vengono risolti in relazione al fuso orario dell'inserzionista principale.

  • Le date specificate qui non influiranno sulla pubblicazione. Vengono utilizzati per generare avvisi. Ad esempio, se la data di pubblicazione di un ordine di inserimento secondario non rientra nell'intervallo di queste date, l'interfaccia utente mostrerà un avviso.
  • startDate è obbligatorio e deve corrispondere alla data corrente o a una data successiva.
  • endDate è facoltativo. Se specificato, deve essere startDate o una data successiva.
  • Qualsiasi data specificata deve essere precedente all'anno 2037.

CampaignBudget

Impostazioni che controllano la modalità di allocazione del budget della campagna.

Rappresentazione JSON 
{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
Campi
budgetId

string (int64 format)

L'ID univoco del budget della campagna. Assegnato dal sistema. Non impostare per i nuovi budget.

Deve essere incluso quando aggiorni o aggiungi budget a campaignBudgets. In caso contrario, verrà generato e assegnato un nuovo ID.
displayName

string

Obbligatorio. Il nome visualizzato del budget.

Deve essere codificata in UTF-8 con una dimensione massima di 240 byte.
budgetUnit

enum (BudgetUnit)

Obbligatorio. Immutabile. Specifica se il budget è misurato in valuta o impressioni.
budgetAmountMicros

string (int64 format)

Obbligatorio. L'importo totale che i segmenti dell'ordine di inserzione collegato possono budgetare.

L'importo è in micro. Deve essere maggiore di 0. Ad esempio, 500000000 rappresenta 500 unità standard della valuta.
dateRange

object (DateRange)

Obbligatorio. L'intervallo di date per il budget della campagna. I segmenti di budget collegati potrebbero avere un intervallo di date diverso. Vengono risolti in relazione al fuso orario dell'inserzionista principale.

Sia startDate che endDate devono essere precedenti all'anno 2037.
externalBudgetSource

enum (ExternalBudgetSource)

Obbligatorio. L'origine esterna del budget.
externalBudgetId

string

Immutabile. L'ID che identifica questo budget per l'origine esterna.

Se questo campo è impostato e il livello di dettaglio della fattura del profilo di fatturazione corrispondente è impostato su "Ordine di acquisto a livello di budget", tutte le impressioni pubblicate in base a questo budget includeranno questo ID nella fattura.

Deve essere univoco nella campagna.
invoiceGroupingId

string

Immutabile. L'ID utilizzato per raggruppare i budget da includere nella stessa fattura.

Se questo campo è impostato e il livello fattura del profilo di fatturazione corrispondente è impostato su "ID di raggruppamento delle fatture del budget", tutti gli externalBudgetId che condividono lo stesso invoiceGroupingId verranno raggruppati nella stessa fattura.
prismaConfig

object (PrismaConfig)

Metadati aggiuntivi da utilizzare con lo strumento Mediaocean Prisma.

Obbligatorio per i budget Mediaocean.

Valido solo per gli inserzionisti prismaEnabled.

ExternalBudgetSource

Origine esterna per un segmento di budget della campagna.

Enum
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED Il valore dell'origine budget esterna non è specificato o è sconosciuto in questa versione.
EXTERNAL_BUDGET_SOURCE_NONE Il budget non ha un'origine esterna.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN L'origine del budget è Mediaocean.

PrismaConfig

Impostazioni specifiche dello strumento Mediaocean Prisma.

Rappresentazione JSON 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
Campi
prismaType

enum (PrismaType)

Obbligatorio. Il tipo di Prisma.
prismaCpeCode

object (PrismaCpeCode)

Obbligatorio. Codici cliente, prodotto e stima pertinenti dello strumento Mediaocean Prisma.
supplier

string

Obbligatorio. L'entità che ha allocato questo budget (DSP, sito e così via).

PrismaType

Possibili tipi di budget Prisma.

Enum
PRISMA_TYPE_UNSPECIFIED Il tipo non è specificato o sconosciuto in questa versione.
PRISMA_TYPE_DISPLAY Tipo di display.
PRISMA_TYPE_VIDEO Tipo di video.
PRISMA_TYPE_AUDIO Tipo di audio.
PRISMA_TYPE_SOCIAL Tipo social.
PRISMA_TYPE_FEE Tipo di tariffa.

PrismaCpeCode

Il Centro pagamenti Google supporta la ricerca e il filtro nei campi dei componenti di questo codice.

Rappresentazione JSON 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
Campi
prismaClientCode

string

Il codice cliente Prisma.
prismaProductCode

string

Il codice prodotto Prisma.
prismaEstimateCode

string

Il codice stima Prisma.

Metodi

create

 Crea una nuova campagna.

delete

 Elimina definitivamente una campagna.

get

 Recupera una campagna.

list

 Elenca le campagne di un inserzionista.

listAssignedTargetingOptions

 Elenca le opzioni di targeting assegnate di una campagna in tutti i tipi di targeting.

patch

 Aggiorna una campagna esistente.