Udostępnij za pośrednictwem


Zarządzanie liniami dostarczania

Użyj tych metod w interfejsie API promocji sklepu Microsoft Store, aby utworzyć co najmniej jeden wierszy dostawy kupić zapasy i dostarczyć reklamy na kampanię reklam promocyjnych. Dla każdej linii dostawy można ustawić targetowanie, określić cenę oferty i zdecydować, ile chcesz wydać, ustalając budżet i łącząc się z kreacjami reklamowymi, których chcesz użyć.

Aby uzyskać więcej informacji na temat relacji między liniami dostaw a kampaniami reklamowymi, profilami ukierunkowanymi i kreacjami reklamowymi, zobacz Uruchamianie kampanii reklamowych za pomocą usług Microsoft Store.

Uwaga Zanim będzie można pomyślnie utworzyć linie dostarczania dla kampanii reklamowych przy użyciu tego interfejsu API, musisz najpierw utworzyć jedną płatną kampanię reklamową przy użyciu strony Kampanii reklamowych w Centrum Partnera, oraz na tej stronie musisz dodać co najmniej jeden instrument płatniczy. Po wykonaniu tej czynności będzie można pomyślnie utworzyć rozliczane linie dostarczania dla kampanii reklamowych przy użyciu tego interfejsu API. Kampanie reklamowe tworzone przy użyciu interfejsu API będą automatycznie rozliczać domyślny instrument płatniczy wybrany na stronie kampanie reklamowe w Centrum partnerskim.

Wymagania wstępne

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

  • Jeśli jeszcze tego nie zrobiłeś/zrobiłaś, ukończ wszystkie te wymagania wstępne dla API promocji Microsoft Store.

    Uwaga / Notatka

    W ramach wymagań wstępnych upewnij się, że utworzysz co najmniej jedną płatną kampanię reklamową w Centrum partnerskim i dodasz co najmniej jedną metodę płatności dla kampanii reklamowej w Centrum partnerskim. Linie dostarczania tworzone przy użyciu tego interfejsu API automatycznie będą rozliczać domyślny instrument płatniczy wybrany na stronie kampanii reklamowych w Centrum partnerskim.

  • Uzyskaj token dostępu usługi Azure AD do użycia w nagłówku żądania dla tych metod. 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

Te metody mają następujące identyfikatory URI.

Typ metody Żądanie URI Opis
Bez znajomości kontekstu, w którym "POST" jest używany, nie mogę zaproponować dokładnego tłumaczenia. Jeżeli dotyczy HTTP, pozostaw jako "POST". https://manage.devcenter.microsoft.com/v1.0/my/promotion/line Tworzy nową linię dostawy.
POŁÓŻ https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} Edytuje wiersz dostarczania określony przez lineId.
POBIERZ https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} Pobiera wiersz dostawy określony przez lineId.
Nagłówek Typ Opis
Autoryzacja sznurek To jest wymagane. Token dostępu usługi Azure AD w postaci tokenu typu Bearer <>.
Identyfikator śledzenia GUID (Globalny Unikalny Identyfikator) Opcjonalny. Identyfikator śledzący przepływ wywołań.

Ciało żądania

Metody POST i PUT wymagają treści żądania w formacie JSON, zawierającej wymagane pola obiektu wiersza dostawy oraz wszelkie dodatkowe pola, które chcesz ustawić lub zmienić.

Prośba o przykłady

W poniższym przykładzie pokazano, jak wywołać metodę POST w celu utworzenia pozycji dostawy.

POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/line HTTP/1.1
Authorization: Bearer <your access token>

{
    "name": "Contoso App Campaign - Paid Line",
    "configuredStatus": "Active",
    "startDateTime": "2017-01-19T12:09:34Z",
    "endDateTime": "2017-01-31T23:59:59Z",
    "bidAmount": 0.4,
    "dailyBudget": 20,
    "targetProfileId": {
        "id": 310021746
    },
    "creatives": [
        {
            "id": 106851
        }
    ],
    "campaignId": 31043481,
    "minMinutesPerImp ": 1
}

W poniższym przykładzie pokazano, jak wywołać metodę GET w celu pobrania wiersza dostawy.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/31019990  HTTP/1.1
Authorization: Bearer <your access token>

Odpowiedź

Te metody zwracają treść odpowiedzi JSON z wierszem dostarczania obiektem zawierającym informacje o wierszu dostarczania, który został utworzony, zaktualizowany lub pobrany. W poniższym przykładzie przedstawiono treść odpowiedzi dla tych metod.

