Udostępnij przez

Pobieranie danych dotyczących wydajności kampanii reklamowej

Użyj tej metody w interfejsie API analizy sklepu Microsoft Store, aby uzyskać zagregowane podsumowanie danych wydajności kampanii reklamowej promocyjnej dla aplikacji w danym zakresie dat i innych opcjonalnych filtrach. Ta metoda zwraca dane w formacie JSON.

Ta metoda zwraca te same dane, które są dostarczane przez raport kampanii reklamowych w Centrum Partnerskim. Aby uzyskać więcej informacji na temat kampanii reklamowych, zobacz Tworzenie kampanii reklamowej dla aplikacji.

Aby utworzyć, zaktualizować lub pobrać szczegóły kampanii reklamowych, możesz użyć zarządzanie kampaniami reklamowymi metod w interfejsie API promocji Microsoft Store.

Wymagania wstępne

Aby użyć tej metody, należy najpierw wykonać następujące czynności:

  • Jeśli jeszcze tego nie zrobiłeś, wykonaj wszystkie wymagania wstępne i dla API analizy Microsoft Store.
  • Uzyskaj token dostępu usługi Azure AD do użycia w nagłówku żądania dla tej metody. Po uzyskaniu tokenu dostępu należy 60 minut używać go przed jego wygaśnięciem. Po wygaśnięciu tokenu można uzyskać nowy.

Żądanie

Składnia żądania

Metoda Żądanie URI
POBIERZ https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion

Nagłówek żądania

Nagłówek Typ Opis
Autoryzacja sznurek To jest wymagane. Token dostępu usługi Azure AD w postaci tokenu typu Bearer <>.

Parametry żądania

Aby pobrać dane wydajności kampanii reklamowej dla określonej aplikacji, użyj parametru applicationId. Aby pobrać dane wydajności reklam dla wszystkich aplikacji skojarzonych z kontem dewelopera, pomiń parametr applicationId.

Parametr Typ Opis Wymagane
applicationId (identyfikator aplikacji) sznurek Identyfikator sklepu aplikacji, dla której chcesz pobrać dane dotyczące wydajności kampanii reklamowej. Nie.
data rozpoczęcia termin Data rozpoczęcia zakresu dat do pobrania danych dotyczących wydajności kampanii reklamowej w formacie RRRR/MM/DD. Wartość domyślna to bieżąca data minus 30 dni. Nie.
data zakończenia termin Data zakończenia w zakresie dat pobierania danych dotyczących wydajności kampanii reklamowej w formacie RRRR/MM/DD. Wartość domyślna to bieżąca data minus jeden dzień. Nie.
Do góry int (integer) Liczba wierszy danych, które należy zwrócić w żądaniu. Wartość maksymalna i wartość domyślna, jeśli nie zostanie określona, to 10000. Jeśli w zapytaniu znajduje się więcej wierszy, treść odpowiedzi zawiera następny link, którego można użyć do żądania następnej strony danych. Nie.
pominąć int (integer) Liczba wierszy do pominięcia w zapytaniu. Użyj tego parametru, aby przeglądać duże zestawy danych. Na przykład top=10000 i skip=0 pobiera pierwsze 10000 wierszy danych, top=10000 i skip=10000 pobiera następne 10000 wierszy danych itd. Nie.
filtr sznurek Jedno lub więcej wyrażeń, które filtrują wiersze w odpowiedzi. Jedynym obsługiwanym filtrem jest campaignId. Każda instrukcja może używać operatorów eq lub ne, a instrukcje można łączyć przy użyciu i lub lub. Oto przykład filtru parametru: filter=campaignId eq '100023'. Nie.
poziom agregacji sznurek Określa zakres czasu, dla którego mają być pobierane agregowane dane. Może być jednym z następujących ciągów: dzień, tydzień lub miesiąc. Jeśli jest to nieokreślone, wartość domyślna to dzień. Nie.
sortowanie według sznurek

Instrukcja, która porządkuje wartości danych wyników dla danych wydajności kampanii reklamowej. Składnia to orderby=field [order],field [order],.... Parametr field może być jednym z następujących ciągów:

  • daty
  • Id kampanii

