REST Resource: curators.reports

Ressource : Report

Ressource Report.

Représentation JSON
{
  "name": string,
  "reportId": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "displayName": string,
  "updateTime": string,
  "createTime": string,
  "locale": string
}
Champs
name

string

Identifiant. Nom de ressource du rapport. Le nom de la ressource du rapport se présente sous la forme suivante : curators/{accountId}/reports/{reportId}

reportId

string (int64 format)

Uniquement en sortie. ID du rapport.

reportDefinition

object (ReportDefinition)

Obligatoire. Définition du rapport.

displayName

string

Facultatif. Nom à afficher du rapport.

updateTime

string (Timestamp format)

Uniquement en sortie. Date et heure de la dernière modification de ce rapport.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

createTime

string (Timestamp format)

Uniquement en sortie. Instant auquel ce rapport a été créé.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

locale

string

Uniquement en sortie. Paramètres régionaux de ce rapport. Les paramètres régionaux sont définis à partir des paramètres régionaux de l'utilisateur au moment de la requête. Impossible de modifier les paramètres régionaux.

ReportDefinition

Définition de l'exécution d'un rapport.

Représentation JSON
{
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "filters": [
    {
      object (Filter)
    }
  ],
  "timeZoneSource": enum (TimeZoneSource),
  "timeZone": string,
  "currencyCode": string,
  "dateRange": {
    object (DateRange)
  },
  "sorts": [
    {
      object (Sort)
    }
  ]
}
Champs
dimensions[]

enum (Dimension)

Obligatoire. Liste des dimensions sur lesquelles doit porter le rapport. Si ce champ est vide, le rapport ne comportera aucune dimension et les métriques seront des totaux.

metrics[]

enum (Metric)

Obligatoire. Liste des métriques à inclure dans le rapport. Si ce champ est vide, le rapport ne contiendra aucune métrique.

filters[]

object (Filter)

Facultatif. Filtres de ce rapport.

timeZoneSource

enum (TimeZoneSource)

Facultatif. Où obtenir le fuseau horaire de ce rapport. Par défaut, le fuseau horaire du Pacifique (PT) est utilisé. Si la source est "PROVIDED", le champ "timeZone" de la définition du rapport doit également définir un fuseau horaire.

timeZone

string

Facultatif. Si la valeur de "timeZoneSource" est "PROVIDED", il s'agit du fuseau horaire à utiliser pour ce rapport. Laissez ce champ vide pour toute autre source de fuseau horaire. Fuseau horaire au format IANA. Par exemple, "America/New_York".

currencyCode

string

Facultatif. Code de la devise ISO 4217 pour ce rapport. Si aucune valeur n'est spécifiée, la valeur par défaut est le code de la devise du compte.

dateRange

object (DateRange)

Obligatoire. La plage de dates principale de ce rapport.

sorts[]

object (Sort)

Facultatif. Tris par défaut à appliquer à ce rapport.

Dimension

Dimensions de rapport.

Enums
DIMENSION_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
ADVERTISER_DOMAIN Le domaine de l'annonceur.
COUNTRY Nom à afficher d'un pays.
CURATION_DATA_SEGMENT_ID ID du segment de données créé par un curateur.
CURATION_DATA_SEGMENT_RESPONSE_STATUS État de la réponse des requêtes de segment de données dans la curation en temps réel. Pour en savoir plus, consultez https://developers.google.com/authorized-buyers/curation/get-started/start.
CURATION_DATA_SEGMENT_RESPONSE_STATUS_NAME Nom à afficher localisé de l'état de la réponse des requêtes de segment de données dans la sélection en temps réel. Pour en savoir plus, consultez https://developers.google.com/authorized-buyers/curation/get-started/start.
CURATOR_FEE_TYPE Type de service de curation (par exemple, packaging ou segment de données).
DATE Date
DEAL_ID ID de l'accord.
DEAL_NAME Nom de l'accord.
DETECTED_ADVERTISER_NAME Nom à afficher de l'annonceur détecté.
DSP_NAME Nom à afficher de la DSP.
DSP_SEAT_ID ID de siège DSP.
ENVIRONMENT L'appareil de l'utilisateur et l'environnement du conteneur d'où provient l'impression. Les valeurs acceptées sont "app" et "web".
ENVIRONMENT_NAME Nom à afficher localisé de l'appareil de l'utilisateur et de l'environnement de conteneur d'où provient l'impression. Les valeurs acceptées sont "app" et "web".
HOLDING_COMPANY_NAME Nom à afficher de la holding.
HOUR Heure.
MOBILE_APP_ID ID d'application mobile.
MOBILE_APP_NAME Nom de l'application mobile.
MOBILE_OS Système d'exploitation mobile.
MONTH Month.
PACKAGE_FEE_VISIBILITY La visibilité des frais liés au package (par exemple, divulgués ou non divulgués).
PLATFORM Plate-forme, par exemple "ordinateur" ou "mobile".
PUBLISHER_DOMAIN Domaine de l'éditeur.
PUBLISHER_ID Identifiant de l'éditeur.
PUBLISHER_NAME Nom de l'éditeur.
WEEK Semaine.

