REST Resource: curators.reports

Recurso: Informe

Es el recurso Report.

Representación JSON
{
  "name": string,
  "reportId": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "displayName": string,
  "updateTime": string,
  "createTime": string,
  "locale": string
}
Campos
name

string

Es el identificador. Es el nombre del recurso del informe. El nombre del recurso del informe tiene el siguiente formato: curators/{accountId}/reports/{reportId}

reportId

string (int64 format)

Solo salida. Es el ID del informe.

reportDefinition

object (ReportDefinition)

Obligatorio. Es la definición del informe.

displayName

string

Opcional. Es el nombre visible del informe.

updateTime

string (Timestamp format)

Solo salida. Es el momento en que se modificó este informe por última vez.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

createTime

string (Timestamp format)

Solo salida. Es el momento en que se creó este informe.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

locale

string

Solo salida. Es la configuración regional de este informe. La configuración regional se establece a partir de la configuración regional del usuario en el momento de la solicitud. No se puede modificar la configuración regional.

ReportDefinition

Es la definición de cómo se debe ejecutar un informe.

Representación JSON
{
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "filters": [
    {
      object (Filter)
    }
  ],
  "timeZoneSource": enum (TimeZoneSource),
  "timeZone": string,
  "currencyCode": string,
  "dateRange": {
    object (DateRange)
  },
  "sorts": [
    {
      object (Sort)
    }
  ]
}
Campos
dimensions[]

enum (Dimension)

Obligatorio. Es la lista de dimensiones sobre las que se generarán informes. Si está vacío, el informe no tendrá dimensiones y las métricas serán totales.

metrics[]

enum (Metric)

Obligatorio. Es la lista de métricas sobre las que se generarán informes. Si está vacío, el informe no tendrá métricas.

filters[]

object (Filter)

Opcional. Son los filtros de este informe.

timeZoneSource

enum (TimeZoneSource)

Opcional. Dónde obtener la zona horaria de este informe. De forma predeterminada, se usa la zona horaria del Pacífico (PT). Si la fuente es PROVIDED, el campo timeZone en la definición del informe también debe establecer una zona horaria.

timeZone

string

Opcional. Si timeZoneSource es PROVIDED, esta es la zona horaria que se usará para este informe. Déjalo vacío para cualquier otra fuente de zona horaria. Es la zona horaria en formato de IANA. Por ejemplo, "America/New_York".

currencyCode

string

Opcional. Es el código de moneda ISO 4217 para este informe. Si no se especifica, se usa el código de moneda de la cuenta de forma predeterminada.

dateRange

object (DateRange)

Obligatorio. Es el período principal de este informe.

sorts[]

object (Sort)

Opcional. Son los ordenamientos predeterminados que se aplicarán a este informe.

Dimensión

Dimensiones de los informes

Enums
DIMENSION_UNSPECIFIED Valor predeterminado Este valor no se usa.
ADVERTISER_DOMAIN Es el dominio del anunciante.
COUNTRY Es el nombre visible de un país.
CURATION_DATA_SEGMENT_ID Es el ID del segmento de datos que creó un administrador.
CURATION_DATA_SEGMENT_RESPONSE_STATUS Es el estado de respuesta de las solicitudes de segmentos de datos en la selección en tiempo real. Consulta https://developers.google.com/authorized-buyers/curation/get-started/start para obtener más detalles.
CURATION_DATA_SEGMENT_RESPONSE_STATUS_NAME Es el nombre visible localizado del estado de respuesta de las solicitudes de segmentos de datos en la selección en tiempo real. Consulta https://developers.google.com/authorized-buyers/curation/get-started/start para obtener más detalles.
CURATOR_FEE_TYPE Es el tipo de servicio de selección (p.ej., empaquetado o segmento de datos).
DATE Fecha.
DEAL_ID ID del acuerdo
DEAL_NAME Nombre del acuerdo.
DETECTED_ADVERTISER_NAME Es el nombre visible del anunciante detectado.
DSP_NAME Es el nombre visible de la DSP.
DSP_SEAT_ID Es el ID de la licencia de DSP.
ENVIRONMENT Es el entorno del dispositivo y del contenedor del usuario donde se origina la impresión. Los valores admitidos son "app" y "web".
ENVIRONMENT_NAME Es el nombre visible localizado del dispositivo del usuario y el entorno del contenedor donde se origina la impresión. Los valores admitidos son "app" y "web".
HOLDING_COMPANY_NAME Es el nombre visible de la sociedad de cartera.
HOUR Hora.
MOBILE_APP_ID ID de la aplicación para dispositivos móviles
MOBILE_APP_NAME Nombre de la app para dispositivos móviles
MOBILE_OS Sistema operativo para dispositivos móviles
MONTH Mes.
PACKAGE_FEE_VISIBILITY La visibilidad de la tarifa del paquete (p.ej., divulgada o no divulgada).
PLATFORM Plataforma, p. ej., "computadora de escritorio" en comparación con "dispositivo móvil"
PUBLISHER_DOMAIN Es el dominio del publicador.
PUBLISHER_ID Es el identificador del publicador.
PUBLISHER_NAME Es el nombre del publicador.
WEEK Semana.

