REST Resource: properties

Ressource: Propriété

Un message de ressource représentant une propriété GA4 Google Analytics.

Représentation JSON
{
  "name": string,
  "propertyType": enum (PropertyType),
  "createTime": string,
  "updateTime": string,
  "parent": string,
  "displayName": string,
  "industryCategory": enum (IndustryCategory),
  "timeZone": string,
  "currencyCode": string,
  "serviceLevel": enum (ServiceLevel),
  "deleteTime": string,
  "expireTime": string,
  "account": string
}
Champs
name

string

Uniquement en sortie. Nom de ressource de cette propriété. Format: Properties/{property_id} (exemple : "properties/1000")

propertyType

enum (PropertyType)

Immuable. Type de propriété pour cette ressource de propriété. Lors de la création d'une propriété, si le type est "PROPERTY_TYPE_UNSPECIFIED", alors "ORDINARY_PROPERTY" sera implicite.

createTime

string (Timestamp format)

Uniquement en sortie. Heure de création initiale de l'entité.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Uniquement en sortie. Heure de la dernière mise à jour des champs de charge utile de l'entité.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

parent

string

Immuable. Nom de ressource du parent logique de cette propriété.

Remarque: L'interface utilisateur de déplacement de propriétés peut être utilisée pour modifier le parent. Format : accounts/{account}, properties/{property} (par exemple, "accounts/100", "properties/101")

displayName

string

Obligatoire. Nom à afficher lisible pour cette propriété.

La longueur maximale autorisée pour le nom à afficher est de 100 unités de code UTF-16.

industryCategory

enum (IndustryCategory)

Secteur associé à cette propriété (par exemple, AUTOMOTIVE, FOOD_AND_DRINK)

timeZone

string

Obligatoire. Fuseau horaire des rapports, utilisé comme repère temporel pour les rapports, quelle que soit l'origine des données. Si le fuseau horaire respecte le passage à l'heure d'été, Analytics ajuste automatiquement les modifications en conséquence.

REMARQUE: Le changement de fuseau horaire n'affecte que les données à venir. Il n'est pas appliqué de manière rétroactive.

Format: https://www.iana.org/time-zones Exemple : "America/Los_Angeles"

currencyCode

string

Type de devise utilisé dans les rapports impliquant des valeurs monétaires.

Format: https://en.wikipedia.org/wiki/ISO_4217 Exemples : "USD", "EUR", "JPY"

serviceLevel

enum (ServiceLevel)

Uniquement en sortie. Niveau de service Google Analytics qui s'applique à cette propriété.

deleteTime

string (Timestamp format)

Uniquement en sortie. Si cette valeur est définie, il s'agit de l'heure à laquelle cette propriété a été placée dans la corbeille. Si cette règle n'est pas configurée, cette propriété ne se trouve pas dans la corbeille.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

expireTime

string (Timestamp format)

Uniquement en sortie. Si cette valeur est définie, l'heure à laquelle cette propriété placée dans la corbeille sera définitivement supprimée. Si cette règle n'est pas configurée, cette propriété ne se trouve actuellement pas dans la corbeille et ne devrait pas être supprimée.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

account

string

Immuable. Nom de ressource du compte parent. Format: accounts/{account_id}. Exemple : "accounts/123"

PropertyType

Types de ressources de propriété.

Enums
PROPERTY_TYPE_UNSPECIFIED Type de propriété inconnu ou non spécifié
PROPERTY_TYPE_ORDINARY Propriété GA4 ordinaire
PROPERTY_TYPE_SUBPROPERTY Sous-propriété GA4
PROPERTY_TYPE_ROLLUP Propriété de consolidation GA4

IndustryCategory

Catégorie sélectionnée pour cette propriété, utilisée pour l'analyse comparative du secteur.

Enums
INDUSTRY_CATEGORY_UNSPECIFIED Catégorie sectorielle non spécifiée
AUTOMOTIVE Automobile
BUSINESS_AND_INDUSTRIAL_MARKETS Commerce et industrie
FINANCE Finance
HEALTHCARE Santé
TECHNOLOGY Technologie
TRAVEL Voyages
OTHER Autre
ARTS_AND_ENTERTAINMENT Arts et divertissements
BEAUTY_AND_FITNESS Soins du corps et remise en forme
BOOKS_AND_LITERATURE Livres et littérature
FOOD_AND_DRINK Alimentation et boissons
GAMES Jeux
HOBBIES_AND_LEISURE Hobbies et loisirs
HOME_AND_GARDEN Maison et jardinage
INTERNET_AND_TELECOM Internet et télécoms
LAW_AND_GOVERNMENT Justice et administrations
NEWS Actualités
ONLINE_COMMUNITIES Communautés en ligne
PEOPLE_AND_SOCIETY Individus et société
PETS_AND_ANIMALS Animaux
REAL_ESTATE Immobilier
REFERENCE Référence
SCIENCE Science
SPORTS Sport
JOBS_AND_EDUCATION Emploi et enseignement
SHOPPING Shopping

ServiceLevel

Différents niveaux de service pour Google Analytics.

Enums
SERVICE_LEVEL_UNSPECIFIED Niveau de service non spécifié ou non valide.
GOOGLE_ANALYTICS_STANDARD Version standard de Google Analytics.
GOOGLE_ANALYTICS_360 Version premium payante de Google Analytics

Méthodes

acknowledgeUserDataCollection

Accepte les conditions de collecte des données utilisateur pour la propriété spécifiée.

create

Crée un "GA4" avec l'emplacement et les attributs spécifiés.

delete

Marque la propriété cible comme supprimée de façon réversible (par exemple, "Corbeille") et la renvoie.

get

Rechercher un seul "GA4" Propriété.

getDataRetentionSettings

Renvoie les paramètres de conservation des données du singleton pour cette propriété.

list

Affiche les propriétés enfants du compte parent spécifié.

patch

Met à jour une propriété.

runAccessReport

Renvoie un rapport personnalisé sur les enregistrements d'accès aux données.

updateDataRetentionSettings

Met à jour les paramètres de conservation des données du singleton pour cette propriété.