Method: properties.audienceLists.query

Ruft eine Zielgruppenliste mit Nutzern ab. Nachdem Sie eine Zielgruppe erstellt haben, sind die Nutzer nicht sofort für die Auflistung verfügbar. Zuerst ist eine Anfrage an audienceLists.create erforderlich, um eine Zielgruppenliste mit Nutzern zu erstellen. Anschließend wird diese Methode verwendet, um die Nutzer in der Zielgruppenliste abzurufen.

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

Mit Zielgruppen in Google Analytics 4 können Sie Ihre Nutzer so segmentieren, wie es für Ihr Unternehmen wichtig 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 Formular für Feedback 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 der Offset wird auf 0 gesetzt. Die erste Anfrage gibt die ersten limit Zeilen zurück. In der zweiten Anfrage wird der Offset auf limit der ersten Anfrage festgelegt. Die zweite Anfrage gibt die zweiten limit Zeilen zurück.

Weitere Informationen zu diesem Paginierungsparameter finden Sie unter Paginierung.
limit

string (int64 format)

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

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

Weitere Informationen zu diesem Paginierungsparameter 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 AudienceList. Wird zurückgegeben, um die Zielgruppenzeilen in dieser Antwort zu interpretieren. Die Dimensionen in dieser AudienceList entsprechen beispielsweise den Spalten in den AudienceRows.
rowCount

integer

Die Gesamtzahl der Zeilen im AudienceList-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 in der API-Anfrage limit von 50 enthalten ist, enthält die Antwort rowCount von 175, aber nur 50 Zeilen.

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

Attributwerte für die Dimension in der Nutzerzeile der Zielgruppe.

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

object (AudienceDimensionValue)

Jedes Attribut für den Dimensionswert eines Zielgruppennutzers. Für jede angeforderte Dimensionsspalte wird ein Dimensionswert hinzugefügt.

AudienceDimensionValue

Der Wert einer Dimension.

JSON-Darstellung 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string
  // End of mutually exclusive fields.
}
Felder
Eine Art von Dimensionswert. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
value

string

Wert als String, wenn der Dimensionstyp ein String ist.
Ende der sich gegenseitig ausschließenden Felder.