REST Resource: properties

Recurso: Propiedad

Es un mensaje de recurso que representa una propiedad de Google Analytics.

Representación 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
}
Campos
name

string

Es el identificador. Es el nombre del recurso de esta propiedad. Formato: properties/{property_id} Ejemplo: "properties/1000"

propertyType

enum (PropertyType)

Inmutable. Es el tipo de propiedad para este recurso de propiedad. Cuando se crea una propiedad, si el tipo es "PROPERTY_TYPE_UNSPECIFIED", se implicará "ORDINARY_PROPERTY".

createTime

string (Timestamp format)

Solo salida. Es la hora en la que se creó la entidad originalmente.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Solo salida. Es la hora en la que se actualizaron por última vez los campos de carga útil de la entidad.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

parent

string

Inmutable. Es el nombre del recurso del elemento superior lógico de esta propiedad.

Nota: Se puede usar la IU de traslado de propiedades para cambiar el elemento superior. Formato: accounts/{account}, properties/{property} Ejemplo: "accounts/100", "properties/101"

displayName

string

Obligatorio. Es el nombre visible y legible por humanos de esta propiedad.

La longitud máxima permitida del nombre visible es de 100 unidades de código UTF-16.

industryCategory

enum (IndustryCategory)

Es la industria asociada con esta propiedad. Ejemplo: AUTOMOTIVE, FOOD_AND_DRINK

timeZone

string

Obligatorio. Es la zona horaria de los informes, que se usa como el límite diario para los informes, sin importar dónde se originen los datos. Si la zona horaria respeta el horario de verano, Analytics se ajustará automáticamente a los cambios.

NOTA: Cambiar la zona horaria afecta los datos a futuro. Este no es un cambio que se aplique de forma retroactiva.

Formato: https://www.iana.org/time-zones Ejemplo: "America/Los_Angeles"

currencyCode

string

Es el tipo de moneda que se usa en los informes que incluyen valores monetarios.

Formato: https://en.wikipedia.org/wiki/ISO_4217 Ejemplos: "USD", "EUR", "JPY"

serviceLevel

enum (ServiceLevel)

Solo salida. Es el nivel de servicio de Google Analytics que se aplica a esta propiedad.

deleteTime

string (Timestamp format)

Solo salida. Si se establece, es la hora en la que se envió esta propiedad a la papelera. Si no se establece, esta propiedad no está en la papelera.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

expireTime

string (Timestamp format)

Solo salida. Si se establece, es la hora en la que se borrará de forma permanente esta propiedad enviada a la papelera. Si no se establece, esta propiedad no está en la papelera y no está programada para borrarse.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

account

string

Inmutable. Es el nombre del recurso de la cuenta superior. Formato: accounts/{account_id} Ejemplo: "accounts/123"

PropertyType

Tipos de recursos Property.

Enums
PROPERTY_TYPE_UNSPECIFIED Tipo de propiedad desconocido o sin especificar
PROPERTY_TYPE_ORDINARY Propiedad común de Google Analytics
PROPERTY_TYPE_SUBPROPERTY Subpropiedad de Google Analytics
PROPERTY_TYPE_ROLLUP Propiedad de resumen de Google Analytics

IndustryCategory

Es la categoría seleccionada para esta propiedad, que se usa para la comparación de la industria.

Enums
INDUSTRY_CATEGORY_UNSPECIFIED Categoría de industria no especificada
AUTOMOTIVE Industria automotriz
BUSINESS_AND_INDUSTRIAL_MARKETS Mercados comerciales e industriales
FINANCE Finanzas
HEALTHCARE Salud
TECHNOLOGY Tecnología
TRAVEL Viajes
OTHER Otro
ARTS_AND_ENTERTAINMENT Arte y entretenimiento
BEAUTY_AND_FITNESS Belleza y bienestar
BOOKS_AND_LITERATURE Libros y literatura
FOOD_AND_DRINK Comidas y bebidas
GAMES Juegos
HOBBIES_AND_LEISURE Pasatiempos y ocio
HOME_AND_GARDEN Hogar y jardín
INTERNET_AND_TELECOM Internet y telecomunicaciones
LAW_AND_GOVERNMENT Gobierno y leyes
NEWS Noticias
ONLINE_COMMUNITIES Comunidades en línea
PEOPLE_AND_SOCIETY Personas y sociedad
PETS_AND_ANIMALS Mascotas y animales
REAL_ESTATE Bienes raíces
REFERENCE Referencia
SCIENCE Ciencia
SPORTS Deportes
JOBS_AND_EDUCATION Trabajos y educación
SHOPPING Shopping

ServiceLevel

Varios niveles de servicio para Google Analytics.

Enums
SERVICE_LEVEL_UNSPECIFIED Nivel de servicio no especificado o no válido
GOOGLE_ANALYTICS_STANDARD La versión estándar de Google Analytics
GOOGLE_ANALYTICS_360 La versión premium pagada de Google Analytics

Métodos

acknowledgeUserDataCollection

Confirma las condiciones de la recopilación de datos del usuario para la propiedad especificada.

create

Crea una propiedad de Google Analytics con la ubicación y los atributos especificados.

delete

Marca la propiedad de destino como borrada de forma no definitiva (es decir, "enviada a la papelera") y la muestra.

get

Busca una sola propiedad de GA.

getDataRetentionSettings

Muestra la configuración de retención de datos singleton para esta propiedad.

list

Muestra las propiedades secundarias en la cuenta superior especificada.

patch

Actualiza una propiedad.

runAccessReport

Muestra un informe personalizado de los registros de acceso a los datos.

updateDataRetentionSettings

Actualiza la configuración de retención de datos singleton para esta propiedad.