Reports

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

Reprezentacje zasobów

Raport DoubleClick Search. Ten obiekt zawiera żądanie raportu, niektóre metadane raportu, np. kod waluty, oraz wygenerowane wiersze lub pliki raportu.

{
  "kind": "doubleclicksearch#report",
  "id": string,
  "isReportReady": boolean,
  "request": {
    "reportScope": {
      "agencyId": long,
      "advertiserId": long,
      "engineAccountId": long,
      "campaignId": long,
      "adGroupId": long,
      "keywordId": long,
      "adId": long
    },
    "reportType": string,
    "columns": [
      {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      }
    ],
    "timeRange": {
      "startDate": string,
      "endDate": string,
      "changedMetricsSinceTimestamp": datetime,
      "changedAttributesSinceTimestamp": datetime
    },
    "filters": [
      {
        "column": {
          "columnName": string,
          "savedColumnName": string,
          "customDimensionName": string,
          "customMetricName": string,
          "headerText": string,
          "startDate": string,
          "endDate": string,
          "groupByColumn": boolean,
          "platformSource": string,
          "productReportPerspective": string
        },
        "operator": string,
        "values": [
          (value)
        ]
      }
    ],
    "orderBy": [
      {
        "column": {
          "columnName": string,
          "savedColumnName": string,
          "customDimensionName": string,
          "customMetricName": string,
          "headerText": string,
          "startDate": string,
          "endDate": string,
          "groupByColumn": boolean,
          "platformSource": string,
          "productReportPerspective": string
        },
        "sortOrder": string
      }
    ],
    "includeDeletedEntities": boolean,
    "includeRemovedEntities": boolean,
    "verifySingleTimeZone": boolean,
    "downloadFormat": string,
    "statisticsCurrency": string,
    "startRow": integer,
    "rowCount": integer,
    "maxRowsPerFile": integer
  },
  "statisticsCurrencyCode": string,
  "statisticsTimeZone": string,
  "rowCount": integer,
  "files": [
    {
      "url": string,
      "byteCount": long
    }
  ],
  "rows": [
    {
      (key): (value)
    }
  ]
}
Nazwa usługi Wartość opis, Uwagi
files[] list Tylko raport asynchroniczny. Zawiera listę wygenerowanych plików raportów po pomyślnym utworzeniu raportu.
files[].byteCount long Rozmiar tego pliku raportu w bajtach.
files[].url string Aby pobrać plik raportu, użyj tego adresu URL.
id string Tylko raport asynchroniczny. Identyfikator raportu.
isReportReady boolean Tylko raport asynchroniczny. Wartość to „prawda”, jeśli raport został ukończony, a pliki są gotowe do pobrania.
kind string Określa ten zasób jako zasób raportu. Wartość: ustalony ciąg znaków doubleclicksearch#report.
request nested object Żądanie, które spowodowało utworzenie raportu. Pola opcjonalne, które nie zostały określone w pierwotnym żądaniu, są wypełnione wartościami domyślnymi.
request.columns[] list Kolumny do uwzględnienia w raporcie. Dotyczy to zarówno kolumn DoubleClick Search, jak i zapisanych. W przypadku kolumn DoubleClick Search wymagany jest tylko parametr columnName. W przypadku zapisanych kolumn wymagany jest tylko parametr savedColumnName. Nie można ustawić jednocześnie columnName i savedColumnName w tej samej pozycji.

Maksymalna liczba kolumn w żądaniu to 300.

request.columns[].columnName string Nazwa kolumny DoubleClick Search do uwzględnienia w raporcie.
request.columns[].customDimensionName string Podział raportu na segmenty według wymiaru niestandardowego. Raport musi mieć zakres ograniczony do reklamodawcy lub niższy, a wymiar niestandardowy musi być już skonfigurowany w usłudze DoubleClick Search. W nazwie wymiaru niestandardowego, która pojawia się w DoubleClick Search, wielkość liter ma znaczenie.

Jeśli jest używany w raporcie konwersji, zwraca wartość określonego wymiaru niestandardowego dla danej konwersji (jeśli jest ustawiona). Ta kolumna nie dzieli raportu konwersji na segmenty.

