Package google.analytics.admin.v1beta

Índice

AnalyticsAdminService

Interfaz de servicio para la API de Analytics Admin (GA4)

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse)

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

Esta confirmación se debe completar (ya sea en la IU de Google Analytics o a través de esta API) antes de que se puedan crear los recursos de MeasurementProtocolSecret.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
ArchiveCustomDimension

rpc ArchiveCustomDimension(ArchiveCustomDimensionRequest) returns (Empty)

Archiva una CustomDimension en una propiedad.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
ArchiveCustomMetric

rpc ArchiveCustomMetric(ArchiveCustomMetricRequest) returns (Empty)

Archiva una CustomMetric en una propiedad.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateConversionEvent

rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent)

Crea un evento de conversión con los atributos especificados.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateCustomDimension

rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension)

Crea una CustomDimension.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateCustomMetric

rpc CreateCustomMetric(CreateCustomMetricRequest) returns (CustomMetric)

Crea una CustomMetric.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateDataStream

rpc CreateDataStream(CreateDataStreamRequest) returns (DataStream)

Crea un DataStream.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateKeyEvent

rpc CreateKeyEvent(CreateKeyEventRequest) returns (KeyEvent)

Crea un evento clave.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateMeasurementProtocolSecret

rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Crea un secreto de Protocolo de medición.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateProperty

rpc CreateProperty(CreatePropertyRequest) returns (Property)

Crea una propiedad "GA4" con la ubicación y los atributos especificados.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteAccount

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

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

Esta API no tiene un método para restablecer cuentas borradas de forma no definitiva. Sin embargo, se pueden restablecer con la IU de la papelera.

Si las cuentas no se restablecen antes de la fecha de vencimiento, la cuenta y todos los recursos secundarios (p. ej., Properties, GoogleAdsLinks, Streams, AccessBindings) se borrarán definitivamente. https://support.google.com/analytics/answer/6154772

Muestra un error si no se encuentra el destino.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteConversionEvent

rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (Empty)

Borra un evento de conversión en una propiedad.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteDataStream

rpc DeleteDataStream(DeleteDataStreamRequest) returns (Empty)

Borra un DataStream en una propiedad.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteKeyEvent

rpc DeleteKeyEvent(DeleteKeyEventRequest) returns (Empty)

Borra un evento clave.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteMeasurementProtocolSecret

rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (Empty)

Borra el MeasurementProtocolSecret de destino.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteProperty

rpc DeleteProperty(DeletePropertyRequest) returns (Property)

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

Esta API no tiene un método para restablecer las propiedades borradas de forma no definitiva. Sin embargo, se pueden restablecer con la IU de la papelera.

Si no se restablecen las propiedades antes de la fecha de vencimiento, la propiedad y todos los recursos secundarios (p. ej., GoogleAdsLinks, Streams o AccessBindings) se borrarán definitivamente. https://support.google.com/analytics/answer/6154772

Muestra un error si el objetivo no se encuentra o si no es una propiedad GA4.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Buscar una sola cuenta.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetConversionEvent

rpc GetConversionEvent(GetConversionEventRequest) returns (ConversionEvent)

Recuperar un solo evento de conversión

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetCustomDimension

rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension)

Es la búsqueda de una sola dimensión personalizada.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetCustomMetric

rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric)

Busca una sola CustomMetric.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataRetentionSettings

rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest) returns (DataRetentionSettings)

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

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataSharingSettings

rpc GetDataSharingSettings(GetDataSharingSettingsRequest) returns (DataSharingSettings)

Obtén la configuración de uso compartido de datos de una cuenta. La configuración de uso compartido de datos es singleton.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataStream

rpc GetDataStream(GetDataStreamRequest) returns (DataStream)

Busca un solo DataStream.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetKeyEvent

rpc GetKeyEvent(GetKeyEventRequest) returns (KeyEvent)

Recuperar un solo evento clave.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetMeasurementProtocolSecret

rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Busca un solo Secreto de protocolo de medición "GA4".

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetProperty

rpc GetProperty(GetPropertyRequest) returns (Property)

Busca una sola propiedad "GA4".

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAccountSummaries

rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse)

Muestra resúmenes de todas las cuentas a las que puede acceder el emisor.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Muestra todas las cuentas a las que puede acceder el emisor.

Ten en cuenta que es posible que estas cuentas actualmente no tengan propiedades GA4. Las cuentas borradas de forma no definitiva (es decir, "enviadas a la papelera") se excluyen de forma predeterminada. Muestra una lista vacía si no se encuentran cuentas relevantes.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListConversionEvents

rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse)

Muestra una lista de los eventos de conversión en la propiedad superior especificada.

Muestra una lista vacía si no se encuentran eventos de conversión.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCustomDimensions

rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse)

Muestra una lista de CustomDimensions en una propiedad.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCustomMetrics

rpc ListCustomMetrics(ListCustomMetricsRequest) returns (ListCustomMetricsResponse)

Muestra una lista de CustomMetrics en una propiedad.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListDataStreams

rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse)

Muestra una lista de DataStreams en una propiedad.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListKeyEvents

rpc ListKeyEvents(ListKeyEventsRequest) returns (ListKeyEventsResponse)

Muestra una lista de eventos clave en la propiedad superior especificada. Muestra una lista vacía si no se encuentran eventos clave.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListMeasurementProtocolSecrets

rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse)

Muestra los objetos MeasurementProtocolSecrets secundarios en la propiedad principal especificada.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListProperties

rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse)

Devuelve Propiedades secundarias bajo la cuenta principal especificada.

Solo se mostrarán las propiedades "GA4". Se excluirán las propiedades si el llamador no tiene acceso. Las propiedades de eliminación no definitiva (es decir, las que se envían a la papelera) se excluyen de forma predeterminada. Muestra una lista vacía si no se encuentran propiedades relevantes.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ProvisionAccountTicket

rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse)

Solicita un ticket para crear una cuenta.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
RunAccessReport

rpc RunAccessReport(RunAccessReportRequest) returns (RunAccessReportResponse)

Devuelve un informe personalizado de los registros de acceso a los datos. El informe proporciona registros de cada vez que un usuario lee datos de informes de Google Analytics. Los registros de acceso se conservan por un máximo de 2 años.

Se pueden solicitar informes de acceso a los datos para una propiedad. Se pueden solicitar informes para cualquier propiedad, pero las dimensiones que no estén relacionadas con la cuota solo se pueden solicitar en las propiedades de Google Analytics 360. Este método solo está disponible para los administradores.

Estos registros de acceso a los datos incluyen los informes de la IU de GA4, las exploraciones de la IU de GA4, la API de datos de GA4 y otros productos, como Firebase y AdMob, que pueden recuperar datos de Google Analytics a través de una vinculación. Estos registros no incluyen cambios en la configuración de la propiedad, como agregar un flujo o cambiar la zona horaria de una propiedad. Para ver el historial de cambios de configuración, consulta searchChangeHistoryEvents.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
SearchChangeHistoryEvents

rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse)

Busca en todos los cambios en una cuenta o en sus elementos secundarios según el conjunto especificado de filtros.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Actualiza una cuenta.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateConversionEvent

rpc UpdateConversionEvent(UpdateConversionEventRequest) returns (ConversionEvent)

Actualiza un evento de conversión con los atributos especificados.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateCustomDimension

rpc UpdateCustomDimension(UpdateCustomDimensionRequest) returns (CustomDimension)

Actualiza una CustomDimension en una propiedad.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateCustomMetric

rpc UpdateCustomMetric(UpdateCustomMetricRequest) returns (CustomMetric)

Actualiza una CustomMetric en una propiedad.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataRetentionSettings

rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings)

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

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataStream

rpc UpdateDataStream(UpdateDataStreamRequest) returns (DataStream)

Actualiza un DataStream en una propiedad.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateKeyEvent

rpc UpdateKeyEvent(UpdateKeyEventRequest) returns (KeyEvent)

Actualiza un evento clave.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateMeasurementProtocolSecret

rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Actualiza un secreto del Protocolo de medición.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateProperty

rpc UpdateProperty(UpdatePropertyRequest) returns (Property)

Actualiza una propiedad.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/analytics.edit

AccessBetweenFilter

expresar que el resultado debe estar entre dos números (inclusive).

Campos
from_value

NumericValue

Comienza con este número.

to_value

NumericValue

Termina con este número.

AccessDateRange

Un intervalo contiguo de días: startDate, startDate + 1, ..., endDate.

Campos
start_date

string

La fecha de inicio inclusiva de la consulta en el formato YYYY-MM-DD. No puede ser posterior a endDate. También se acepta el formato NdaysAgo, yesterday o today. En ese caso, la fecha se infiere en función de la hora actual en la zona horaria de la solicitud.

end_date

string

La fecha de finalización inclusiva de la consulta en el formato YYYY-MM-DD. No puede ser anterior a startDate. También se acepta el formato NdaysAgo, yesterday o today. En ese caso, la fecha se infiere en función de la hora actual en la zona horaria de la solicitud.

AccessDimension

Las dimensiones son atributos de tus datos. Por ejemplo, la dimensión userEmail indica el correo electrónico del usuario que accedió a los datos de informes. Los valores de dimensiones en las respuestas del informe son cadenas.

