REST Resource: curators.reports

Recurso: Report

O recurso Report.

Representação JSON
{
  "name": string,
  "reportId": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "displayName": string,
  "updateTime": string,
  "createTime": string,
  "locale": string
}
Campos
name

string

Identificador. O nome do recurso do relatório. O nome do recurso do relatório tem o formato: curators/{accountId}/reports/{reportId}

reportId

string (int64 format)

Apenas saída. ID do relatório.

reportDefinition

object (ReportDefinition)

Obrigatório. A definição do relatório.

displayName

string

Opcional. Nome de exibição do relatório.

updateTime

string (Timestamp format)

Apenas saída. O momento em que este relatório foi modificado pela última vez.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

createTime

string (Timestamp format)

Apenas saída. O momento em que o relatório foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

locale

string

Apenas saída. A localidade deste relatório. A localidade é definida com base na localidade do usuário no momento da solicitação. Não é possível modificar a localidade.

ReportDefinition

A definição de como um relatório deve ser gerado.

Representação 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)

Obrigatório. A lista de dimensões para gerar relatórios. Se estiver vazio, o relatório não terá dimensões, e as métricas serão totais.

metrics[]

enum (Metric)

Obrigatório. A lista de métricas para gerar relatórios. Se estiver vazio, o relatório não terá métricas.

filters[]

object (Filter)

Opcional. Os filtros deste relatório.

timeZoneSource

enum (TimeZoneSource)

Opcional. Onde encontrar o fuso horário deste relatório. Por padrão, usa o fuso horário do Pacífico (PT). Se a origem for PROVIDED, o campo timeZone na definição do relatório também precisará definir um fuso horário.

timeZone

string

Opcional. Se timeZoneSource for PROVIDED, este será o fuso horário usado no relatório. Deixe em branco para qualquer outra fonte de fuso horário. Fuso horário no formato IANA. Por exemplo, "America/New_York".

currencyCode

string

Opcional. O código de moeda ISO 4217 para este relatório. Se não for especificado, o padrão será o código da moeda da conta.

dateRange

object (DateRange)

Obrigatório. O período principal deste relatório.

sorts[]

object (Sort)

Opcional. Classificações padrão a serem aplicadas a este relatório.

Dimensão

Dimensões de relatórios.

Tipos enumerados
DIMENSION_UNSPECIFIED Valor padrão. Esse valor não é usado.
ADVERTISER_DOMAIN O domínio do anunciante.
COUNTRY Nome de exibição de um país.
CURATION_DATA_SEGMENT_ID É o ID do segmento de dados criado por um curador.
CURATION_DATA_SEGMENT_RESPONSE_STATUS O status de resposta das solicitações de segmento de dados na curadoria em tempo real. Consulte https://developers.google.com/authorized-buyers/curation/get-started/start para mais detalhes.
CURATION_DATA_SEGMENT_RESPONSE_STATUS_NAME O nome de exibição localizado do status de resposta das solicitações de segmento de dados na curadoria em tempo real. Consulte https://developers.google.com/authorized-buyers/curation/get-started/start para mais detalhes.
CURATOR_FEE_TYPE O tipo de serviço de curadoria (por exemplo, empacotamento ou segmento de dados).
DATE vigência.
DEAL_ID ID da transação.
DEAL_NAME Nome da transação.
DETECTED_ADVERTISER_NAME Nome de exibição do anunciante detectado.
DSP_NAME Nome de exibição da DSP.
DSP_SEAT_ID ID de vaga na DSP.
ENVIRONMENT O dispositivo do usuário e o ambiente do contêiner de origem da impressão. Os valores compatíveis são "app" e "web".
ENVIRONMENT_NAME O nome de exibição localizado do dispositivo do usuário e do ambiente do contêiner em que a impressão se origina. Os valores compatíveis são "app" e "web".
HOLDING_COMPANY_NAME Nome de exibição da holding.
HOUR Hora.
MOBILE_APP_ID ID do app para dispositivos móveis.
MOBILE_APP_NAME Nome do app para dispositivos móveis.
MOBILE_OS Sistema operacional para dispositivos móveis.
MONTH Mês.
PACKAGE_FEE_VISIBILITY A visibilidade da taxa do pacote (por exemplo, divulgada ou não divulgada).
PLATFORM Plataforma, por exemplo, "computador" x "dispositivo móvel".
PUBLISHER_DOMAIN Domínio do publisher.
PUBLISHER_ID Identificador do editor.
PUBLISHER_NAME Nome do editor.
WEEK Semana.

Métrica

Métricas de relatórios.