Métrica

Métricas de informes

Enums
METRIC_UNSPECIFIED Valor predeterminado Este valor no se usa.
ACTIVE_VIEW_MEASURABILITY_RATE Porcentaje de visibilidad de Vista activa medible.
ACTIVE_VIEW_MEASURABLE Vista activa medible
ACTIVE_VIEW_VIEWABILITY_RATE Es el porcentaje de visibilidad de Vista activa.
ACTIVE_VIEW_VIEWABLE Impresiones visibles de Vista activa
AUCTIONS_WON Subastas ganadas.
BIDS Ofertas.
BIDS_IN_AUCTION Ofertas en subasta
BID_REQUESTS Solicitudes de oferta
CLICKS Clics
CURATION_PARTNER_FEE Tarifa del selector. Este valor se ocultará y se mostrará como 0.00 si la visibilidad del paquete se establece como no divulgada. Usa la dimensión PACKAGE_FEE_VISIBILITY para verificar si se divulga la tarifa del paquete.
DATA_SEGMENT_REQUESTS Es la cantidad de solicitudes de segmentos de datos enviadas en la selección de contenido en tiempo real.
IMPRESSIONS Impresiones
SPEND Es la inversión en la moneda del informe especificada en la solicitud. La configuración predeterminada es USD.

Filtro

Un filtro sobre uno o más campos.

Representación JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fieldFilter": {
    object (FieldFilter)
  },
  "notFilter": {
    object (Filter)
  },
  "andFilter": {
    object (FilterList)
  },
  "orFilter": {
    object (FilterList)
  }
  // End of mutually exclusive fields.
}
Campos
El tipo determina cómo se combinan los filtros subyacentes. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
fieldFilter

object (FieldFilter)

Un filtro en un solo campo.

notFilter

object (Filter)

Es un filtro cuyo resultado se niega.

andFilter

object (FilterList)

Es una lista de filtros cuyos resultados se combinan con AND.

orFilter

object (FilterList)

Es una lista de filtros cuyos resultados se combinan con OR.

Fin de los campos mutuamente excluyentes.

FieldFilter

Un filtro en un campo específico.

Representación JSON
{
  "field": {
    object (Field)
  },
  "operation": enum (Operation),
  "values": [
    {
      object (ReportValue)
    }
  ]
}
Campos
field

object (Field)

Obligatorio. Es el campo por el que se filtrará.

operation

enum (Operation)

Obligatorio. La operación de este filtro.

values[]

object (ReportValue)

Obligatorio. Son los valores por los que se filtrará.

Campo

Una dimensión o una métrica en un informe.

Representación JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of mutually exclusive fields.
}
Campos
Una dimensión o una métrica La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
dimension

enum (Dimension)

Es la dimensión que representa este campo.

metric

enum (Metric)

Es la métrica que representa este campo.

Fin de los campos mutuamente excluyentes.

Operación

Operaciones de filtro admitidas.

Enums
IN

Para los operandos escalares, verifica si el operando está en el conjunto de valores de filtro proporcionados.

En el caso de los operandos de lista, verifica si algún elemento del operando se encuentra en el conjunto de valores de filtro proporcionados.

Valor predeterminado

NOT_IN

En el caso de los operandos escalares, verifica que el operando no esté en el conjunto de valores de filtro proporcionados.

En el caso de los operandos de lista, verifica que ninguno de los elementos del operando esté en el conjunto de valores de filtro proporcionados.

CONTAINS

En el caso de los operandos de cadena escalar, verifica si el operando contiene alguna de las substrings de filtro proporcionadas.

En el caso de los operandos de lista de cadenas, comprueba si alguna cadena del operando contiene alguna de las subcadenas de filtro proporcionadas.