Campos
dimension_name

string

El nombre de la API de la dimensión. Consulta Esquema de acceso a los datos para ver la lista de dimensiones admitidas en esta API.

Se hace referencia a las dimensiones por su nombre en dimensionFilter y orderBys.

AccessDimensionHeader

Describe una columna de dimensiones del informe. Las dimensiones solicitadas en un informe producen entradas de columna en filas y DimensionHeaders. Sin embargo, las dimensiones que se usan exclusivamente en filtros o expresiones no generan columnas en un informe. Por lo tanto, esas dimensiones no generan encabezados.

Campos
dimension_name

string

El nombre de la dimensión, por ejemplo, "userEmail".

AccessDimensionValue

Indica el valor de una dimensión.

Campos
value

string

Es el valor de la dimensión. Por ejemplo, este valor puede ser "Francia" para la dimensión "país".

AccessFilter

Una expresión para filtrar valores de dimensión o métrica.

Campos
field_name

string

El nombre de la dimensión o la métrica.

Campo de unión one_filter. Especifica un tipo de filtro para Filter. one_filter puede ser solo uno de los siguientes:
string_filter

AccessStringFilter

Filtro relacionado con cadenas.

in_list_filter

AccessInListFilter

Un filtro para los valores en la lista.

numeric_filter

AccessNumericFilter

Un filtro para valores numéricos o de fecha.

between_filter

AccessBetweenFilter

Un filtro para dos valores.

AccessFilterExpression

Expresa filtros de dimensiones o métricas. Los campos de la misma expresión deben ser todas las dimensiones o todas las métricas.

Campos
Campo de unión one_expression. Especifica un tipo de expresión de filtro para FilterExpression. one_expression puede ser solo uno de los siguientes:
and_group

AccessFilterExpressionList

Cada una de las FilterExpressions en and_group tiene una relación de AND.

or_group

AccessFilterExpressionList

Cada una de las FilterExpressions en el grupo or_group tiene una relación OR.

not_expression

AccessFilterExpression

La FilterExpression NO es de not_expression.

access_filter

AccessFilter

Un filtro primitivo En la misma FilterExpression, todos los nombres de campo del filtro deben ser todas las dimensiones o todas las métricas.

AccessFilterExpressionList

Una lista de expresiones de filtro.

Campos
expressions[]

AccessFilterExpression

Una lista de expresiones de filtro.

AccessInListFilter

El resultado debe estar en una lista de valores de cadena.

Campos
values[]

string

La lista de valores de cadena. Este campo no puede estar vacío.

case_sensitive

bool

Si es verdadero, el valor de la string distingue mayúsculas de minúsculas.

AccessMetric

Son las mediciones cuantitativas de un informe. Por ejemplo, la métrica accessCount es la cantidad total de registros de acceso a los datos.

Campos
metric_name

string

El nombre de la API de la métrica. Consulta Esquema de acceso a los datos para ver la lista de métricas compatibles con esta API.

Las métricas se mencionan por nombre en metricFilter y orderBys.

AccessMetricHeader

Describe una columna de métricas del informe. Las métricas visibles solicitadas en un informe producen entradas de columna dentro de las filas y MetricHeaders. Sin embargo, las métricas que se usan exclusivamente en filtros o expresiones no generan columnas en un informe. Por lo tanto, esas métricas no generan encabezados.

Campos
metric_name

string

El nombre de la métrica; por ejemplo, "accessCount".

AccessMetricValue

Es el valor de una métrica.

Campos
value

string

Es el valor de medición. Por ejemplo, este valor puede ser "13".

AccessNumericFilter

Filtra por valores numéricos o de fecha.

Campos
operation

Operation

El tipo de operación de este filtro.

value

NumericValue

Es un valor numérico o de fecha.

Operación

La operación aplicada a un filtro numérico.

Enumeradores
OPERATION_UNSPECIFIED No se especifica.
EQUAL Igual
LESS_THAN Menor que
LESS_THAN_OR_EQUAL Menor que o igual
GREATER_THAN Mayor que
GREATER_THAN_OR_EQUAL Mayor o igual que

AccessOrderBy

El criterio Ordenar por define cómo se ordenarán las filas en la respuesta. Por ejemplo, ordenar las filas por recuento de acceso descendente es un orden, y ordenar las filas por la cadena de país es un orden diferente.

Campos
desc

bool

Si el valor es verdadero, se ordena por orden descendente. Si es falso o no se especifica, se ordena en orden ascendente.

Campo de unión one_order_by. Especifica un tipo de pedido por para OrderBy. one_order_by puede ser solo uno de los siguientes:
metric

MetricOrderBy

Ordena los resultados según los valores de una métrica.

dimension

DimensionOrderBy

Ordena los resultados según los valores de una dimensión.

DimensionOrderBy

Ordena por valores de dimensión.

Campos
dimension_name

string

Un nombre de dimensión en la solicitud para ordenar.

order_type

OrderType

Controla la regla para el orden de los valores de dimensión.

OrderType

Regla para ordenar los valores de dimensión de la cadena.

Enumeradores
ORDER_TYPE_UNSPECIFIED No se especifica.
ALPHANUMERIC Orden alfabético por punto de código Unicode. Por ejemplo, “2” < “A” < “X” < “b” < “z”.
CASE_INSENSITIVE_ALPHANUMERIC Orden alfanumérico que no distingue entre mayúsculas y minúsculas por punto de código Unicode en minúscula. Por ejemplo, “2” < “A” < “b” < “X” < “z”.
NUMERIC Los valores de las dimensiones se convierten en números antes de ordenarlos. Por ejemplo, en el orden NUMERIC, “25” < “100” y en el orden ALPHANUMERIC, “100” < “25”. Todos los valores de dimensión no numéricos tienen el mismo valor de orden por debajo de todos los valores numéricos.

MetricOrderBy

Ordena por valores de métricas.

Campos
metric_name

string

Un nombre de métrica en la solicitud para ordenar.

AccessQuota

Estado actual de todas las cuotas de esta propiedad de Analytics. Si se agota la cuota de una propiedad, todas las solicitudes que se hagan a esa propiedad mostrarán errores de recursos agotados.

Campos
tokens_per_day

AccessQuotaStatus

Las propiedades pueden usar 250,000 tokens por día. La mayoría de las solicitudes consumen menos de 10 tokens.

tokens_per_hour

AccessQuotaStatus

Las propiedades pueden usar 50,000 tokens por hora. Una solicitud a la API consume una sola cantidad de tokens, y esa cantidad se deduce de todas las cuotas por hora, por día y por proyecto.

concurrent_requests

AccessQuotaStatus

Las propiedades pueden usar hasta 50 solicitudes simultáneas.

server_errors_per_project_per_hour

AccessQuotaStatus

Los pares de propiedades y proyectos de la nube pueden tener hasta 50 errores de servidor por hora.

tokens_per_project_per_hour

AccessQuotaStatus

Las propiedades pueden usar hasta el 25% de sus tokens por proyecto por hora. Esto equivale a que las propiedades de Analytics 360 pueden utilizar 12,500 tokens por proyecto por hora. Una solicitud a la API consume una sola cantidad de tokens, y esa cantidad se deduce de todas las cuotas por hora, por día y por proyecto.

AccessQuotaStatus

El estado actual de un grupo de cuotas en particular.

Campos
consumed

int32

Cuota consumida por esta solicitud.

remaining

int32

Cuota restante después de esta solicitud.

AccessRow

Acceder a los datos del informe para cada fila

Campos
dimension_values[]

AccessDimensionValue

Lista de valores de dimensión. Estos valores están en el mismo orden que se especificó en la solicitud.

metric_values[]

AccessMetricValue

Lista de valores de métricas. Estos valores están en el mismo orden que se especificó en la solicitud.

AccessStringFilter

Es el filtro para cadenas.

Campos
match_type

MatchType

El tipo de concordancia de este filtro.

value

string

El valor de string que se usa para la coincidencia.

case_sensitive

bool

Si es verdadero, el valor de la string distingue mayúsculas de minúsculas.

MatchType

El tipo de coincidencia de un filtro de string.

Enumeradores
MATCH_TYPE_UNSPECIFIED Sin especificar
EXACT Coincidencia exacta del valor de la cadena.
BEGINS_WITH Comienza con el valor de cadena.
ENDS_WITH Termina con el valor de la cadena.
CONTAINS Contiene el valor de la cadena.
FULL_REGEXP Coincidencia completa para la expresión regular con el valor de cadena.
PARTIAL_REGEXP Coincidencia parcial para la expresión regular con el valor de string.

Cuenta

Un mensaje de recurso que representa una cuenta de Google Analytics.

Campos
name

string

Solo salida. Nombre del recurso de esta cuenta. Formato: accounts/{account} Ejemplo: "accounts/100"

create_time

Timestamp

Solo salida. Hora en la que se creó originalmente esta cuenta.

update_time

Timestamp

Solo salida. Hora en la que se actualizaron por última vez los campos de carga útil de la cuenta.

display_name

string

Obligatorio. Es el nombre visible y legible de esta cuenta.

region_code

string

País de la empresa. Debe ser un código regional CLDR de Unicode.

