Creare un'esportazione dei segmenti di pubblico

I segmenti di pubblico in Google Analytics ti permettono di suddividere gli utenti in base agli obiettivi più importanti per la tua attività. Con i segmenti di pubblico, puoi raggruppare gli utenti del tuo sito o della tua applicazione in base ad attributi condivisi.

Puoi esportare i segmenti di pubblico, inclusa un'istantanea dei relativi utenti, utilizzando l'API Data.

Consulta la guida Aspettative relative ai dati di esportazione dei segmenti di pubblico per informazioni importanti sui dati visualizzati nelle esportazioni dei segmenti di pubblico.

Panoramica

Invia le seguenti richieste API di dati per creare ed eseguire query su un'esportazione del segmento di pubblico:

1. Chiama il metodo audienceExports.create per creare un'esportazione del segmento di pubblico.
2. Chiama il metodo audienceExports.query per recuperare gli utenti nel segmento di pubblico.

Per saperne di più, puoi chiamare audienceExports.get per recuperare i metadati di configurazione relativi a un'esportazione del segmento di pubblico specifica e audienceExports.list per elencare tutte le esportazioni dei segmenti di pubblico per una proprietà specifica.

Seleziona un'entità di reporting

Tutti i metodi dell'API di dati richiedono che l'identificatore della proprietà Google Analytics sia specificato all'interno di un percorso di richiesta dell'URL, nel formato properties/GA_PROPERTY_ID. Ecco un esempio:

  POST  https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/audienceExports

Il report viene generato in base ai dati sugli eventi di Google Analytics raccolti nella proprietà Google Analytics specificata.

Se utilizzi una delle librerie client dell'API di dati, non devi modificare il percorso dell'URL della richiesta. La maggior parte dei client API fornisce un parametro property che prevede una stringa nel formato properties/GA_PROPERTY_ID. Consulta la guida rapida per esempi di utilizzo delle librerie client.

Crea un'esportazione dei segmenti di pubblico

Per creare un'esportazione del segmento di pubblico, chiama il metodo audienceExports.create utilizzando l'oggetto AudienceExport nella richiesta. I seguenti parametri sono obbligatori:

• Un nome di pubblico valido nel campo audience, formattato come properties/{propertyId}/audiences/{audienceId}. Puoi utilizzare il metodo audiences.list dell'API Google Analytics Admin v1 per ottenere questo valore. Il campo Audience.name della risposta audiences.list contiene il nome del segmento di pubblico.
• Un elenco valido di dimensioni nel campo dimensions. L'elenco delle dimensioni supportate da questo metodo è disponibile nella documentazione relativa allo schema di esportazione dei segmenti di pubblico. Solo i dati relativi alle dimensioni menzionate in questo campo vengono inclusi in un'esportazione del segmento di pubblico.

Di seguito è riportata una richiesta di esempio per creare un'esportazione del segmento di pubblico:

POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports
{
  "audience": "properties/1234567/audiences/12345",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ]
}

Una risposta del metodo audienceExports.create contiene il nome dell'esportazione del segmento di pubblico nel campo name, ad esempio properties/1234567/audienceExports/123. Ecco un esempio di risposta:

{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.AudienceExport",
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "CREATING",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  }
}

Puoi utilizzare name per eseguire query sugli utenti dall'esportazione del segmento di pubblico.

Esegui una query sullo stato di idoneità dell'esportazione dei segmenti di pubblico

La generazione dell'esportazione del segmento di pubblico potrebbe richiedere alcuni minuti dopo la chiamata audienceExports.create.

Puoi controllare lo stato di idoneità di un'esportazione del pubblico chiamando il metodo audienceExports.get.

Utilizza il nome dell'esportazione del segmento di pubblico di una risposta audienceExports.create per specificare l'esportazione del segmento di pubblico nella richiesta.

Ecco una richiesta di esempio:

GET https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123

Lo stato di idoneità per un'esportazione del segmento di pubblico viene restituito nel campo state della risposta. Una volta completata la generazione dell'esportazione del segmento di pubblico, lo stato cambia da CREATING a ACTIVE.

Ecco un esempio di risposta:

{
  "name": "properties/1234567/audienceExports/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "state": "CREATING",
  "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
}

Puoi ottenere lo stato di tutte le esportazioni dei segmenti di pubblico chiamando il metodo audienceExports.list.

Recupera gli utenti da un'esportazione dei segmenti di pubblico

Una volta generata l'esportazione del segmento di pubblico, chiama il metodo audienceExports.query e specifica il name dell'esportazione del segmento di pubblico nella richiesta.

Ecco una richiesta di esempio:

POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123:query

Se l'esportazione del segmento di pubblico è pronta, questa chiamata restituisce l'elenco degli utenti nel segmento di pubblico.

Ecco un esempio di risposta:

{
  "audienceExport": {
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "ACTIVE",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  },
  "audienceRows": [
    {
      "dimensionValues": [
        {
          "value": "1000276123.1681742376"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000374452.1668627377"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000391956.1652750758"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000410539.1682018694"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000703969.1666725875"
        }
      ]
    }
  ],
  "rowCount": 5
}