Instrukcje

Ta strona zawiera szczegółowe informacje o tym, jak wykonywać typowe zadania przy użyciu interfejsu API.

Tworzenie użytkowników

UserService umożliwia użytkownikowi z uprawnieniami administratora tworzenie użytkownika bezpośrednio w jego sieci. Każdy programista może to zrobić bez konieczności wcześniejszego zarejestrowania się nowego użytkownika. Jeśli na przykład testujesz interfejs API po raz pierwszy, zamiast wykonywać każde wywołanie interfejsu API jako administrator (ustawienie domyślne dla Twojego adresu e-mail), możesz utworzyć kilku użytkowników z rolami takimi jak Sprzedawca, Trafiker lub Reklamodawca, aby przetestować rzeczywiste przepływy pracy.

1. Utwórz nowe adresy Gmail, takie jak [e-mail]. Możesz też zarejestrować istniejący adres inny niż Gmail jako nowe konto Google.
2. Zadzwoń do firmy createUsers z nowym adresem i wybranym numerem Role.
3. Możesz uwierzytelnić się jako nowy użytkownik przy użyciu OAuth 2.0 w celu wygenerowania tokena dostępu.

Uzyskiwanie głównej jednostki reklamowej

Zarówno najwyższy poziom (AdUnit), do którego możesz dodawać węzły podrzędne, jak i dozwolona głębokość hierarchii zależą od typu konta (mała firma lub usługa Premium). AdUnit najwyższy, który obsługuje modyfikowanie węzłów podrzędnych, jest nazywany efektywnym poziomem głównym AdUnit.

Aby pobrać obowiązujący poziom główny, wywołaj NetworkService.getCurrentNetwork() i sprawdź pole effectiveRootAdUnitId w zwracanym obiekcie Network.

Uwaga: różne rodzaje kont obsługują różne wzorce hierarchii.

Wysyłanie zapytań dotyczących obiektu

Obiekty wyszukuje się według kryteriów wyszukiwania przy użyciu metody getObjectsByStatement() udostępnianej przez wiele usług, gdzie Object to określony typ obiektu. Ta metoda wykorzystuje zapytanie PQL, które jest podobne do zapytania SQL, ponieważ umożliwia określenie pól do wyszukiwania (przy czym nazwy pól mapują się na właściwości obiektu), sortowanie, ograniczanie i przesunięcie wyników wyszukiwania. Zapoznaj się z przewodnikiem PQL, aby dowiedzieć się więcej o PQL oraz o tym, według których pól obiektów możesz filtrować.

Tworzenie zamówienia

Aby utworzyć zamówienie, wystarczy utworzyć obiekt Order, ustawić odpowiednich użytkowników jako identyfikatory reklamodawcy, sprzedawcy i trafikera, przypisać im unikalną nazwę i wywołać metodę createOrders(). Wynik będzie zawierał nowo utworzony plik Order lub błąd.

Przykład

Zobacz przykładowy kod w języku Java do tworzenia zamówienia.

Tworzenie elementu zamówienia

Aby utworzyć nowy element zamówienia:

1. Utwórz nowy obiekt Order lub użyj istniejącego.
2. Utwórz nowy obiekt LineItem i ustaw typ rotacji, tablicę rozmiarów kreacji, datę rozpoczęcia i zakończenia oraz inne właściwości.
3. Utwórz nowy obiekt InventoryTargeting i określ, które obiekty Placement lub AdUnit mają być objęte kierowaniem lub wykluczane.
4. Spakuj obiekt InventoryTargeting wewnątrz nowego obiektu Targeting i przypisz go do właściwości kierowania LineItem.
5. Wywołaj metodę usługi elementu zamówienia createLineItems() z nowym obiektem i sprawdź, czy obiekt został utworzony.

Przykład

Zobacz przykładowy kod Java do tworzenia elementu zamówienia.

Tworzenie kreacji

Różne typy kreacji obsługują różne komponenty. Na przykład kreacja graficzna obsługuje jeden plik źródłowy obrazu, a kreacja Flash obsługuje dwa pliki zasobów: plik flash i plik obrazu zapasowego, na wypadek gdyby nie można wyświetlić pliku Flash. W przypadku kreacji hostowanych w witrynach zewnętrznych przesyłasz tylko fragment kodu HTML, który odwołuje się do pliku na serwerze firmy zewnętrznej. Zapoznaj się z konkretną podklasą Creative, aby dowiedzieć się, jakie zasoby musisz przesłać, aby utworzyć kreację.

Przykład

Zobacz przykład kodu Java do tworzenia kreacji graficznej.

Modyfikowanie istniejącego obiektu

Aby zmodyfikować istniejący obiekt, wyślij do niego zapytanie, wywołując getObjectsByStatement(), zaktualizuj wartości w zwróconych obiektach, a następnie wywołaj updateObjects().

Uwaga: zaktualizowane obiekty całkowicie zastąpią istniejące obiekty, więc jeśli nie ustawisz w nim wartości właściwości, zapisany obiekt otrzyma domyślną wartość tej właściwości, a nie poprzednią.

Zmiana stanu obiektu

Stan obiektu zmienia się przez wywołanie metody performObjectAction() ujawnianej przez usługę. Ta metoda przyjmuje 2 parametry:

• Wystąpienie obiektu działania, które opisuje, co chcesz zrobić. Na przykład usługa zamówień udostępnia kilka działań, w tym ApproveOrders, PauseOrders i ArchiveOrders. Wszystkie obiekty akcji pochodzą z podstawowej klasy akcji odpowiedniej dla Twojej usługi.
• Zapytanie PQL opisujące, które obiekty mają zostać zmienione. Możesz zmienić stan jednego lub wielu obiektów naraz, określając odpowiednią instrukcję PQL.

Generowanie tagów reklam

Nie możesz generować tagów reklam za pomocą interfejsu API. Musisz zamiast tego użyć witryny Google Ad Managera. Więcej informacji znajdziesz w sekcji Tagowanie w Centrum pomocy.

Więcej przykładów

Więcej przykładów znajdziesz w przykładowym kodzie w naszej bibliotece klienta w kilku różnych językach programowania. Link do przykładów w Twoim języku programowania znajdziesz na stronie Biblioteki klienta i przykładowy kod .