deleted

bool

Solo salida. Indica si esta cuenta se borró de forma no definitiva o no. Las cuentas borradas se excluyen de los resultados de Lista, a menos que se solicite específicamente.

gmp_organization

string

Solo salida. El URI de un recurso de la organización de Google Marketing Platform. Solo se establece cuando esta cuenta está conectada a una organización de GMP. Formato: marketingplatformadmin.googleapis.com/organizations/{org_id}

AccountSummary

Es un recurso virtual que representa una descripción general de una cuenta y todas sus propiedades GA4 secundarias.

Campos
name

string

Es el nombre del recurso de este resumen de la cuenta. Formato: accountSummaries/{account_id} Ejemplo: "accountSummaries/1000"

account

string

Nombre del recurso de la cuenta a la que hace referencia este resumen de la cuenta Formato: accounts/{account_id} Ejemplo: “accounts/1000”

display_name

string

Es el nombre visible de la cuenta a la que se hace referencia en este resumen de la cuenta.

property_summaries[]

PropertySummary

Lista de resúmenes para las cuentas secundarias de esta cuenta.

AcknowledgeUserDataCollectionRequest

Mensaje de solicitud para la RPC de AcknowledgeUserDataCollection.

Campos
property

string

Obligatorio. Es la propiedad para la que se confirma la recopilación de datos del usuario.

acknowledgement

string

Obligatorio. Una confirmación de que el llamador de este método comprende las condiciones de la recopilación de datos del usuario.

Este campo debe contener el valor exacto: "Reconozco que cuento con las divulgaciones de privacidad y los derechos necesarios de mis usuarios finales para recopilar y procesar sus datos, incluida la asociación de esos datos con la información de visitas que Google Analytics recopila de mi sitio o propiedad de la aplicación".

AcknowledgeUserDataCollectionResponse

Este tipo no tiene campos.

Mensaje de respuesta para la RPC de AcknowledgeUserDataCollection.

ActionType

Tipos de acciones que pueden cambiar un recurso.

Enumeradores
ACTION_TYPE_UNSPECIFIED Tipo de acción desconocido o no especificado.
CREATED El recurso se creó en este cambio.
UPDATED Se actualizó el recurso con este cambio.
DELETED Se borró el recurso con este cambio.

ActorType

Diferentes tipos de actores que pueden realizar cambios en los recursos de Google Analytics.

Enumeradores
ACTOR_TYPE_UNSPECIFIED Tipo de actor desconocido o no especificado.
USER Los cambios que realizó el usuario especificado en actor_email.
SYSTEM Cambios realizados por el sistema de Google Analytics.
SUPPORT Cambios que realizó el personal del equipo de asistencia al cliente de Google Analytics.

ArchiveCustomDimensionRequest

Mensaje de solicitud para la RPC de ArchiveCustomDimension.

Campos
name

string

Obligatorio. El nombre de la CustomDimension que se archivará. Formato de ejemplo: properties/1234/customDimensions/5678

ArchiveCustomMetricRequest

Mensaje de solicitud para la RPC de ArchiveCustomMetric.

Campos
name

string

Obligatorio. El nombre de la CustomMetric que se archivará. Formato de ejemplo: properties/1234/customMetrics/5678

ChangeHistoryChange

Es la descripción de un cambio realizado en un solo recurso de Google Analytics.

Campos
resource

string

Nombre del recurso del recurso cuyos cambios se describen en esta entrada.

action

ActionType

El tipo de acción que cambió este recurso.

resource_before_change

ChangeHistoryResource

Contenidos del recurso antes de realizar el cambio. Si este recurso se creó con este cambio, faltará este campo.

resource_after_change

ChangeHistoryResource

Contenidos del recurso posterior a la implementación del cambio Si se borró el recurso durante el cambio, este campo no estará disponible.

ChangeHistoryResource

Instantánea de un recurso antes o después del resultado de un cambio en el historial de cambios.

Campos

Campo de unión resource.

resource puede ser una de las siguientes opciones:

account

Account

Un resumen de un recurso de la cuenta en el historial de cambios.

property

Property

Instantánea de un recurso de la propiedad en el historial de cambios.

conversion_event

ConversionEvent

Es un resumen de un recurso de ConversionEvent en el historial de cambios.

measurement_protocol_secret

MeasurementProtocolSecret

Un resumen de un recurso MeasurementProtocolSecret en el historial de cambios.

data_retention_settings

DataRetentionSettings

Instantánea de un recurso de configuración de retención de datos en el historial de cambios.

data_stream

DataStream

Una instantánea de un recurso de DataStream en el historial de cambios.

ChangeHistoryEvent

Es un conjunto de cambios en una cuenta de Google Analytics o sus propiedades secundarias que se produjeron por la misma causa. Las causas más comunes son las actualizaciones realizadas en la IU de Google Analytics, los cambios en la asistencia al cliente o los cambios automáticos en el sistema de Google Analytics.

Campos
id

string

ID de este evento del historial de cambios. Este ID es único en Google Analytics.

change_time

Timestamp

Hora en la que se realizó el cambio.

actor_type

ActorType

Indica el tipo de actor que realizó este cambio.

user_actor_email

string

Dirección de correo electrónico de la Cuenta de Google con la que se realizó el cambio Esta será una dirección de correo electrónico válida si el campo del actor está configurado como USER; de lo contrario, está vacío. Las Cuentas de Google que se borraron causarán un error.

changes_filtered

bool

Si es verdadero, se filtró la lista de cambios que se muestra y no representa todos los cambios que ocurrieron en este evento.

changes[]

ChangeHistoryChange

Una lista de los cambios realizados en este evento del historial de cambios que se ajustan a los filtros especificados en SearchChangeHistoryEventsRequest.

ChangeHistoryResourceType

Tipos de recursos cuyos cambios se pueden mostrar a partir del historial de cambios.

Enumeradores
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED Tipo de recurso desconocido o no especificado.
ACCOUNT Recurso de la cuenta
PROPERTY Recurso de propiedad
GOOGLE_SIGNALS_SETTINGS Recurso GoogleSignalsSettings
CONVERSION_EVENT Recurso de ConversionEvent
MEASUREMENT_PROTOCOL_SECRET Recurso MeasurementProtocolSecret
DATA_RETENTION_SETTINGS Recurso DataRetainSettings
DATA_STREAM Recurso de DataStream
ATTRIBUTION_SETTINGS Recurso AttributionSettings

ConversionEvent

Un evento de conversión en una propiedad de Google Analytics.

Campos
name

string

Solo salida. Es el nombre del recurso de este evento de conversión. Formato: properties/{property}/conversionEvents/{conversion_event}

event_name

string

Inmutable. Es el nombre del evento de este tipo de conversión. Ejemplos: "clic", "compra".

create_time

Timestamp

Solo salida. Hora en la que se creó este evento de conversión en la propiedad.

deletable

bool

Solo salida. Si se establece, este evento se puede borrar actualmente con DeleteConversionEvent.

custom

bool

Solo salida. Si la estableces como verdadera, este evento de conversión hará referencia a un evento personalizado. Si se establece como falsa, este evento de conversión hace referencia a un evento predeterminado en Google Analytics. Los eventos predeterminados suelen tener un significado especial en Google Analytics. Por lo general, el sistema de Google Analytics crea los eventos predeterminados para usted, pero, en algunos casos, los administradores de las propiedades pueden crearlos. Los eventos personalizados se registran para la cantidad máxima de eventos de conversión personalizados que se pueden crear por propiedad.

counting_method

ConversionCountingMethod

Opcional. Es el método mediante el cual se registrarán las conversiones en varios eventos dentro de una sesión. Si no se proporciona este valor, se establecerá en ONCE_PER_EVENT.

default_conversion_value

DefaultConversionValue

Opcional. Define un valor o una moneda predeterminados para un evento de conversión.

ConversionCountingMethod

Es el método mediante el cual se registrarán las conversiones en varios eventos dentro de una sesión.

Enumeradores
CONVERSION_COUNTING_METHOD_UNSPECIFIED No se especificó el método de registro.
ONCE_PER_EVENT Cada instancia de Evento se considera una Conversión.
ONCE_PER_SESSION Una instancia de Evento se considera una Conversión, como máximo, una vez por sesión por usuario.

DefaultConversionValue

Define un valor o una moneda predeterminados para un evento de conversión. Se deben proporcionar tanto el valor como la moneda.

Campos
value

double

Este valor se utilizará para propagar el valor de todas las conversiones del event_name especificado en las que no se haya establecido el parámetro del evento "value".

currency_code

string

Cuando un evento de conversión para este event_name no tenga una moneda establecida, esta se aplicará como predeterminada. Debe tener el formato de código de moneda ISO 4217. Consulta https://en.wikipedia.org/wiki/ISO_4217 para obtener más información.

CreateConversionEventRequest

Mensaje de solicitud para la RPC de CreateConversionEvent

Campos
conversion_event

ConversionEvent

Obligatorio. El evento de conversión que se creará.

parent

string

Obligatorio. El nombre del recurso de la propiedad superior en la que se creará este evento de conversión. Formato: propiedades/123

CreateCustomDimensionRequest

Mensaje de solicitud para la RPC de CreateCustomDimension.

