Queries

Ta wersja interfejsu API usługi Bid Manager została wycofana. Użytkownicy muszą używać interfejsu API usługi Bid Manager w wersji 2.

Listę metod dla tego zasobu znajdziesz na końcu tej strony.

Reprezentacje zasobów

Reprezentuje zapytanie.

{
  "kind": "doubleclickbidmanager#query",
  "queryId": long,
  "metadata": {
    "title": string,
    "dataRange": string,
    "format": string,
    "running": boolean,
    "reportCount": integer,
    "googleCloudStoragePathForLatestReport": string,
    "latestReportRunTimeMs": long,
    "googleDrivePathForLatestReport": string,
    "sendNotification": boolean,
    "shareEmailAddress": [
      string
    ],
    "locale": string
  },
  "params": {
    "type": string,
    "groupBys": [
      string
    ],
    "filters": [
      {
        "type": string,
        "value": string
      }
    ],
    "metrics": [
      string
    ],
    "includeInviteData": boolean
  },
  "schedule": {
    "frequency": string,
    "endTimeMs": long,
    "nextRunMinuteOfDay": integer,
    "nextRunTimezoneCode": string
  },
  "reportDataStartTimeMs": long,
  "reportDataEndTimeMs": long,
  "timezoneCode": string
}

Nazwa usługi	Wartość	Opis	Uwagi
kind	string	Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków "doubleclickbidmanager#query".
metadata	nested object	Metadane zapytania.
metadata.dataRange	string	Zakres danych raportu. Akceptowane wartości to: „ALL_TIME” „CURRENT_DAY” „CUSTOM_DATES” „LAST_14_DAYS” „LAST_30_DAYS” „LAST_365_DAYS” „LAST_7_DAYS” „LAST_90_DAYS” „MONTH_TO_DATE” „PREVIOUS_DAY” „PREVIOUS_HALF_MONTH” „PREVIOUS_MONTH” „PREVIOUS_QUARTER” „PREVIOUS_WEEK” „PREVIOUS_YEAR” „QUARTER_TO_DATE” „TYPE_NOT_SUPPORTED” „WEEK_TO_DATE” „YEAR_TO_DATE”
metadata.format	string	Format wygenerowanego raportu. Akceptowane wartości to: „CSV” „EXCEL_CSV” „XLSX”
metadata.googleCloudStoragePathForLatestReport	string	Ścieżka do lokalizacji w Google Cloud Storage, w której jest przechowywany najnowszy raport.
metadata.googleDrivePathForLatestReport	string	Ścieżka najnowszego raportu na Dysku Google.
metadata.latestReportRunTimeMs	long	Godzina rozpoczęcia generowania najnowszego raportu.
metadata.locale	string	Język wygenerowanych raportów. Akceptowane wartości: „cs” dla CZECH „de” do NIEMIECKI „en” dla ENGLISH „es” dla języka HISZPAŃSKIEGO „fr” dla FRANCUSKI „it” dla włoskich „ja” dla JAPOŃSKI „ko” dla KOREAN „pl” dla polskiego „pt-BR” dla BRAZILIAN_PORTUGUESE „ru” do ROSYJSKI „tr” dla tureckiego „uk” dla UKRAINIANKI „zh-CN” dla CHINA_CHINESE „zh-TW” dla TAIWAN_CHINESE Ciąg znaków dotyczący regionu, którego nie ma na powyższej liście, będzie generować raporty w języku angielskim.
metadata.reportCount	integer	Liczba raportów wygenerowanych dla zapytania.
metadata.running	boolean	Wskazuje, czy jest generowany najnowszy raport.
metadata.sendNotification	boolean	Określa, czy wysłać e-maila z powiadomieniem, gdy raport będzie gotowy. Wartość domyślna to fałsz.
metadata.shareEmailAddress[]	list	Lista adresów e-mail, na które będą wysyłane powiadomienia po wygenerowaniu raportu. Oddzielny od sendNotification.
metadata.title	string	Tytuł zapytania. Służy do nadawania nazw raportom wygenerowanym na podstawie tego zapytania.
params	nested object	Parametry zapytania.
params.filters[]	list	Filtry służące do dopasowywania w raporcie danych o ruchu.
params.filters[].type	string	Typ filtra. Akceptowane wartości to: „FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY” „FILTER_ACTIVITY_ID” „FILTER_ADVERTISER” „FILTER_ADVERTISER_CURRENCY” „FILTER_ADVERTISER_TIMEZONE” „FILTER_AD_POSITION” „FILTER_AGE” „FILTER_AUTHORIZED_SELLER_STATE_ID” „FILTER_BRANDSAFE_CHANNEL_ID” „FILTER_BROWSER” „FILTER_BUDGET_SEGMENT_DESCRIPTION” „FILTER_CAMPAIGN_DAILY_FREQUENCY” „FILTER_CARRIER” „FILTER_CHANNEL_ID” „FILTER_CITY” „FILTER_COMPANION_CREATIVE_ID” „FILTER_CONVERSION_DELAY” „FILTER_COUNTRY” „FILTER_CREATIVE_ATTRIBUTE” „FILTER_CREATIVE_HEIGHT” „FILTER_CREATIVE_ID” „FILTER_CREATIVE_SIZE” „FILTER_CREATIVE_TYPE” „FILTER_CREATIVE_WIDTH” „FILTER_DATA_PROVIDER” „FILTER_DATE” „FILTER_DAY_OF_WEEK” „FILTER_DEVICE_MAKE” „FILTER_DEVICE_MODEL” „FILTER_DEVICE_TYPE” „FILTER_DFP_ORDER_ID” „FILTER_DMA” „FILTER_DV360_ACTIVITY_ID” „FILTER_EXCHANGE_ID” „FILTER_FLOODLIGHT_ACTIVITY_ID” „FILTER_FLOODLIGHT_PIXEL_ID” „FILTER_GENDER” „FILTER_INSERTION_ORDER” „FILTER_INVENTORY_COMMITMENT_TYPE” „FILTER_INVENTORY_DELIVERY_METHOD” „FILTER_INVENTORY_FORMAT” „FILTER_INVENTORY_RATE_TYPE” „FILTER_INVENTORY_SOURCE” „FILTER_INVENTORY_SOURCE_TYPE” „FILTER_KEYWORD” „FILTER_LINE_ITEM” „FILTER_LINE_ITEM_DAILY_FREQUENCY” „FILTER_LINE_ITEM_LIFETIME_FREQUENCY” „FILTER_LINE_ITEM_TYPE” „FILTER_MEDIA_PLAN” „FILTER_MOBILE_DEVICE_MAKE” „FILTER_MOBILE_DEVICE_MAKE_MODEL” „FILTER_MOBILE_DEVICE_TYPE” „FILTER_MOBILE_GEO” „FILTER_MONTH” „FILTER_MRAID_SUPPORT” „FILTER_NIELSEN_AGE” „FILTER_NIELSEN_COUNTRY_CODE” „FILTER_NIELSEN_DEVICE_ID” „FILTER_NIELSEN_GENDER” „FILTER_NOT_SUPPORTED” „FILTER_ORDER_ID” „FILTER_OS” „FILTER_PAGE_CATEGORY” „FILTER_PAGE_LAYOUT” „FILTER_PARTNER” „FILTER_PARTNER_CURRENCY” „FILTER_PUBLIC_INVENTORY” „FILTER_QUARTER” „FILTER_REGION” „FILTER_REGULAR_CHANNEL_ID” „FILTER_SITE_ID” „FILTER_SITE_LANGUAGE” „FILTER_SKIPPABLE_SUPPORT” „FILTER_TARGETED_USER_LIST” „FILTER_TIME_OF_DAY” „FILTER_TRUEVIEW_AD_GROUP_AD_ID” „FILTER_TRUEVIEW_AD_GROUP_ID” „FILTER_TRUEVIEW_AGE” „FILTER_TRUEVIEW_CATEGORY” „FILTER_TRUEVIEW_CITY” „FILTER_TRUEVIEW_CONVERSION_TYPE” „FILTER_TRUEVIEW_COUNTRY” „FILTER_TRUEVIEW_CUSTOM_AFFINITY” „FILTER_TRUEVIEW_DMA” „FILTER_TRUEVIEW_GENDER” „FILTER_TRUEVIEW_IAR_AGE” „FILTER_TRUEVIEW_IAR_CATEGORY” „FILTER_TRUEVIEW_IAR_CITY” „FILTER_TRUEVIEW_IAR_COUNTRY” „FILTER_TRUEVIEW_IAR_GENDER” „FILTER_TRUEVIEW_IAR_INTEREST” „FILTER_TRUEVIEW_IAR_LANGUAGE” „FILTER_TRUEVIEW_IAR_PARENTAL_STATUS” „FILTER_TRUEVIEW_IAR_REGION” „FILTER_TRUEVIEW_IAR_REMARKETING_LIST” „FILTER_TRUEVIEW_IAR_TIME_OF_DAY” „FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL” „FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO” „FILTER_TRUEVIEW_IAR_ZIPCODE” „FILTER_TRUEVIEW_INTEREST” „FILTER_TRUEVIEW_KEYWORD” „FILTER_TRUEVIEW_PARENTAL_STATUS” „FILTER_TRUEVIEW_PLACEMENT” „FILTER_TRUEVIEW_REGION” „FILTER_TRUEVIEW_REMARKETING_LIST” „FILTER_TRUEVIEW_URL” „FILTER_TRUEVIEW_ZIPCODE” „FILTER_UNKNOWN” „FILTER_USER_LIST” „FILTER_USER_LIST_FIRST_PARTY” „FILTER_USER_LIST_THIRD_PARTY” „FILTER_VIDEO_AD_POSITION_IN_STREAM” „FILTER_VIDEO_COMPANION_SIZE” „FILTER_VIDEO_COMPANION_TYPE” „FILTER_VIDEO_CREATIVE_DURATION” „FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE” „FILTER_VIDEO_DURATION_SECONDS” „FILTER_VIDEO_FORMAT_SUPPORT” „FILTER_VIDEO_INVENTORY_TYPE” „FILTER_VIDEO_PLAYER_SIZE” „FILTER_VIDEO_RATING_TIER” „FILTER_VIDEO_SKIPPABLE_SUPPORT” „FILTER_VIDEO_VPAID_SUPPORT” „FILTER_WEEK” „FILTER_YEAR” „FILTER_YOUTUBE_VERTICAL” „FILTER_ZIP_CODE”
params.filters[].value	string	Wartość filtra.
params.groupBys[]	list	Dane są pogrupowane według filtrów podanych w tym polu.
params.includeInviteData	boolean	Rola wycofana. To pole nie jest już używane.
params.metrics[]	list	Dane, które mają zostać uwzględnione jako kolumny w raporcie.
params.type	string	Typ raportu. Ograniczenia typu: TYPE_ORDER_ID obsługuje zakresy dat sięgające do 60 dni w przeszłość. TYPE_AUDIENCE_COMPOSITION, TYPE_INVENTORY_AVAILABILITY, TYPE_TRUEVIEW_IAR obsługują zakresy dat z maksymalnie 30 dni wstecz. . Akceptowane wartości: „TYPE_ACTIVE_GRP” „TYPE_AUDIENCE_COMPOSITION” „TYPE_AUDIENCE_PERFORMANCE” „TYPE_CLIENT_SAFE” „TYPE_COMSCORE_VCE” „TYPE_CROSS_FEE” „TYPE_CROSS_PARTNER” „TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER” „TYPE_ESTIMATED_CONVERSION” „TYPE_FEE” „TYPE_GENERAL” „TYPE_INVENTORY_AVAILABILITY” „TYPE_KEYWORD” „TYPE_LINEAR_TV_SEARCH_LIFT” „TYPE_NIELSEN_AUDIENCE_PROFILE” „TYPE_NIELSEN_DAILY_REACH_BUILD” „TYPE_NIELSEN_ONLINE_GLOBAL_MARKET” „TYPE_NIELSEN_SITE” „TYPE_NOT_SUPPORTED” „TYPE_ORDER_ID” „TYPE_PAGE_CATEGORY” „TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE” „TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD” „TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET” „TYPE_PIXEL_LOAD” „TYPE_REACH_AND_FREQUENCY” „TYPE_REACH_AUDIENCE” „TYPE_THIRD_PARTY_DATA_PROVIDER” „TYPE_TRUEVIEW” „TYPE_TRUEVIEW_IAR” „TYPE_VERIFICATION” „TYPE_YOUTUBE_VERTICAL”
queryId	long	Identyfikator zapytania.
reportDataEndTimeMs	long	Ostateczny czas przechowywania danych wyświetlanych w raporcie. Uwaga: pole reportDataEndTimeMs jest wymagane, jeśli pole metadata.dataRange ma wartość CUSTOM_DATES. W przeciwnym razie jest ona ignorowana.
reportDataStartTimeMs	long	Godzina rozpoczęcia zbierania danych wyświetlanych w raporcie. Uwaga: pole reportDataStartTimeMs jest wymagane, jeśli pole metadata.dataRange ma wartość CUSTOM_DATES. W przeciwnym razie jest ona ignorowana.
schedule	nested object	Informacje o tym, jak często i kiedy należy wykonywać zapytanie.
schedule.endTimeMs	long	Data i godzina, do których okresowe wykonywanie zapytania.
schedule.frequency	string	Częstotliwość uruchamiania zapytania. Akceptowane wartości to: „DAILY” „MONTHLY” „ONE_TIME” „QUARTERLY” „SEMI_MONTHLY” „WEEKLY”
schedule.nextRunMinuteOfDay	integer	Rola wycofana. To pole nie ma żadnego efektu.
schedule.nextRunTimezoneCode	string	Kanoniczny kod strefy czasowej dla czasu generowania raportu. Domyślna wartość to America/New_York.
timezoneCode	string	Kanoniczny kod strefy czasowej dla czasu danych raportu. Domyślna wartość to America/New_York.

Metody

createquery

Tworzy zapytanie.

deletequery

Usuwa zapisane zapytanie, a także powiązane zapisane raporty.

getquery

Pobiera zapisane zapytanie.

listqueries

Pobiera zapisane zapytania.

runquery

Uruchamia zapisane zapytanie, aby wygenerować raport.