Sdílet prostřednictvím

Získání dat o výkonu reklamní kampaně

Tuto metodu můžete použít v rozhraní API pro analýzu Microsoft Storu k získání souhrnného souhrnu údajů o výkonu propagačních reklamních kampaní pro vaše aplikace během daného rozsahu kalendářních dat a dalších volitelných filtrů. Tato metoda vrátí data ve formátu JSON.

Tato metoda vrátí stejná data, která poskytuje sestava reklamní kampaně v Partner Center. Další informace o reklamních kampaních najdete v tématu Vytvoření reklamní kampaně pro vaši aplikaci.

K vytváření, aktualizaci nebo načítání podrobností reklamních kampaní můžete použít Spravovat reklamní kampaně metody v rozhraní API propagačních akcí v Microsoft Storu.

Požadavky

Pokud chcete použít tuto metodu, musíte nejprve provést následující:

  • Pokud jste to ještě neudělali, splňte všechny předpoklady pro Microsoft Store Analytics API.
  • Získejte přístupový token Azure AD a použijte ho v hlavičce požadavku pro tuto metodu. Po získání přístupového tokenu ho budete mít 60 minut, než vyprší jeho platnost. Po vypršení platnosti tokenu můžete získat nový.

Žádost

Syntaxe požadavku

Metoda Požadavek na URI
získej https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion

Hlavička požadavku

Záhlaví Typ Popis
Autorizace řetězec Povinné. Přístupový token Azure AD ve formátu Bearer<token>.

Parametry požadavku

Pokud chcete načíst údaje o výkonu reklamních kampaní pro konkrétní aplikaci, použijte parametr applicationId . Pokud chcete načíst údaje o výkonu reklam pro všechny aplikace, které jsou přidružené k vašemu vývojářskému účtu, vynecháte parametr applicationId .

Parametr Typ Popis Povinné
ID aplikace řetězec ID obchodu , aplikace, pro kterou chcete získat údaje o výkonu reklamní kampaně. Ne
Datum zahájení datum Počáteční datum v rozsahu dat o výkonu reklamní kampaně, které se mají načíst, ve formátu RRRR/MM/DD. Výchozí hodnota je aktuální datum minus 30 dnů. Ne
datum ukončení datum Koncové datum v rozsahu dat o výkonu reklamní kampaně, která se mají načíst, ve formátu RRRR/MM/DD. Výchozí hodnota je aktuální datum minus jeden den. Ne
vrchol int (integer) Počet řádků dat, které se mají v požadavku vrátit. Maximální hodnota a výchozí hodnota, pokud není zadána, je 1 0000. Pokud dotaz obsahuje více řádků, text odpovědi obsahuje další odkaz, který můžete použít k vyžádání další stránky dat. Ne
přeskočit int (integer) Počet řádků k přeskočení v dotazu. Pomocí tohoto parametru můžete procházet velké datové sady. Například top=100000 a skip=0 načte prvních 1 0000 řádků dat, top=10000 a skip=10000 načte dalších 1 0000 řádků dat atd. Ne
filtr řetězec Jeden nebo více příkazů, které filtrují řádky v odpovědi. Jediným podporovaným filtrem je campaignId. Každý příkaz může používat operátory eq nebo ne a příkazy lze kombinovat pomocí a nebo nebo. Tady je příklad parametru filtru: filter=campaignId eq '100023'. Ne
úroveň agregace řetězec Určuje časový rozsah, pro který se mají načítat agregovaná data. Může to být jeden z následujících řetězců: den, týden nebo měsíc. Pokud není zadáno, výchozí hodnota je . Ne
seřadit podle řetězec

Příkaz, který uspořádá hodnoty výsledných dat pro údaje o výkonu reklamní kampaně. Syntaxe je následující: orderby=field [order],field [order],.... Parametr pole může být jedním z následujících řetězců:

  • datum
  • ID kampaně

Parametr pořadí je volitelný a může být asc nebo desc k určení vzestupného nebo sestupného pořadí pro každé pole. Výchozí hodnota je asc.

Tady je příklad řetězce orderby: orderby=date,campaignId

 Ne
skupinování řetězec

Příkaz, který použije agregaci dat pouze na zadaná pole. Můžete zadat následující pole:

  • ID kampaně
  • ID aplikace
  • datum
  • kód měny

Parametr groupby lze použít s parametrem aggregationLevel . Příklad: &groupby=applicationId&aggregationLevel=week

 Ne

Požadavek příkladu

Následující příklad ukazuje několik požadavků na získání dat o výkonu reklamní kampaně.

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>

Odezva

Obsah odpovědi

Hodnota Typ Popis
Hodnota pole Pole objektů, které obsahují agregovaná data o výkonu reklamních kampaní. Další informace o datech v jednotlivých objektech najdete v objektu výkonu kampaně níže.
@nextLink řetězec Pokud jsou k dispozici další stránky dat, obsahuje tento řetězec identifikátor URI, který můžete použít k vyžádání další stránky dat. Tato hodnota se například vrátí, pokud je horní parametr požadavku nastavený na 5, ale dotaz obsahuje více než 5 položek dat.
Celkový počet int (integer) Celkový počet řádků ve výsledku dat dotazu.

Objekt výkonu kampaně

Prvky v poli Hodnota obsahují následující hodnoty.

Hodnota Typ Popis
datum řetězec První datum v rozsahu dat o výkonu reklamní kampaně. Pokud je v požadavku uveden jeden den, je tato hodnota tímto datem. Pokud požadavek zadal týden, měsíc nebo jiný rozsah kalendářních dat, je tato hodnota prvním datem v daném rozsahu dat.
ID aplikace řetězec ID aplikace ve Store, pro kterou načítáte údaje o výkonech reklamní kampaně.
ID kampaně řetězec ID reklamní kampaně.
lineId řetězec Identifikátor kampaně a řádku doručení, který generoval tato data o výkonu.
kód měny řetězec Kód měny rozpočtu kampaně.
strávit / utrácet (depending on context) řetězec Částka rozpočtu, která byla vynaložena na reklamní kampaň.
dojmy dlouhý Počet zobrazení reklam kampaně
instaluje dlouhý Počet instalací aplikací souvisejících s kampaní.
kliknutí dlouhý Počet kliknutí na reklamy pro kampaň
iapInstalls dlouhý Počet instalací doplňků (označovaných také jako nákup v aplikaci nebo IAP) souvisejících s kampaní.
aktivní uživatelé dlouhý Počet uživatelů, kteří klikli na reklamu, jež je součástí kampaně, a vrátili se do aplikace.

Příklad odpovědi

Následující příklad ukazuje příklad textu odpovědi JSON pro tento požadavek.

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