Campos
parent

string

Obligatorio. Formato de ejemplo: propiedades/1234

custom_dimension

CustomDimension

Obligatorio. La CustomDimension que se creará.

CreateCustomMetricRequest

Mensaje de solicitud para la RPC de CreateCustomMetric.

Campos
parent

string

Obligatorio. Formato de ejemplo: propiedades/1234

custom_metric

CustomMetric

Obligatorio. La CustomMetric que se creará.

CreateDataStreamRequest

Mensaje de solicitud para la RPC de CreateDataStream.

Campos
parent

string

Obligatorio. Formato de ejemplo: propiedades/1234

data_stream

DataStream

Obligatorio. El DataStream que se creará.

CreateFirebaseLinkRequest

Mensaje de solicitud para la RPC CreateFirebaseLink

Campos
parent

string

Obligatorio. Formato: properties/{property_id} Ejemplo: properties/1234

CreateGoogleAdsLinkRequest

Mensaje de solicitud para la RPC de CreateGoogleAdsLink

Campos
parent

string

Obligatorio. Formato de ejemplo: propiedades/1234

CreateKeyEventRequest

Mensaje de solicitud para la RPC de CreateKeyEvent

Campos
key_event

KeyEvent

Obligatorio. El evento clave que se creará.

parent

string

Obligatorio. El nombre del recurso de la propiedad superior en la que se creará este evento clave. Formato: propiedades/123

CreateMeasurementProtocolSecretRequest

Mensaje de solicitud para la RPC de CreateMeasurementProtocolSecret

Campos
parent

string

Obligatorio. El recurso superior en el que se creará este secreto. Formato: properties/{property}/dataStreams/{dataStream}

measurement_protocol_secret

MeasurementProtocolSecret

Obligatorio. El secreto del Protocolo de medición que se creará.

CreatePropertyRequest

Mensaje de solicitud para la RPC de CreateProperty.

Campos
property

Property

Obligatorio. La propiedad que se creará. Nota: La propiedad proporcionada debe especificar su superior.

CustomDimension

Es una definición para CustomDimension.

Campos
name

string

Solo salida. Es el nombre del recurso para este recurso CustomDimension. Formato: properties/{property}/customDimensions/{customDimension}

parameter_name

string

Obligatorio. Inmutable. Es el nombre del parámetro de etiquetado de esta dimensión personalizada.

Si se trata de una dimensión centrada en el usuario, este es el nombre de la propiedad del usuario. Si se trata de una dimensión centrada en el evento, este es el nombre del parámetro del evento.

Si se trata de una dimensión centrada en el artículo, este es el nombre del parámetro que se encuentra en el array de artículos de comercio electrónico.

Solo puede contener caracteres alfanuméricos y guiones bajos, que comienzan con una letra. La longitud máxima es de 24 caracteres para las dimensiones centradas en el usuario, de 40 caracteres para las dimensiones centradas en el evento.

display_name

string

Obligatorio. Es el nombre visible de esta dimensión personalizada como se muestra en la IU de Analytics. Longitud máxima de 82 caracteres, caracteres alfanuméricos más un espacio y un guion bajo que comience con una letra. Los nombres visibles heredados generados por el sistema pueden contener corchetes, pero las actualizaciones de este campo nunca permitirán los corchetes.

description

string

Opcional. Es la descripción de esta dimensión personalizada. La longitud máxima es de 150 caracteres.

scope

DimensionScope

Obligatorio. Inmutable. Es el alcance de esta dimensión.

disallow_ads_personalization

bool

Opcional. Si se establece como verdadera, establece esta dimensión como NPA y la excluye de la personalización de anuncios.

Actualmente, esto solo es compatible con las dimensiones personalizadas centradas en el usuario.

DimensionScope

Valores válidos para el alcance de esta dimensión.

Enumeradores
DIMENSION_SCOPE_UNSPECIFIED Alcance desconocido o no especificado.
EVENT Dimensión centrada en un evento.
USER Dimensión centrada en un usuario.
ITEM Dimensión específica de los artículos de comercio electrónico

CustomMetric

Una definición de una métrica personalizada.

Campos
name

string

Solo salida. Nombre del recurso para este recurso CustomMetric. Formato: properties/{property}/customMetrics/{customMetric}

parameter_name

string

Obligatorio. Inmutable. Nombre del etiquetado de esta métrica personalizada.

Si se trata de una métrica centrada en el evento, este es el nombre del parámetro del evento.

Solo puede contener caracteres alfanuméricos y guiones bajos, que comiencen con una letra. Longitud máxima de 40 caracteres para las métricas centradas en el evento.

display_name

string

Obligatorio. Nombre visible de esta métrica personalizada como se muestra en la IU de Analytics. Longitud máxima de 82 caracteres, caracteres alfanuméricos más un espacio y un guion bajo que comience con una letra. Los nombres visibles heredados generados por el sistema pueden contener corchetes, pero las actualizaciones de este campo nunca permitirán los corchetes.

description

string

Opcional. Es la descripción de esta dimensión personalizada. La longitud máxima es de 150 caracteres.

measurement_unit

MeasurementUnit

Obligatorio. Es el tipo del valor de la métrica personalizada.

scope

MetricScope

Obligatorio. Inmutable. El alcance de esta métrica personalizada.

restricted_metric_type[]

RestrictedMetricType

Opcional. Tipos de datos restringidos que puede contener esta métrica. Obligatorio para las métricas con la unidad de medida CURRENCY. Debe estar vacío para las métricas con una unidad de medida que no sea CURRENCY.

MeasurementUnit

Tipos posibles de representar el valor de la métrica personalizada.

La representación de la moneda puede cambiar en el futuro, lo que requiere un cambio rotundo en la API.

Enumeradores
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit no se especificó o no se especificó.
STANDARD Esta métrica usa unidades predeterminadas.
CURRENCY Esta métrica mide una moneda.
FEET Esta métrica mide pies.
METERS Esta métrica mide metros.
KILOMETERS Esta métrica mide kilómetros.
MILES Esta métrica mide millas.
MILLISECONDS Esta métrica mide los milisegundos.
SECONDS Esta métrica mide segundos.
MINUTES Esta métrica mide minutos.
HOURS Esta métrica mide las horas.

MetricScope

El alcance de esta métrica.

Enumeradores
METRIC_SCOPE_UNSPECIFIED Alcance desconocido o no especificado.
EVENT Métrica centrada en un evento.

RestrictedMetricType

Son las etiquetas que marcan los datos de esta métrica personalizada como datos que deben restringirse a usuarios específicos.

Enumeradores
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tipo desconocido o no especificado.
COST_DATA Las métricas informan los datos de costos.
REVENUE_DATA Las métricas informan datos de ingresos.

DataRetentionSettings

Valores de configuración para la retención de datos. Este es un recurso singleton.

Campos
name

string

Solo salida. Nombre del recurso para este recurso DataRetentionSetting. Formato: properties/{property}/dataRetentionSettings

event_data_retention

RetentionDuration

La cantidad de tiempo que se conservan los datos a nivel del evento.

reset_user_data_on_new_activity

bool

Si es verdadero, restablece el período de retención para el identificador de usuario con cada evento de ese usuario.

RetentionDuration

Valores válidos para la duración de la retención de datos.

Enumeradores
RETENTION_DURATION_UNSPECIFIED No se especificó la duración del tiempo de retención de datos.
TWO_MONTHS El período de retención de datos es de 2 meses.
FOURTEEN_MONTHS El tiempo de retención de datos es de 14 meses.
TWENTY_SIX_MONTHS El tiempo de retención de datos es de 26 meses. Disponible solo para las propiedades 360.
THIRTY_EIGHT_MONTHS El tiempo de retención de datos es de 38 meses. Disponible solo para las propiedades 360.
FIFTY_MONTHS El tiempo de retención de datos es de 50 meses. Disponible solo para las propiedades 360.

DataSharingSettings

Un mensaje de recurso que representa la configuración de uso compartido de datos de una cuenta de Google Analytics.

Campos
name

string

Solo salida. Nombre del recurso. Formato: accounts/{account}/dataSharingSettings Ejemplo: "accounts/1000/dataSharingSettings"

sharing_with_google_support_enabled

bool

Permite que la Atención al cliente de Google acceda a los datos para ayudar a solucionar problemas.

sharing_with_google_assigned_sales_enabled

bool

Permite que los equipos de ventas de Google que están asignados al cliente accedan a los datos para sugerir cambios en la configuración a fin de mejorar los resultados. Las restricciones para el equipo de ventas se siguen aplicando cuando se habilita esta opción.

sharing_with_google_any_sales_enabled

bool

Permite que cualquiera de los equipos de ventas de Google acceda a los datos para sugerir cambios de configuración que mejoren los resultados.

sharing_with_google_products_enabled

bool

Permite que Google use los datos para mejorar otros productos o servicios de Google.

sharing_with_others_enabled

bool

Permite que Google comparta los datos de forma anónima con otras personas de forma agregada.

DataStream

Un mensaje de recurso que representa un flujo de datos.

Campos
name

string

Solo salida. Nombre del recurso de este flujo de datos. Formato: properties/{property_id}/dataStreams/{stream_id} Ejemplo: "properties/1000/dataStreams/2000"

