- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- AudienceCompositionSection
- AudienceCompositionAttribute.
- AudienceCompositionMetrics
- AudienceCompositionAttributeCluster
- Pruébala
Muestra una colección de atributos representados en un público de interés, con métricas que comparan la proporción de cada atributo del público con la correspondiente a un público de referencia.
Lista de errores arrojados: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError
Solicitud HTTP
POST https://googleads.googleapis.com/v16/customers/{customerId}:generateAudienceCompositionInsights
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
customerId |
Obligatorio. El ID del cliente. |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "audience": { object ( |
Campos | |
---|---|
audience |
Obligatorio. Es el público de interés para el que se solicitan estadísticas. |
baselineAudience |
Es el público de referencia con el que se compara el público de interés. |
dataMonth |
Es el rango de datos históricos de un mes que se usará para las estadísticas, en el formato "aaaa-mm". Si no la estableces, se mostrarán estadísticas de los últimos treinta días. |
dimensions[] |
Obligatorio. Las dimensiones de público para las que se deben mostrar las estadísticas de composición |
customerInsightsGroup |
Es el nombre del cliente para el que se planifica. Este es un valor definido por el usuario. |
Cuerpo de la respuesta
Mensaje de respuesta para AudienceInsightsService.GenerateAudienceCompositionInsights
.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"sections": [
{
object ( |
Campos | |
---|---|
sections[] |
Los contenidos del informe de estadísticas organizados en secciones. Cada sección está asociada con uno de los valores de AudienceInsightsDimension de la solicitud. Puede haber más de una sección por dimensión. |
Permisos de autorización
Requiere el siguiente alcance de OAuth:
https://www.googleapis.com/auth/adwords
Para obtener más información, consulta la Descripción general de OAuth 2.0.
AudienceCompositionSection
Es una colección de atributos relacionados del mismo tipo en un informe de estadísticas de composición del público.
Representación JSON |
---|
{ "dimension": enum ( |
Campos | |
---|---|
dimension |
El tipo de atributos en esta sección. |
topAttributes[] |
Son los segmentos más relevantes para este público. Si la dimensión es GENDER, AGE_RANGE o PARENTAL_STATUS, esta lista de atributos es exhaustiva. |
clusteredAttributes[] |
Atributos adicionales para este público, agrupados en clústeres. Solo se completa si la dimensión es YOUTUBE_CHANNEL. |
AudienceCompositionAttribute
Un atributo de público con metadatos y métricas
Representación JSON |
---|
{ "attributeMetadata": { object ( |
Campos | |
---|---|
attributeMetadata |
El atributo y sus metadatos. |
metrics |
Comparte y, luego, indexa las métricas del atributo. |
AudienceCompositionMetrics
Son las métricas de índice y porcentaje asociadas con un atributo de un informe de estadísticas de composición del público.
Representación JSON |
---|
{ "baselineAudienceShare": number, "audienceShare": number, "index": number, "score": number } |
Campos | |
---|---|
baselineAudienceShare |
Es la fracción (de 0 a 1 inclusive) del público de referencia que coincide con el atributo. |
audienceShare |
Es la fracción (de 0 a 1 inclusive) del público específico que coincide con el atributo. |
index |
Es la proporción entre el público compartido con el valor baselineAudienceShare, o bien en cero si esta proporción no está definida o no es significativa. |
score |
Una puntuación de relevancia de 0 a 1 inclusive. |
AudienceCompositionAttributeCluster
Una colección de atributos relacionados, con metadatos y métricas, en un informe de estadísticas de composición del público.
Representación JSON |
---|
{ "clusterDisplayName": string, "clusterMetrics": { object ( |
Campos | |
---|---|
clusterDisplayName |
El nombre de este clúster de atributos |
clusterMetrics |
Si la dimensión asociada con este clúster es YOUTUBE_CHANNEL, clusterMetrics son métricas asociadas con el clúster en su totalidad. Para las demás dimensiones, este campo no está establecido. |
attributes[] |
Los atributos individuales que conforman este clúster, con metadatos y métricas. |