docs/dyn/admob_v1beta.accounts.campaignReport.html - external/github.com/google/google-api-python-client - Git at Google

 <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="admob_v1beta.html">AdMob API</a> . <a href="admob_v1beta.accounts.html">accounts</a> . <a href="admob_v1beta.accounts.campaignReport.html">campaignReport</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#close">close()</a></code></p>
 <p class="firstline">Close httplib2 connections.</p>
 <p class="toc_element">
   <code><a href="#generate">generate(parent, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Generates Campaign Report based on provided specifications.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="close">close()</code>
   <pre>Close httplib2 connections.</pre>
 </div>

 <div class="method">
     <code class="details" id="generate">generate(parent, body=None, x__xgafv=None)</code>
   <pre>Generates Campaign Report based on provided specifications.

 Args:
   parent: string, Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654 (required)
   body: object, The request body.
     The object takes the form of:

 { # Request to generate campaign report.
   &quot;reportSpec&quot;: { # The specification for generating a Campaign report. For example, the specification to get IMPRESSIONS and CLICKS sliced by CAMPAIGN_ID can look like the following example: { &quot;date_range&quot;: { &quot;start_date&quot;: {&quot;year&quot;: 2021, &quot;month&quot;: 12, &quot;day&quot;: 1}, &quot;end_date&quot;: {&quot;year&quot;: 2021, &quot;month&quot;: 12, &quot;day&quot;: 30} }, &quot;dimensions&quot;: [&quot;CAMPAIGN_ID&quot;], &quot;metrics&quot;: [&quot;IMPRESSIONS&quot;, &quot;CLICKS&quot;], } # Campaign report specification.
     &quot;dateRange&quot;: { # Specification of a single date range. Both dates are inclusive. # The date range for which the report is generated. The max range is 30 days.
       &quot;endDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # End date of the date range, inclusive. Must be greater than or equal to the start date.
         &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
         &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
         &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
       },
       &quot;startDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Start date of the date range, inclusive. Must be less than or equal to the end date.
         &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
         &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
         &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
       },
     },
     &quot;dimensions&quot;: [ # List of dimensions of the report. The value combination of these dimensions determines the row of the report. If no dimensions are specified, the report returns a single row of requested metrics for the entire account.
       &quot;A String&quot;,
     ],
     &quot;languageCode&quot;: &quot;A String&quot;, # Language used for any localized text, such as certain applicable dimension values. The language tag is defined in the IETF BCP47. Defaults to &#x27;en-US&#x27; if unspecified or invalid.
     &quot;metrics&quot;: [ # List of metrics of the report. A report must specify at least one metric.
       &quot;A String&quot;,
     ],
   },
 }

   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Campaign Report API response.
   &quot;rows&quot;: [ # The campaign report data from the specified publisher. At most 100000 rows will be returned from the API.
     { # A row of the returning report.
       &quot;dimensionValues&quot;: { # Map of dimension values in a row, with keys as enum name of the dimensions.
         &quot;a_key&quot;: { # Representation of a dimension value.
           &quot;displayLabel&quot;: &quot;A String&quot;, # The localized string representation of the value. If unspecified, the display label should be derived from the value.
           &quot;value&quot;: &quot;A String&quot;, # Dimension value in the format specified in the report&#x27;s spec Dimension enum.
         },
       },
       &quot;metricValues&quot;: { # Map of metric values in a row, with keys as enum name of the metrics. If a metric being requested has no value returned, the map will not include it.
         &quot;a_key&quot;: { # Representation of a metric value.
           &quot;doubleValue&quot;: 3.14, # Double precision (approximate) decimal values. Rates are from 0 to 1.
           &quot;integerValue&quot;: &quot;A String&quot;, # Metric integer value.
           &quot;microsValue&quot;: &quot;A String&quot;, # Amount in micros. One million is equivalent to one unit. Currency value is in the unit (USD, EUR or other) specified by the request. For example, $6.50 whould be represented as 6500000 micros.
         },
       },
     },
   ],
 }</pre>
 </div>

 </body></html>
	<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="admob_v1beta.html">AdMob API</a> . <a href="admob_v1beta.accounts.html">accounts</a> . <a href="admob_v1beta.accounts.campaignReport.html">campaignReport</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#close">close()</a></code></p>
	<p class="firstline">Close httplib2 connections.</p>
	<p class="toc_element">
	<code><a href="#generate">generate(parent, body=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Generates Campaign Report based on provided specifications.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="close">close()</code>
	<pre>Close httplib2 connections.</pre>
	</div>

	<div class="method">
	<code class="details" id="generate">generate(parent, body=None, x__xgafv=None)</code>
	<pre>Generates Campaign Report based on provided specifications.

	Args:
	parent: string, Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654 (required)
	body: object, The request body.
	The object takes the form of:

	{ # Request to generate campaign report.
	"reportSpec": { # The specification for generating a Campaign report. For example, the specification to get IMPRESSIONS and CLICKS sliced by CAMPAIGN_ID can look like the following example: { "date_range": { "start_date": {"year": 2021, "month": 12, "day": 1}, "end_date": {"year": 2021, "month": 12, "day": 30} }, "dimensions": ["CAMPAIGN_ID"], "metrics": ["IMPRESSIONS", "CLICKS"], } # Campaign report specification.
	"dateRange": { # Specification of a single date range. Both dates are inclusive. # The date range for which the report is generated. The max range is 30 days.
	"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # End date of the date range, inclusive. Must be greater than or equal to the start date.
	"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
	"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
	"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
	},
	"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Start date of the date range, inclusive. Must be less than or equal to the end date.
	"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
	"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
	"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
	},
	},
	"dimensions": [ # List of dimensions of the report. The value combination of these dimensions determines the row of the report. If no dimensions are specified, the report returns a single row of requested metrics for the entire account.
	"A String",
	],
	"languageCode": "A String", # Language used for any localized text, such as certain applicable dimension values. The language tag is defined in the IETF BCP47. Defaults to 'en-US' if unspecified or invalid.
	"metrics": [ # List of metrics of the report. A report must specify at least one metric.
	"A String",
	],
	},
	}

	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Campaign Report API response.
	"rows": [ # The campaign report data from the specified publisher. At most 100000 rows will be returned from the API.
	{ # A row of the returning report.
	"dimensionValues": { # Map of dimension values in a row, with keys as enum name of the dimensions.
	"a_key": { # Representation of a dimension value.
	"displayLabel": "A String", # The localized string representation of the value. If unspecified, the display label should be derived from the value.
	"value": "A String", # Dimension value in the format specified in the report's spec Dimension enum.
	},
	},
	"metricValues": { # Map of metric values in a row, with keys as enum name of the metrics. If a metric being requested has no value returned, the map will not include it.
	"a_key": { # Representation of a metric value.
	"doubleValue": 3.14, # Double precision (approximate) decimal values. Rates are from 0 to 1.
	"integerValue": "A String", # Metric integer value.
	"microsValue": "A String", # Amount in micros. One million is equivalent to one unit. Currency value is in the unit (USD, EUR or other) specified by the request. For example, $6.50 whould be represented as 6500000 micros.
	},
	},
	},
	],
	}</pre>
	</div>

	</body></html>