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. Es el ID único del anunciante al que pertenece la campaña.
campaignId

string (int64 format)

Solo salida. El ID único de la campaña. Asignada por 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.

  • Los valores aceptados son 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. Asignada por el sistema.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una 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. Es 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 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 de 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

Posibles tipos de objetivos de la campaña.

Enumeraciones
CAMPAIGN_GOAL_TYPE_UNSPECIFIED El valor del objetivo no se especificó o se desconoce en esta versión.
CAMPAIGN_GOAL_TYPE_APP_INSTALL Generar instalaciones de la app o participación en ella
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Aumentar el reconocimiento de una marca o de un producto.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Genera ventas tradicionales o en la tienda.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Generar acciones o visitas en línea

PerformanceGoal

Es la configuración que controla el objetivo de rendimiento de una campaña.

Representación 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.
}
Campos
performanceGoalType

enum (PerformanceGoalType)

Obligatorio. Es el tipo de objetivo de rendimiento.
Campo de unión performance_goal_value. Obligatorio. Es el valor del objetivo de rendimiento correspondiente a un performance_goal_type determinado. performance_goal_value puede ser solo uno de los siguientes:
performanceGoalAmountMicros

string (int64 format)

Es el importe del objetivo, expresado en micrones de la moneda del anunciante.

Se aplica cuando performanceGoalType es uno de los siguientes:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

Por ejemplo, 1500000 representa 1.5 unidades estándar de la moneda.
performanceGoalPercentageMicros

string (int64 format)

Representación decimal del porcentaje objetivo en micros.

Se aplica cuando performanceGoalType es uno de los siguientes:

  • 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

Por ejemplo, 70,000 representa el 7% (0.07 decimal).
performanceGoalString

string

Una cadena de indicador clave de rendimiento (KPI), que puede estar vacía. Debe estar codificado en UTF-8 y con una longitud máxima de 100 caracteres.

Se aplica cuando performanceGoalType se configura como PERFORMANCE_GOAL_TYPE_OTHER.

PerformanceGoalType

Posibles tipos de objetivos de rendimiento.

Enumeraciones
PERFORMANCE_GOAL_TYPE_UNSPECIFIED No se especifica el tipo de objetivo de rendimiento en esta versión o se desconoce.
PERFORMANCE_GOAL_TYPE_CPM El objetivo de rendimiento se establece en CPM (costo por mil).
PERFORMANCE_GOAL_TYPE_CPC El objetivo de rendimiento se establece en CPC (costo por clic).
PERFORMANCE_GOAL_TYPE_CPA El objetivo de rendimiento se establece en CPA (costo por acción).
PERFORMANCE_GOAL_TYPE_CTR El objetivo de rendimiento se establece en el porcentaje de CTR (tasa de clics).
PERFORMANCE_GOAL_TYPE_VIEWABILITY El objetivo de rendimiento se establece en el porcentaje de visibilidad.
PERFORMANCE_GOAL_TYPE_CPIAVC El objetivo de rendimiento se establece como CPIAVC (costo por impresión audible y visible al finalizar).
PERFORMANCE_GOAL_TYPE_CPE El objetivo de rendimiento se establece en CPE (costo por participación).
PERFORMANCE_GOAL_TYPE_CLICK_CVR El objetivo de rendimiento se establece en el porcentaje de porcentaje de conversiones por clic (conversiones por clic).
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR El objetivo de rendimiento se establece en el porcentaje de porcentaje de conversiones de impresiones (conversiones por impresión).
PERFORMANCE_GOAL_TYPE_VCPM El objetivo de rendimiento se establece en VCPM (costo por cada mil impresiones visibles).
PERFORMANCE_GOAL_TYPE_VTR El objetivo de rendimiento se establece en el porcentaje de tasa de vistas de YouTube (vistas de YouTube por impresión).
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE El objetivo de rendimiento se establece en el porcentaje de tasa de finalización de audio (reproducciones de audio completas por impresión).
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE El objetivo de rendimiento se establece en el porcentaje de tasa de finalización de video (vistas de video completas por impresión).
PERFORMANCE_GOAL_TYPE_OTHER El objetivo de rendimiento se estableció en Otro.

CampaignFlight

Es una configuración que hace 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 invierta la campaña 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.

La cantidad es en micros. Debe ser mayor o igual que 0. Por ejemplo, 5,000,000,000 representa 500 unidades estándar de moneda.
plannedDates

object (DateRange)

Obligatorio. Son las fechas en las que se espera que se publique la campaña. Se resuelven según 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 cualquier pedido de inserción de niños está fuera del intervalo 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 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. Asignada por el sistema. No la establezcas para los presupuestos nuevos.

Se debe incluir cuando se actualizan o agregan presupuestos a campaignBudgets. De lo contrario, se generará y 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.

La cantidad es en micros. Debe ser mayor que 0. Por ejemplo, 5,000,000,000 representa 500 unidades estándar de moneda.
dateRange

object (DateRange)

Obligatorio. El período del presupuesto de la campaña. Los segmentos de presupuesto vinculados pueden tener un período diferente. Se resuelven según la zona horaria del anunciante principal.

Tanto startDate como 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 en la fuente externa.

Si se establece 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 para este presupuesto incluirán este ID en la factura.

Debe ser único en la campaña.
invoiceGroupingId

string

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

Si se establece este campo y el nivel de factura del perfil de facturación correspondiente se establece en "ID de agrupación de facturas del presupuesto", todos los externalBudgetId que compartan el mismo 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 un segmento del presupuesto de una campaña.

Enumeraciones
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED El valor de la fuente del presupuesto externo no se especifica o no se conoce 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

La 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 de cliente, producto y estimación relevantes de la herramienta Mediaocean Prisma.
supplier

string

Obligatorio. La entidad asignó este presupuesto (DSP, sitio, etcétera).

PrismaType

Posibles tipos para un presupuesto de Prisma.

Enumeraciones
PRISMA_TYPE_UNSPECIFIED No se especificó el tipo en esta versión o se desconoce.
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 los 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

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

 Borra una campaña de forma permanente.

get

 Obtiene una campaña.

list

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

listAssignedTargetingOptions

 Se muestran las opciones de segmentación asignadas de una campaña en todos los tipos de segmentación.

patch

 Actualiza una campaña existente.