type

DataStreamType

Obligatorio. Inmutable. El tipo de este recurso de DataStream.

display_name

string

Es el nombre visible y legible por humanos del flujo de datos.

Obligatorio para los flujos de datos web.

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

create_time

Timestamp

Solo salida. Hora en la que se creó originalmente esta transmisión.

update_time

Timestamp

Solo salida. Tiempo en que se actualizaron por última vez los campos de carga útil de transmisión.

Campo de unión stream_data. Datos para tipos específicos de flujos de datos. El mensaje que se establecerá corresponde al tipo de esta transmisión. Las direcciones (stream_data) solo pueden ser una de las siguientes opciones:
web_stream_data

WebStreamData

Datos específicos de los flujos web. Se debe propagar si el tipo es WEB_DATA_STREAM.

android_app_stream_data

AndroidAppStreamData

Datos específicos de los flujos de aplicaciones para Android. Se debe propagar si el tipo es ANDROID_APP_DATA_STREAM.

ios_app_stream_data

IosAppStreamData

Datos específicos de los flujos de aplicaciones para iOS. Se debe propagar si el tipo es IOS_APP_DATA_STREAM.

AndroidAppStreamData

Datos específicos de los flujos de aplicaciones para Android.

Campos
firebase_app_id

string

Solo salida. Es el ID de la app para Android correspondiente en Firebase, si corresponde. Este ID puede cambiar si se borra y se vuelve a crear la app para Android.

package_name

string

Inmutable. Es el nombre del paquete de la aplicación que se mide. Ejemplo: "com.example.miandroidapp".

DataStreamType

Es el tipo de flujo de datos.

Enumeradores
DATA_STREAM_TYPE_UNSPECIFIED Tipo desconocido o no especificado.
WEB_DATA_STREAM Flujo de datos web
ANDROID_APP_DATA_STREAM Flujo de datos de aplicaciones para Android.
IOS_APP_DATA_STREAM Flujo de datos de aplicaciones para iOS.

IosAppStreamData

Datos específicos de los flujos de aplicaciones para iOS.

Campos
firebase_app_id

string

Solo salida. Es el ID de la app para iOS correspondiente en Firebase, si corresponde. Este ID puede cambiar si se borra y se vuelve a crear la app para iOS.

bundle_id

string

Obligatorio. Inmutable. El ID del paquete de la App Store de Apple de la app (ejemplo: “com.example.miiosapp”)

WebStreamData

Datos específicos de los flujos web.

Campos
measurement_id

string

Solo salida. ID de medición de Analytics.

Ejemplo: "G-1A2BCD345E"

firebase_app_id

string

Solo salida. Es el ID de la app web correspondiente en Firebase, si corresponde. Este ID puede cambiar si se borra y se vuelve a crear la app web.

default_uri

string

Es el nombre de dominio de la aplicación web que se mide, o está vacía. Ejemplo: "http://www.google.com", "https://www.google.com"

DeleteAccountRequest

Mensaje de solicitud para la RPC de DeleteAccount.

Campos
name

string

Obligatorio. El nombre de la cuenta que se borrará de forma no definitiva Formato: accounts/{account} Ejemplo: "accounts/100"

DeleteConversionEventRequest

Mensaje de solicitud para la RPC de DeleteConversionEvent

Campos
name

string

Obligatorio. El nombre del recurso del evento de conversión que se borrará. Formato: properties/{property}/conversionEvents/{conversion_event} Ejemplo: "properties/123/conversionEvents/456"

DeleteDataStreamRequest

Mensaje de solicitud para la RPC de DeleteDataStream.

Campos
name

string

Obligatorio. El nombre del DataStream que se borrará. Formato de ejemplo: properties/1234/dataStreams/5678

DeleteFirebaseLinkRequest

Mensaje de solicitud para la RPC de DeleteFirebaseLink

Campos
name

string

Obligatorio. Formato: properties/{property_id}/firebaseLinks/{firebase_link_id} Ejemplo: properties/1234/firebaseLinks/5678

DeleteGoogleAdsLinkRequest

Mensaje de solicitud para la RPC de DeleteGoogleAdsLink.

Campos
name

string

Obligatorio. Formato de ejemplo: properties/1234/googleAdsLinks/5678

DeleteKeyEventRequest

Mensaje de solicitud para la RPC de DeleteKeyEvent

Campos
name

string

Obligatorio. El nombre del recurso del evento de tecla que se borrará. Formato: properties/{property}/keyEvents/{key_event} Ejemplo: "properties/123/keyEvents/456"

DeleteMeasurementProtocolSecretRequest

Mensaje de solicitud para la RPC de DeleteMeasurementProtocolSecret

Campos
name

string

Obligatorio. Es el nombre del MeasurementProtocolSecret que se borrará. Formato: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

DeletePropertyRequest

Mensaje de solicitud para la RPC de DeleteProperty.

Campos
name

string

Obligatorio. El nombre de la propiedad que se borrará de forma no definitiva Formato: properties/{property_id} Ejemplo: "properties/1000"

GetAccountRequest

Mensaje de solicitud para el RPC de GetAccount.

Campos
name

string

Obligatorio. El nombre de la cuenta que se buscará. Formato: accounts/{account} Ejemplo: "accounts/100"

GetConversionEventRequest

Mensaje de solicitud para la RPC de GetConversionEvent

Campos
name

string

Obligatorio. El nombre del recurso del evento de conversión que se recuperará. Formato: properties/{property}/conversionEvents/{conversion_event} Ejemplo: "properties/123/conversionEvents/456"

GetCustomDimensionRequest

Mensaje de solicitud para la RPC de GetCustomDimension.

Campos
name

string

Obligatorio. Es el nombre de la CustomDimension que se obtendrá. Formato de ejemplo: properties/1234/customDimensions/5678

GetCustomMetricRequest

Mensaje de solicitud para la RPC de GetCustomMetric.

Campos
name

string

Obligatorio. El nombre de la CustomMetric que se obtendrá. Formato de ejemplo: properties/1234/customMetrics/5678

GetDataRetentionSettingsRequest

Mensaje de solicitud para la RPC de GetDataRetentionSettings.

Campos
name

string

Obligatorio. El nombre de la configuración que se buscará. Formato: properties/{property}/dataRetentionSettings Ejemplo: "properties/1000/dataRetentionSettings"

GetDataSharingSettingsRequest

Mensaje de solicitud para la RPC de GetDataSharingSettings.

Campos
name

string

Obligatorio. El nombre de la configuración que se buscará. Formato: accounts/{account}/dataSharingSettings Ejemplo: "accounts/1000/dataSharingSettings"

GetDataStreamRequest

Mensaje de solicitud para la RPC de GetDataStream.

Campos
name

string

Obligatorio. El nombre del DataStream que se obtendrá. Formato de ejemplo: properties/1234/dataStreams/5678

GetKeyEventRequest

Mensaje de solicitud para el RPC de GetKeyEvent

Campos
name

string

Obligatorio. El nombre del recurso del evento clave que se recuperará. Formato: properties/{property}/keyEvents/{key_event} Ejemplo: "properties/123/keyEvents/456"

GetMeasurementProtocolSecretRequest

Mensaje de solicitud para la RPC de GetMeasurementProtocolSecret.

Campos
name

string

Obligatorio. Es el nombre del secreto de Protocolo de medición que se debe buscar. Formato: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

GetPropertyRequest

Mensaje de solicitud para la RPC de GetProperty.

Campos
name

string

Obligatorio. Es el nombre de la propiedad que se buscará. Formato: properties/{property_id} Ejemplo: "properties/1000"

IndustryCategory

La categoría seleccionada para esta propiedad, que se usa en las comparativas de sectores.

Enumeradores
INDUSTRY_CATEGORY_UNSPECIFIED Categoría del sector sin especificar
AUTOMOTIVE Industria automotriz
BUSINESS_AND_INDUSTRIAL_MARKETS Mercados industriales y comerciales
FINANCE Finanzas
HEALTHCARE Servicios de 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 Alimentos 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 Ley y Gobierno
NEWS Noticias
ONLINE_COMMUNITIES Comunidades online
PEOPLE_AND_SOCIETY Personas y sociedad
PETS_AND_ANIMALS Mascotas y animales
REAL_ESTATE Bienes raíces
REFERENCE Reference
SCIENCE Ciencia
SPORTS Deportes
JOBS_AND_EDUCATION Trabajos y educación
SHOPPING Compras

KeyEvent

Es un evento clave en una propiedad de Google Analytics.

Campos
name

string

Solo salida. Es el nombre del recurso de este evento de tecla. Formato: properties/{property}/keyEvents/{key_event}

event_name

string

Inmutable. El nombre del evento para este evento clave. Ejemplos: "clic", "compra".

create_time

Timestamp

Solo salida. Hora a la que se creó este evento clave en la propiedad.

deletable

bool

Solo salida. Si se establece como verdadera, se puede borrar este evento.

custom

bool

Solo salida. Si se configura como verdadero, este evento clave hace referencia a un evento personalizado. Si se establece como falsa, este evento clave hace referencia a un evento predeterminado en Google Analytics. Los eventos predeterminados suelen tener un significado especial en Google Analytics. Por lo general, el sistema de Google Analytics crea los eventos predeterminados para usted, pero, en algunos casos, los administradores de las propiedades pueden crearlos. Los eventos personalizados se tienen en cuenta para la cantidad máxima de eventos de clave personalizados que se pueden crear por propiedad.

