Pobieranie elementów wiersza komercyjnego użycia nierozliczonego na fakturze

Artykuł
04/26/2024

Uwaga

Po 30 września 2024 r. ten interfejs API nie będzie już działać. Skorzystaj z informacji, aby wybrać swoją wersję i zaplanować z wyprzedzeniem.

Aby uzyskać dostęp do nierozliczonych szczegółów dziennego użycia dla bieżących i poprzednich okresów rozliczeniowych, użyj tego interfejsu API. Można go użyć do 30 września 2024 r., chyba że przejdziesz do wersji 2 ogólnie dostępnej przed tą datą.
Aby uzyskać niezliczone dzienne użycie dla bieżących i poprzednich okresów, przejdź do interfejsu API w wersji 2 ogólnie dostępnej do 30 września 2024 r.

W przypadku kroków migracji interfejsu API w wersji 2 przejdź do:

Rozliczane i nienaliczone dzienne interfejs API uzgodnień użycia w wersji 2 (GA)

Jak uzyskać kolekcję nierozliczonych szczegółów elementu wiersza użycia komercyjnego.

Za pomocą poniższych metod można programowo pobrać kolekcję nienaliczonych elementów wiersza użycia komercyjnego (nazywanych również otwartymi elementami wiersza użycia).

Ważne

Dane dziennego użycia nie obejmują opłat za te produkty:

Rezerwacja platformy Azure
Plan oszczędnościowy Azure
Office
Dynamics
Microsoft Power Apps
Oprogramowanie bezterminowe
Subskrypcja oprogramowania
Produkt SaaS z witryny Marketplace

Uwaga

Dzienne dane użycia niezbillowane można pobrać za pośrednictwem interfejsu API lub portalu Centrum partnerskiego. Udostępnienie danych może potrwać do 24 godzin. Jednak mogą wystąpić dalsze opóźnienia w zależności od lokalizacji i kiedy mierniki zgłaszają użycie.

Czasami może nie być widocznych najnowszych, niezaliczonych danych użycia do momentu dostarczenia rozliczanych danych użycia w poprzednim miesiącu. Jest to wykonywane w celu zapewnienia, że rozliczane dane użycia są dostarczane w uzgodnionym czasie. Po otrzymaniu rozliczanych danych użycia powinno być możliwe pobranie wszystkich zaktualizowanych, niezmierowanych danych użycia od początku miesiąca.

Wymagania wstępne

Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje uwierzytelnianie zarówno przy użyciu autonomicznych poświadczeń aplikacji, jak i aplikacji i użytkownika.

C#

Aby pobrać elementy wiersza dla określonej faktury:

Wywołaj metodę ById , aby pobrać interfejs do operacji na fakturze dla określonej faktury.
Wywołaj metodę Get lub GetAsync , aby pobrać obiekt faktury.

Obiekt faktury zawiera wszystkie informacje dotyczące określonej faktury. Dostawca identyfikuje źródło nierozliczonych informacji szczegółowych (na przykład OneTime). Parametr InvoiceLineItemType określa typ (na przykład UsageLineItem).

Poniższy przykładowy kod używa pętli foreach do przetwarzania kolekcji InvoiceLineItems . Dla każdego elementu InvoiceLineItemType jest pobierana oddzielna kolekcja elementów wiersza.

Aby uzyskać kolekcję elementów wiersza odpowiadających wystąpieniu InvoiceDetail :

Przekaż element BillingProvider i InvoiceLineItemType wystąpienia do metody By.
Wywołaj metodę Get lub GetAsync , aby pobrać skojarzone elementy wiersza.
Utwórz moduł wyliczający, aby przejść przez kolekcję, jak pokazano w poniższym przykładzie.

// IAggregatePartner partnerOperations;
// string curencyCode;
// string period;
// int pageMaxSizeReconLineItems = 2000;

// all the operations executed on this partner operation instance will share the same correlation Id but will differ in request Id
IPartner scopedPartnerOperations = partnerOperations.With(RequestContextFactory.Instance.Create(Guid.NewGuid()));

var seekBasedResourceCollection = scopedPartnerOperations.Invoices.ById("unbilled").By("onetime", "usagelineitems", curencyCode, period, pageMaxSizeReconLineItems).Get();

var fetchNext = true;

ConsoleKeyInfo keyInfo;