Parametr order jest opcjonalny i może być asc lub desc w celu określenia kolejności rosnącej lub malejącej dla każdego pola. Wartość domyślna to asc.

Oto przykładowy ciąg znaków orderby: orderby=date,campaignId

 Nie.
grupowanie sznurek

Instrukcja, która stosuje agregację danych tylko do określonych pól. Możesz określić następujące pola:

  • Id kampanii
  • applicationId (identyfikator aplikacji)
  • daty
  • kod waluty

Parametr groupby może być używany z parametrem aggregationLevel . Na przykład: &groupby=applicationId&aggregationLevel=week

 Nie.

Przykład zapytania

W poniższym przykładzie pokazano kilka żądań uzyskania danych dotyczących wydajności kampanii reklamowej.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?aggregationLevel=week&groupby=applicationId,campaignId,date  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?applicationId=9NBLGGH0XK8Z&startDate=2015/1/20&endDate=2016/8/31&skip=0&filter=campaignId eq '31007388' HTTP/1.1
Authorization: Bearer <your access token>

Odpowiedź

Ciało odpowiedzi

Wartość Typ Opis
Wartość układ Tablica obiektów zawierających zagregowane dane wydajności kampanii reklamowej. Aby uzyskać więcej informacji na temat danych w każdym obiekcie, zobacz sekcję obiektu wydajności kampanii poniżej.
@nextLink sznurek Jeśli istnieją dodatkowe strony danych, ten ciąg zawiera identyfikator URI, którego można użyć do żądania następnej strony danych. Na przykład ta wartość jest zwracana, jeśli główny parametr żądania jest ustawiony na 5, ale dla zapytania dostępnych jest więcej niż 5 elementów danych.
Łączna liczba int (integer) Całkowita liczba wierszy w wyniku danych dla zapytania.

Obiekt wyników kampanii

Elementy w tablicy Value zawierają następujące wartości.

Wartość Typ Opis
termin sznurek Pierwsza data z zakresu dat dotyczących danych o wydajności kampanii reklamowej. Jeśli żądanie określiło jeden dzień, ta wartość to ta data. Jeśli w żądaniu określono tydzień, miesiąc lub inny zakres dat, ta wartość jest pierwszą datą w tym zakresie dat.
applicationId (identyfikator aplikacji) sznurek Identyfikator sklepu aplikacji, dla której pobierasz dane wydajności kampanii reklamowej.
identyfikator kampanii sznurek Identyfikator kampanii reklamowej.
lineId sznurek Identyfikator linii dostarczania kampanii reklamowej , która wygenerowała te dane dotyczące wydajności.
kod waluty sznurek Kod waluty budżetu kampanii.
spędzać sznurek Kwota budżetowa wydana na kampanię reklamową.
Wrażenia długi Liczba wyświetleń reklam dla kampanii.
Instaluje długi Liczba instalacji aplikacji związanych z kampanią.
Kliknięć długi Liczba kliknięć reklam dla kampanii.
iapInstalls długi Liczba instalacji dodatków (nazywanych również zakupem w aplikacji lub IAP) związanych z kampanią.
aktywni użytkownicy długi Liczba użytkowników, którzy klikili reklamę, która jest częścią kampanii i wróciła do aplikacji.

Przykład odpowiedzi

W poniższym przykładzie pokazano przykładową treść odpowiedzi JSON dla tego żądania.

{
  "Value": [
    {
      "date": "2015-04-12",
      "applicationId": "9WZDNCRFJ31Q",
      "campaignId": "4568",
      "lineId": "0001",
      "currencyCode": "USD",
      "spend": 700.6,
      "impressions": 200,
      "installs": 30,
      "clicks": 8,
      "iapInstalls": 0,
      "activeUsers": 0
    },
    {
      "date": "2015-05-12",
      "applicationId": "9WZDNCRFJ31Q",
      "campaignId": "1234",
      "lineId": "0002",
      "currencyCode": "USD",
      "spend": 325.3,
      "impressions": 20,
      "installs": 2,
      "clicks": 5,
      "iapInstalls": 0,
      "activeUsers": 0
    }
  ],
  "@nextLink": "promotion?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/1/20&endDate=2016/8/31&top=2&skip=2",
  "TotalCount": 1917
}
  • Last updated on