Method: advertisers.campaigns.list

Wyświetla listę kampanii reklamodawcy.

Kolejność jest określana przez parametr orderBy. Jeśli nie określisz wartości filter w kolumnie entityStatus, kampanie z wartością ENTITY_STATUS_ARCHIVED nie będą uwzględniane w wynikach.

Żądanie HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/campaigns

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

Identyfikator reklamodawcy, dla którego chcesz wyświetlić listę kampanii.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wymagana wartość z zakresu od 1 do 200. Jeśli nie podasz żadnej wartości, zostanie użyta wartość domyślna 100.
pageToken

string

Token identyfikujący stronę wyników, którą serwer powinien zwrócić. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody campaigns.list. Jeśli nie zostanie określony, zwrócona zostanie pierwsza strona wyników.
orderBy

string

Pole, według którego lista ma być sortowana. Akceptowane wartości:

  • displayName (domyślnie)
  • entityStatus
  • updateTime

Domyślna kolejność sortowania to rosnąco. Aby określić kolejność malejącą, do nazwy pola należy dodać sufiks „desc”. Przykład: displayName desc.
filter

string

Umożliwia filtrowanie według pól kampanii.

Obsługiwana składnia:

  • Wyrażenia filtra składają się z co najmniej 1 ograniczenia.
  • Ograniczenia można łączyć za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń używa domyślnie AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Pole updateTime musi zawierać operatory GREATER THAN OR EQUAL TO (>=) lub LESS THAN OR EQUAL TO (<=).
  • W pozostałych polach musisz użyć operatora EQUALS (=).

Obsługiwane pola:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (wpisz w formacie ISO 8601 lub YYYY-MM-DDTHH:MM:SSZ)

Przykłady:

  • Wszystkie kampanie ENTITY_STATUS_ACTIVE lub ENTITY_STATUS_PAUSED reklamodawcy: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Wszystkie kampanie z czasem aktualizacji krótszym lub równym 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Wszystkie kampanie z czasem aktualizacji równym 2020-11-04T18:54:47Z (format ISO 8601): updateTime>="2020-11-04T18:54:47Z"

Długość tego pola nie powinna przekraczać 500 znaków.

Więcej informacji znajdziesz w przewodniku dotyczącym żądań LIST.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
Pola
campaigns[]

object (Campaign)

Lista kampanii.

Jeśli lista jest pusta, nie będzie widoczna.
nextPageToken

string

Token do pobrania następnej strony wyników. Aby pobrać kolejną stronę wyników, prześlij tę wartość w polu pageToken w kolejnych wywołaniach metody campaigns.list.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/display-video
  • https://www.googleapis.com/auth/display-video-mediaplanning

Więcej informacji znajdziesz w artykule Omówienie OAuth 2.0.