happygapi.dfareporting.reports — happygapi 0.4.8

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/api/reference/rest/v3.5/reports

compatibleFields-query$ clj

(compatibleFields-query$ auth parameters body)

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

Required parameters: profileId

Optional parameters: none

Body:

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

Required parameters: profileId, reportId

Optional parameters: maxResults, sortField, pageToken, sortOrder

Lists files for a report.

get$ clj

(get$ auth parameters)

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

Required parameters: reportId, profileId

Optional parameters: none

Retrieves a report by its ID.

insert$ clj

(insert$ auth parameters body)

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

Required parameters: profileId

Optional parameters: none

Body:

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

Creates a report.

list$ clj

(list$ auth parameters)

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

Required parameters: profileId

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

Retrieves list of reports.

patch$ clj

(patch$ auth parameters body)

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

Required parameters: profileId, reportId

Optional parameters: none

Body:

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

Updates an existing report. This method supports patch semantics.

run$ clj

(run$ auth parameters)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v3.5/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/v3.5/reports/update

Required parameters: reportId, profileId

Optional parameters: none

Body:

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

Updates a report.