Method: properties.audienceLists.query

Ruft eine Zielgruppenliste mit Nutzern ab. Nachdem eine Zielgruppe erstellt wurde, können die Nutzer nicht sofort Einträge erstellt werden. Zum Erstellen einer Zielgruppenliste mit Nutzern ist zuerst eine Anfrage an audienceLists.create erforderlich. Anschließend werden mit dieser Methode die Nutzer in der Zielgruppenliste abgerufen.

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 Ihr Unternehmen wichtig ist. Weitere Informationen finden Sie unter https://support.google.com/analytics/answer/9267572.

Diese Methode ist in der Beta-Stabilität unter audienceExports.query verfügbar. Wenn Sie Feedback zu dieser API geben möchten, füllen Sie das Formular 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 mit der ersten Anfrage kein Offset angegeben. oder entsprechend setzt Offset auf 0; Die erste Anfrage gibt die ersten limit der Zeilen zurück. Die zweite Anfrage legt einen Offset auf den limit der ersten Anfrage fest. Die zweite Anfrage gibt die zweiten limit der 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 Zeilen angefordert werden. limit muss positiv sein.

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

Weitere Informationen zu diesem Paginierungsparameter 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 für die abgefragte Zielgruppenliste. Wird zurückgegeben, um die Zielgruppenzeilen in dieser Antwort zu interpretieren. Beispielsweise entsprechen die Dimensionen in dieser "Zielgruppenliste" 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 sowie den Anfrageparametern limit und offset. Wenn eine Abfrage beispielsweise 175 Zeilen zurückgibt und limit von 50 in die API-Anfrage einschließt, enthält die Antwort rowCount von 175 Zeilen, 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

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.