NOT_CONTAINS

En el caso de los operandos de cadena escalar, verifica que el operando no contenga ninguna de las subcadenas de filtro proporcionadas.

Para los operandos de lista de cadenas, verifica que ninguna de las cadenas del operando contenga ninguna de las subcadenas de filtro proporcionadas.

LESS_THAN El operando es menor que el valor de filtro proporcionado.
LESS_THAN_EQUALS El operando es menor o igual que el valor de filtro proporcionado.
GREATER_THAN El operando es mayor que el valor de filtro proporcionado.
GREATER_THAN_EQUALS El operando es mayor o igual que el valor de filtro proporcionado.
BETWEEN El operando se encuentra entre los valores de filtro proporcionados.
MATCHES El operando coincide con una expresión regular o un conjunto de expresiones regulares (una debe coincidir).
NOT_MATCHES El operando coincide de forma negativa con una expresión regular o un conjunto de expresiones regulares (ninguna debe coincidir).

ReportValue

Representa un solo valor en un informe.

Representación JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "intValue": string,
  "doubleValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "intListValue": {
    object (IntList)
  },
  "stringListValue": {
    object (StringList)
  },
  "doubleListValue": {
    object (DoubleList)
  },
  "bytesValue": string
  // End of mutually exclusive fields.
}
Campos
El valor del campo depende del formato de datos del campo. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
intValue

string (int64 format)

Para valores enteros.

doubleValue

number

Para valores dobles.

stringValue

string

Para los valores de cadena.

boolValue

boolean

Para valores booleanos.

intListValue

object (IntList)

Para listas de valores enteros.

stringListValue

object (StringList)

Para listas de valores de cadena.

doubleListValue

object (DoubleList)

Para listas de valores dobles.

bytesValue

string (bytes format)

Para los valores de bytes.

String codificada en base64.

Fin de los campos mutuamente excluyentes.

IntList

Es una lista de valores enteros.

Representación JSON
{
  "values": [
    string
  ]
}
Campos
values[]

string (int64 format)

Los valores

StringList

Es una lista de valores de cadena.

Representación JSON
{
  "values": [
    string
  ]
}
Campos
values[]

string

Los valores

DoubleList

Es una lista de valores dobles.

Representación JSON
{
  "values": [
    number
  ]
}
Campos
values[]

number

Los valores

FilterList

Es una lista de filtros.

Representación JSON
{
  "filters": [
    {
      object (Filter)
    }
  ]
}
Campos
filters[]

object (Filter)

Obligatorio. Es una lista de filtros.

TimeZoneSource

Es la fuente que determina la zona horaria del informe.

Enums
TIME_ZONE_SOURCE_UNSPECIFIED Es el valor predeterminado no especificado.
AD_EXCHANGE Usa la zona horaria del Pacífico(PT).
UTC Usa la zona horaria UTC.
PROVIDED Usa la zona horaria que se proporciona en el campo ReportDefinition.time_zone. Es posible que los informes tarden más en ejecutarse, ya que las fechas se calculan de forma dinámica en el momento de la solicitud.
CURATOR Usa la zona horaria de la configuración de la cuenta del curador.

DateRange

Es un período para un informe.

Representación JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fixed": {
    object (FixedDateRange)
  },
  "relative": enum (RelativeDateRange)
  // End of mutually exclusive fields.
}
Campos
Un período fijo o relativo. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
fixed

object (FixedDateRange)

Un período fijo

relative

enum (RelativeDateRange)

Un período relativo

Fin de los campos mutuamente excluyentes.

FixedDateRange

Un período entre dos fechas fijas (incluida la fecha de finalización).

Representación JSON
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Campos
startDate

object (Date)

Obligatorio. Es la fecha de inicio de este período.

endDate

object (Date)

Obligatorio. Es la fecha de finalización (incluida) de este período.

Fecha

Representa una fecha de calendario completa o parcial, como un cumpleaños. La hora del día y la zona horaria se especifican en otro lugar o son insignificantes. La fecha está relacionada con el calendario gregoriano. Puede representar una de las siguientes opciones:

  • Una fecha completa con valores para el año, mes y día que no sean cero.
  • Un mes y un día, con cero año (por ejemplo, un aniversario).
  • Un año por sí solo, con un mes cero y un día cero.
  • Es un año y un mes, con un día cero (por ejemplo, la fecha de vencimiento de una tarjeta de crédito).

Tipos relacionados:

