happygapi.doubleclicksearch.reports — happygapi 0.4.10

Search Ads 360 API: reports. The Search Ads 360 API allows developers to automate uploading conversions and downloading reports from Search Ads 360. See: https://developers.google.com/search-adsdocs/reference/rest/v2/reports

generate$ clj

(generate$ auth parameters body)

https://developers.google.com/search-adsapi/reference/rest/v2/reports/generate

Required parameters: none

Optional parameters: none

Body:

{:timeRange {:changedMetricsSinceTimestamp string, :changedAttributesSinceTimestamp string, :startDate string, :endDate string}, :filters [{:column {:productReportPerspective string, :customMetricName string, :startDate string, :headerText string, :endDate string, :groupByColumn boolean, :platformSource string, :customDimensionName string, :savedColumnName string, :columnName string}, :operator string, :values [any]}], :columns [{:productReportPerspective string, :customMetricName string, :startDate string, :headerText string, :endDate string, :groupByColumn boolean, :platformSource string, :customDimensionName string, :savedColumnName string, :columnName string}], :includeRemovedEntities boolean, :verifySingleTimeZone boolean, :includeDeletedEntities boolean, :statisticsCurrency string, :reportScope {:agencyId string, :advertiserId string, :engineAccountId string, :campaignId string, :adGroupId string, :keywordId string, :adId string}, :reportType string, :startRow integer, :maxRowsPerFile integer, :rowCount integer, :downloadFormat string, :orderBy [{:column {:productReportPerspective string, :customMetricName string, :startDate string, :headerText string, :endDate string, :groupByColumn boolean, :platformSource string, :customDimensionName string, :savedColumnName string, :columnName string}, :sortOrder string}]}

Generates and returns a report immediately.

get$ clj

(get$ auth parameters)

https://developers.google.com/search-adsapi/reference/rest/v2/reports/get

Required parameters: reportId

Optional parameters: none

Polls for the status of a report request.

getFile$ clj

(getFile$ auth parameters)

https://developers.google.com/search-adsapi/reference/rest/v2/reports/getFile

Required parameters: reportId, reportFragment

Optional parameters: none

Downloads a report file encoded in UTF-8.

getIdMappingFile$ clj

(getIdMappingFile$ auth parameters)

https://developers.google.com/search-adsapi/reference/rest/v2/reports/getIdMappingFile

Required parameters: agencyId, advertiserId

Optional parameters: none

Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360. The file includes all children entities of the given advertiser(e.g. engine accounts, campaigns, ad groups, etc.) that exist in both legacy SA360 and new SA360.

request$ clj

(request$ auth parameters body)

https://developers.google.com/search-adsapi/reference/rest/v2/reports/request

Required parameters: none

Optional parameters: none

Body:

{:timeRange {:changedMetricsSinceTimestamp string, :changedAttributesSinceTimestamp string, :startDate string, :endDate string}, :filters [{:column {:productReportPerspective string, :customMetricName string, :startDate string, :headerText string, :endDate string, :groupByColumn boolean, :platformSource string, :customDimensionName string, :savedColumnName string, :columnName string}, :operator string, :values [any]}], :columns [{:productReportPerspective string, :customMetricName string, :startDate string, :headerText string, :endDate string, :groupByColumn boolean, :platformSource string, :customDimensionName string, :savedColumnName string, :columnName string}], :includeRemovedEntities boolean, :verifySingleTimeZone boolean, :includeDeletedEntities boolean, :statisticsCurrency string, :reportScope {:agencyId string, :advertiserId string, :engineAccountId string, :campaignId string, :adGroupId string, :keywordId string, :adId string}, :reportType string, :startRow integer, :maxRowsPerFile integer, :rowCount integer, :downloadFormat string, :orderBy [{:column {:productReportPerspective string, :customMetricName string, :startDate string, :headerText string, :endDate string, :groupByColumn boolean, :platformSource string, :customDimensionName string, :savedColumnName string, :columnName string}, :sortOrder string}]}

Inserts a report request into the reporting system.