La liste des méthodes associées à cette ressource est présentée au bas de la page.
Représentations de la ressource
Représente une requête.
{
"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
}| Nom de propriété | Valeur | Description | Remarques |
|---|---|---|---|
kind |
string |
Identifie le type de ressource. Valeur: chaîne fixe "doubleclickbidmanager#query". |
|
metadata |
nested object |
Interroger les métadonnées | |
metadata.dataRange |
string |
Plage de données du rapport.
Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
|
|
metadata.format |
string |
Format du rapport généré.
Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
|
|
metadata.googleCloudStoragePathForLatestReport |
string |
Chemin d'accès à l'emplacement Google Cloud Storage où le dernier rapport est stocké. | |
metadata.googleDrivePathForLatestReport |
string |
Chemin d'accès au dernier rapport dans Google Drive. | |
metadata.latestReportRunTimeMs |
long |
Heure à laquelle le dernier rapport a commencé à être généré. | |
metadata.locale |
string |
Paramètres régionaux des rapports générés. Les valeurs acceptées sont les suivantes :
Si une chaîne de paramètres régionaux ne figure pas dans la liste ci-dessus, les rapports seront générés en anglais. |
|
metadata.reportCount |
integer |
Nombre de rapports générés pour la requête. | |
metadata.running |
boolean |
Indique si le dernier rapport est en cours d'exécution. | |
metadata.sendNotification |
boolean |
Permet d'envoyer ou non une notification par e-mail lorsqu'un rapport est prêt. La valeur par défaut est "false". | |
metadata.shareEmailAddress[] |
list |
Liste des adresses e-mail qui reçoivent des notifications par e-mail lorsque le rapport est terminé. Distingué de sendNotification. |
|
metadata.title |
string |
Titre de la requête. Il est utilisé pour nommer les rapports générés à partir de cette requête. | |
params |
nested object |
Paramètres de requête. | |
params.filters[] |
list |
Les filtres utilisés pour faire correspondre les données de trafic dans votre rapport. | |
params.filters[].type |
string |
Type de filtre.
Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
|
|
params.filters[].value |
string |
Valeur du filtre. | |
params.groupBys[] |
list |
Les données sont regroupées selon les filtres répertoriés dans ce champ. | |
params.includeInviteData |
boolean |
Obsolète. Ce champ n'est plus utilisé. | |
params.metrics[] |
list |
Métriques à inclure dans votre rapport sous forme de colonnes. | |
params.type |
string |
Type de rapport. Limites propres à un type:
Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
|
|
queryId |
long |
ID de la requête. | |
reportDataEndTimeMs |
long |
Heure de fin des données affichées dans le rapport. Notez que reportDataEndTimeMs est obligatoire si la valeur de metadata.dataRange est CUSTOM_DATES et est ignoré dans les autres cas. |
|
reportDataStartTimeMs |
long |
Heure de début des données affichées dans le rapport. Notez que reportDataStartTimeMs est obligatoire si la valeur de metadata.dataRange est CUSTOM_DATES et est ignoré dans les autres cas. |
|
schedule |
nested object |
Informations sur la fréquence et le moment d'exécution d'une requête. | |
schedule.endTimeMs |
long |
Date/Heure jusqu'à laquelle la requête doit être régulièrement exécutée. | |
schedule.frequency |
string |
Fréquence d'exécution de la requête.
Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
|
|
schedule.nextRunMinuteOfDay |
integer |
Obsolète. Ce champ n'a aucun effet. | |
schedule.nextRunTimezoneCode |
string |
Code de fuseau horaire canonique pour l'heure de génération du rapport. La valeur par défaut est America/New_York. |
|
timezoneCode |
string |
Code de fuseau horaire canonique pour l'heure des données du rapport. La valeur par défaut est America/New_York. |
Méthodes
- createquery
- Crée une requête.
- deletequery
- Supprime une requête stockée, ainsi que les rapports stockés associés.
- getquery
- Récupère une requête stockée.
- listqueries
- Récupère les requêtes stockées.
- runquery.
- Exécute une requête stockée pour générer un rapport.