REST Resource: advertisers.campaigns

Recurso: Campaign

Una sola campaña

Representación 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)
    }
  ]
}
Campos
name

string

Solo salida. El nombre del recurso de la campaña.
advertiserId

string (int64 format)

Solo salida. El ID único del anunciante al que pertenece la campaña
campaignId

string (int64 format)

Solo salida. El ID único de la campaña. Lo asigna el sistema.
displayName

string

Obligatorio. El nombre visible de la campaña.

Debe estar codificado en UTF-8, con un tamaño máximo de 240 bytes.
entityStatus

enum (EntityStatus)

Obligatorio. Controla si los pedidos de inserción de esta campaña pueden invertir sus presupuestos y ofertar en el inventario.

  • Se aceptan los valores ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED y ENTITY_STATUS_PAUSED.
  • Para el método campaigns.create, no se permite ENTITY_STATUS_ARCHIVED.
updateTime

string (Timestamp format)

Solo salida. La marca de tiempo de la última actualización de la campaña. Lo asigna el sistema.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
campaignGoal

object (CampaignGoal)

Obligatorio. El objetivo de la campaña.
campaignFlight

object (CampaignFlight)

Obligatorio. Es la inversión y la duración planificadas de la campaña.
frequencyCap

object (FrequencyCap)

Obligatorio. La configuración de limitación de frecuencia de la campaña.
campaignBudgets[]

object (CampaignBudget)

Es la lista de presupuestos disponibles para esta campaña.

Si no se establece este campo, la campaña utiliza un presupuesto ilimitado.

CampaignGoal

Son los parámetros de configuración que controlan el objetivo de una campaña.

Representación JSON 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
Campos
campaignGoalType

enum (CampaignGoalType)

Obligatorio. El tipo del objetivo de la campaña.
performanceGoal

object (PerformanceGoal)

Obligatorio. El objetivo de rendimiento de la campaña.

Los valores aceptables para performanceGoalType son los siguientes:

  • 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

Tipos de objetivos de campaña posibles.

Enumeradores
CAMPAIGN_GOAL_TYPE_UNSPECIFIED El valor del objetivo no se especifica o se desconoce en esta versión.
CAMPAIGN_GOAL_TYPE_APP_INSTALL Generar instalaciones de la aplicación o participaciones en ella
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Aumentar el reconocimiento de una marca o producto.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Generar ventas tradicionales o en la tienda
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Generar acciones o visitas en línea

CampaignFlight

Son parámetros de configuración que hacen un seguimiento de la inversión y la duración planificadas de una campaña.

Representación JSON 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
Campos
plannedSpendAmountMicros

string (int64 format)

Es el importe que se espera que la campaña invierta para los plannedDates especificados. Esto no limitará la publicación, pero se usará para hacer un seguimiento de la inversión en la IU de DV360.

El importe está en micros. Debe ser mayor o igual que 0. Por ejemplo, 500000000 representa 500 unidades estándar de la moneda.
plannedDates

object (DateRange)

Obligatorio. Son las fechas en las que se espera que se publique la campaña. Se resuelven en función de la zona horaria del anunciante principal.

  • Las fechas que se especifiquen aquí no afectarán la publicación. Se usan para generar alertas y advertencias. Por ejemplo, si la fecha de publicación de un pedido de inserción secundario está fuera del rango de estas fechas, la interfaz de usuario mostrará una advertencia.
  • startDate es obligatorio y debe ser la fecha actual o una posterior.
  • endDate es opcional. Si se especifica, debe ser startDate o una versión posterior.
  • Cualquier fecha especificada debe ser anterior al año 2037.

CampaignBudget

Son los parámetros de configuración que controlan cómo se asigna el presupuesto de la campaña.

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

string (int64 format)

El ID único del presupuesto de la campaña. Lo asigna el sistema. No establecer para presupuestos nuevos.

Debe incluirse cuando se actualizan o se agregan presupuestos a campaignBudgets. De lo contrario, se generará y se asignará un ID nuevo.
displayName