counting_method

CountingMethod

Obligatorio. Es el método mediante el cual los eventos clave se contarán en varios eventos dentro de una sesión.

default_value

DefaultValue

Opcional. Define un valor o una moneda predeterminados para un evento de clave.

CountingMethod

Es el método mediante el cual los eventos clave se contarán en varios eventos dentro de una sesión.

Enumeradores
COUNTING_METHOD_UNSPECIFIED No se especificó el método de registro.
ONCE_PER_EVENT Cada instancia de Evento se considera un evento clave.
ONCE_PER_SESSION Una instancia de Evento se considera un evento clave, como máximo, una vez por sesión por usuario.

DefaultValue

Define un valor o una moneda predeterminados para un evento de clave.

Campos
numeric_value

double

Obligatorio. Esto se usará para propagar el parámetro "value" para todos los casos de este evento clave (especificado por event_name) donde ese parámetro no esté establecido.

currency_code

string

Obligatorio. Cuando una instancia de este evento clave (especificado por event_name) no tenga una moneda establecida, esta se aplicará como predeterminada. Debe tener el formato de código de moneda ISO 4217.

Consulta https://en.wikipedia.org/wiki/ISO_4217 para obtener más información.

ListAccountSummariesRequest

Mensaje de solicitud para la RPC de ListAccountSummaries.

Campos
page_size

int32

La cantidad máxima de recursos AccountSummary que se pueden mostrar. Es posible que el servicio muestre menos que este valor, incluso si hay páginas adicionales. Si no se especifica, se mostrarán 50 recursos como máximo. El valor máximo es 200 (los valores más altos se forzarán al máximo).

page_token

string

Un token de página, recibido desde una llamada ListAccountSummaries anterior. Proporciona esto para recuperar la página siguiente. Cuando se utiliza la paginación, todos los demás parámetros proporcionados a ListAccountSummaries deben coincidir con la llamada que proporcionó el token de la página.

ListAccountSummariesResponse

Mensaje de respuesta para la RPC de ListAccountSummaries.

Campos
account_summaries[]

AccountSummary

Resúmenes de todas las cuentas a las que tiene acceso el emisor

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListAccountsRequest

Mensaje de solicitud para la RPC de ListCuentas.

Campos
page_size

int32

La cantidad máxima de recursos que se mostrarán. Es posible que el servicio muestre menos que este valor, incluso si hay páginas adicionales. Si no se especifica, se mostrarán 50 recursos como máximo. El valor máximo es 200 (los valores más altos se forzarán al máximo).

page_token

string

Un token de página, recibido desde una llamada ListAccounts anterior. Proporciona esto para recuperar la página siguiente. Cuando se utiliza la paginación, todos los demás parámetros proporcionados a ListAccounts deben coincidir con la llamada que proporcionó el token de la página.

show_deleted

bool

Indica si se deben incluir cuentas borradas de forma no definitiva (es decir, cuentas "enviadas a la papelera") en los resultados. Las cuentas se pueden inspeccionar para determinar si se borraron o no.

ListAccountsResponse

Mensaje de solicitud para la RPC de ListCuentas.

Campos
accounts[]

Account

Resultados a los que pudo acceder el emisor.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListConversionEventsRequest

Mensaje de solicitud para la RPC de ListConversionEvents

Campos
parent

string

Obligatorio. El nombre del recurso de la propiedad superior. Ejemplo: "properties/123"

page_size

int32

La cantidad máxima de recursos que se mostrarán. Si no se especifica, se mostrarán 50 recursos como máximo. El valor máximo es 200 (los valores más altos se forzarán al máximo).

page_token

string

Un token de página, recibido desde una llamada ListConversionEvents anterior. Proporciona esto para recuperar la página siguiente. Cuando se utiliza la paginación, todos los demás parámetros proporcionados a ListConversionEvents deben coincidir con la llamada que proporcionó el token de la página.

ListConversionEventsResponse

Mensaje de respuesta para la RPC de ListConversionEvents.

Campos
conversion_events[]

ConversionEvent

Los eventos de conversión solicitados

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListCustomDimensionsRequest

Mensaje de solicitud para la RPC de ListCustomDimensions.

Campos
parent

string

Obligatorio. Formato de ejemplo: propiedades/1234

page_size

int32

La cantidad máxima de recursos que se mostrarán. Si no se especifica, se mostrarán 50 recursos como máximo. El valor máximo es 200 (los valores más altos se forzarán al máximo).

page_token

string

Un token de página, recibido desde una llamada ListCustomDimensions anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListCustomDimensions deben coincidir con la llamada que proporcionó el token de la página.

ListCustomDimensionsResponse

Mensaje de respuesta para la RPC de ListCustomDimensions.

Campos
custom_dimensions[]

CustomDimension

Lista de CustomDimensions.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListCustomMetricsRequest

Mensaje de solicitud para la RPC de ListCustomMetrics.

Campos
parent

string

Obligatorio. Formato de ejemplo: propiedades/1234

page_size

int32

La cantidad máxima de recursos que se mostrarán. Si no se especifica, se mostrarán 50 recursos como máximo. El valor máximo es 200 (los valores más altos se forzarán al máximo).

page_token

string

Un token de página, recibido desde una llamada ListCustomMetrics anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListCustomMetrics deben coincidir con la llamada que proporcionó el token de la página.

ListCustomMetricsResponse

Mensaje de respuesta para la RPC de ListCustomMetrics.

Campos
custom_metrics[]

CustomMetric

Lista de CustomMetrics.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListDataStreamsRequest

Mensaje de solicitud para la RPC de ListDataStreams.

Campos
parent

string

Obligatorio. Formato de ejemplo: propiedades/1234

page_size

int32

La cantidad máxima de recursos que se mostrarán. Si no se especifica, se mostrarán 50 recursos como máximo. El valor máximo es 200 (los valores más altos se forzarán al máximo).

page_token

string

Un token de página, recibido desde una llamada ListDataStreams anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListDataStreams deben coincidir con la llamada que proporcionó el token de la página.

ListDataStreamsResponse

Mensaje de respuesta para la RPC de ListDataStreams.

Campos
data_streams[]

DataStream

Lista de DataStreams.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListFirebaseLinksRequest

Mensaje de solicitud para la RPC de ListFirebaseLinks

Campos
parent

string

Obligatorio. Formato: properties/{property_id} Ejemplo: properties/1234

page_size

int32

La cantidad máxima de recursos que se mostrarán. Es posible que el servicio muestre menos que este valor, incluso si hay páginas adicionales. Si no se especifica, se mostrarán 50 recursos como máximo. El valor máximo es 200 (los valores más altos se forzarán al máximo).

page_token

string

Un token de página, recibido desde una llamada ListFirebaseLinks anterior. Proporciona esto para recuperar la página siguiente. Cuando se utiliza la paginación, todos los demás parámetros proporcionados a ListFirebaseLinks deben coincidir con la llamada que proporcionó el token de la página.

ListFirebaseLinksResponse

Mensaje de respuesta para la RPC de ListFirebaseLinks

Campos
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes. Actualmente, Google Analytics solo admite un FirebaseLink por propiedad, por lo que nunca se propagará.

ListGoogleAdsLinksRequest

Mensaje de solicitud para la RPC de ListGoogleAdsLinks.

Campos
parent

string

Obligatorio. Formato de ejemplo: propiedades/1234

page_size

int32

La cantidad máxima de recursos que se mostrarán. Si no se especifica, se mostrarán 50 recursos como máximo. El valor máximo es 200 (los valores más altos se forzarán al máximo).

page_token

string

Un token de página, recibido desde una llamada ListGoogleAdsLinks anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListGoogleAdsLinks deben coincidir con la llamada que proporcionó el token de la página.

ListGoogleAdsLinksResponse

Mensaje de respuesta para la RPC de ListGoogleAdsLinks.

Campos
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListKeyEventsRequest

Mensaje de solicitud para la RPC de ListKeyEvents

Campos
parent

string

Obligatorio. El nombre del recurso de la propiedad superior. Ejemplo: "properties/123"

page_size

int32

La cantidad máxima de recursos que se mostrarán. Si no se especifica, se mostrarán 50 recursos como máximo. El valor máximo es 200 (los valores más altos se forzarán al máximo).

page_token

string

Un token de página, recibido desde una llamada ListKeyEvents anterior. Proporciona esto para recuperar la página siguiente. Cuando se utiliza la paginación, todos los demás parámetros proporcionados a ListKeyEvents deben coincidir con la llamada que proporcionó el token de la página.

ListKeyEventsResponse

Mensaje de respuesta para la RPC de ListKeyEvents.

Campos
key_events[]

KeyEvent

Los eventos clave solicitados

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListMeasurementProtocolSecretsRequest

Mensaje de solicitud para la RPC de ListMeasurementProtocolSecret

Campos
parent

string

Obligatorio. El nombre del recurso de la transmisión superior. Formato: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

page_size

int32

