happygapi.dfareporting.reports — happygapi 0.4.10

Campaign Manager 360 API: reports. Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360. See: https://developers.google.com/doubleclick-advertisers/docs/reference/rest/v4/reports

compatibleFields-query$ clj

(compatibleFields-query$ auth parameters body)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v4/reports/compatibleFields/query

Required parameters: profileId

Optional parameters: none

Body:

{:floodlightCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}, :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :customRichMediaEvents [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :reportProperties {:includeAttributedIPConversions boolean, :includeUnattributedCookieConversions boolean, :includeUnattributedIPConversions boolean}}, :schedule {:active boolean, :repeats string, :repeatsOnWeekDays [string], :every integer, :startDate string, :expirationDate string, :runsOnDayOfMonth string, :timezone string}, :format string, :subAccountId string, :name string, :fileName string, :criteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :activities {:filters [DimensionValue], :metricNames [string], :kind string}, :customRichMediaEvents {:filteredEventIds [DimensionValue], :kind string}}, :delivery {:emailOwner boolean, :emailOwnerDeliveryType string, :message string, :recipients [{:email string, :deliveryType string, :kind string}]}, :type string, :etag string, :pathCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}, :activityFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :customChannelGrouping {:name string, :rules [ChannelGroupingRule], :fallbackName string, :kind string}, :pathFilters [{:kind string, :pathMatchPosition string, :eventFilters [EventFilter]}], :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string]}, :reachCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :activities {:filters [DimensionValue], :metricNames [string], :kind string}, :customRichMediaEvents {:filteredEventIds [DimensionValue], :kind string}, :reachByFrequencyMetricNames [string], :enableAllDimensionCombinations boolean}, :pathToConversionCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :conversionDimensions [{:name string, :sortOrder string, :kind string}], :customRichMediaEvents [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :reportProperties {:maximumInteractionGap integer, :includeAttributedIPConversions boolean, :includeUnattributedIPConversions boolean, :clicksLookbackWindow integer, :includeUnattributedCookieConversions boolean, :impressionsLookbackWindow integer, :maximumClickInteractions integer, :pivotOnInteractionPath boolean, :maximumImpressionInteractions integer}, :activityFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :customFloodlightVariables [{:name string, :sortOrder string, :kind string}], :perInteractionDimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}}, :lastModifiedTime string, :id string, :pathAttributionCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}, :activityFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :customChannelGrouping {:name string, :rules [ChannelGroupingRule], :fallbackName string, :kind string}, :pathFilters [{:kind string, :pathMatchPosition string, :eventFilters [EventFilter]}], :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string]}, :kind string, :ownerProfileId string, :accountId string, :crossDimensionReachCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :dimension string, :pivoted boolean, :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :breakdown [{:name string, :sortOrder string, :kind string}], :metricNames [string], :overlapMetricNames [string]}}

Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.

delete$ clj

(delete$ auth parameters)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v4/reports/delete

Required parameters: profileId, reportId

Optional parameters: none

Deletes a report by its ID.

files-get$ clj

(files-get$ auth parameters)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v4/reports/files/get

Required parameters: profileId, reportId, fileId

Optional parameters: none

Retrieves a report file by its report ID and file ID. This method supports media download.

files-list$ clj

(files-list$ auth parameters)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v4/reports/files/list

Required parameters: profileId, reportId

Optional parameters: sortField, sortOrder, maxResults, pageToken

Lists files for a report.

get$ clj

(get$ auth parameters)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v4/reports/get

Required parameters: profileId, reportId

Optional parameters: none

Retrieves a report by its ID.

insert$ clj

(insert$ auth parameters body)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v4/reports/insert

Required parameters: profileId

Optional parameters: none

Body:

{:floodlightCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}, :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :customRichMediaEvents [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :reportProperties {:includeAttributedIPConversions boolean, :includeUnattributedCookieConversions boolean, :includeUnattributedIPConversions boolean}}, :schedule {:active boolean, :repeats string, :repeatsOnWeekDays [string], :every integer, :startDate string, :expirationDate string, :runsOnDayOfMonth string, :timezone string}, :format string, :subAccountId string, :name string, :fileName string, :criteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :activities {:filters [DimensionValue], :metricNames [string], :kind string}, :customRichMediaEvents {:filteredEventIds [DimensionValue], :kind string}}, :delivery {:emailOwner boolean, :emailOwnerDeliveryType string, :message string, :recipients [{:email string, :deliveryType string, :kind string}]}, :type string, :etag string, :pathCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}, :activityFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :customChannelGrouping {:name string, :rules [ChannelGroupingRule], :fallbackName string, :kind string}, :pathFilters [{:kind string, :pathMatchPosition string, :eventFilters [EventFilter]}], :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string]}, :reachCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :activities {:filters [DimensionValue], :metricNames [string], :kind string}, :customRichMediaEvents {:filteredEventIds [DimensionValue], :kind string}, :reachByFrequencyMetricNames [string], :enableAllDimensionCombinations boolean}, :pathToConversionCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :conversionDimensions [{:name string, :sortOrder string, :kind string}], :customRichMediaEvents [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :reportProperties {:maximumInteractionGap integer, :includeAttributedIPConversions boolean, :includeUnattributedIPConversions boolean, :clicksLookbackWindow integer, :includeUnattributedCookieConversions boolean, :impressionsLookbackWindow integer, :maximumClickInteractions integer, :pivotOnInteractionPath boolean, :maximumImpressionInteractions integer}, :activityFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :customFloodlightVariables [{:name string, :sortOrder string, :kind string}], :perInteractionDimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}}, :lastModifiedTime string, :id string, :pathAttributionCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}, :activityFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :customChannelGrouping {:name string, :rules [ChannelGroupingRule], :fallbackName string, :kind string}, :pathFilters [{:kind string, :pathMatchPosition string, :eventFilters [EventFilter]}], :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string]}, :kind string, :ownerProfileId string, :accountId string, :crossDimensionReachCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :dimension string, :pivoted boolean, :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :breakdown [{:name string, :sortOrder string, :kind string}], :metricNames [string], :overlapMetricNames [string]}}

Creates a report.

list$ clj

(list$ auth parameters)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v4/reports/list

Required parameters: profileId

Optional parameters: maxResults, pageToken, scope, sortField, sortOrder

Retrieves list of reports.

patch$ clj

(patch$ auth parameters body)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v4/reports/patch

Required parameters: profileId, reportId

Optional parameters: none

Body:

{:floodlightCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}, :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :customRichMediaEvents [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :reportProperties {:includeAttributedIPConversions boolean, :includeUnattributedCookieConversions boolean, :includeUnattributedIPConversions boolean}}, :schedule {:active boolean, :repeats string, :repeatsOnWeekDays [string], :every integer, :startDate string, :expirationDate string, :runsOnDayOfMonth string, :timezone string}, :format string, :subAccountId string, :name string, :fileName string, :criteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :activities {:filters [DimensionValue], :metricNames [string], :kind string}, :customRichMediaEvents {:filteredEventIds [DimensionValue], :kind string}}, :delivery {:emailOwner boolean, :emailOwnerDeliveryType string, :message string, :recipients [{:email string, :deliveryType string, :kind string}]}, :type string, :etag string, :pathCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}, :activityFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :customChannelGrouping {:name string, :rules [ChannelGroupingRule], :fallbackName string, :kind string}, :pathFilters [{:kind string, :pathMatchPosition string, :eventFilters [EventFilter]}], :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string]}, :reachCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :activities {:filters [DimensionValue], :metricNames [string], :kind string}, :customRichMediaEvents {:filteredEventIds [DimensionValue], :kind string}, :reachByFrequencyMetricNames [string], :enableAllDimensionCombinations boolean}, :pathToConversionCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :conversionDimensions [{:name string, :sortOrder string, :kind string}], :customRichMediaEvents [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :reportProperties {:maximumInteractionGap integer, :includeAttributedIPConversions boolean, :includeUnattributedIPConversions boolean, :clicksLookbackWindow integer, :includeUnattributedCookieConversions boolean, :impressionsLookbackWindow integer, :maximumClickInteractions integer, :pivotOnInteractionPath boolean, :maximumImpressionInteractions integer}, :activityFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :customFloodlightVariables [{:name string, :sortOrder string, :kind string}], :perInteractionDimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}}, :lastModifiedTime string, :id string, :pathAttributionCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}, :activityFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :customChannelGrouping {:name string, :rules [ChannelGroupingRule], :fallbackName string, :kind string}, :pathFilters [{:kind string, :pathMatchPosition string, :eventFilters [EventFilter]}], :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string]}, :kind string, :ownerProfileId string, :accountId string, :crossDimensionReachCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :dimension string, :pivoted boolean, :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :breakdown [{:name string, :sortOrder string, :kind string}], :metricNames [string], :overlapMetricNames [string]}}