var itemNumber = 1;
while (fetchNext)
{
    Console.Out.WriteLine("\tLine items count: " + seekBasedResourceCollection.Items.Count());

    seekBasedResourceCollection.Items.ToList().ForEach(item =>
    {
        // Instance of type DailyRatedUsageLineItem
        if (item is DailyRatedUsageLineItem)
        {
            Type t = typeof(DailyRatedUsageLineItem);
            PropertyInfo[] properties = t.GetProperties();

            foreach (PropertyInfo property in properties)
            {
                // Insert code here to work with the line item properties
            }
        }
        itemNumber++;
    });

    Console.Out.WriteLine("\tPress any key to fetch next data. Press the Escape (Esc) key to quit: \n");
    keyInfo = Console.ReadKey();

    if (keyInfo.Key == ConsoleKey.Escape)
    {
        break;
    }

    fetchNext = !string.IsNullOrWhiteSpace(seekBasedResourceCollection.ContinuationToken);

    if (fetchNext)
    {
        if (seekBasedResourceCollection.Links.Next.Headers != null && seekBasedResourceCollection.Links.Next.Headers.Any())
        {
            seekBasedResourceCollection = scopedPartnerOperations.Invoices.ById("unbilled").By("onetime", "usagelineitems", curencyCode, period, pageMaxSizeReconLineItems).Seek(seekBasedResourceCollection.ContinuationToken, SeekOperation.Next);
        }
    }
}

Aby zapoznać się z podobnym przykładem, zobacz:

Przykład: aplikacja testowa konsoli
Projekt: Przykłady zestawu SDK Centrum partnerskiego
Klasa: GetUnBilledConsumptionReconLineItemsPaging.cs

Żądanie REST

Składnia żądania

W zależności od przypadku użycia można użyć następujących składni dla żądania REST. Aby uzyskać więcej informacji, zobacz opisy każdej składni.

Method	Identyfikator URI żądania	Opis przypadku użycia składni
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period} HTTP/1.1	Użyj tej składni, aby zwrócić pełną listę każdego elementu wiersza dla danej faktury.
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period}&size={size} HTTP/1.1	Użyj tej składni dla dużych faktur. Użyj tej składni z określonym rozmiarem i przesunięciem opartym na 0, aby zwrócić stronicową listę elementów wiersza.
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period}&size={size}&seekOperation=Next	Użyj tej składni, aby uzyskać następną stronę elementów wiersza uzgodnień przy użyciu polecenia `seekOperation = "Next"`.

Parametry identyfikatora URI

Podczas tworzenia żądania użyj następującego identyfikatora URI i parametrów zapytania.

Nazwisko	Type	Wymagania	opis
dostawca	string	Tak	Dostawca: "OneTime".
typ elementu faktury	string	Tak	Typ szczegółów faktury: "UsageLineItems", "UsageLineItems".
currencyCode	string	Tak	Kod waluty dla niezaliczonych elementów wiersza.
Okres	string	Tak	Okres dla nierozliczonych recon (na przykład: current, previous). Załóżmy, że w styczniu musisz wykonać zapytanie dotyczące niezbilonych danych użycia cyklu rozliczeniowego (01/01/2020 – 01/31/2020) w styczniu wybierz okres jako "Bieżący" , w przeciwnym razie "Poprzedni".
size	numer	Nie.	Maksymalna liczba elementów do zwrócenia. Domyślny rozmiar to 2000.
seekOperation	string	Nie	Ustaw `seekOperation=Next` pozycję , aby pobrać następną stronę elementów wiersza uzgodnień.

Nagłówki żądań

Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.

Treść żądania

Brak.

Odpowiedź REST

W przypadku powodzenia odpowiedź zawiera kolekcję szczegółów elementu wiersza.

W przypadku elementu wiersza ChargeType wartość Zakup jest mapowana na nowy , a wartość Zwrot jest mapowany na Anuluj.

Kody powodzenia i błędów odpowiedzi

Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i inne informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i inne parametry. Aby uzyskać pełną listę, zobacz Kody błędów REST Centrum partnerskiego.

Przykłady odpowiedzi na żądanie

Przykład odpowiedzi na żądanie 1

Poniższe szczegóły dotyczą tego przykładu:

Dostawca: OneTime
InvoiceLineItemType: UsageLineItems
Okres: poprzedni

Przykład żądania 1

GET https://api.partnercenter.microsoft.com/v1//invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems&currencycode=usd&period=previous&size=2000 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 1234ecb8-37af-45f4-a1a1-358de3ca2b9e
MS-CorrelationId: 5e612512-4345-4bb0-866e-47aeda031234
X-Locale: en-US
MS-PartnerCenter-Application: Partner Center .NET SDK Samples
Host: api.partnercenter.microsoft.com