Cykliczne listy odbiorców

W tym dokumencie opisujemy powtarzające się listy odbiorców, które są zaawansowanej funkcji interfejsu Google Analytics Data API w wersji 1. Wprowadzenie do funkcji eksportowania listy odbiorców: przeczytaj podstawowe informacje o eksportowaniu list odbiorców.

Cykliczne listy odbiorców codziennie generują listy odbiorców, informacje o członkostwie na liście odbiorców zmieniają się, aby mieć pewność, że korzystasz z najnowszych danych.

Zwykłe (niecykliczne) listy odbiorców to statyczne listy użytkowników z danej listy odbiorców w momencie generowania listy.

Codziennie twórz nową listę odbiorców

Przetworzenie danych o odbiorcach z jednego dnia i ich aktualizacja subskrypcji. Nie można się upewnić, że dane listy odbiorców zostały zaktualizowane w 24 godziny.

Na przykład nawet jeśli wysyłasz prośbę o listę odbiorców codziennie o tej samej godzinie, w niektórych dniach lista odbiorców będzie taka sama tak jak w poprzednim dniu, a w inne dni lista odbiorców będzie inna. może obejmować dodatkowy dzień zmian członkostwa.

Codziennie tworzę nową listę odbiorców

Listy odbiorców powstają na podstawie danych zdarzeń sprzed ostatniego dnia zmiany dotyczące subskrypcji. Jeśli utworzysz listę odbiorców przed rozpoczęciem codziennego wspierania po aktualizacji, system użyje danych sprzed dwóch dni. Jeśli utworzysz po codziennej aktualizacji listy odbiorców, użyje danych z wczoraj.

Okresowe sondowanie cyklicznej listy odbiorców

Cykliczne listy odbiorców tworzą listy odbiorców tylko wtedy, gdy jest następny dzień i danych. Dzięki temu nie trzeba zgadywać, kiedy tworzyć nowe Listy odbiorców. Zamiast tego możesz tanio przeprowadzać ankietę na cyklicznej liście odbiorców w ciągu dnia, aby sprawdzić, czy są dostępne dodatkowe dane.

okresowe przeprowadzanie w ciągu dnia sondowania cyklicznej listy odbiorców;

Tworzenie cyklicznej listy odbiorców

Aby utworzyć cykliczną listę odbiorców, wywołaj funkcję recurringAudienceLists.create za pomocą funkcji RecurringAudienceList do wybranego obiektu w żądaniu. Wymagane są te parametry:

  • Prawidłowa nazwa listy odbiorców w audience w formacie properties/{propertyId}/audiences/{audienceId}. Za pomocą audiences.list interfejsu Google Analytics Admin API w wersji 1. Audience.name pole odpowiedzi audiences.list zawiera nazwę listy odbiorców.
  • Prawidłową listę wymiarów w funkcji dimensions . Listę wymiarów obsługiwanych przez tę metodę znajdziesz w Dokumentacja schematu eksportu odbiorców. Dane dotyczą tylko wymiarów wymienionych w tym polu. Lista odbiorców.

Oto przykładowe cykliczne żądanie utworzenia listy odbiorców:

Żądanie HTTP

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

Odpowiedź metody recurringAudienceLists.create zawiera nazwę w polu name (np. properties/1234567/recurringAudienceLists/123), których można użyć w kolejnych zapytań pobierających metadane konfiguracji. dla tej cyklicznej listy odbiorców. Dodatkowo metadane konfiguracji zawierają nazwy zasobów instancji z listą odbiorców utworzona dla tej cyklicznej listy odbiorców.

Odpowiedź HTTP

{
  "name": "properties/1234567/recurringAudienceLists/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "activeDaysRemaining": 180,
  "audienceLists": [
    "properties/1234567/audienceLists/45678"
  ]
}

Metadane konfiguracji ankiety

Użyj recurringAudienceLists.get do pobierania metadanych konfiguracji dotyczących określonego cykliczną listę odbiorców. Metadane konfiguracji zawierają nazwy zasobów instancji z listą odbiorców utworzona dla tej cyklicznej listy odbiorców.

Oto przykład:

Żądanie HTTP

GET https://analyticsdata.googleapis.com/v1alpha/properties/1234567/recurringAudienceLists/123

Wystąpienie RecurringAudienceList . Zawiera on metadane konfiguracji, które obejmują nazwy zasobów instancji z listą odbiorców utworzona dla tej cyklicznej listy odbiorców.

Odpowiedź HTTP

{
  "name": "properties/1234567/recurringAudienceLists/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "activeDaysRemaining": 180,
  "audienceLists": [
    "properties/1234567/audienceLists/45678"
  ]
}

Za pomocą recurringAudienceLists.list aby wyświetlić listę wszystkich cyklicznych list odbiorców w danej usłudze.

Używanie webhooków do otrzymywania asynchronicznych powiadomień o nowych listach odbiorców

Zamiast okresowo odpytywać metadane konfiguracji dotyczące określonego cykliczną listę odbiorców za pomocą recurringAudienceLists.get umożliwia asynchroniczne otrzymywanie powiadomień webhooka, gdy odbiorcy .

Aby skonfigurować powiadomienia webhooka, określ webhookNotification podczas tworzenia nowej cyklicznej listy odbiorców.

Postępuj zgodnie z przewodnikiem po Async audience lists with webhooks znajdziesz więcej informacji o korzystaniu z webhooków w interfejsie Google Analytics Data API w wersji 1.

Pobieranie użytkowników z eksportu list odbiorców

Aby pobrać listę użytkowników z eksportu list odbiorców, wywołaj metodę audienceExports.query i podaj nazwę eksportu listy odbiorców, pobrane z metadanych konfiguracji dostarczonych przez recurringAudienceLists.get lub recurringAudienceLists.list.

Żądanie HTTP

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

Jeśli eksport odbiorców jest gotowy, odpowiedź zawierająca listę użytkownicy z listy odbiorców są zwracane:

Odpowiedź HTTP

{
  "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
}