La cantidad máxima de recursos que se mostrarán. Si no se especifica, se mostrarán 10 recursos como máximo. El valor máximo es 10. Los valores más altos se forzarán al máximo.

page_token

string

Un token de página, recibido desde una llamada ListMeasurementProtocolSecrets anterior. Proporciona esto para recuperar la página siguiente. Cuando se utiliza la paginación, todos los demás parámetros proporcionados a ListMeasurementProtocolSecrets deben coincidir con la llamada que proporcionó el token de la página.

ListMeasurementProtocolSecretsResponse

Mensaje de respuesta para la RPC de ListMeasurementProtocolSecret

Campos
measurement_protocol_secrets[]

MeasurementProtocolSecret

Una lista de secretos para la transmisión superior especificada en la solicitud.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListPropertiesRequest

Mensaje de solicitud para la RPC de ListProperties.

Campos
filter

string

Obligatorio. Una expresión para filtrar los resultados de la solicitud. Los campos aptos para filtrar son los siguientes: parent:(el nombre del recurso de la cuenta o propiedad superior), ancestor:(el nombre del recurso de la cuenta principal) o firebase_project:(el ID o número del proyecto de Firebase vinculado). Estos son algunos ejemplos de filtros:

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
page_size

int32

La cantidad máxima de recursos que se mostrarán. Es posible que el servicio muestre menos que este valor, incluso si hay páginas adicionales. Si no se especifica, se mostrarán 50 recursos como máximo. El valor máximo es 200 (los valores más altos se forzarán al máximo).

page_token

string

Un token de página, recibido desde una llamada ListProperties anterior. Proporciona esto para recuperar la página siguiente. Cuando se utiliza la paginación, todos los demás parámetros proporcionados a ListProperties deben coincidir con la llamada que proporcionó el token de la página.

show_deleted

bool

Indica si se deben incluir propiedades borradas de forma no definitiva (es decir: “enviadas a la papelera”) en los resultados. Es posible inspeccionar las propiedades para determinar si se borraron o no.

ListPropertiesResponse

Mensaje de respuesta para la RPC de ListProperties.

Campos
properties[]

Property

Resultados que coincidieron con los criterios del filtro y que el llamador podía acceder a ellos

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

MeasurementProtocolSecret

Es un valor secreto que se usa para enviar hits al Protocolo de medición.

Campos
name

string

Solo salida. Nombre del recurso de este secreto. Este secreto puede ser un elemento secundario de cualquier tipo de transmisión. Formato: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

display_name

string

Obligatorio. Nombre visible legible para este Secret.

secret_value

string

Solo salida. El valor del secreto del Protocolo de medición. Pasa este valor al campo api_secret de la API del Protocolo de medición cuando envíes hits a la propiedad superior de este secreto.

NumericValue

Representar un número

Campos
Campo de unión one_value. Uno de los valores numéricos one_value puede ser solo una de las siguientes opciones:
int64_value

int64

Valor del número entero

double_value

double

Valor doble

Propiedad

Un mensaje de recurso que representa una propiedad GA4 de Google Analytics.

Campos
name

string

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

property_type

PropertyType

Inmutable. El tipo de propiedad para este recurso de la propiedad. Cuando se crea una propiedad, si el tipo es "PROPERTY_TYPE_UNSPECIFIED", entonces "ORDINARY_PROPERTY" está implícito.

create_time

Timestamp

Solo salida. Hora en la que se creó originalmente la entidad.

update_time

Timestamp

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

parent

string

Inmutable. 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"

display_name

string

Obligatorio. Es el nombre visible legible de esta propiedad.

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

industry_category

IndustryCategory

Industria asociada con esta propiedad. Ejemplo: AUTOMOTIVE, FOOD_AND_DRINK

time_zone

string

Obligatorio. La zona horaria de los informes, que se usa como 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 solo afecta los datos futuros y no se aplica de forma retroactiva.

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

currency_code

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” o “JPY”

service_level

ServiceLevel

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

delete_time

Timestamp

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

expire_time

Timestamp

Solo salida. Si se configura, la hora a la que esta propiedad enviada a la papelera se borrará de forma permanente. Si no la estableces, esta propiedad no está actualmente en la papelera y no se borrará.

account

string

Inmutable. El nombre del recurso de la cuenta principal Formato: accounts/{account_id} Ejemplo: "accounts/123"

PropertySummary

Un recurso virtual que representa los metadatos de una propiedad GA4.

Campos
property

string

Nombre del recurso de la propiedad a la que hace referencia este resumen de propiedad Formato: properties/{property_id} Ejemplo: "properties/1000"

display_name

string

Es el nombre visible de la propiedad a la que se hace referencia en este resumen de la propiedad.

property_type

PropertyType

El tipo de propiedad de la propiedad.

parent

string

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/200"

PropertyType

Tipos de recursos de propiedades.

Enumeradores
PROPERTY_TYPE_UNSPECIFIED Tipo de propiedad desconocido o sin especificar
PROPERTY_TYPE_ORDINARY Propiedad GA4 común
PROPERTY_TYPE_SUBPROPERTY Subpropiedad GA4
PROPERTY_TYPE_ROLLUP Propiedad de datos integrados GA4

ProvisionAccountTicketRequest

Mensaje de solicitud para la RPC de ProvisionAccountTicket.

Campos
account

Account

La cuenta que se creará.

redirect_uri

string

El URI de redireccionamiento al que se enviará al usuario después de aceptar las Condiciones del Servicio. Se debe configurar en la consola de Cloud como un URI de redireccionamiento.

ProvisionAccountTicketResponse

Mensaje de respuesta para la RPC de ProvisionAccountTicket.

Campos
account_ticket_id

string

El parámetro que se pasará en el vínculo de las Condiciones del Servicio.

RunAccessReportRequest

La solicitud de un informe de registro de acceso a los datos.

Campos
entity

string

El informe de acceso a los datos admite solicitudes a nivel de la propiedad o de la cuenta. Si se solicitan a nivel de la cuenta, estos informes incluirán todo el acceso a todas las propiedades de esa cuenta.

Para realizar una solicitud a nivel de la propiedad, la entidad debería ser, por ejemplo, "propiedades/123" si "123" es el ID de tu propiedad GA4. Para enviar una solicitud a nivel de la cuenta, la entidad debería ser, por ejemplo, "accounts/1234" si "1234" es el ID de tu cuenta de GA4.

dimensions[]

AccessDimension

Son las dimensiones solicitadas y que se muestran en la respuesta. Se permiten solicitudes con hasta 9 dimensiones.

metrics[]

AccessMetric

Las métricas solicitadas y que se muestran en la respuesta. Se permiten hasta 10 métricas de solicitud.

date_ranges[]

AccessDateRange

Períodos de los registros de acceso que se deben leer. Si se solicitan varios períodos, cada fila de respuesta contendrá un índice de período basado en cero. Si dos períodos se superponen, los registros de acceso de los días superpuestos se incluyen en las filas de respuesta de ambos períodos. Las solicitudes se permiten en un máximo de 2 períodos.

dimension_filter

AccessFilterExpression

Los filtros de dimensión te permiten restringir la respuesta del informe a valores de dimensión específicos que coincidan con el filtro. Por ejemplo, filtrar los registros de acceso de un solo usuario. Si deseas obtener más información, consulta ejemplos del artículo Aspectos básicos de los filtros de dimensión. No se pueden usar métricas en este filtro.

metric_filter

AccessFilterExpression

Los filtros de métricas te permiten restringir la respuesta del informe a valores de métricas específicos que coincidan con el filtro. Los filtros de métricas se aplican después de agregar las filas del informe, de manera similar a la cláusula de cláusula de SQL. No se pueden usar dimensiones en este filtro.

offset

int64

El recuento de filas de la fila de inicio. La primera fila se cuenta como la fila 0. Si no se especifica el desplazamiento, se trata como 0. Si el desplazamiento es cero, este método mostrará la primera página de resultados con entradas limit.

Para obtener más información sobre este parámetro de paginación, consulta Paginación.

limit

int64

Cantidad de filas que se mostrarán. Si no se especifica, se muestran 10,000 filas. La API devuelve un máximo de 100,000 filas por solicitud, sin importar cuántas tengas. limit debe ser positivo.

La API puede mostrar menos filas que la limit solicitada si no hay tantas filas restantes como la limit. Por ejemplo, hay menos de 300 valores posibles para la dimensión country. Por lo tanto, si genera informes solo de country, no podrá obtener más de 300 filas, incluso si establece limit en un valor más alto.

Para obtener más información sobre este parámetro de paginación, consulta Paginación.

time_zone

string

Zona horaria de esta solicitud, si se especifica. Si no se especifica, se usa la zona horaria de la propiedad. La zona horaria de la solicitud se utiliza para interpretar las fechas de inicio y finalización del informe.

