Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / v1.6.0 / . / docs / dyn / dfareporting_v2_7.reports.html
blob: 8ac050cbe00f466d9551e44ebdd60b906a433c89 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dfareporting_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="dfareporting_v2_7.reports.compatibleFields.html">compatibleFields()</a></code>
</p>
<p class="firstline">Returns the compatibleFields Resource.</p>
<p class="toc_element">
<code><a href="dfareporting_v2_7.reports.files.html">files()</a></code>
</p>
<p class="firstline">Returns the files Resource.</p>
<p class="toc_element">
<code><a href="#delete">delete(profileId, reportId)</a></code></p>
<p class="firstline">Deletes a report by its ID.</p>
<p class="toc_element">
<code><a href="#get">get(profileId, reportId)</a></code></p>
<p class="firstline">Retrieves a report by its ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(profileId, body)</a></code></p>
<p class="firstline">Creates a report.</p>
<p class="toc_element">
<code><a href="#list">list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)</a></code></p>
<p class="firstline">Retrieves list of reports.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(profileId, reportId, body)</a></code></p>
<p class="firstline">Updates a report. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#run">run(profileId, reportId, synchronous=None)</a></code></p>
<p class="firstline">Runs a report.</p>
<p class="toc_element">
<code><a href="#update">update(profileId, reportId, body)</a></code></p>
<p class="firstline">Updates a report.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(profileId, reportId)</code>
<pre>Deletes a report by its ID.
Args:
profileId: string, The DFA user profile ID. (required)
reportId: string, The ID of the report. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(profileId, reportId)</code>
<pre>Retrieves a report by its ID.
Args:
profileId: string, The DFA user profile ID. (required)
reportId: string, The ID of the report. (required)
Returns:
An object of the form:
{ # Represents a Report resource.
"pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
"conversionDimensions": [ # The list of conversion dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"reportProperties": { # The properties of the report.
"clicksLookbackWindow": 42, # DFA 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.
"pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
"impressionsLookbackWindow": 42, # DFA 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.
"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.
"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.
"maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
"includeAttributedIPConversions": True or False, # Deprecated: has no effect.
"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.
},
"perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
},
"kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
"subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
"name": "A String", # The name of the report.
"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".
"startDate": "A String", # Start date of date range for which scheduled reports should be run.
"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.
"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", # The expiration date when the scheduled report stops running.
"active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
"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",
],
},
"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.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
"A String",
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
"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 three months.
},
"floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reportProperties": { # The properties of the report.
"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.
"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.
"includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
},
},
"fileName": "A String", # The filename used when generating report files for this report.
"delivery": { # The report's email delivery settings.
"message": "A String", # The message to be sent with each email.
"emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
"recipients": [ # The list of recipients to which to email the report.
{ # Represents a recipient.
"kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
"deliveryType": "A String", # The delivery type for the recipient.
"email": "A String", # The email address of the recipient.
},
],
"emailOwner": True or False, # Whether the report should be emailed to the report owner.
},
"etag": "A String", # The eTag of this response for caching purposes.
"criteria": { # The report criteria for a report of type "STANDARD".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of standard dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range for which this report should be run.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
},
"id": "A String", # The unique ID identifying this report resource.
"lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
"type": "A String", # The type of the report.
"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": "dfareporting#sortedDimension", # 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.
},
],
"overlapMetricNames": [ # The list of names of overlap metrics the report should include.
"A String",
],
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
"dimension": "A String", # The dimension option.
},
"accountId": "A String", # The account ID to which this report belongs.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(profileId, body)</code>
<pre>Creates a report.
Args:
profileId: string, The DFA user profile ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Represents a Report resource.
"pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
"conversionDimensions": [ # The list of conversion dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"reportProperties": { # The properties of the report.
"clicksLookbackWindow": 42, # DFA 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.
"pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
"impressionsLookbackWindow": 42, # DFA 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.
"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.
"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.
"maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
"includeAttributedIPConversions": True or False, # Deprecated: has no effect.
"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.
},
"perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
},
"kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
"subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
"name": "A String", # The name of the report.
"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".
"startDate": "A String", # Start date of date range for which scheduled reports should be run.
"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.
"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", # The expiration date when the scheduled report stops running.
"active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
"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",
],
},
"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.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
"A String",
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
"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 three months.
},
"floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reportProperties": { # The properties of the report.
"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.
"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.
"includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
},
},
"fileName": "A String", # The filename used when generating report files for this report.
"delivery": { # The report's email delivery settings.
"message": "A String", # The message to be sent with each email.
"emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
"recipients": [ # The list of recipients to which to email the report.
{ # Represents a recipient.
"kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
"deliveryType": "A String", # The delivery type for the recipient.
"email": "A String", # The email address of the recipient.
},
],
"emailOwner": True or False, # Whether the report should be emailed to the report owner.
},
"etag": "A String", # The eTag of this response for caching purposes.
"criteria": { # The report criteria for a report of type "STANDARD".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of standard dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range for which this report should be run.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
},
"id": "A String", # The unique ID identifying this report resource.
"lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
"type": "A String", # The type of the report.
"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": "dfareporting#sortedDimension", # 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.
},
],
"overlapMetricNames": [ # The list of names of overlap metrics the report should include.
"A String",
],
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
"dimension": "A String", # The dimension option.
},
"accountId": "A String", # The account ID to which this report belongs.
}
Returns:
An object of the form:
{ # Represents a Report resource.
"pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
"conversionDimensions": [ # The list of conversion dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"reportProperties": { # The properties of the report.
"clicksLookbackWindow": 42, # DFA 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.
"pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
"impressionsLookbackWindow": 42, # DFA 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.
"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.
"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.
"maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
"includeAttributedIPConversions": True or False, # Deprecated: has no effect.
"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.
},
"perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
},
"kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
"subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
"name": "A String", # The name of the report.
"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".
"startDate": "A String", # Start date of date range for which scheduled reports should be run.
"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.
"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", # The expiration date when the scheduled report stops running.
"active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
"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",
],
},
"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.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
"A String",
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
"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 three months.
},
"floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reportProperties": { # The properties of the report.
"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.
"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.
"includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
},
},
"fileName": "A String", # The filename used when generating report files for this report.
"delivery": { # The report's email delivery settings.
"message": "A String", # The message to be sent with each email.
"emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
"recipients": [ # The list of recipients to which to email the report.
{ # Represents a recipient.
"kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
"deliveryType": "A String", # The delivery type for the recipient.
"email": "A String", # The email address of the recipient.
},
],
"emailOwner": True or False, # Whether the report should be emailed to the report owner.
},
"etag": "A String", # The eTag of this response for caching purposes.
"criteria": { # The report criteria for a report of type "STANDARD".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of standard dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range for which this report should be run.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
},
"id": "A String", # The unique ID identifying this report resource.
"lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
"type": "A String", # The type of the report.
"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": "dfareporting#sortedDimension", # 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.
},
],
"overlapMetricNames": [ # The list of names of overlap metrics the report should include.
"A String",
],
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
"dimension": "A String", # The dimension option.
},
"accountId": "A String", # The account ID to which this report belongs.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)</code>
<pre>Retrieves list of reports.
Args:
profileId: string, The DFA user profile ID. (required)
pageToken: string, The value of the nextToken from the previous result page.
maxResults: integer, Maximum number of results to return.
sortOrder: string, Order of sorted results, default is 'DESCENDING'.
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
sortField: string, The field by which to sort the list.
Allowed values
ID - Sort by report ID.
LAST_MODIFIED_TIME - Sort by 'lastModifiedTime' field.
NAME - Sort by name of reports.
scope: string, The scope that defines which results are returned, default is 'MINE'.
Allowed values
ALL - All reports in account.
MINE - My reports.
Returns:
An object of the form:
{ # Represents the list of reports.
"nextPageToken": "A String", # Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
"items": [ # The reports returned in this response.
{ # Represents a Report resource.
"pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
"conversionDimensions": [ # The list of conversion dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"reportProperties": { # The properties of the report.
"clicksLookbackWindow": 42, # DFA 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.
"pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
"impressionsLookbackWindow": 42, # DFA 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.
"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.
"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.
"maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
"includeAttributedIPConversions": True or False, # Deprecated: has no effect.
"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.
},
"perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
},
"kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
"subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
"name": "A String", # The name of the report.
"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".
"startDate": "A String", # Start date of date range for which scheduled reports should be run.
"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.
"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", # The expiration date when the scheduled report stops running.
"active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
"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",
],
},
"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.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
"A String",
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
"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 three months.
},
"floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reportProperties": { # The properties of the report.
"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.
"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.
"includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
},
},
"fileName": "A String", # The filename used when generating report files for this report.
"delivery": { # The report's email delivery settings.
"message": "A String", # The message to be sent with each email.
"emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
"recipients": [ # The list of recipients to which to email the report.
{ # Represents a recipient.
"kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
"deliveryType": "A String", # The delivery type for the recipient.
"email": "A String", # The email address of the recipient.
},
],
"emailOwner": True or False, # Whether the report should be emailed to the report owner.
},
"etag": "A String", # The eTag of this response for caching purposes.
"criteria": { # The report criteria for a report of type "STANDARD".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of standard dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range for which this report should be run.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
},
"id": "A String", # The unique ID identifying this report resource.
"lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
"type": "A String", # The type of the report.
"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": "dfareporting#sortedDimension", # 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.
},
],
"overlapMetricNames": [ # The list of names of overlap metrics the report should include.
"A String",
],
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
"dimension": "A String", # The dimension option.
},
"accountId": "A String", # The account ID to which this report belongs.
},
],
"kind": "dfareporting#reportList", # The kind of list this is, in this case dfareporting#reportList.
"etag": "A String", # The eTag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(profileId, reportId, body)</code>
<pre>Updates a report. This method supports patch semantics.
Args:
profileId: string, The DFA user profile ID. (required)
reportId: string, The ID of the report. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Represents a Report resource.
"pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
"conversionDimensions": [ # The list of conversion dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"reportProperties": { # The properties of the report.
"clicksLookbackWindow": 42, # DFA 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.
"pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
"impressionsLookbackWindow": 42, # DFA 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.
"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.
"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.
"maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
"includeAttributedIPConversions": True or False, # Deprecated: has no effect.
"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.
},
"perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
},
"kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
"subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
"name": "A String", # The name of the report.
"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".
"startDate": "A String", # Start date of date range for which scheduled reports should be run.
"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.
"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", # The expiration date when the scheduled report stops running.
"active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
"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",
],
},
"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.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
"A String",
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
"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 three months.
},
"floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reportProperties": { # The properties of the report.
"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.
"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.
"includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
},
},
"fileName": "A String", # The filename used when generating report files for this report.
"delivery": { # The report's email delivery settings.
"message": "A String", # The message to be sent with each email.
"emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
"recipients": [ # The list of recipients to which to email the report.
{ # Represents a recipient.
"kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
"deliveryType": "A String", # The delivery type for the recipient.
"email": "A String", # The email address of the recipient.
},
],
"emailOwner": True or False, # Whether the report should be emailed to the report owner.
},
"etag": "A String", # The eTag of this response for caching purposes.
"criteria": { # The report criteria for a report of type "STANDARD".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of standard dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range for which this report should be run.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
},
"id": "A String", # The unique ID identifying this report resource.
"lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
"type": "A String", # The type of the report.
"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": "dfareporting#sortedDimension", # 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.
},
],
"overlapMetricNames": [ # The list of names of overlap metrics the report should include.
"A String",
],
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
"dimension": "A String", # The dimension option.
},
"accountId": "A String", # The account ID to which this report belongs.
}
Returns:
An object of the form:
{ # Represents a Report resource.
"pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
"conversionDimensions": [ # The list of conversion dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"reportProperties": { # The properties of the report.
"clicksLookbackWindow": 42, # DFA 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.
"pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
"impressionsLookbackWindow": 42, # DFA 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.
"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.
"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.
"maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
"includeAttributedIPConversions": True or False, # Deprecated: has no effect.
"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.
},
"perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
},
"kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
"subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
"name": "A String", # The name of the report.
"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".
"startDate": "A String", # Start date of date range for which scheduled reports should be run.
"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.
"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", # The expiration date when the scheduled report stops running.
"active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
"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",
],
},
"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.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
"A String",
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
"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 three months.
},
"floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reportProperties": { # The properties of the report.
"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.
"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.
"includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
},
},
"fileName": "A String", # The filename used when generating report files for this report.
"delivery": { # The report's email delivery settings.
"message": "A String", # The message to be sent with each email.
"emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
"recipients": [ # The list of recipients to which to email the report.
{ # Represents a recipient.
"kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
"deliveryType": "A String", # The delivery type for the recipient.
"email": "A String", # The email address of the recipient.
},
],
"emailOwner": True or False, # Whether the report should be emailed to the report owner.
},
"etag": "A String", # The eTag of this response for caching purposes.
"criteria": { # The report criteria for a report of type "STANDARD".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of standard dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range for which this report should be run.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
},
"id": "A String", # The unique ID identifying this report resource.
"lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
"type": "A String", # The type of the report.
"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": "dfareporting#sortedDimension", # 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.
},
],
"overlapMetricNames": [ # The list of names of overlap metrics the report should include.
"A String",
],
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
"dimension": "A String", # The dimension option.
},
"accountId": "A String", # The account ID to which this report belongs.
}</pre>
</div>
<div class="method">
<code class="details" id="run">run(profileId, reportId, synchronous=None)</code>
<pre>Runs a report.
Args:
profileId: string, The DFA profile ID. (required)
reportId: string, The ID of the report. (required)
synchronous: boolean, If set and true, tries to run the report synchronously.
Returns:
An object of the form:
{ # Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
"status": "A String", # The status of the report file.
"kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
"format": "A String", # The output format of the report. Only available once the file is available.
"dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"fileName": "A String", # The filename of the file.
"etag": "A String", # The eTag of this response for caching purposes.
"reportId": "A String", # The ID of the report this file was generated from.
"urls": { # The URLs where the completed report file can be downloaded.
"browserUrl": "A String", # The URL for downloading the report data through a browser.
"apiUrl": "A String", # The URL for downloading the report data through the API.
},
"lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
"id": "A String", # The unique ID of this report file.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(profileId, reportId, body)</code>
<pre>Updates a report.
Args:
profileId: string, The DFA user profile ID. (required)
reportId: string, The ID of the report. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Represents a Report resource.
"pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
"conversionDimensions": [ # The list of conversion dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"reportProperties": { # The properties of the report.
"clicksLookbackWindow": 42, # DFA 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.
"pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
"impressionsLookbackWindow": 42, # DFA 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.
"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.
"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.
"maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
"includeAttributedIPConversions": True or False, # Deprecated: has no effect.
"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.
},
"perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
},
"kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
"subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
"name": "A String", # The name of the report.
"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".
"startDate": "A String", # Start date of date range for which scheduled reports should be run.
"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.
"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", # The expiration date when the scheduled report stops running.
"active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
"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",
],
},
"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.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
"A String",
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
"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 three months.
},
"floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reportProperties": { # The properties of the report.
"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.
"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.
"includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
},
},
"fileName": "A String", # The filename used when generating report files for this report.
"delivery": { # The report's email delivery settings.
"message": "A String", # The message to be sent with each email.
"emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
"recipients": [ # The list of recipients to which to email the report.
{ # Represents a recipient.
"kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
"deliveryType": "A String", # The delivery type for the recipient.
"email": "A String", # The email address of the recipient.
},
],
"emailOwner": True or False, # Whether the report should be emailed to the report owner.
},
"etag": "A String", # The eTag of this response for caching purposes.
"criteria": { # The report criteria for a report of type "STANDARD".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of standard dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range for which this report should be run.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
},
"id": "A String", # The unique ID identifying this report resource.
"lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
"type": "A String", # The type of the report.
"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": "dfareporting#sortedDimension", # 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.
},
],
"overlapMetricNames": [ # The list of names of overlap metrics the report should include.
"A String",
],
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
"dimension": "A String", # The dimension option.
},
"accountId": "A String", # The account ID to which this report belongs.
}
Returns:
An object of the form:
{ # Represents a Report resource.
"pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
"conversionDimensions": [ # The list of conversion dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"reportProperties": { # The properties of the report.
"clicksLookbackWindow": 42, # DFA 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.
"pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
"impressionsLookbackWindow": 42, # DFA 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.
"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.
"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.
"maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
"includeAttributedIPConversions": True or False, # Deprecated: has no effect.
"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.
},
"perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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.
},
],
},
"kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
"subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
"name": "A String", # The name of the report.
"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".
"startDate": "A String", # Start date of date range for which scheduled reports should be run.
"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.
"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", # The expiration date when the scheduled report stops running.
"active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
"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",
],
},
"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.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
"A String",
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
"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 three months.
},
"floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
"dimensions": [ # The list of dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"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'.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"customRichMediaEvents": [ # The list of custom rich media events to include.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"reportProperties": { # The properties of the report.
"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.
"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.
"includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
},
},
"fileName": "A String", # The filename used when generating report files for this report.
"delivery": { # The report's email delivery settings.
"message": "A String", # The message to be sent with each email.
"emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
"recipients": [ # The list of recipients to which to email the report.
{ # Represents a recipient.
"kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
"deliveryType": "A String", # The delivery type for the recipient.
"email": "A String", # The email address of the recipient.
},
],
"emailOwner": True or False, # Whether the report should be emailed to the report owner.
},
"etag": "A String", # The eTag of this response for caching purposes.
"criteria": { # The report criteria for a report of type "STANDARD".
"activities": { # Represents an activity group. # Activity group.
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"metricNames": [ # List of names of floodlight activity metrics.
"A String",
],
},
"dimensions": [ # The list of standard dimensions the report should include.
{ # Represents a sorted dimension.
"kind": "dfareporting#sortedDimension", # 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",
],
"dateRange": { # Represents a date range. # The date range for which this report should be run.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"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.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
},
},
"id": "A String", # The unique ID identifying this report resource.
"lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
"type": "A String", # The type of the report.
"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": "dfareporting#sortedDimension", # 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.
},
],
"overlapMetricNames": [ # The list of names of overlap metrics the report should include.
"A String",
],
"metricNames": [ # The list of names of metrics the report should include.
"A String",
],
"dateRange": { # Represents a date range. # The date range this report should be run for.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
{ # Represents a DimensionValue resource.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
],
"pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
"dimension": "A String", # The dimension option.
},
"accountId": "A String", # The account ID to which this report belongs.
}</pre>
</div>
</body></html>