Method: properties.audienceLists.query

Ruft eine Zielgruppenliste mit Nutzern ab. Nach dem Erstellen einer Zielgruppe sind die Nutzer nicht sofort für die Liste verfügbar. Zuerst ist eine Anfrage an audienceLists.create erforderlich, um eine Zielgruppenliste mit Nutzern zu erstellen. Anschließend werden mit dieser Methode die Nutzer in der Zielgruppenliste abgerufen.

Im Hilfeartikel Zielgruppenliste erstellen finden Sie eine Einführung in Zielgruppenlisten mit Beispielen.

Mit Zielgruppen in Google Analytics 4 können Sie Ihre Nutzer so segmentieren, wie es für Ihr Unternehmen sinnvoll ist. Weitere Informationen finden Sie unter https://support.google.com/analytics/answer/9267572.

Diese Methode ist in der Betaversion unter audienceExports.query verfügbar. Wenn Sie Feedback zu dieser API geben möchten, füllen Sie bitte das Feedback-Formular zur Google Analytics Audience Export API aus.

HTTP-Anfrage

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Name der Zielgruppenliste, aus der Nutzer abgerufen werden sollen. Format: properties/{property}/audienceLists/{audienceList}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "offset": string,
  "limit": string
}
Felder
offset

string (int64 format)

Optional. Die Zeilenanzahl der Startzeile. Die erste Zeile wird als Zeile 0 gezählt.

Bei der Paginierung wird in der ersten Anfrage kein Offset angegeben oder der Offset wird auf 0 gesetzt. Die erste Anfrage gibt die ersten limit Zeilen zurück. Bei der zweiten Anfrage wird der Offset auf den limit der ersten Anfrage festgelegt. Die zweite Anfrage gibt die zweite limit von Zeilen zurück.

Weitere Informationen zu diesem Parameter für die Paginierung finden Sie unter Paginierung.
limit

string (int64 format)

Optional. Die Anzahl der zurückzugebenden Zeilen. Wenn keine Angabe gemacht wird, werden 10.000 Zeilen zurückgegeben. Die API gibt pro Anfrage maximal 250.000 Zeilen zurück,unabhängig davon, wie viele Sie anfordern. limit muss positiv sein.

Die API kann auch weniger Zeilen als die angeforderte limit zurückgeben, wenn es nicht so viele Dimensionswerte wie die limit gibt.

Weitere Informationen zu diesem Parameter für die Paginierung finden Sie unter Paginierung.

Antworttext

Eine Liste von Nutzern in einer Zielgruppenliste.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
Felder
audienceRows[]

object (AudienceRow)

Zeilen für jeden Nutzer in einer Zielgruppenliste. Die Anzahl der Zeilen in dieser Antwort ist kleiner oder gleich der Seitengröße der Anfrage.
audienceList

object (AudienceList)

Konfigurationsdaten zur abgefragten Zielgruppenliste. Wird zurückgegeben, um die Zeilen mit Zielgruppendaten in dieser Antwort zu interpretieren. Die Dimensionen in dieser Zielgruppenliste entsprechen beispielsweise den Spalten in den Zielgruppenzeilen.
rowCount

integer

Die Gesamtzahl der Zeilen im Ergebnis „Zielgruppenliste“. rowCount ist unabhängig von der Anzahl der Zeilen, die in der Antwort zurückgegeben werden, vom Anfrageparameter limit und vom Anfrageparameter offset. Wenn eine Abfrage beispielsweise 175 Zeilen zurückgibt und limit von 50 in der API-Anfrage enthält, enthält die Antwort rowCount von 175, aber nur 50 Zeilen.

Weitere Informationen zu diesem Parameter für die Paginierung finden Sie unter Paginierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

AudienceRow

Dimensionswertattribute für die Zeile „Zielgruppennutzer“.

JSON-Darstellung 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
Felder
dimensionValues[]

object (AudienceDimensionValue)

Jedes Dimensionswertattribut für einen Zielgruppennutzer. Für jede angeforderte Dimensionsspalte wird ein Dimensionswert hinzugefügt.

AudienceDimensionValue

Der Wert einer Dimension.

JSON-Darstellung 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
Felder
Union-Feld one_value. Eine Art von Dimensionswert. Für one_value ist nur einer der folgenden Werte zulässig:
value

string

Wert als String, wenn der Dimensionstyp ein String ist.