Tienen formato como cadenas de la base de datos de zonas horarias de la IANA (https://www.iana.org/time-zones). Por ejemplo, "America/New_York" o "Asia/Tokyo".

order_bys[]

AccessOrderBy

Especifica cómo se ordenan las filas en la respuesta.

return_entity_quota

bool

Activa o desactiva si se muestra el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra en AccessQuota. Para solicitudes a nivel de la cuenta, este campo debe ser falso.

include_all_users

bool

Opcional. Determina si se deben incluir en la respuesta usuarios que nunca hayan realizado una llamada a la API. Si es verdadero, todos los usuarios con acceso a la propiedad o cuenta especificada se incluyen en la respuesta, independientemente de si realizaron o no una llamada a la API. Si es falso, solo se incluirán los usuarios que hayan realizado una llamada a la API.

expand_groups

bool

Opcional. Decide si se muestran los usuarios dentro de los grupos de usuarios. Este campo funciona solo cuando include_all_users está configurado como verdadero. Si es verdadero, se mostrarán todos los usuarios con acceso a la propiedad o cuenta especificadas. Si es falso, solo se mostrarán los usuarios con acceso directo.

RunAccessReportResponse

La respuesta personalizada del informe de registro de acceso a los datos.

Campos
dimension_headers[]

AccessDimensionHeader

Es el encabezado de una columna del informe que corresponde a una dimensión específica. La cantidad de DimensionHeaders y el orden de DimensionHeaders coinciden con las dimensiones presentes en las filas.

metric_headers[]

AccessMetricHeader

Es el encabezado de una columna del informe que corresponde a una métrica específica. La cantidad de MetricHeaders y el orden de los de MetricHeaders coinciden con las métricas presentes en las filas.

rows[]

AccessRow

Filas de combinaciones de valores de dimensiones y valores de métricas del informe.

row_count

int32

La cantidad total de filas en el resultado de la consulta. rowCount es independiente de la cantidad de filas que se muestran en la respuesta, los parámetros de solicitud limit y offset. Por ejemplo, si una consulta muestra 175 filas e incluye limit de 50 en la solicitud a la API, la respuesta contendrá rowCount de 175, pero solo 50 filas.

Para obtener más información sobre este parámetro de paginación, consulta Paginación.

quota

AccessQuota

Es el estado de la cuota de esta propiedad de Analytics que incluye esta solicitud. Este campo no funciona con solicitudes a nivel de la cuenta.

SearchChangeHistoryEventsRequest

Mensaje de solicitud para la RPC de SearchChangeHistoryEvents.

Campos
account

string

Obligatorio. El recurso de la cuenta para el que se muestran los recursos del historial de cambios. Formato: accounts/{account} Ejemplo: "accounts/100"

property

string

Opcional. El nombre de recurso de una propiedad secundaria. Si se configura, solo mostrará los cambios realizados en esta propiedad o en sus recursos secundarios. Formato: properties/{propertyId} Ejemplo: "properties/100"

resource_type[]

ChangeHistoryResourceType

Opcional. Si se configura, solo se mostrarán los cambios si corresponden a un recurso que coincide con al menos uno de estos tipos.

action[]

ActionType

Opcional. Si se configura, solo se mostrarán los cambios que coincidan con uno o más de estos tipos de acciones.

actor_email[]

string

Opcional. Si se configura, solo se mostrarán los cambios si los realizó un usuario de esta lista.

earliest_change_time

Timestamp

Opcional. Si se establece, solo se mostrarán los cambios realizados después de este período (inclusive).

latest_change_time

Timestamp

Opcional. Si se establece, solo se mostrarán los cambios realizados antes de esa fecha (inclusive).

page_size

int32

Opcional. La cantidad máxima de elementos de ChangeHistoryEvent que se mostrarán. Es posible que el servicio muestre menos que este valor, incluso si hay páginas adicionales. Si no se especifica, se mostrarán 50 elementos como máximo. El valor máximo es 200 (los valores más altos se forzarán al máximo).

page_token

string

Opcional. Un token de página, recibido desde una llamada SearchChangeHistoryEvents anterior. Proporciona esto para recuperar la página siguiente. Cuando se utiliza la paginación, todos los demás parámetros proporcionados a SearchChangeHistoryEvents deben coincidir con la llamada que proporcionó el token de la página.

SearchChangeHistoryEventsResponse

Mensaje de respuesta para la RPC de SearchCuentas.

Campos
change_history_events[]

ChangeHistoryEvent

Resultados a los que pudo acceder el emisor.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ServiceLevel

Varios niveles de servicio para Google Analytics.

Enumeradores
SERVICE_LEVEL_UNSPECIFIED Nivel de servicio no especificado o no válido.
GOOGLE_ANALYTICS_STANDARD Es la versión estándar de Google Analytics.
GOOGLE_ANALYTICS_360 Es la versión premium pagada de Google Analytics.

UpdateAccountRequest

Mensaje de solicitud para la RPC de UpdateAccount.

Campos
account

Account

Obligatorio. La cuenta que se actualizará. El campo name de la cuenta se usa para identificar la cuenta.

update_mask

FieldMask

Obligatorio. La lista de campos que se actualizará. Los nombres de los campos deben estar escritos con Snake case (por ejemplo, "field_to_update"). No se actualizarán los campos omitidos. Para reemplazar toda la entidad, utiliza una ruta de acceso con la string “*” para que coincidan todos los campos.

UpdateConversionEventRequest

Mensaje de solicitud para la RPC de UpdateConversionEvent

Campos
conversion_event

ConversionEvent

Obligatorio. El evento de conversión que se actualizará. El campo name se usa para identificar la configuración que se actualizará.

update_mask

FieldMask

Obligatorio. La lista de campos que se actualizará. Los nombres de los campos deben estar en snake case (p.ej., "campo_para_actualizar"). No se actualizarán los campos omitidos. Para reemplazar toda la entidad, utiliza una ruta de acceso con la string “*” para que coincidan todos los campos.

UpdateCustomDimensionRequest

Mensaje de solicitud para la RPC de UpdateCustomDimension.

Campos
custom_dimension

CustomDimension

La dimensión personalizada que se actualizará

update_mask

FieldMask

Obligatorio. La lista de campos que se actualizará. No se actualizarán los campos omitidos. Para reemplazar toda la entidad, utiliza una ruta de acceso con la string “*” para que coincidan todos los campos.

UpdateCustomMetricRequest

Mensaje de solicitud para la RPC de UpdateCustomMetric.

Campos
custom_metric

CustomMetric

La CustomMetric que se actualizará

update_mask

FieldMask

Obligatorio. La lista de campos que se actualizará. No se actualizarán los campos omitidos. Para reemplazar toda la entidad, utiliza una ruta de acceso con la string “*” para que coincidan todos los campos.

UpdateDataRetentionSettingsRequest

Mensaje de solicitud para la RPC de UpdateDataRetentionSettings.

Campos
data_retention_settings

DataRetentionSettings

Obligatorio. La configuración que se actualizará. El campo name se usa para identificar la configuración que se actualizará.

update_mask

FieldMask

Obligatorio. La lista de campos que se actualizará. Los nombres de los campos deben estar en snake case (p.ej., "campo_para_actualizar"). No se actualizarán los campos omitidos. Para reemplazar toda la entidad, utiliza una ruta de acceso con la string “*” para que coincidan todos los campos.

UpdateDataStreamRequest

Mensaje de solicitud para la RPC de UpdateDataStream.

Campos
data_stream

DataStream

El DataStream que se actualizará

update_mask

FieldMask

Obligatorio. La lista de campos que se actualizará. No se actualizarán los campos omitidos. Para reemplazar toda la entidad, utiliza una ruta de acceso con la string “*” para que coincidan todos los campos.

UpdateGoogleAdsLinkRequest

Mensaje de solicitud para la RPC de UpdateGoogleAdsLink

Campos
update_mask

FieldMask

Obligatorio. La lista de campos que se actualizará. Los nombres de los campos deben estar en snake case (p.ej., "campo_para_actualizar"). No se actualizarán los campos omitidos. Para reemplazar toda la entidad, utiliza una ruta de acceso con la string “*” para que coincidan todos los campos.

UpdateKeyEventRequest

Mensaje de solicitud para la RPC de UpdateKeyEvent

Campos
key_event

KeyEvent

Obligatorio. El evento clave que se actualizará. El campo name se usa para identificar la configuración que se actualizará.

update_mask

FieldMask

Obligatorio. La lista de campos que se actualizará. Los nombres de los campos deben estar en snake case (p.ej., "campo_para_actualizar"). No se actualizarán los campos omitidos. Para reemplazar toda la entidad, utiliza una ruta de acceso con la string “*” para que coincidan todos los campos.

UpdateMeasurementProtocolSecretRequest

Mensaje de solicitud para la RPC de UpdateMeasurementProtocolSecret

Campos
measurement_protocol_secret

MeasurementProtocolSecret

Obligatorio. El secreto del Protocolo de medición que se actualizará.

update_mask

FieldMask

Obligatorio. La lista de campos que se actualizará. No se actualizarán los campos omitidos.

UpdatePropertyRequest

Mensaje de solicitud para la RPC de UpdateProperty.

Campos
property

Property

Obligatorio. La propiedad que se actualizará. El campo name de la propiedad se usa para identificar la propiedad que se actualizará.

update_mask

FieldMask

Obligatorio. La lista de campos que se actualizará. Los nombres de los campos deben estar en snake case (p.ej., "campo_para_actualizar"). No se actualizarán los campos omitidos. Para reemplazar toda la entidad, utiliza una ruta de acceso con la string “*” para que coincidan todos los campos.