Para ver uma lista de métodos desse recurso, consulte o final desta página.
Representações de recursos
Representa uma consulta.
{
"kind": "doubleclickbidmanager#query",
"queryId": long,
"metadata": {
"title": string,
"dataRange": string,
"format": string,
"running": boolean,
"reportCount": integer,
"googleCloudStoragePathForLatestReport": string,
"latestReportRunTimeMs": long,
"googleDrivePathForLatestReport": string,
"sendNotification": boolean,
"shareEmailAddress": [
string
],
"locale": string
},
"params": {
"type": string,
"groupBys": [
string
],
"filters": [
{
"type": string,
"value": string
}
],
"metrics": [
string
],
"includeInviteData": boolean
},
"schedule": {
"frequency": string,
"endTimeMs": long,
"nextRunMinuteOfDay": integer,
"nextRunTimezoneCode": string
},
"reportDataStartTimeMs": long,
"reportDataEndTimeMs": long,
"timezoneCode": string
}| Nome da propriedade | Valor | Descrição | Observações |
|---|---|---|---|
kind |
string |
Identifica o tipo de recurso. Valor: a string fixa "doubleclickbidmanager#query". |
|
metadata |
nested object |
Metadados de consulta. | |
metadata.dataRange |
string |
Intervalo de dados do relatório.
Os valores aceitáveis são:
|
|
metadata.format |
string |
Formato do relatório gerado.
Os valores aceitáveis são:
|
|
metadata.googleCloudStoragePathForLatestReport |
string |
O caminho para o local no Google Cloud Storage onde o relatório mais recente está armazenado. | |
metadata.googleDrivePathForLatestReport |
string |
O caminho no Google Drive para o relatório mais recente. | |
metadata.latestReportRunTimeMs |
long |
A hora em que o relatório mais recente começou a ser gerado. | |
metadata.locale |
string |
Local dos relatórios gerados. Os valores aceitáveis são:
Uma string de localidade que não está na lista acima gerará relatórios em inglês. |
|
metadata.reportCount |
integer |
Número de relatórios que foram gerados para a consulta. | |
metadata.running |
boolean |
Se o relatório mais recente está sendo gerado no momento. | |
metadata.sendNotification |
boolean |
Define se uma notificação por e-mail será enviada quando um relatório estiver pronto. O padrão é "false". | |
metadata.shareEmailAddress[] |
list |
Lista de endereços de e-mail que recebem notificações quando o relatório é concluído. Separado de sendNotification. |
|
metadata.title |
string |
Título da consulta. Ele é usado para nomear os relatórios gerados a partir da consulta. | |
params |
nested object |
Parâmetros de consulta. | |
params.filters[] |
list |
Filtros usados para fazer a correspondência dos dados de tráfego no seu relatório. | |
params.filters[].type |
string |
Tipo de filtro.
Os valores aceitáveis são:
|
|
params.filters[].value |
string |
Valor do filtro. | |
params.groupBys[] |
list |
Os dados são agrupados pelos filtros listados nesse campo. | |
params.includeInviteData |
boolean |
Obsoleto. Este campo não está mais em uso. | |
params.metrics[] |
list |
Métricas a serem incluídas como colunas no relatório. | |
params.type |
string |
Tipo de relatório. Limitações específicas do tipo:
Os valores aceitáveis são os seguintes:
|
|
queryId |
long |
ID da consulta. | |
reportDataEndTimeMs |
long |
A hora de término dos dados mostrados no relatório. Observe que reportDataEndTimeMs será necessário se metadata.dataRange for CUSTOM_DATES. Caso contrário, será ignorado. |
|
reportDataStartTimeMs |
long |
A hora de início dos dados mostrados no relatório. Observe que reportDataStartTimeMs será necessário se metadata.dataRange for CUSTOM_DATES. Caso contrário, será ignorado. |
|
schedule |
nested object |
Informações sobre com que frequência e quando executar uma consulta. | |
schedule.endTimeMs |
long |
Data e hora de execução periódica da consulta. | |
schedule.frequency |
string |
Com que frequência a consulta é executada.
Os valores aceitáveis são:
|
|
schedule.nextRunMinuteOfDay |
integer |
Obsoleto. Esse campo não tem efeito. | |
schedule.nextRunTimezoneCode |
string |
Código de fuso horário canônico para o horário de geração do relatório. O valor padrão é America/New_York. |
|
timezoneCode |
string |
Código de fuso horário canônico para a hora dos dados do relatório. O valor padrão é America/New_York. |
Métodos
- createquery
- Cria uma consulta.
- deletequery
- Exclui uma consulta armazenada e os relatórios armazenados associados a ela.
- getquery
- Recupera uma consulta armazenada.
- listqueries
- Recupera as consultas armazenadas.
- runquery (em inglês)
- Executa uma consulta armazenada para gerar um relatório.