Métrique

Métriques de rapport.

Enums
METRIC_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
ACTIVE_VIEW_MEASURABILITY_RATE Taux de mesurabilité Active View.
ACTIVE_VIEW_MEASURABLE Active View mesurables.
ACTIVE_VIEW_VIEWABILITY_RATE Taux de visibilité Active View.
ACTIVE_VIEW_VIEWABLE Impr. Active View visibles
AUCTIONS_WON Enchères remportées.
BIDS Enchères.
BIDS_IN_AUCTION Offres au moment des enchères.
BID_REQUESTS Demandes d'enchères.
CLICKS Clics.
CURATION_PARTNER_FEE Frais du curateur. Cette valeur sera masquée et remplacée par 0,00 si la visibilité du package est définie sur "Non divulgué". Utilisez la dimension PACKAGE_FEE_VISIBILITY pour vérifier si les frais du package sont divulgués.
DATA_SEGMENT_REQUESTS Nombre de requêtes de segment de données envoyées dans la curation en temps réel.
IMPRESSIONS Impressions.
SPEND Dépenses dans la devise de référence spécifiée dans la requête. La valeur par défaut est USD.

Filtre

Filtre sur un ou plusieurs champs.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fieldFilter": {
    object (FieldFilter)
  },
  "notFilter": {
    object (Filter)
  },
  "andFilter": {
    object (FilterList)
  },
  "orFilter": {
    object (FilterList)
  }
  // End of mutually exclusive fields.
}
Champs
Le type détermine la façon dont les filtres sous-jacents sont combinés. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
fieldFilter

object (FieldFilter)

Filtre sur un seul champ.

notFilter

object (Filter)

Filtre dont le résultat est inversé.

andFilter

object (FilterList)

Liste de filtres dont les résultats sont combinés avec l'opérateur AND.

orFilter

object (FilterList)

Liste de filtres dont les résultats sont combinés avec l'opérateur OR.

Fin des champs mutuellement exclusifs.

FieldFilter

Filtre sur un champ spécifique.

Représentation JSON
{
  "field": {
    object (Field)
  },
  "operation": enum (Operation),
  "values": [
    {
      object (ReportValue)
    }
  ]
}
Champs
field

object (Field)

Obligatoire. Champ sur lequel filtrer.

operation

enum (Operation)

Obligatoire. Opération de ce filtre.

values[]

object (ReportValue)

Obligatoire. Valeurs à filtrer.

Champs

Une dimension ou une métrique dans un rapport.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of mutually exclusive fields.
}
Champs
Une dimension ou une métrique. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
dimension

enum (Dimension)

Dimension représentée par ce champ.

metric

enum (Metric)

Métrique représentée par ce champ.

Fin des champs mutuellement exclusifs.

Opération

Opérations de filtrage compatibles.

Enums
IN

Pour les opérandes scalaires, vérifie si l'opérande se trouve dans l'ensemble de valeurs de filtre fournies.

Pour les opérandes de liste, vérifie si un élément de l'opérande figure dans l'ensemble de valeurs de filtre fournies.

Valeur par défaut.

NOT_IN

Pour les opérandes scalaires, vérifie que l'opérande ne figure pas dans l'ensemble de valeurs de filtre fournies.

Pour les opérandes de liste, vérifie qu'aucun des éléments de l'opérande ne figure dans l'ensemble de valeurs de filtre fournies.

CONTAINS

Pour les opérandes de chaîne scalaires, vérifie si l'opérande contient l'une des sous-chaînes de filtre fournies.

Pour les opérandes de liste de chaînes, vérifie si une chaîne de l'opérande contient l'une des sous-chaînes de filtre fournies.

NOT_CONTAINS

Pour les opérandes de chaîne scalaires, vérifie que l'opérande ne contient aucune des sous-chaînes de filtre fournies.

