Błyskawicznie generuje i zwraca raport. Wypróbuj
Żądanie
Żądanie HTTP
POST https://www.googleapis.com/doubleclicksearch/v2/reports/generate
Autoryzacja
To żądanie wymaga autoryzacji w tym zakresie:
| Zakres | 
|---|
| https://www.googleapis.com/auth/doubleclicksearch | 
Więcej informacji znajdziesz na stronie dotyczącej uwierzytelniania i autoryzacji.
Treść żądania
Dane w treści żądania podaj w następującej 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 | RaportZakres to zbiór identyfikatorów służących do określania podzbioru elementów, które będą zwracane w raporcie. Wymagana jest pełna historia identyfikatorów z najniższego poziomu zakresu żądanego przez agencję. | |
| 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 DS. | |
| reportScope.keywordId | long | Identyfikator słowa kluczowego DS. | |
| reportScope.adId | long | Identyfikator reklamy DS. | |
| reportType | string | Określa typ wierszy zwracanych w raporcie. Jeśli np. podasz reportType: keyword, każdy wiersz raportu będzie zawierał dane o słowie kluczowym. Kolumny dostępne dla poszczególnych typów znajdziesz w informacjach o typach raportów. | |
| columns[] | list | Kolumny do uwzględnienia w raporcie. Obejmuje to zarówno kolumny DoubleClick Search, jak i zapisane kolumny. W przypadku kolumn DoubleClick Search wymagany jest tylko parametr columnName. W przypadku zapisanych kolumn wymagany jest tylko parametrsavedColumnName. ZarównocolumnName, jak isavedColumnNamenie mogą być ustawione w tej samej strofie.Maksymalna liczba kolumn na żądanie to 300. | |
| columns[].columnName | string | Nazwa kolumny DoubleClick Search, która ma zostać uwzględniona w raporcie. | |
| columns[].savedColumnName | string | Nazwa zapisanej kolumny do uwzględnienia w raporcie. Zakres raportu musi być ograniczony do reklamodawcy lub niższego. Zapisana kolumna musi być już utworzona w interfejsie DoubleClick Search. | |
| columns[].headerText | string | tekst służący do identyfikacji tej kolumny w wynikach raportu; Jeśli nie zostanie określony, domyślna wartość to columnNamelubsavedColumnName. Pozwala to uniknąć kolizji między kolumnami DoubleClick Search a zapisanymi kolumnami o tej samej nazwie. | |
| columns[].startDate | string | Uwzględniaj datę w formacie RRRR-MM-DD. Jeśli podasz dane, zastąpią one ogólny zakres czasowy raportu w tej kolumnie. Wartość musi być podana razem z właściwością endDate. | |
| columns[].endDate | string | Dzień promujący integrację społeczną w formacie RRRR-MM-DD. Jeśli podasz dane, zastąpią one ogólny zakres czasowy raportu w tej kolumnie. Wartość musi być podana razem z właściwością startDate. | |
| columns[].groupByColumn | boolean | Tylko raport synchroniczny. Ustaw jako true, aby grupować według tej kolumny. Domyślna wartość tofalse. | |
| timeRange | object | Jeśli w raporcie zażądają danych, ten argument będzie używany do ograniczenia danych do określonego zakresu czasowego. | |
| timeRange.startDate | string | Uwzględniaj datę w formacie RRRR-MM-DD. | |
| timeRange.endDate | string | Uwzględniaj datę w formacie RRRR-MM-DD. | |
| timeRange.changedMetricsSinceTimestamp | datetime | Sygnatura czasowa UTC uwzględniająca warunki w formacie RFC, np. 2013-07-16T10:16:23.555Z. Zobacz dodatkowe materiały na temat tego, jak działają raporty o zmienionych danych. | |
| timeRange.changedAttributesSinceTimestamp | datetime | Sygnatura czasowa UTC uwzględniająca warunki w formacie RFC, np. 2013-07-16T10:16:23.555Z. Zapoznaj się z dodatkowymi materiałami na temat działania raportów o zmienionych atrybutach. | |
| filters[] | list | Lista filtrów, które można zastosować w raporcie. Maksymalna liczba filtrów na żądanie to 300. | |
| filters[].column | nested object | Kolumna, według której zostanie zastosowany filtr. Może to być kolumna DoubleClick Search lub zapisana kolumna. | |
| filters[].column.columnName | string | Nazwa kolumny DoubleClick Search, która ma zostać uwzględniona w raporcie. | |
| filters[].column.savedColumnName | string | Nazwa zapisanej kolumny do uwzględnienia w raporcie. Zakres raportu musi być ograniczony do reklamodawcy lub niższego. Zapisana kolumna musi być już utworzona w interfejsie DoubleClick Search. | |
| filters[].operator | string | Operator do użycia w filtrze. Listę dostępnych operatorów znajdziesz w opisie filtrów. | |
| filters[].values[] | list | Lista wartości, według których ma być filtrowana wartość kolumny. Maksymalna liczba wartości filtra na żądanie to 300. | |
| orderBy[] | list | Tylko raport synchroniczny. Lista kolumn i kierunków definiujących sortowanie wierszy raportu. Maksymalna liczba zamówień na żądanie to 300. | |
| orderBy[].column | nested object | Kolumna, w której ma zostać wykonane sortowanie. Może to być kolumna zdefiniowana w usłudze DoubleClick Search lub kolumna zapisana. | |
| orderBy[].column.columnName | string | Nazwa kolumny DoubleClick Search, która ma zostać uwzględniona w raporcie. | |
| orderBy[].column.savedColumnName | string | Nazwa zapisanej kolumny do uwzględnienia w raporcie. Zakres raportu musi być ograniczony do reklamodawcy lub niższego. Zapisana kolumna musi być już utworzona w interfejsie DoubleClick Search. | |
| orderBy[].sortOrder | string | Kierunek sortowania, który jest wartością ascendinglubdescending. | |
| includeDeletedEntities | boolean | Określa, czy usunięte elementy powinny być uwzględnione w raporcie. Domyślna wartość to false. Wycofano. Zamiast niego używaj:includeRemovedEntities. | |
| verifySingleTimeZone | boolean | W przypadku wartości trueraport zostanie utworzony tylko wtedy, gdy wszystkie żądane dane statystyczne pochodzą z jednej strefy czasowej. Domyślna wartość tofalse. | |
| downloadFormat | string | Format, w jakim ma być zwracany raport. Obecnie obsługiwane są formy csvitsv. | |
| statisticsCurrency | string | Określa walutę, w której zostanie zwrócona kwota pieniężna. Możliwe wartości: usd,agency(prawidłowe, jeśli raport jest ograniczony do agencji lub niższego zakresu),advertiser(ważny, jeśli raport ma zakres ograniczony do reklamodawcy * lub węższego) orazaccount(obowiązują, jeśli raport ma zakres ograniczony do konta wyszukiwarki lub niższym). | |
| startRow | integer | Tylko raport synchroniczny. Indeks liczony od zera dla pierwszego wiersza do zwrócenia. Akceptowane wartości to od 0do50000włącznie. Domyślna wartość to0. | |
| rowCount | integer | Tylko raport synchroniczny. maksymalna liczba wierszy do zwrócenia; są pomijane dodatkowe wiersze. Akceptowane wartości to od 0do10000włącznie. Domyślna wartość to10000. | |
| maxRowsPerFile | integer | Tylko raport asynchroniczny. Maksymalna liczba wierszy w pliku raportu. Na podstawie tego pola duży raport jest dzielony na wiele plików. Akceptowane wartości to od 1000000do100000000włącznie. | |
| includeRemovedEntities | boolean | Określa, czy usunięte elementy powinny być uwzględnione w raporcie. Domyślna wartość to false. | |
| columns[].customDimensionName | string | Segmentuje raport według wymiaru niestandardowego. Zakres raportu musi być na poziomie reklamodawcy lub niższym, a wymiar niestandardowy musi być już skonfigurowany w Search Ads 360. W nazwie wymiaru niestandardowego widoczna w usłudze DoubleClick Search jest rozróżniana wielkość liter. Jeśli używasz go 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 służąca do dostarczania danych do wymiaru niestandardowego. Akceptowane wartości to „floodlight”. | |
| filters[].column.customDimensionName | string | Segmentuje raport według wymiaru niestandardowego. Zakres raportu musi być na poziomie reklamodawcy lub niższym, a wymiar niestandardowy musi być już skonfigurowany w usłudze DoubleClick Search. W nazwie wymiaru niestandardowego widoczna w usłudze DoubleClick Search jest rozróżniana wielkość liter. Jeśli używasz go 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 służący do identyfikacji tej kolumny w wynikach raportu; Jeśli nie zostanie określony, domyślna wartość to columnNamelubsavedColumnName. Pozwala to uniknąć kolizji między kolumnami DoubleClick Search a zapisanymi kolumnami o tej samej nazwie. | |
| filters[].column.startDate | string | Uwzględniaj datę w formacie RRRR-MM-DD. Jeśli podasz dane, zastąpią one ogólny zakres czasowy raportu w tej kolumnie. Wartość musi być podana razem z właściwością endDate. | |
| filters[].column.endDate | string | Dzień promujący integrację społeczną w formacie RRRR-MM-DD. Jeśli podasz dane, zastąpią one ogólny zakres czasowy raportu w tej kolumnie. Wartość musi być podana razem z właściwością startDate. | |
| filters[].column.groupByColumn | boolean | Tylko raport synchroniczny. Ustaw jako true, aby grupować według tej kolumny. Domyślna wartość tofalse. | |
| filters[].column.platformSource | string | Platforma służąca do dostarczania danych do wymiaru niestandardowego. Akceptowane wartości to „floodlight”. | |
| orderBy[].column.customDimensionName | string | Segmentuje raport według wymiaru niestandardowego. Zakres raportu musi być na poziomie reklamodawcy lub niższym, a wymiar niestandardowy musi być już skonfigurowany w usłudze DoubleClick Search. W nazwie wymiaru niestandardowego widoczna w usłudze DoubleClick Search jest rozróżniana wielkość liter. Jeśli używasz go 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 służący do identyfikacji tej kolumny w wynikach raportu; Jeśli nie zostanie określony, domyślna wartość to columnNamelubsavedColumnName. Pozwala to uniknąć kolizji między kolumnami DoubleClick Search a zapisanymi kolumnami o tej samej nazwie. | |
| orderBy[].column.startDate | string | Uwzględniaj datę w formacie RRRR-MM-DD. Jeśli podasz dane, zastąpią one ogólny zakres czasowy raportu w tej kolumnie. Wartość musi być podana razem z właściwością endDate. | |
| orderBy[].column.endDate | string | Dzień promujący integrację społeczną w formacie RRRR-MM-DD. Jeśli podasz dane, zastąpią one ogólny zakres czasowy raportu w tej kolumnie. Wartość musi być podana razem z właściwością startDate. | |
| orderBy[].column.groupByColumn | boolean | Tylko raport synchroniczny. Ustaw jako true, aby grupować według tej kolumny. Domyślna wartość tofalse. | |
| orderBy[].column.platformSource | string | Platforma służąca do dostarczania danych do wymiaru niestandardowego. Akceptowane wartości to „floodlight”. | |
| columns[].customMetricName | string | Nazwa danych niestandardowych do uwzględnienia w raporcie. Zakres raportu musi być ograniczony do reklamodawcy lub niższego, a dane niestandardowe muszą być już skonfigurowane w Search Ads 360. W nazwie danych niestandardowych widoczna w Search Ads 360 jest rozróżniana wielkość liter. | |
| filters[].column.customMetricName | string | Nazwa danych niestandardowych do uwzględnienia w raporcie. Zakres raportu musi być ograniczony do reklamodawcy lub niższego, a dane niestandardowe muszą być już skonfigurowane w Search Ads 360. W nazwie danych niestandardowych widoczna w Search Ads 360 jest rozróżniana wielkość liter. | |
| orderBy[].column.customMetricName | string | Nazwa danych niestandardowych do uwzględnienia w raporcie. Zakres raportu musi być ograniczony do reklamodawcy lub niższego, a dane niestandardowe muszą być już skonfigurowane w Search Ads 360. W nazwie danych niestandardowych widoczna w Search Ads 360 jest rozróżniana wielkość liter. | |
| columns[].productReportPerspective | string | Zwraca dane tylko o określonym typie aktywności związanej z produktem. Akceptowane wartości to: 
 | |
| filters[].column.productReportPerspective | string | Zwraca dane tylko o określonym typie aktywności związanej z produktem. Akceptowane wartości to: 
 | |
| orderBy[].column.productReportPerspective | string | Zwraca dane tylko o określonym typie aktywności związanej z produktem. Akceptowane wartości to: 
 | 
Odpowiedź
Jeśli operacja się uda, metoda zwróci zasób Reports (zasób) w treści odpowiedzi.
Wypróbuj
Użyj poniższego eksploratora interfejsów API, aby wywołać tę metodę na bieżących danych i wyświetlić odpowiedź. Możesz też wypróbować samodzielna Eksplorator.
