Wstawia żądanie raportu do systemu raportu. Wypróbuj teraz
Żądanie
Żądanie HTTP
POST https://www.googleapis.com/doubleclicksearch/v2/reports
Upoważnienie
To żądanie wymaga autoryzacji w następującym zakresie:
Zakres |
---|
https://www.googleapis.com/auth/doubleclicksearch |
Więcej informacji znajdziesz na stronie uwierzytelniania i autoryzacji.
Treść żądania
W treści żądania podaj dane o tej strukturze:
{ "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 }
Nazwa usługi | Wartość | opis, | Uwagi |
---|---|---|---|
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. | |
reportScope.agencyId |
long |
Identyfikator agencji w DS. | |
reportScope.advertiserId |
long |
Identyfikator reklamodawcy DS. | |
reportScope.engineAccountId |
long |
Identyfikator konta wyszukiwarki DS. | |
reportScope.campaignId |
long |
Identyfikator kampanii DS. | |
reportScope.adGroupId |
long |
Identyfikator grupy reklam w DS. | |
reportScope.keywordId |
long |
Identyfikator słowa kluczowego DS. | |
reportScope.adId |
long |
Identyfikator reklamy w DS. | |
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. |
|
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. |
|
columns[].columnName |
string |
Nazwa kolumny DoubleClick Search do uwzględnienia w raporcie. | |
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. | |
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. |
|
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 . |
|
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 . |
|
columns[].groupByColumn |
boolean |
Tylko raport synchroniczny. Wybierz true , aby grupować według tej kolumny. Domyślna wartość to false . |
|
timeRange |
object |
Jeśli w raporcie zostaną żądane dane, ten argument służy do ograniczenia danych do określonego przedziału czasu. | |
timeRange.startDate |
string |
Data uwzględniania daty w formacie RRRR-MM-DD. | |
timeRange.endDate |
string |
Data uwzględniania daty w formacie RRRR-MM-DD. | |
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. |
|
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. |
|
filters[] |
list |
Lista filtrów, które chcesz zastosować w raporcie. Maksymalna liczba filtrów na żądanie wynosi 300. |
|
filters[].column |
nested object |
Kolumna, na której chcesz wykonać filtr. Może to być kolumna DoubleClick Search lub zapisana. | |
filters[].column.columnName |
string |
Nazwa kolumny DoubleClick Search do uwzględnienia w raporcie. | |
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. | |
filters[].operator |
string |
Operator używany w filtrze. Listę dostępnych operatorów znajdziesz w dokumentacji filtra. | |
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. |
|
orderBy[] |
list |
Tylko raport synchroniczny. Lista kolumn i kierunków definiujących sposób sortowania w wierszach raportu. Maksymalna liczba zamówień to 300. |
|
orderBy[].column |
nested object |
Kolumna używana do sortowania. Może to być kolumna zdefiniowana przez DoubleClick Search lub zapisana. | |
orderBy[].column.columnName |
string |
Nazwa kolumny DoubleClick Search do uwzględnienia w raporcie. | |
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. | |
orderBy[].sortOrder |
string |
Kierunek sortowania, czyli ascending lub descending . |
|
includeDeletedEntities |
boolean |
Określa, czy usunięte elementy powinny być uwzględnione w raporcie. Domyślna wartość to false . Wycofano, użyj interfejsu includeRemovedEntities . |
|
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 . |
|
downloadFormat |
string |
Format, w jakim ma zostać zwrócony raport. Obecnie obsługiwana jest csv lub tsv . |
|
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). |
|
startRow |
integer |
Tylko raport synchroniczny. Indeks zerowy pierwszego wiersza do zwrócenia. Akceptowane wartości to 0 –50000 (włącznie). Domyślna wartość to 0 . |
|
rowCount |
integer |
Tylko raport synchroniczny. Maksymalna liczba wierszy do zwrócenia; dodatkowe wiersze są pomijane. Akceptowane wartości to 0 –10000 (włącznie). Domyślna wartość to 10000 . |
|
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 1000000 –100000000 (włącznie). |
|
includeRemovedEntities |
boolean |
Określa, czy usunięte elementy powinny być uwzględnione w raporcie. Domyślna wartość to false . |
|
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. |
|
columns[].platformSource |
string |
Platforma, która służy do dostarczania danych do wymiaru niestandardowego. Dopuszczalne wartości to „Floodlight”. | |
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. |
|
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. |
|
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 . |
|
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 . |
|
filters[].column.groupByColumn |
boolean |
Tylko raport synchroniczny. Wybierz true , aby grupować według tej kolumny. Domyślna wartość to false . |
|
filters[].column.platformSource |
string |
Platforma, która służy do dostarczania danych do wymiaru niestandardowego. Dopuszczalne wartości to „Floodlight”. | |
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. |
|
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. |
|
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 . |
|
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 . |
|
orderBy[].column.groupByColumn |
boolean |
Tylko raport synchroniczny. Wybierz true , aby grupować według tej kolumny. Domyślna wartość to false . |
|
orderBy[].column.platformSource |
string |
Platforma, która służy do dostarczania danych do wymiaru niestandardowego. Dopuszczalne wartości to „Floodlight”. | |
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. | |
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. | |
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. | |
columns[].productReportPerspective |
string |
Zwraca dane tylko o określonym typie aktywności produktu. Akceptowane wartości to:
|
|
filters[].column.productReportPerspective |
string |
Zwraca dane tylko o określonym typie aktywności produktu. Akceptowane wartości to:
|
|
orderBy[].column.productReportPerspective |
string |
Zwraca dane tylko o określonym typie aktywności produktu. Akceptowane wartości to:
|
Odpowiedź
Jeśli operacja się uda, metoda zwróci zasób raportów w treści odpowiedzi.
Wypróbuj
Skorzystaj z eksploratora interfejsów API poniżej, aby wywołać tę metodę w aktywnych danych i zobaczyć odpowiedź. Możesz też wypróbować samodzielny eksplorator.