request.columns[].customMetricName string Nazwa danych niestandardowych do uwzględnienia w raporcie. Raport musi mieć zakres ograniczony do reklamodawcy lub niższy, a dane niestandardowe muszą być już skonfigurowane w usłudze DoubleClick Search. W nazwie danych niestandardowych, która pojawia się w DoubleClick Search, wielkość liter ma znaczenie.
request.columns[].endDate string Dzień włącznie w formacie RRRR-MM-DD. Jeśli podasz wartość, zastąpi ona ogólny zakres czasowy raportu tylko dla tej kolumny. musi być podany razem z startDate.
request.columns[].groupByColumn boolean Tylko raport synchroniczny. Wybierz true, aby grupować według tej kolumny. Domyślna wartość to false.
request.columns[].headerText string Tekst używany do identyfikacji tej kolumny w wynikach raportu. Jeśli nie zostanie podany, przyjmuje domyślnie wartość columnName lub savedColumnName. Pozwala to zapobiec kolizji między kolumnami DoubleClick Search i zapisanymi kolumnami o tej samej nazwie.
request.columns[].platformSource string Platforma, która służy do dostarczania danych do wymiaru niestandardowego. Dopuszczalne wartości to „Floodlight”.
request.columns[].productReportPerspective string Zwraca dane tylko o określonym typie aktywności produktu. Akceptowane wartości to:
  • sold”: wyświetla dane tylko dla produktów, które zostały sprzedane.
  • advertised”: wyświetla dane tylko dla produktów reklamowanych w kampanii produktowej, które zostały lub nie zostały sprzedane.
request.columns[].savedColumnName string Nazwa zapisanej kolumny do uwzględnienia w raporcie. Raport musi obejmować zakres reklamodawcy lub niższy, a zapisana kolumna musi być już utworzona w interfejsie DoubleClick Search.
request.columns[].startDate string Data uwzględniania daty w formacie RRRR-MM-DD. Jeśli podasz wartość, zastąpi ona ogólny zakres czasowy raportu tylko dla tej kolumny. musi być podany razem z endDate.
request.downloadFormat string Format, w jakim ma zostać zwrócony raport. Obecnie obsługiwana jest csv lub tsv.
request.filters[] list Lista filtrów, które chcesz zastosować w raporcie.

Maksymalna liczba filtrów na żądanie wynosi 300.

request.filters[].column nested object Kolumna, na której chcesz wykonać filtr. Może to być kolumna DoubleClick Search lub zapisana.
request.filters[].column.columnName string Nazwa kolumny DoubleClick Search do uwzględnienia w raporcie.
request.filters[].column.customDimensionName string Podział raportu na segmenty według wymiaru niestandardowego. Raport musi mieć zakres ograniczony do reklamodawcy lub niższy, a wymiar niestandardowy musi być już skonfigurowany w usłudze DoubleClick Search. W nazwie wymiaru niestandardowego, która pojawia się w DoubleClick Search, wielkość liter ma znaczenie.

Jeśli jest używany w raporcie konwersji, zwraca wartość określonego wymiaru niestandardowego dla danej konwersji (jeśli jest ustawiona). Ta kolumna nie dzieli raportu konwersji na segmenty.

request.filters[].column.customMetricName string Nazwa danych niestandardowych do uwzględnienia w raporcie. Raport musi mieć zakres ograniczony do reklamodawcy lub niższy, a dane niestandardowe muszą być już skonfigurowane w usłudze DoubleClick Search. W nazwie danych niestandardowych, która pojawia się w DoubleClick Search, wielkość liter ma znaczenie.
request.filters[].column.endDate string Dzień włącznie w formacie RRRR-MM-DD. Jeśli podasz wartość, zastąpi ona ogólny zakres czasowy raportu tylko dla tej kolumny. musi być podany razem z startDate.
request.filters[].column.groupByColumn boolean Tylko raport synchroniczny. Wybierz true, aby grupować według tej kolumny. Domyślna wartość to false.
request.filters[].column.headerText string Tekst używany do identyfikacji tej kolumny w wynikach raportu. Jeśli nie zostanie podany, przyjmuje domyślnie wartość columnName lub savedColumnName. Pozwala to zapobiec kolizji między kolumnami DoubleClick Search i zapisanymi kolumnami o tej samej nazwie.
request.filters[].column.platformSource string Platforma, która służy do dostarczania danych do wymiaru niestandardowego. Dopuszczalne wartości to „Floodlight”.
request.filters[].column.productReportPerspective string Zwraca dane tylko o określonym typie aktywności produktu. Akceptowane wartości to:
  • sold”: wyświetla dane tylko dla produktów, które zostały sprzedane.
  • advertised”: wyświetla dane tylko dla produktów reklamowanych w kampanii produktowej, które zostały lub nie zostały sprzedane.