Updates an existing report. This method supports patch semantics.

run$ clj

(run$ auth parameters)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v4/reports/run

Required parameters: profileId, reportId

Optional parameters: synchronous

Runs a report.

update$ clj

(update$ auth parameters body)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v4/reports/update

Required parameters: profileId, reportId

Optional parameters: none

Body:

{:floodlightCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}, :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :customRichMediaEvents [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :reportProperties {:includeAttributedIPConversions boolean, :includeUnattributedCookieConversions boolean, :includeUnattributedIPConversions boolean}}, :schedule {:active boolean, :repeats string, :repeatsOnWeekDays [string], :every integer, :startDate string, :expirationDate string, :runsOnDayOfMonth string, :timezone string}, :format string, :subAccountId string, :name string, :fileName string, :criteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :activities {:filters [DimensionValue], :metricNames [string], :kind string}, :customRichMediaEvents {:filteredEventIds [DimensionValue], :kind string}}, :delivery {:emailOwner boolean, :emailOwnerDeliveryType string, :message string, :recipients [{:email string, :deliveryType string, :kind string}]}, :type string, :etag string, :pathCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}, :activityFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :customChannelGrouping {:name string, :rules [ChannelGroupingRule], :fallbackName string, :kind string}, :pathFilters [{:kind string, :pathMatchPosition string, :eventFilters [EventFilter]}], :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string]}, :reachCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :activities {:filters [DimensionValue], :metricNames [string], :kind string}, :customRichMediaEvents {:filteredEventIds [DimensionValue], :kind string}, :reachByFrequencyMetricNames [string], :enableAllDimensionCombinations boolean}, :pathToConversionCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :conversionDimensions [{:name string, :sortOrder string, :kind string}], :customRichMediaEvents [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :reportProperties {:maximumInteractionGap integer, :includeAttributedIPConversions boolean, :includeUnattributedIPConversions boolean, :clicksLookbackWindow integer, :includeUnattributedCookieConversions boolean, :impressionsLookbackWindow integer, :maximumClickInteractions integer, :pivotOnInteractionPath boolean, :maximumImpressionInteractions integer}, :activityFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :customFloodlightVariables [{:name string, :sortOrder string, :kind string}], :perInteractionDimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string], :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}}, :lastModifiedTime string, :id string, :pathAttributionCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :floodlightConfigId {:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}, :activityFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :customChannelGrouping {:name string, :rules [ChannelGroupingRule], :fallbackName string, :kind string}, :pathFilters [{:kind string, :pathMatchPosition string, :eventFilters [EventFilter]}], :dimensions [{:name string, :sortOrder string, :kind string}], :metricNames [string]}, :kind string, :ownerProfileId string, :accountId string, :crossDimensionReachCriteria {:dateRange {:startDate string, :endDate string, :relativeDateRange string, :kind string}, :dimension string, :pivoted boolean, :dimensionFilters [{:dimensionName string, :value string, :id string, :matchType string, :kind string, :etag string}], :breakdown [{:name string, :sortOrder string, :kind string}], :metricNames [string], :overlapMetricNames [string]}}

Updates a report.