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 da consulta. | |
metadata.dataRange |
string |
Intervalo dos 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 em que 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 |
Localidade dos relatórios gerados. Os valores aceitos são:
Uma string de localidade que não está na lista acima gera 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 |
Se uma notificação será enviada por e-mail quando um relatório estiver pronto. O padrão é falso. | |
metadata.shareEmailAddress[] |
list |
Lista de endereços de e-mail que recebem notificações por e-mail quando o relatório é concluído. Separados de sendNotification . |
|
metadata.title |
string |
Título da consulta. Ele é usado para nomear os relatórios gerados a partir dessa consulta. | |
params |
nested object |
Parâmetros de consulta. | |
params.filters[] |
list |
Filtros usados para corresponder os 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 seu relatório. | |
params.type |
string |
Tipo de relatório. Limitações específicas de tipo:
Os valores aceitáveis são os seguintes:
|
|
queryId |
long |
ID da consulta. | |
reportDataEndTimeMs |
long |
O horário de término dos dados que são exibidos no relatório. reportDataEndTimeMs será obrigatório se metadata.dataRange for CUSTOM_DATES . Caso contrário, ele será ignorado. |
|
reportDataStartTimeMs |
long |
O horário de início dos dados exibidos no relatório. reportDataStartTimeMs será obrigatório se metadata.dataRange for CUSTOM_DATES . Caso contrário, ele será ignorado. |
|
schedule |
nested object |
Informações sobre a frequência e quando executar uma consulta. | |
schedule.endTimeMs |
long |
Datetime para executar a consulta periodicamente até. | |
schedule.frequency |
string |
A frequência de execução da consulta.
Os valores aceitáveis são:
|
|
schedule.nextRunMinuteOfDay |
integer |
Obsoleto. Esse campo não tem efeito. | |
schedule.nextRunTimezoneCode |
string |
Código canônico do fuso horário para a geração do relatório. O valor padrão é America/New_York . |
|
timezoneCode |
string |
Código do fuso horário canônico para o tempo de dados do relatório. O valor padrão é America/New_York . |
Métodos
- criar consulta
- Cria uma consulta.
- deletequery
- Exclui uma consulta armazenada e os relatórios armazenados associados.
- getquery (em inglês)
- Recupera uma consulta armazenada.
- listqueries
- Recupera consultas armazenadas.
- runquery (em inglês)
- Executa uma consulta armazenada para gerar um relatório.