Para obtener una lista de métodos de este recurso, consulta el final de esta página.
Representaciones de recursos
Representa una 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
}
| Nombre de la propiedad | Valor | Descripción | Notas |
|---|---|---|---|
kind |
string |
Identifica qué tipo de recurso es este. Valor: la string fija "doubleclickbidmanager#query". |
|
metadata |
nested object |
Metadatos de consultas | |
metadata.dataRange |
string |
Rango de datos de informes.
Los valores aceptables son los siguientes:
|
|
metadata.format |
string |
Formato del informe generado.
Los valores aceptables son los siguientes:
|
|
metadata.googleCloudStoragePathForLatestReport |
string |
La ruta a la ubicación en Google Cloud Storage donde se almacena el informe más reciente. | |
metadata.googleDrivePathForLatestReport |
string |
La ruta en Google Drive para el informe más reciente. | |
metadata.latestReportRunTimeMs |
long |
Es la hora a la que comenzó a generarse el informe más reciente. | |
metadata.locale |
string |
Configuración regional de los informes generados Los valores aceptables son:
Una string de configuración regional que no se encuentre en la lista anterior generará informes en inglés. |
|
metadata.reportCount |
integer |
Cantidad de informes que se generaron para la consulta. | |
metadata.running |
boolean |
Indica si se está ejecutando el informe más reciente. | |
metadata.sendNotification |
boolean |
Indica si se debe enviar una notificación por correo electrónico cuando un informe está listo. El valor predeterminado es falso. | |
metadata.shareEmailAddress[] |
list |
Lista de direcciones de correo electrónico a las que se envían notificaciones cuando finaliza el informe. Independiente de sendNotification. |
|
metadata.title |
string |
Título de la consulta. Se usa para asignar un nombre a los informes generados a partir de esta consulta. | |
params |
nested object |
Parámetros de búsqueda | |
params.filters[] |
list |
Son los filtros que se utilizan para hacer coincidir los datos de tráfico de su informe. | |
params.filters[].type |
string |
Tipo de filtro.
Los valores aceptables son los siguientes:
|
|
params.filters[].value |
string |
Valor del filtro. | |
params.groupBys[] |
list |
Los datos se agrupan según los filtros que aparecen en este campo. | |
params.includeInviteData |
boolean |
Ya no está disponible. Este campo ya no está en uso. | |
params.metrics[] |
list |
Métricas para incluirlas como columnas en su informe. | |
params.type |
string |
Tipo de informe Limitaciones específicas de cada tipo:
Los valores aceptables son los siguientes:
|
|
queryId |
long |
ID de la consulta | |
reportDataEndTimeMs |
long |
Es la hora de finalización de los datos que se muestran en el informe. Ten en cuenta que reportDataEndTimeMs es obligatorio si metadata.dataRange es CUSTOM_DATES y, de lo contrario, se ignora. |
|
reportDataStartTimeMs |
long |
Es la hora de inicio de los datos que se muestran en el informe. Ten en cuenta que reportDataStartTimeMs es obligatorio si metadata.dataRange es CUSTOM_DATES y, de lo contrario, se ignora. |
|
schedule |
nested object |
Información sobre con qué frecuencia y cuándo ejecutar una consulta. | |
schedule.endTimeMs |
long |
Fecha y hora para ejecutar la consulta de forma periódica hasta | |
schedule.frequency |
string |
Es la frecuencia con la que se ejecuta la consulta.
Los valores aceptables son los siguientes:
|
|
schedule.nextRunMinuteOfDay |
integer |
Ya no está disponible. Este campo no tiene efecto. | |
schedule.nextRunTimezoneCode |
string |
Es el código de zona horaria canónico para la generación de informes. La configuración predeterminada es America/New_York. |
|
timezoneCode |
string |
Es el código de zona horaria canónico para la hora de los datos del informe. La configuración predeterminada es America/New_York. |
Métodos
- creacióndebúsqueda
- Crea una consulta.
- borrar consulta
- Borra una consulta almacenada, así como los informes almacenados asociados.
- getquery
- Recupera una consulta almacenada.
- listaconsultas
- Recupera las consultas almacenadas.
- runquery
- Ejecuta una consulta almacenada para generar un informe.