Representación JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Año de la fecha. Debe ser entre 1 y 9,999, o bien 0 para especificar una fecha sin año.

month

integer

Mes del año. Debe ser del 1 al 12 o 0 para especificar un año sin un mes ni un día.

day

integer

Día del mes. Debe ser entre 1 y 31 y ser válido para el año y el mes o bien 0 para especificar un año solo o un año y un mes en los que el día no sea significativo.

RelativeDateRange

Son opciones para los períodos relativos.

Enums
RELATIVE_DATE_RANGE_UNSPECIFIED Valor predeterminado Este valor no se usa.
TODAY Es la fecha en que se ejecuta el informe.
YESTERDAY La fecha un día antes de la fecha en que se ejecuta el informe.
THIS_WEEK_TO_DATE Desde el comienzo de la semana del calendario en la que se ejecuta el informe hasta el día en que se ejecuta, inclusive.
THIS_WEEK_TO_YESTERDAY Desde el comienzo de la semana calendario en la que se ejecuta el informe hasta el día anterior a la ejecución del informe, inclusive.
THIS_MONTH_TO_DATE Desde el comienzo del mes calendario en el que se ejecuta el informe hasta el día en que se ejecuta, inclusive.
THIS_MONTH_TO_YESTERDAY Desde el comienzo del mes calendario en el que se ejecuta el informe hasta el día anterior a la ejecución del informe, inclusive.
THIS_QUARTER_TO_DATE Desde el comienzo del trimestre calendario en el que se ejecuta el informe hasta el día en que se ejecuta, inclusive.
THIS_QUARTER_TO_YESTERDAY Desde el comienzo del trimestre calendario en el que se ejecuta el informe hasta el día anterior a la ejecución del informe, inclusive.
THIS_YEAR_TO_DATE Desde el comienzo del año calendario en el que se ejecuta el informe hasta el día en que se ejecuta el informe, inclusive.
THIS_YEAR_TO_YESTERDAY Desde el comienzo del año calendario en el que se ejecuta el informe hasta el día anterior a la ejecución del informe, inclusive.
LAST_WEEK Toda la semana calendario anterior, de lunes a domingo (inclusive), que precede a la semana calendario en la que se ejecuta el informe.
LAST_WEEK_STARTING_SUNDAY Toda la semana calendario anterior, de domingo a sábado (inclusive), que precede a la semana calendario en la que se ejecuta el informe.
LAST_MONTH Todo el mes calendario anterior al mes calendario en el que se ejecuta el informe.
LAST_QUARTER Todo el trimestre calendario anterior al trimestre calendario en el que se ejecuta el informe.
LAST_YEAR Todo el año calendario anterior al año calendario en el que se ejecuta el informe.
LAST_7_DAYS Los 7 días anteriores al día en que se ejecuta el informe.
LAST_30_DAYS Los 30 días anteriores al día en que se ejecuta el informe
LAST_60_DAYS Los 60 días anteriores al día en que se ejecuta el informe
LAST_90_DAYS Los 90 días anteriores al día en que se ejecuta el informe.
LAST_93_DAYS Los 93 días anteriores al día en que se ejecuta el informe.
LAST_180_DAYS Los 180 días anteriores al día en que se ejecuta el informe
LAST_360_DAYS Los 360 días anteriores al día en que se ejecuta el informe.
LAST_365_DAYS Los 365 días anteriores al día en que se ejecuta el informe
LAST_3_MONTHS Los 3 meses calendario completos anteriores al mes calendario en el que se ejecuta el informe
LAST_6_MONTHS Los 6 meses calendario completos anteriores al mes calendario en el que se ejecuta el informe.
LAST_12_MONTHS Los 12 meses calendario anteriores al mes calendario en el que se ejecuta el informe.
ALL_AVAILABLE Desde 3 años antes de que se ejecute el informe hasta el día anterior a la ejecución del informe, inclusive.

Ordenar

Representa un orden en un informe.

Representación JSON
{
  "field": {
    object (Field)
  },
  "descending": boolean
}
Campos
field

object (Field)

Obligatorio. Es un campo (dimensión o métrica) por el que se ordenarán los datos.

descending

boolean

Opcional. Es el orden de clasificación. Si es verdadero, el orden será descendente.

Métodos

create

Crea un objeto Report.

delete

Borra un objeto Report.

get

Recupera un objeto Report.

list

Enumera objetos Report.

patch

Actualiza un objeto Report.

run

Inicia la ejecución de un informe existente de forma asíncrona.