request.filters[].column.savedColumnName string Nazwa zapisanej kolumny do uwzględnienia w raporcie. Raport musi obejmować zakres reklamodawcy lub niższy, a zapisana kolumna musi być już utworzona w interfejsie DoubleClick Search.
request.filters[].column.startDate string Data uwzględniania daty w formacie RRRR-MM-DD. Jeśli podasz wartość, zastąpi ona ogólny zakres czasowy raportu tylko dla tej kolumny. musi być podany razem z endDate.
request.filters[].operator string Operator używany w filtrze. Listę dostępnych operatorów znajdziesz w dokumentacji filtra.
request.filters[].values[] list Lista wartości, według których można filtrować wartość kolumny.

Maksymalna liczba wartości filtra na jedno żądanie to 300.

request.includeDeletedEntities boolean Określa, czy usunięte elementy powinny być uwzględnione w raporcie. Domyślna wartość to false. Wycofano, użyj interfejsu includeRemovedEntities.
request.includeRemovedEntities boolean Określa, czy usunięte elementy powinny być uwzględnione w raporcie. Domyślna wartość to false.
request.maxRowsPerFile integer Tylko raport asynchroniczny. Maksymalna liczba wierszy w pliku raportu. Duży raport jest podzielony na wiele plików opartych na tym polu. Akceptowane wartości to 1000000100000000 (włącznie).
request.orderBy[] list Tylko raport synchroniczny. Lista kolumn i kierunków definiujących sposób sortowania w wierszach raportu.

Maksymalna liczba zamówień to 300.

request.orderBy[].column nested object Kolumna używana do sortowania. Może to być kolumna zdefiniowana przez DoubleClick Search lub zapisana.
request.orderBy[].column.columnName string Nazwa kolumny DoubleClick Search do uwzględnienia w raporcie.
request.orderBy[].column.customDimensionName string Podział raportu na segmenty według wymiaru niestandardowego. Raport musi mieć zakres ograniczony do reklamodawcy lub niższy, a wymiar niestandardowy musi być już skonfigurowany w usłudze DoubleClick Search. W nazwie wymiaru niestandardowego, która pojawia się w DoubleClick Search, wielkość liter ma znaczenie.

Jeśli jest używany w raporcie konwersji, zwraca wartość określonego wymiaru niestandardowego dla danej konwersji (jeśli jest ustawiona). Ta kolumna nie dzieli raportu konwersji na segmenty.

request.orderBy[].column.customMetricName string Nazwa danych niestandardowych do uwzględnienia w raporcie. Raport musi mieć zakres ograniczony do reklamodawcy lub niższy, a dane niestandardowe muszą być już skonfigurowane w usłudze DoubleClick Search. W nazwie danych niestandardowych, która pojawia się w DoubleClick Search, wielkość liter ma znaczenie.
request.orderBy[].column.endDate string Dzień włącznie w formacie RRRR-MM-DD. Jeśli podasz wartość, zastąpi ona ogólny zakres czasowy raportu tylko dla tej kolumny. musi być podany razem z startDate.
request.orderBy[].column.groupByColumn boolean Tylko raport synchroniczny. Wybierz true, aby grupować według tej kolumny. Domyślna wartość to false.
request.orderBy[].column.headerText string Tekst używany do identyfikacji tej kolumny w wynikach raportu. Jeśli nie zostanie podany, przyjmuje domyślnie wartość columnName lub savedColumnName. Pozwala to zapobiec kolizji między kolumnami DoubleClick Search i zapisanymi kolumnami o tej samej nazwie.
request.orderBy[].column.platformSource string Platforma, która służy do dostarczania danych do wymiaru niestandardowego. Dopuszczalne wartości to „Floodlight”.
request.orderBy[].column.productReportPerspective string Zwraca dane tylko o określonym typie aktywności produktu. Akceptowane wartości to:
  • sold”: wyświetla dane tylko dla produktów, które zostały sprzedane.
  • advertised”: wyświetla dane tylko dla produktów reklamowanych w kampanii produktowej, które zostały lub nie zostały sprzedane.
