REST Resource: advertisers.campaigns

Risorsa: Campagna

Una sola 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. Consente di stabilire se gli ordini di inserzione in 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. Il timestamp dell'ultimo aggiornamento della campagna. Assegnato dal sistema.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
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 viene 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 accettati 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 Aumenta le installazioni di app o il coinvolgimento.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Aumenta la notorietà di un brand o di un prodotto.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Incentiva le vendite offline o in negozio.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Incentiva le azioni o le visite online.

CampaignFlight

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

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

string (int64 format)

L'importo che la campagna dovrebbe spendere per il relativo plannedDates. Ciò non limiterà la pubblicazione, ma verrà utilizzato 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 di pubblicazione previste della campagna. Vengono risolti in base al fuso orario dell'inserzionista principale.

  • Le date specificate qui non influiranno sulla pubblicazione. Vengono utilizzate per generare avvisi e avvisi. Ad esempio, se il periodo di pubblicazione di un ordine di inserzione secondario è al di fuori dell'intervallo di queste date, l'interfaccia utente mostrerà un avviso.
  • startDate è obbligatorio e deve essere la data corrente o una successiva.
  • Il campo endDate è facoltativo. Se specificato, deve essere startDate o versioni successive.
  • 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 nuovi budget.

Deve essere inclusa durante l'aggiornamento o l'aggiunta di 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 degli ordini di inserzione collegati possono impostare come budget.

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 base al fuso orario dell'inserzionista principale.

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

enum (ExternalBudgetSource)

Obbligatorio. La sorgente esterna del budget.
externalBudgetId

string

Immutabile. L'ID che identifica il budget per la sorgente 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 all'interno della campagna.
invoiceGroupingId

string

Immutabile. L'ID utilizzato per raggruppare i budget in modo da includere la stessa fattura.

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

object (PrismaConfig)

Metadati aggiuntivi per l'utilizzo da parte dello strumento Mediaocean Prisma.

Obbligatorio per i budget Mediaocei.

Valido solo per prismaEnabled inserzionisti.

ExternalBudgetSource

Sorgente 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 Prisma.
prismaCpeCode

object (PrismaCpeCode)

Obbligatorio. Codici pertinenti di clienti, prodotti e stime dallo strumento Mediaocean Prisma.
supplier

string

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

PrismaType

Tipi possibili di budget Prisma.

Enum
PRISMA_TYPE_UNSPECIFIED Il tipo non è specificato o sconosciuto in questa versione.
PRISMA_TYPE_DISPLAY Tipo di visualizzazione.
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 l'applicazione di filtri nei campi dei componenti di questo codice.

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

string

Il codice client Prisma.
prismaProductCode

string

Il codice prodotto Prisma.
prismaEstimateCode

string

Il codice di stima Prisma.

Metodi

bulkListCampaignAssignedTargetingOptions

 Elenca le opzioni di targeting assegnate di una campagna nei vari tipi di targeting.

create

 Crea una nuova campagna.

delete

 Elimina definitivamente una campagna.

get

 Ottiene una campagna.

list

 Elenca le campagne di un inserzionista.

patch

 Consente di aggiornare una campagna esistente.