Pour les opérandes de liste de chaînes, vérifie qu'aucune des chaînes de l'opérande ne contient aucune des sous-chaînes de filtre fournies.

LESS_THAN L'opérande est inférieur à la valeur de filtre fournie.
LESS_THAN_EQUALS L'opérande est inférieur ou égal à la valeur de filtre fournie.
GREATER_THAN L'opérande est supérieur à la valeur de filtre fournie.
GREATER_THAN_EQUALS L'opérande est supérieur ou égal à la valeur de filtre fournie.
BETWEEN L'opérande est compris entre les valeurs de filtre fournies.
MATCHES L'opérande correspond à une expression régulière ou à un ensemble d'expressions régulières (une correspondance est requise).
NOT_MATCHES L'opérande ne correspond pas à une expression régulière ou à un ensemble d'expressions régulières (aucune ne doit correspondre).

ReportValue

Représente une valeur unique dans un rapport.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "intValue": string,
  "doubleValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "intListValue": {
    object (IntList)
  },
  "stringListValue": {
    object (StringList)
  },
  "doubleListValue": {
    object (DoubleList)
  },
  "bytesValue": string
  // End of mutually exclusive fields.
}
Champs
La valeur du champ dépend du format de données du champ. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
intValue

string (int64 format)

Pour les valeurs entières.

doubleValue

number

Pour les valeurs doubles.

stringValue

string

Pour les valeurs de chaîne.

boolValue

boolean

Pour les valeurs booléennes.

intListValue

object (IntList)

Pour les listes de valeurs entières.

stringListValue

object (StringList)

Pour les listes de valeurs de chaîne.

doubleListValue

object (DoubleList)

Pour les listes de valeurs doubles.

bytesValue

string (bytes format)

Pour les valeurs d'octets.

Chaîne encodée en base64.

Fin des champs mutuellement exclusifs.

IntList

Liste de valeurs entières.

Représentation JSON
{
  "values": [
    string
  ]
}
Champs
values[]

string (int64 format)

Les valeurs

StringList

Liste de valeurs de chaîne.

Représentation JSON
{
  "values": [
    string
  ]
}
Champs
values[]

string

Les valeurs

DoubleList

Liste de valeurs doubles.

Représentation JSON
{
  "values": [
    number
  ]
}
Champs
values[]

number

Les valeurs

FilterList

Liste de filtres.

Représentation JSON
{
  "filters": [
    {
      object (Filter)
    }
  ]
}
Champs
filters[]

object (Filter)

Obligatoire. Liste de filtres.

TimeZoneSource

Source permettant de déterminer le fuseau horaire du rapport.

Enums
TIME_ZONE_SOURCE_UNSPECIFIED Valeur par défaut non spécifiée.
AD_EXCHANGE Utilisez le fuseau horaire du Pacifique(PT).
UTC Utilisez le fuseau horaire UTC.
PROVIDED Utilisez le fuseau horaire fourni dans le champ ReportDefinition.time_zone. L'exécution des rapports peut prendre plus de temps, car les dates sont calculées de manière dynamique au moment de la demande.
CURATOR Utilisez le fuseau horaire défini dans les paramètres du compte du curateur.

DateRange

Plage de dates d'un rapport.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fixed": {
    object (FixedDateRange)
  },
  "relative": enum (RelativeDateRange)
  // End of mutually exclusive fields.
}
Champs
Plage de dates fixe ou relative. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
fixed

object (FixedDateRange)

Une plage de dates fixe.

relative

enum (RelativeDateRange)

Une plage de dates relative.

Fin des champs mutuellement exclusifs.

FixedDateRange

Plage de dates entre deux dates fixes (date de fin incluse).

Représentation JSON
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Champs
startDate

object (Date)

Obligatoire. Date de début de cette plage de dates.

endDate

object (Date)

Obligatoire. Date de fin (incluse) de cette plage de dates.

Date

Représente une date du calendrier entière ou partielle, par exemple un anniversaire. L'heure de la journée et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. La date correspond au calendrier grégorien proleptique. Il peut s'agir de l'un des éléments suivants :

  • Une date complète, avec des valeurs non nulles pour l'année, le mois et le jour.
  • Un mois et un jour, avec une année nulle (par exemple, un anniversaire).
  • Une année seule, avec un mois et un jour nuls.
  • Une année et un mois, avec un jour zéro (par exemple, la date d'expiration d'une carte de crédit).