Tipos enumerados
METRIC_UNSPECIFIED Valor padrão. Esse valor não é usado.
ACTIVE_VIEW_MEASURABILITY_RATE Taxa de medição do Active View.
ACTIVE_VIEW_MEASURABLE Mensurável do Active View.
ACTIVE_VIEW_VIEWABILITY_RATE Taxa de visibilidade do Active View.
ACTIVE_VIEW_VIEWABLE Impr. visíveis do Active View
AUCTIONS_WON Leilões ganhos.
BIDS Lances.
BIDS_IN_AUCTION Lances no leilão.
BID_REQUESTS Solicitações de lance.
CLICKS Cliques.
CURATION_PARTNER_FEE Taxa do curador. Esse valor será ocultado como 0,00 se a visibilidade do pacote estiver definida como não divulgada. Use a dimensão PACKAGE_FEE_VISIBILITY para verificar se a taxa do pacote foi divulgada.
DATA_SEGMENT_REQUESTS Número de solicitações de segmento de dados enviadas na curadoria em tempo real.
IMPRESSIONS Impressões.
SPEND Gasto na moeda do relatório especificada na solicitação. O padrão é USD.

Filtro

Um filtro em um ou mais campos.

Representação 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
O tipo determina como os filtros subjacentes são combinados. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
fieldFilter

object (FieldFilter)

Um filtro em um único campo.

notFilter

object (Filter)

Um filtro cujo resultado é negado.

andFilter

object (FilterList)

Uma lista de filtros com resultados combinados por AND.

orFilter

object (FilterList)

Uma lista de filtros com resultados que usam o operador OR.

Fim dos campos mutuamente exclusivos.

FieldFilter

Um filtro em um campo específico.

Representação JSON
{
  "field": {
    object (Field)
  },
  "operation": enum (Operation),
  "values": [
    {
      object (ReportValue)
    }
  ]
}
Campos
field

object (Field)

Obrigatório. O campo para filtrar.

operation

enum (Operation)

Obrigatório. A operação desse filtro.

values[]

object (ReportValue)

Obrigatório. Valores para filtrar.

Campo

Uma dimensão ou métrica em um relatório.

Representação 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
Uma dimensão ou uma métrica. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
dimension

enum (Dimension)

A dimensão que esse campo representa.

metric

enum (Metric)

A métrica que esse campo representa.

Fim dos campos mutuamente exclusivos.

Operação

Operações de filtro compatíveis.

Tipos enumerados
IN

Para operandos escalares, verifica se o operando está no conjunto de valores de filtro fornecidos.

Para operandos de lista, verifica se algum elemento no operando está no conjunto de valores de filtro fornecidos.

Valor padrão.

NOT_IN

Para operandos escalares, verifica se o operando não está no conjunto de valores de filtro fornecidos.

Para operandos de lista, verifica se nenhum dos elementos no operando está no conjunto de valores de filtro fornecidos.

CONTAINS

Para operandos de string escalar, verifica se o operando contém alguma das substrings de filtro fornecidas.

Para operandos de lista de strings, verifica se alguma string no operando contém alguma das substrings de filtro fornecidas.

NOT_CONTAINS

Para operandos de string escalar, verifica se o operando não contém nenhuma das substrings de filtro fornecidas.

Para operandos de lista de strings, verifica se nenhuma das strings no operando contém nenhuma das substrings de filtro fornecidas.

LESS_THAN O operando é menor que o valor do filtro fornecido.
LESS_THAN_EQUALS O operando é menor ou igual ao valor de filtro fornecido.
GREATER_THAN O operando é maior que o valor do filtro fornecido.
GREATER_THAN_EQUALS O operando é maior ou igual ao valor de filtro fornecido.
BETWEEN O operando está entre os valores de filtro fornecidos.
MATCHES O operando corresponde a uma expressão regular ou a um conjunto de expressões regulares (uma precisa corresponder).
NOT_MATCHES O operando tem correspondências negativas contra uma expressão regular ou um conjunto de expressões regulares (nenhuma deve corresponder).

ReportValue

Representa um único valor em um relatório.

Representação 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
O valor do campo depende do formato de dados do campo. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
intValue

string (int64 format)

Para valores inteiros.

doubleValue

number

Para valores duplos.

stringValue

string

Para valores de string.

boolValue

boolean

Para valores booleanos.

intListValue

object (IntList)

Para listas de valores inteiros.

stringListValue

object (StringList)

Para listas de valores de string.

doubleListValue

object (DoubleList)

Para listas de valores duplos.

bytesValue

string (bytes format)

Para valores de bytes.

Uma string codificada em base64.

Fim dos campos mutuamente exclusivos.

IntList

Uma lista de valores inteiros.

Representação JSON
{
  "values": [
    string
  ]
}
Campos
values[]

string (int64 format)

Os valores

StringList

Uma lista de valores de string.

Representação JSON
{
  "values": [
    string
  ]
}
Campos
values[]

string

Os valores

DoubleList

Uma lista de valores duplos.

Representação JSON
{
  "values": [
    number
  ]
}
Campos
values[]

number

Os valores

FilterList

Uma lista de filtros.

Representação JSON
{
  "filters": [
    {
      object (Filter)
    }
  ]
}
Campos
filters[]

object (Filter)

Obrigatório. Uma lista de filtros.

TimeZoneSource

A origem para determinar o fuso horário do relatório.

Tipos enumerados
TIME_ZONE_SOURCE_UNSPECIFIED Valor padrão não especificado.
AD_EXCHANGE Use o fuso horário do Pacífico(PT).
UTC Use o fuso horário UTC.
PROVIDED Use o fuso horário fornecido no campo ReportDefinition.time_zone. Os relatórios podem levar mais tempo para serem gerados, já que as datas são calculadas dinamicamente no momento da solicitação.
CURATOR Use o fuso horário das configurações da conta do curador.

