Method: properties.audienceLists.query

Ruft eine Zielgruppenliste mit Nutzern ab. Nutzer, die eine Zielgruppe erstellt haben, können nicht sofort aufgelistet werden. Zuerst ist eine Anfrage an audienceLists.create erforderlich, um eine Zielgruppenliste mit Nutzern zu erstellen, und dann wird diese Methode verwendet, um die Nutzer in der Zielgruppenliste abzurufen.

Eine Einführung in Zielgruppenlisten mit Beispielen finden Sie unter Zielgruppenlisten erstellen.

Mit Zielgruppen in Google Analytics 4 können Sie Ihre Nutzer so segmentieren, wie es für Sie 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 uns 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.

Beim Paging wird in der ersten Anfrage kein „offset“ angegeben oder entsprechend „offset“ auf 0. Die erste Anfrage gibt die erste limit der Zeilen zurück. Die zweite Anfrage legt „Offset“ auf den limit der ersten Anfrage fest. Die zweite Anfrage gibt die zweite limit der Zeilen zurück.

Weitere Informationen zu diesem Parameter finden Sie unter Paginierung.
limit

string (int64 format)

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

Die API kann auch weniger Zeilen als vom angeforderten limit zurückgeben, wenn nicht so viele Dimensionswerte wie limit vorhanden sind.

Weitere Informationen zu diesem Parameter finden Sie unter Paginierung.

Antworttext

Eine Liste der Nutzer 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 AudienceList Wird zurückgegeben, um die Interpretation der Zielgruppenzeilen in dieser Antwort zu erleichtern. Die Dimensionen in dieser AudienceList entsprechen beispielsweise den Spalten in AudienceRows.
rowCount

integer

Die Gesamtzahl der Zeilen im Zielgruppenlisten-Ergebnis. rowCount ist unabhängig von der Anzahl der in der Antwort zurückgegebenen Zeilen, dem Anfrageparameter limit und dem Anfrageparameter offset. Wenn eine Abfrage beispielsweise 175 Zeilen zurückgibt und die API-Anfrage für limit den Wert 50 enthält, enthält die Antwort rowCount von 175, aber nur 50 Zeilen.

Weitere Informationen zu diesem Parameter 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

Attribute für Dimensionswerte in der Zeile „Zielgruppe/Nutzer“

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

object (AudienceDimensionValue)

Jedes Dimensionswertattribut für eine Zielgruppe Für jede angeforderte Dimensionsspalte wird ein Dimensionswert hinzugefügt.

AudienceDimensionValue

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.