request.orderBy[].column.savedColumnName string Nazwa zapisanej kolumny do uwzględnienia w raporcie. Raport musi obejmować zakres reklamodawcy lub niższy, a zapisana kolumna musi być już utworzona w interfejsie DoubleClick Search.
request.orderBy[].column.startDate string Data uwzględniania daty w formacie RRRR-MM-DD. Jeśli podasz wartość, zastąpi ona ogólny zakres czasowy raportu tylko dla tej kolumny. musi być podany razem z endDate.
request.orderBy[].sortOrder string Kierunek sortowania, czyli ascending lub descending.
request.reportScope object Zakres raportu to zestaw identyfikatorów, które służą do określania podzbioru elementów, które zostaną zwrócone w raporcie. Wymagana jest pełna historia identyfikatorów z najniższego poziomu, o który prosisz w agencji.
request.reportScope.adGroupId long Identyfikator grupy reklam w DS.
request.reportScope.adId long Identyfikator reklamy w DS.
request.reportScope.advertiserId long Identyfikator reklamodawcy DS.
request.reportScope.agencyId long Identyfikator agencji w DS.
request.reportScope.campaignId long Identyfikator kampanii DS.
request.reportScope.engineAccountId long Identyfikator konta wyszukiwarki DS.
request.reportScope.keywordId long Identyfikator słowa kluczowego DS.
request.reportType string Określa typ wierszy wyświetlanych w raporcie. Jeśli np. określisz wartość reportType: keyword, każdy wiersz w raporcie będzie zawierał dane dotyczące słowa kluczowego. Informacje o kolumnach dostępnych w przypadku poszczególnych typów znajdziesz w artykule Typy raportów.
request.rowCount integer Tylko raport synchroniczny. Maksymalna liczba wierszy do zwrócenia; dodatkowe wiersze są pomijane. Akceptowane wartości to 010000 (włącznie). Domyślna wartość to 10000.
request.startRow integer Tylko raport synchroniczny. Indeks zerowy pierwszego wiersza do zwrócenia. Akceptowane wartości to 050000 (włącznie). Domyślna wartość to 0.
request.statisticsCurrency string Określa walutę, w której będą zwracane środki. Możliwe wartości: usd, agency (ważne, jeśli raport dotyczy zakresu agencji lub niższego zakresu), advertiser (ważne, jeśli raport ma zakres * reklamodawcy lub niższy), albo account (ważny, jeśli raport dotyczy zakresu konta wyszukiwarki lub niższego).
request.timeRange object Jeśli w raporcie zostaną żądane dane, ten argument służy do ograniczenia danych do określonego przedziału czasu.
request.timeRange.changedAttributesSinceTimestamp datetime Sygnatura czasowa UTC uwzględniająca format RFC, np. 2013-07-16T10:16:23.555Z. Zapoznaj się z dodatkowymi informacjami o działaniu raportów o zmienionych atrybutach.
request.timeRange.changedMetricsSinceTimestamp datetime Sygnatura czasowa UTC uwzględniająca format RFC, np. 2013-07-16T10:16:23.555Z. Zobacz dodatkowe materiały o tym, jak działają raporty o zmienionych wskaźnikach.
request.timeRange.endDate string Data uwzględniania daty w formacie RRRR-MM-DD.
request.timeRange.startDate string Data uwzględniania daty w formacie RRRR-MM-DD.
request.verifySingleTimeZone boolean Jeśli wybierzesz true, raport zostanie utworzony tylko wtedy, gdy wszystkie żądane dane statystyczne pochodzą z jednej strefy czasowej. Domyślna wartość to false.
rowCount integer Liczba wierszy wygenerowanych przez raport (bez nagłówków).
rows[] list Tylko raport synchroniczny. Wygenerowano wiersze raportu.
rows[].(key) any value Wskazuje kolumny przedstawione w tym wierszu. To oznacza, że każdy klucz odpowiada kolumnie z niepustą komórką w tym wierszu.
statisticsCurrencyCode string Kod waluty wszystkich wartości pieniężnych utworzonych w raporcie, łącznie z wartościami ustawianymi przez użytkowników (np. ustawieniami stawek za słowa kluczowe) i danymi (np. kosztem i przychodem). Kod waluty raportu jest określany w polu statisticsCurrency żądania.
statisticsTimeZone string Jeśli wszystkie statystyki w raporcie pochodzą z tej samej strefy czasowej, to właśnie on odpowiada za jego działanie. W przeciwnym razie pole nie jest skonfigurowane.

Metody

generuj
Generuje i zwraca raport od razu.
pobierz
Ankiety na temat stanu żądania raportu.
PobierzPlik
Pobiera plik raportu zakodowany w formacie UTF-8.
Plik GetIdMappingFile
Pobiera plik CSV (zakodowany w UTF-8), który zawiera mapowania identyfikatorów między poprzednią a nową wersją Search Ads 360. W przypadku wybranego reklamodawcy plik zawiera wszystkie elementy podrzędne (np. konta wyszukiwarek, kampanie, grupy reklam itp.), które występują zarówno w poprzedniej wersji Search Ads 360, jak i w nowej.
poproś
Wstawia żądanie raportu do systemu raportu.