{
    "Data": {
        "id": 31043476,
        "name": "Contoso App Campaign - Paid Line",
        "configuredStatus": "Active",
        "effectiveStatus": "Active",
        "effectiveStatusReasons": [
            "{\"ValidationStatusReasons\":null}"
        ],
        "startDateTime": "2017-01-19T12:09:34Z",
        "endDateTime": "2017-01-31T23:59:59Z",
        "createdDateTime": "2017-01-17T10:28:34Z",
        "bidType": "CPM",
        "bidAmount": 0.4,
        "dailyBudget": 20,
        "targetProfileId": {
            "id": 310021746
        },
        "creatives": [
            {
                "id": 106126
            }
        ],
        "campaignId": 31043481,
        "minMinutesPerImp ": 1,
        "pacingType ": "SpendEvenly",
        "currencyId ": 732
    }
}

Obiekt linii dostarczania

Treść żądania i odpowiedzi dla tych metod zawiera następujące pola. W tej tabeli pokazano, które pola są tylko do odczytu (co oznacza, że nie można ich zmienić w metodzie PUT) i które pola są wymagane w treści żądania dla metod POST lub PUT.

(No changes needed) Typ Opis Tylko do odczytu Wartość domyślna Wymagane w przypadku funkcji POST/PUT
id liczba całkowita Identyfikator linii dostawy. Tak Nie.
nazwa sznurek Nazwa linii dostawy. Nie. Bez znajomości kontekstu, w którym "POST" jest używany, nie mogę zaproponować dokładnego tłumaczenia. Jeżeli dotyczy HTTP, pozostaw jako "POST".
statusSkonfigurowany sznurek Jedną z następujących wartości określających stan wiersza dostawy określonego przez dewelopera:
  • Aktywny
  • Nieaktywny
Nie. Bez znajomości kontekstu, w którym "POST" jest używany, nie mogę zaproponować dokładnego tłumaczenia. Jeżeli dotyczy HTTP, pozostaw jako "POST".
effectiveStatus sznurek Jedną z następujących wartości określających obowiązujący stan linii dostarczania na podstawie weryfikacji systemu:
  • Aktywny
  • Nieaktywny
  • Przetwarzanie
  • Nie działa
Tak Nie.
powody skutecznego statusu układ Co najmniej jedna z następujących wartości określających przyczynę aktualnego stanu wiersza dostawy:
  • AdCreativesInactive
  • Weryfikacja nieudana
Tak Nie.
data i czas rozpoczęcia sznurek Data i godzina rozpoczęcia linii dostawy w standardzie ISO 8601. Tej wartości nie można zmienić, jeśli jest już w przeszłości. Nie. WYŚLIJ, UMIEŚĆ
endDatetime sznurek Data i godzina zakończenia pozycji dostawy w formacie ISO 8601. Tej wartości nie można zmienić, jeśli jest już w przeszłości. Nie. WYŚLIJ, UMIEŚĆ
createdDatetime sznurek Data i godzina utworzenia linii dostaw w formacie ISO 8601. Tak Nie.
typ oferty sznurek Wartość określająca typ licytacji linii dostaw. Obecnie jedyną obsługiwaną wartością jest CPM. Nie. Koszt na tysiąc wyświetleń (CPM) Nie.
kwota oferty dziesiętny ułamek Kwota oferty do składania ofert na dowolne zapytanie o reklamy. Nie. Średnia wartość CPM oparta na rynkach docelowych (ta wartość jest okresowo zmieniana). Nie.
budżet dzienny dziesiętny ułamek Dzienny budżet dla linii dostarczania. Należy ustawić dailyBudget lub lifetimeBudget. Nie. POST, PUT (jeśli nie ustawiono okresu istnieniaBudget)
budżet na cały okres istnienia dziesiętny ułamek Budżet okresu istnienia dla linii dostarczania. lifetimeBudget* lub dzienny budżet musi być ustawiony. Nie. POST, PUT (jeśli dailyBudget nie jest ustawiony)
idProfiluCelu przedmiot Obiekt, który identyfikuje profil docelowy , opisujący użytkowników, lokalizacje geograficzne i typy zasobów, na które chcesz kierować tę linię dostaw. Ten obiekt składa się z pojedynczego pola id, które określa identyfikator profilu kierowania. Nie. Nie.
twórcy układ Co najmniej jeden obiekt reprezentujący materiały reklamowe , które są skojarzone z linią emisji. Każdy obiekt w tym polu składa się z jednego identyfikatora pola, które określa identyfikator twórcy. Nie. Nie.
identyfikator kampanii liczba całkowita Identyfikator kampanii reklamowej nadrzędnej. Nie. Nie.
minMinutesPerImp liczba całkowita Określa minimalny interwał czasu (w minutach) między dwoma wyświetleniami wyświetlanymi dla tego samego użytkownika z tego wiersza dostawy. Nie. 4000 Nie.
typ tempowania sznurek Jedna z następujących wartości, które określają rodzaj tempa:
  • SpendEvenly
  • WydawajJakNajszybciej
Nie. SpendEvenly Nie.
identyfikator waluty liczba całkowita Identyfikator (ID) waluty kampanii. Tak Waluta konta dewelopera (nie trzeba określać tego pola w wywołaniach POST lub PUT) Nie.