DateRange

Um período para um relatório.

Representação 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
Um período fixo ou relativo. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
fixed

object (FixedDateRange)

Um período fixo.

relative

enum (RelativeDateRange)

Um período relativo.

Fim dos campos mutuamente exclusivos.

FixedDateRange

Um período entre duas datas fixas (incluindo a data de término).

Representação JSON
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Campos
startDate

object (Date)

Obrigatório. A data de início desse período.

endDate

object (Date)

Obrigatório. A data de término (inclusiva) desse período.

Data

Representa uma data inteira ou parcial do calendário, como um aniversário. A hora do dia e o fuso horário são especificados em outro lugar ou são insignificantes. A data é referente ao calendário gregoriano. Isso pode representar uma das seguintes opções:

  • uma data completa, com valores de ano, mês e dia diferentes de zero;
  • um mês e dia, com um ano zero (por exemplo, uma data comemorativa);
  • um ano sozinho, com um mês zero e um dia zero;
  • um ano e mês, com um dia zero (por exemplo, uma data de validade de cartão de crédito).

Tipos relacionados:

Representação JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano.

month

integer

Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia.

day

integer

Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 para especificar um ano sozinho ou um ano e mês em que o dia não é significativo.

RelativeDateRange

Opções para períodos relativos.

Tipos enumerados
RELATIVE_DATE_RANGE_UNSPECIFIED Valor padrão. Esse valor não é usado.
TODAY A data em que o relatório é gerado.
YESTERDAY A data do dia anterior à data em que o relatório é gerado.
THIS_WEEK_TO_DATE Do início da semana do calendário até o dia em que o relatório é gerado.
THIS_WEEK_TO_YESTERDAY Do início da semana do calendário em que o relatório é gerado até o dia anterior à geração do relatório.
THIS_MONTH_TO_DATE Do início do mês em que o relatório é gerado até o dia em que ele é gerado (inclusive).
THIS_MONTH_TO_YESTERDAY Do início do mês em que o relatório é gerado até o dia anterior à geração do relatório.
THIS_QUARTER_TO_DATE Do início do trimestre civil em que o relatório é gerado até o dia em que ele é gerado (inclusive).
THIS_QUARTER_TO_YESTERDAY Do início do trimestre civil em que o relatório é gerado até o dia anterior à geração do relatório.
THIS_YEAR_TO_DATE Do início do ano civil em que o relatório é gerado até o dia em que ele é gerado (inclusive).
THIS_YEAR_TO_YESTERDAY Do início do ano civil em que o relatório é gerado até o dia anterior à geração do relatório.
LAST_WEEK A semana inteira anterior, de segunda-feira a domingo (inclusive), que antecede a semana em que o relatório é gerado.
LAST_WEEK_STARTING_SUNDAY A semana anterior inteira, de domingo a sábado (inclusive), que antecede a semana em que o relatório é gerado.
LAST_MONTH Todo o mês anterior ao mês em que o relatório é gerado.
LAST_QUARTER Todo o trimestre civil anterior ao trimestre em que o relatório é gerado.
LAST_YEAR Todo o ano civil anterior ao ano em que o relatório é gerado.
LAST_7_DAYS Os sete dias anteriores à data em que o relatório é gerado.
LAST_30_DAYS Os 30 dias anteriores ao dia em que o relatório é gerado.
LAST_60_DAYS Os 60 dias anteriores ao dia em que o relatório é gerado.
LAST_90_DAYS Os 90 dias anteriores ao dia em que o relatório é gerado.
LAST_93_DAYS Os 93 dias anteriores à data em que o relatório é gerado.
LAST_180_DAYS Os 180 dias anteriores ao dia em que o relatório é gerado.
LAST_360_DAYS Os 360 dias anteriores ao dia em que o relatório é gerado.
LAST_365_DAYS Os 365 dias anteriores ao dia em que o relatório é gerado.
LAST_3_MONTHS Os três meses anteriores ao mês em que o relatório é gerado.
LAST_6_MONTHS Os seis meses anteriores ao mês em que o relatório é gerado.
LAST_12_MONTHS Os 12 meses anteriores ao mês em que o relatório é gerado.
ALL_AVAILABLE De 3 anos antes da geração do relatório até o dia anterior à geração do relatório, inclusive.

Classificar

Representa uma classificação em um relatório.

Representação JSON
{
  "field": {
    object (Field)
  },
  "descending": boolean
}
Campos
field

object (Field)

Obrigatório. Um campo (dimensão ou métrica) para classificação.

descending

boolean

Opcional. A ordem de classificação. Se for verdadeiro, a classificação será decrescente.

Métodos

create

Cria um objeto Report.

delete

Exclui um objeto Report.

get

Recupera um objeto Report.

list

Lista objetos Report.

patch

Atualiza um objeto Report.

run

Inicia a execução de um relatório de forma assíncrona.