string

Obligatorio. El nombre visible del presupuesto.

Debe estar codificado en UTF-8, con un tamaño máximo de 240 bytes.
budgetUnit

enum (BudgetUnit)

Obligatorio. Inmutable. Especifica si el presupuesto se mide en moneda o impresiones.
budgetAmountMicros

string (int64 format)

Obligatorio. Es el importe total que pueden presupuestar los segmentos de pedidos de inserción vinculados.

El importe está en micros. Debe ser mayor que 0. Por ejemplo, 500000000 representa 500 unidades estándar de la moneda.
dateRange

object (DateRange)

Obligatorio. El período para el presupuesto de la campaña. Los segmentos del presupuesto vinculados pueden tener un período diferente. Se resuelven en función de la zona horaria del anunciante principal.

startDate y endDate deben ser anteriores al año 2037.
externalBudgetSource

enum (ExternalBudgetSource)

Obligatorio. Es la fuente externa del presupuesto.
externalBudgetId

string

Inmutable. Es el ID que identifica este presupuesto ante la fuente externa.

Si se configura este campo y el nivel de detalle de la factura del perfil de facturación correspondiente se establece en "PO a nivel del presupuesto", todas las impresiones publicadas con este presupuesto incluirán este ID en la factura.

Debe ser único en la campaña.
invoiceGroupingId

string

Inmutable. Es el ID que se utiliza para agrupar los presupuestos que se incluirán en la misma factura.

Si se configura este campo y el nivel de factura del perfil de facturación correspondiente se establece en "ID de agrupación de facturas de presupuesto", todos los externalBudgetId que compartan la misma invoiceGroupingId se agruparán en la misma factura.
prismaConfig

object (PrismaConfig)

Metadatos adicionales que puede usar la herramienta Mediaocean Prisma.

Obligatorio para los presupuestos de Mediaocean.

Solo se aplica a prismaEnabled anunciantes.

ExternalBudgetSource

Fuente externa para el segmento del presupuesto de una campaña.

Enumeradores
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED El valor de la fuente del presupuesto externo no se especificó o se desconoce en esta versión.
EXTERNAL_BUDGET_SOURCE_NONE El presupuesto no tiene una fuente externa.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN La fuente del presupuesto es Mediaocean.

PrismaConfig

Configuración específica de la herramienta Mediaocean Prisma.

Representación JSON 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
Campos
prismaType

enum (PrismaType)

Obligatorio. El tipo Prisma.
prismaCpeCode

object (PrismaCpeCode)

Obligatorio. Códigos relevantes de clientes, productos y estimaciones de la herramienta Mediaocean Prisma.
supplier

string

Obligatorio. Es la entidad que asignó este presupuesto (DSP, sitio, etcétera).

PrismaType

Tipos posibles de presupuesto de Prisma.

Enumeradores
PRISMA_TYPE_UNSPECIFIED No se especificó el tipo o es desconocido en esta versión.
PRISMA_TYPE_DISPLAY Tipo de visualización.
PRISMA_TYPE_VIDEO Tipo de video.
PRISMA_TYPE_AUDIO Tipo de audio.
PRISMA_TYPE_SOCIAL Tipo de red social.
PRISMA_TYPE_FEE Tipo de tarifa.

PrismaCpeCode

El centro de pagos de Google admite la búsqueda y el filtrado en los campos de componentes de este código.

Representación JSON 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
Campos
prismaClientCode

string

El código de cliente de Prisma
prismaProductCode

string

Es el código de producto de Prisma.
prismaEstimateCode

string

El código de estimación de Prisma.

Métodos

create

 Crea una campaña nueva.

delete

 Elimina una campaña de forma permanente.

get

 Obtiene una campaña.

list

 Muestra una lista de las campañas de un anunciante.

listAssignedTargetingOptions

 Muestra una lista de las opciones de segmentación asignadas de una campaña en los distintos tipos de segmentación.

patch

 Actualiza una campaña existente.