Method: advertisers.campaigns.list

Wyświetla listę kampanii reklamodawcy.

Kolejność jest określana przez parametr orderBy. Jeśli filter na entityStatus nie zostanie określony, kampanie z ENTITY_STATUS_ARCHIVED nie zostaną uwzględnione w wynikach.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

Identyfikator reklamodawcy, dla którego lista kampanii ma zostać wyświetlona.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wartość musi mieścić się w zakresie od 1 do 100. Jeśli nie określono inaczej, domyślnie przyjmuje się wartość 100.
pageToken

string

Token określający stronę z wynikami zwracanymi przez serwer. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody campaigns.list. Jeśli nie podasz tych danych, zwracana jest pierwsza strona wyników.
orderBy

string

Pole służące do sortowania listy. Dopuszczalne wartości:

  • displayName (domyślnie)
  • entityStatus
  • updateTime

Domyślna kolejność sortowania jest rosnąca. Aby określić kolejność malejącą w przypadku pola, do jego nazwy musisz dodać sufiks „desc”. Przykład: displayName desc.
filter

string

Umożliwia filtrowanie według właściwości kampanii.

Obsługiwana składnia:

  • Wyrażenia filtra składają się z co najmniej 1 ograniczenia.
  • Ograniczenia mogą być łączone za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń domyślnie używa elementu AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Operatorem użytym w updateTime musi być GREATER THAN OR EQUAL TO (>=) lub LESS THAN OR EQUAL TO (<=).
  • Operatorem musi być EQUALS (=).
  • Obsługiwane pola:
    • campaignId
    • displayName
    • entityStatus
    • updateTime (dane wejściowe w formacie ISO 8601 lub RRRR-MM-DDTHH:MM:SSZ)

Przykłady:

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

To pole nie może zawierać więcej niż 500 znaków.

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.

Tej listy nie będzie, jeśli będzie pusta.
nextPageToken

string

Token do pobierania następnej strony wyników. W kolejnym wywołaniu metody campaigns.list przekaż tę wartość w polu pageToken, aby pobrać następną stronę wyników.

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 protokołu OAuth 2.0.