REST Resource: advertisers.campaigns

{
  "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)
    }
  ]
}

string

Solo salida. Es el nombre del recurso de la campaña.

string (int64 format)

Solo salida. Es el ID único del anunciante al que pertenece la campaña.

string (int64 format)

Solo salida. El ID único de la campaña. El sistema lo asigna.

string

Obligatorio. El nombre visible de la campaña.

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

enum (EntityStatus)

Obligatorio. Controla si los pedidos de inserción de esta campaña pueden invertir sus presupuestos y ofertar por 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.

string (Timestamp format)

Solo salida. Es 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".

object (CampaignGoal)

Obligatorio. Es el objetivo de la campaña.

object (CampaignFlight)

Obligatorio. La inversión planificada y la duración de la campaña.

object (FrequencyCap)

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

object (CampaignBudget)

La lista de presupuestos disponibles para esta campaña.

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

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

enum (CampaignGoalType)

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

object (PerformanceGoal)

Obligatorio. Es 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

{
  "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.
}

enum (PerformanceGoalType)

Obligatorio. Es el tipo de objetivo de rendimiento.

string (int64 format)

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

Se aplica cuando el valor de 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.

string (int64 format)

Es la representación decimal del porcentaje del objetivo en micros.

Se aplica cuando el valor de 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, 70000 representa el 7% (decimal 0.07).

string

Es una cadena de indicador clave de rendimiento (KPI) que puede estar vacía. Debe estar codificado en UTF-8 y tener una longitud de no más de 100 caracteres.

Se aplica cuando performanceGoalType se establece como PERFORMANCE_GOAL_TYPE_OTHER.

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

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.

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

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 vuelo de cualquier 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.

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

string (int64 format)

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

Se debe incluir cuando se actualizan o agregan presupuestos a campaignBudgets. De lo contrario, se generará y asignará un ID nuevo.

string

Obligatorio. Es el nombre visible del presupuesto.

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

enum (BudgetUnit)

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

string (int64 format)

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

El importe se expresa en micros. Debe ser mayor que 0. Por ejemplo, 5,000,000,000 representa 500 unidades estándar de moneda.

object (DateRange)

Obligatorio. Es el período del presupuesto de la campaña. Es posible que los segmentos de presupuesto vinculados tengan 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.

enum (ExternalBudgetSource)

Obligatorio. Es la fuente externa del presupuesto.

string

Inmutable. Es el ID que identifica este presupuesto para 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 "Orden de compra a nivel del presupuesto", todas las impresiones publicadas en función de este presupuesto incluirán este ID en la factura.

Debe ser único en la campaña.

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 facturación del perfil de facturación correspondiente se establece en "ID de agrupación de facturas del presupuesto", todas las externalBudgetId que compartan el mismo invoiceGroupingId se agruparán en la misma factura.

object (PrismaConfig)

Metadatos adicionales que puede usar la herramienta Mediaocean Prisma.

Obligatorio para los presupuestos de Mediaocean.

Solo se aplica a prismaEnabled anunciantes.

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

enum (PrismaType)

Obligatorio. Es el tipo de configuración de Prisma.

object (PrismaCpeCode)

Obligatorio. Códigos de cliente, producto y estimación relevantes de la herramienta Mediaocean Prisma.

string

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

{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}

string

El código de cliente de Prisma.

string

Es el código de producto de Prisma.

string

El código de estimación de Prisma.