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 de cette valeur. Valeur: chaîne fixe "doubleclickbidmanager#query". |
|
metadata |
nested object |
Métadonnées de requête. | |
metadata.dataRange |
string |
Plage de données du rapport
Les valeurs acceptées sont les suivantes :
|
|
metadata.format |
string |
Format du rapport généré.
Les valeurs acceptées sont les suivantes :
|
|
metadata.googleCloudStoragePathForLatestReport |
string |
Chemin d'accès à 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 de début de la génération du dernier rapport. | |
metadata.locale |
string |
Paramètres régionaux des rapports générés. Les valeurs acceptées sont les suivantes :
Une chaîne de paramètres régionaux qui ne figure pas dans la liste ci-dessus génère des rapports 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 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 auxquelles les notifications sont envoyées lorsque le rapport est terminé. Distinction avec sendNotification. |
|
metadata.title |
string |
Titre de la requête. Il permet de 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 permettent de faire correspondre les données de trafic dans votre rapport. | |
params.filters[].type |
string |
Type de filtre.
Les valeurs acceptées sont les suivantes :
|
|
params.filters[].value |
string |
Valeur du filtre. | |
params.groupBys[] |
list |
Les données sont regroupées à l'aide des filtres indiqués dans ce champ. | |
params.includeInviteData |
boolean |
Obsolète. Ce champ n'est plus utilisé. | |
params.metrics[] |
list |
Métriques à inclure dans les colonnes de votre rapport | |
params.type |
string |
Type de rapport Limites spécifiques au type:
Les valeurs acceptées sont les suivantes :
|
|
queryId |
long |
ID de la requête. | |
reportDataEndTimeMs |
long |
Heure de fin pour les données affichées dans le rapport. Notez que reportDataEndTimeMs est obligatoire si metadata.dataRange est CUSTOM_DATES et ignoré dans le cas contraire. |
|
reportDataStartTimeMs |
long |
Heure de début des données affichées dans le rapport. Notez que reportDataStartTimeMs est obligatoire si metadata.dataRange est CUSTOM_DATES et ignoré dans le cas contraire. |
|
schedule |
nested object |
Informations sur la fréquence et le moment d'exécution d'une requête. | |
schedule.endTimeMs |
long |
Date et heure auxquelles exécuter la requête régulièrement. | |
schedule.frequency |
string |
Fréquence d'exécution de la requête.
Les valeurs acceptées sont les suivantes :
|
|
schedule.nextRunMinuteOfDay |
integer |
Obsolète. Ce champ n'a aucun effet. | |
schedule.nextRunTimezoneCode |
string |
Code de fuseau horaire canonique pour la 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 de rapport. La valeur par défaut est America/New_York. |
Méthodes
- Créer une requête
- Crée une requête.
- supprimer la requête
- Supprime une requête stockée, ainsi que les rapports stockés associés.
- requête
- Récupère une requête stockée.
- requêtes de liste
- Récupère les requêtes stockées.
- Exécuter la requête
- Exécute une requête stockée pour générer un rapport.