Close httplib2 connections.
query(profileId, body=None, x__xgafv=None)
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.
close()
Close httplib2 connections.
query(profileId, body=None, x__xgafv=None)
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.
Args:
profileId: string, The Campaign Manager 360 user profile ID. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Report resource.
"accountId": "A String", # The account ID to which this report belongs.
"criteria": { # The report criteria for a report of type "STANDARD".
"activities": { # Represents an activity group. # Activity group.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
},
"dateRange": { # Represents a date range. # The date range for which this report should be run.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"dimensions": [ # The list of standard dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
},
"crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
"breakdown": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"dimension": "A String", # The dimension option.
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"overlapMetricNames": [ # The list of names of overlap metrics the report should include.
"A String",
],
"pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
},
"delivery": { # The report's email delivery settings.
"emailOwner": True or False, # Whether the report should be emailed to the report owner.
"emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
"message": "A String", # The message to be sent with each email.
"recipients": [ # The list of recipients to which to email the report.
{ # Represents a recipient.
"deliveryType": "A String", # The delivery type for the recipient.
"email": "A String", # The email address of the recipient.
"kind": "A String", # The kind of resource this is, in this case dfareporting#recipient.
},
],
},
"etag": "A String", # The eTag of this response for caching purposes.
"fileName": "A String", # The filename used when generating report files for this report.
"floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"reportProperties": { # The properties of the report.
"includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
"includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
"includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
},
},
"format": "A String", # The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"id": "A String", # The unique ID identifying this report resource.
"kind": "A String", # The kind of resource this is, in this case dfareporting#report.
"lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
"name": "A String", # The name of the report.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"pathAttributionCriteria": { # The report criteria for a report of type "PATH_ATTRIBUTION".
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
"fallbackName": "A String", # ChannelGrouping fallback name.
"kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
"name": "A String", # ChannelGrouping name.
"rules": [ # The rules contained within this channel grouping.
{ # Represents a DfaReporting channel grouping rule.
"disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
{ # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
"eventFilters": [ # The event filters contained within this disjunctive match statement.
{ # Represents a DfaReporting event filter.
"dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
"dimensionName": "A String", # The name of the dimension.
"ids": [ # The possible ID's associated with the value if available.
"A String",
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"values": [ # The possible values of the dimension.
"A String",
],
},
"kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
"uvarFilter": { # Defines the filtering on a single uvar. # Filter on a custom variable.
"complement": True or False, # Return rows which don't match this filter.
"index": "A String", # Custom variable index the filter is applied to.
"kind": "A String", # The kind of resource this is, in this case dfareporting#uvarFilter.
"match": "A String", # Indicates how the filter should be matched to the values.
"values": [ # Values to filter on.
"A String",
],
},
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
"name": "A String", # Rule name.
},
],
},
"dateRange": { # Represents a date range. # The date range this report should be run for.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"pathFilters": [ # Path Filters.
{ # Represents a DfaReporting path filter.
"eventFilters": [ # Event filters in path report.
{ # Represents a DfaReporting event filter.
"dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
"dimensionName": "A String", # The name of the dimension.
"ids": [ # The possible ID's associated with the value if available.
"A String",
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"values": [ # The possible values of the dimension.
"A String",
],
},
"kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
"uvarFilter": { # Defines the filtering on a single uvar. # Filter on a custom variable.
"complement": True or False, # Return rows which don't match this filter.
"index": "A String", # Custom variable index the filter is applied to.
"kind": "A String", # The kind of resource this is, in this case dfareporting#uvarFilter.
"match": "A String", # Indicates how the filter should be matched to the values.
"values": [ # Values to filter on.
"A String",
],
},
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
"pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
},
],
},
"pathCriteria": { # The report criteria for a report of type "PATH".
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
"fallbackName": "A String", # ChannelGrouping fallback name.
"kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
"name": "A String", # ChannelGrouping name.
"rules": [ # The rules contained within this channel grouping.
{ # Represents a DfaReporting channel grouping rule.
"disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
{ # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
"eventFilters": [ # The event filters contained within this disjunctive match statement.
{ # Represents a DfaReporting event filter.
"dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
"dimensionName": "A String", # The name of the dimension.
"ids": [ # The possible ID's associated with the value if available.
"A String",
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"values": [ # The possible values of the dimension.
"A String",
],
},
"kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
"uvarFilter": { # Defines the filtering on a single uvar. # Filter on a custom variable.
"complement": True or False, # Return rows which don't match this filter.
"index": "A String", # Custom variable index the filter is applied to.
"kind": "A String", # The kind of resource this is, in this case dfareporting#uvarFilter.
"match": "A String", # Indicates how the filter should be matched to the values.
"values": [ # Values to filter on.
"A String",
],
},
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
"name": "A String", # Rule name.
},
],
},
"dateRange": { # Represents a date range. # The date range this report should be run for.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"pathFilters": [ # Path Filters.
{ # Represents a DfaReporting path filter.
"eventFilters": [ # Event filters in path report.
{ # Represents a DfaReporting event filter.
"dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
"dimensionName": "A String", # The name of the dimension.
"ids": [ # The possible ID's associated with the value if available.
"A String",
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"values": [ # The possible values of the dimension.
"A String",
],
},
"kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
"uvarFilter": { # Defines the filtering on a single uvar. # Filter on a custom variable.
"complement": True or False, # Return rows which don't match this filter.
"index": "A String", # Custom variable index the filter is applied to.
"kind": "A String", # The kind of resource this is, in this case dfareporting#uvarFilter.
"match": "A String", # Indicates how the filter should be matched to the values.
"values": [ # Values to filter on.
"A String",
],
},
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
"pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
},
],
},
"pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"conversionDimensions": [ # The list of conversion dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"reportProperties": { # The properties of the report.
"clicksLookbackWindow": 42, # CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
"impressionsLookbackWindow": 42, # CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
"includeAttributedIPConversions": True or False, # Deprecated: has no effect.
"includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
"includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
"maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
"maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
"maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
"pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
},
},
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
},
"dateRange": { # Represents a date range. # The date range this report should be run for.
"endDate": "A String",
"kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
"startDate": "A String",
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
{ # Represents a DimensionValue resource.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
],
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
"name": "A String", # The name of the dimension.
"sortOrder": "A String", # An optional sort order for the dimension column.
},
],
"enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
"A String",
],
},
"schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
"active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
"every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
"expirationDate": "A String",
"repeats": "A String", # The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
"repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
"A String",
],
"runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
"startDate": "A String",
"timezone": "A String", # The timezone when the report will run.
},
"subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
"type": "A String", # The type of the report.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a response to the queryCompatibleFields method.
"crossDimensionReachReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". # Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
"breakdown": [ # Dimensions which are compatible to be selected in the "breakdown" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. impressions
},
],
"overlapMetrics": [ # Metrics which are compatible to be selected in the "overlapMetricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. impressions
},
],
},
"floodlightReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". # Contains items that are compatible to be selected for a report of type "FLOODLIGHT".
"dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. impressions
},
],
},
"kind": "A String", # The kind of resource this is, in this case dfareporting#compatibleFields.
"pathAttributionReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "PATH". # Contains items that are compatible to be selected for a report of type "PATH_ATTRIBUTION".
"channelGroupings": [ # Dimensions which are compatible to be selected in the "channelGroupings" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. impressions
},
],
"pathFilters": [ # Dimensions which are compatible to be selected in the "pathFilters" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
},
"pathReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "PATH". # Contains items that are compatible to be selected for a report of type "PATH".
"channelGroupings": [ # Dimensions which are compatible to be selected in the "channelGroupings" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. impressions
},
],
"pathFilters": [ # Dimensions which are compatible to be selected in the "pathFilters" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
},
"pathToConversionReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION". # Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION".
"conversionDimensions": [ # Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"customFloodlightVariables": [ # Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. impressions
},
],
"perInteractionDimensions": [ # Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
},
"reachReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "REACH". # Contains items that are compatible to be selected for a report of type "REACH".
"dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. impressions
},
],
"pivotedActivityMetrics": [ # Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. impressions
},
],
"reachByFrequencyMetrics": [ # Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. impressions
},
],
},
"reportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "STANDARD". # Contains items that are compatible to be selected for a report of type "STANDARD".
"dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
{ # Represents a dimension.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
"name": "A String", # The dimension name, e.g. advertiser
},
],
"kind": "A String", # The kind of resource this is, in this case dfareporting#reportCompatibleFields.
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. impressions
},
],
"pivotedActivityMetrics": [ # Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
{ # Represents a metric.
"kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
"name": "A String", # The metric name, e.g. impressions
},
],
},
}