Types associés :

Représentation JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Champs
year

integer

Année de la date. Elle doit être comprise entre 1 et 9 999, ou égale à 0 si vous spécifiez une date sans année.

month

integer

Mois d'une année. Il doit être compris entre 1 et 12, ou égal à 0 si vous spécifiez une année sans mois ni jour.

day

integer

Jour du mois. Il doit être compris entre 1 et 31, et valide pour l'année et le mois, ou égal à 0 si vous spécifiez une année seule, ou une année et un mois où le jour n'est pas significatif.

RelativeDateRange

Options pour les plages de dates relatives.

Enums
RELATIVE_DATE_RANGE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
TODAY Date d'exécution du rapport.
YESTERDAY Date correspondant à la veille de la date d'exécution du rapport.
THIS_WEEK_TO_DATE Du début de la semaine calendaire jusqu'au jour d'exécution du rapport (inclus).
THIS_WEEK_TO_YESTERDAY Du début de la semaine calendaire au cours de laquelle le rapport est exécuté jusqu'à la veille de l'exécution du rapport (incluse).
THIS_MONTH_TO_DATE Du début du mois calendaire au cours duquel le rapport est exécuté jusqu'au jour de l'exécution du rapport (inclus).
THIS_MONTH_TO_YESTERDAY Du début du mois civil au cours duquel le rapport est exécuté jusqu'à la veille de l'exécution du rapport (incluse).
THIS_QUARTER_TO_DATE Du début du trimestre civil au cours duquel le rapport est exécuté jusqu'au jour de l'exécution du rapport (inclus).
THIS_QUARTER_TO_YESTERDAY Du début du trimestre civil au cours duquel le rapport est exécuté jusqu'à la veille de l'exécution du rapport (incluse).
THIS_YEAR_TO_DATE Du début de l'année civile au cours de laquelle le rapport est exécuté jusqu'au jour de l'exécution du rapport (inclus).
THIS_YEAR_TO_YESTERDAY Du début de l'année civile au cours de laquelle le rapport est exécuté jusqu'à la veille de l'exécution du rapport (incluse).
LAST_WEEK La semaine calendaire complète précédente, du lundi au dimanche (inclus), précédant la semaine calendaire au cours de laquelle le rapport est exécuté.
LAST_WEEK_STARTING_SUNDAY La semaine calendaire complète précédente, du dimanche au samedi (inclus), précédant la semaine calendaire au cours de laquelle le rapport est exécuté.
LAST_MONTH Le mois calendaire complet précédant le mois calendaire au cours duquel le rapport est exécuté.
LAST_QUARTER Le trimestre civil précédant celui au cours duquel le rapport est exécuté.
LAST_YEAR L'intégralité de l'année civile précédant l'année civile au cours de laquelle le rapport est exécuté.
LAST_7_DAYS Les sept jours précédant la génération du rapport.
LAST_30_DAYS Les 30 jours précédant la génération du rapport.
LAST_60_DAYS Les 60 jours précédant la date de génération du rapport.
LAST_90_DAYS Les 90 jours précédant la génération du rapport.
LAST_93_DAYS Les 93 jours précédant la génération du rapport.
LAST_180_DAYS Les 180 jours précédant la génération du rapport.
LAST_360_DAYS Les 360 jours précédant la génération du rapport.
LAST_365_DAYS Les 365 jours précédant la date de génération du rapport.
LAST_3_MONTHS Les trois mois calendaires complets précédant le mois calendaire au cours duquel le rapport est généré.
LAST_6_MONTHS Les six mois calendaires précédant le mois calendaire au cours duquel le rapport est exécuté.
LAST_12_MONTHS Les 12 mois calendaires précédant le mois calendaire au cours duquel le rapport est exécuté.
ALL_AVAILABLE De trois ans avant l'exécution du rapport à la veille de l'exécution du rapport, inclus.

Trier

Représente un tri dans un rapport.

Représentation JSON
{
  "field": {
    object (Field)
  },
  "descending": boolean
}
Champs
field

object (Field)

Obligatoire. Champ (dimension ou métrique) de tri.

descending

boolean

Facultatif. Ordre de tri. Si la valeur est "true", le tri sera décroissant.

Méthodes

create

Crée un objet Report.

delete

Supprime un objet Report.

get

Récupère un objet Report.

list

Répertorie les objets Report.

patch

Met à jour un objet Report.

run

Lance l'exécution d'un rapport existant de manière asynchrone.