docs/dyn/gan.v1beta1.events.html - platform/external/python/google-api-python-client - Gitiles


 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head><title>Python: class Resource</title>
 </head><body bgcolor="#f0f0f8">
 <p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#ffc8d8">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>

 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 <td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
 <tr><td>&nbsp;</td>
 <td width="100%">Methods defined here:<br>
 <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>

 <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;event&nbsp;data&nbsp;for&nbsp;a&nbsp;given&nbsp;advertiser/publisher.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;orderId:&nbsp;string,&nbsp;Caret(^)&nbsp;delimited&nbsp;list&nbsp;of&nbsp;order&nbsp;IDs.&nbsp;Filters&nbsp;out&nbsp;all&nbsp;events&nbsp;that&nbsp;do&nbsp;not&nbsp;reference&nbsp;one&nbsp;of&nbsp;the&nbsp;given&nbsp;order&nbsp;IDs.&nbsp;Optional.<br>
 &nbsp;&nbsp;linkId:&nbsp;string,&nbsp;Caret(^)&nbsp;delimited&nbsp;list&nbsp;of&nbsp;link&nbsp;IDs.&nbsp;Filters&nbsp;out&nbsp;all&nbsp;events&nbsp;that&nbsp;do&nbsp;not&nbsp;reference&nbsp;one&nbsp;of&nbsp;the&nbsp;given&nbsp;link&nbsp;IDs.&nbsp;Optional.<br>
 &nbsp;&nbsp;advertiserId:&nbsp;string,&nbsp;Caret(^)&nbsp;delimited&nbsp;list&nbsp;of&nbsp;advertiser&nbsp;IDs.&nbsp;Filters&nbsp;out&nbsp;all&nbsp;events&nbsp;that&nbsp;do&nbsp;not&nbsp;reference&nbsp;one&nbsp;of&nbsp;the&nbsp;given&nbsp;advertiser&nbsp;IDs.&nbsp;Only&nbsp;used&nbsp;when&nbsp;under&nbsp;publishers&nbsp;role.&nbsp;Optional.<br>
 &nbsp;&nbsp;sku:&nbsp;string,&nbsp;Caret(^)&nbsp;delimited&nbsp;list&nbsp;of&nbsp;SKUs.&nbsp;Filters&nbsp;out&nbsp;all&nbsp;events&nbsp;that&nbsp;do&nbsp;not&nbsp;reference&nbsp;one&nbsp;of&nbsp;the&nbsp;given&nbsp;SKU.&nbsp;Optional.<br>
 &nbsp;&nbsp;roleId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;requesting&nbsp;advertiser&nbsp;or&nbsp;publisher.&nbsp;(required)<br>
 &nbsp;&nbsp;productCategory:&nbsp;string,&nbsp;Caret(^)&nbsp;delimited&nbsp;list&nbsp;of&nbsp;product&nbsp;categories.&nbsp;Filters&nbsp;out&nbsp;all&nbsp;events&nbsp;that&nbsp;do&nbsp;not&nbsp;reference&nbsp;a&nbsp;product&nbsp;in&nbsp;one&nbsp;of&nbsp;the&nbsp;given&nbsp;product&nbsp;categories.&nbsp;Optional.<br>
 &nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;The&nbsp;value&nbsp;of&nbsp;'nextPageToken'&nbsp;from&nbsp;the&nbsp;previous&nbsp;page.&nbsp;Optional.<br>
 &nbsp;&nbsp;role:&nbsp;string,&nbsp;The&nbsp;role&nbsp;of&nbsp;the&nbsp;requester.&nbsp;Valid&nbsp;values:&nbsp;'advertisers'&nbsp;or&nbsp;'publishers'.&nbsp;(required)<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;advertisers&nbsp;-&nbsp;The&nbsp;requester&nbsp;is&nbsp;requesting&nbsp;as&nbsp;an&nbsp;advertiser.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;publishers&nbsp;-&nbsp;The&nbsp;requester&nbsp;is&nbsp;requesting&nbsp;as&nbsp;a&nbsp;publisher.<br>
 &nbsp;&nbsp;modifyDateMin:&nbsp;string,&nbsp;Filters&nbsp;out&nbsp;all&nbsp;events&nbsp;modified&nbsp;earlier&nbsp;than&nbsp;given&nbsp;date.&nbsp;Optional.&nbsp;Defaults&nbsp;to&nbsp;24&nbsp;hours&nbsp;before&nbsp;the&nbsp;current&nbsp;modifyDateMax,&nbsp;if&nbsp;modifyDateMax&nbsp;is&nbsp;explicitly&nbsp;set.<br>
 &nbsp;&nbsp;type:&nbsp;string,&nbsp;Filters&nbsp;out&nbsp;all&nbsp;events&nbsp;that&nbsp;are&nbsp;not&nbsp;of&nbsp;the&nbsp;given&nbsp;type.&nbsp;Valid&nbsp;values:&nbsp;'action',&nbsp;'transaction',&nbsp;'charge'.&nbsp;Optional.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;action&nbsp;-&nbsp;The&nbsp;completion&nbsp;of&nbsp;an&nbsp;application,&nbsp;sign-up,&nbsp;or&nbsp;other&nbsp;process.&nbsp;For&nbsp;example,&nbsp;an&nbsp;action&nbsp;occurs&nbsp;if&nbsp;a&nbsp;user&nbsp;clicks&nbsp;an&nbsp;ad&nbsp;for&nbsp;a&nbsp;credit&nbsp;card&nbsp;and&nbsp;completes&nbsp;an&nbsp;application&nbsp;for&nbsp;that&nbsp;card.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;charge&nbsp;-&nbsp;A&nbsp;charge&nbsp;event&nbsp;is&nbsp;typically&nbsp;a&nbsp;payment&nbsp;between&nbsp;an&nbsp;advertiser,&nbsp;publisher&nbsp;or&nbsp;Google.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;transaction&nbsp;-&nbsp;A&nbsp;conversion&nbsp;event,&nbsp;typically&nbsp;an&nbsp;e-commerce&nbsp;transaction.&nbsp;Some&nbsp;advertisers&nbsp;use&nbsp;a&nbsp;transaction&nbsp;to&nbsp;record&nbsp;other&nbsp;types&nbsp;of&nbsp;events,&nbsp;such&nbsp;as&nbsp;magazine&nbsp;subscriptions.<br>
 &nbsp;&nbsp;status:&nbsp;string,&nbsp;Filters&nbsp;out&nbsp;all&nbsp;events&nbsp;that&nbsp;do&nbsp;not&nbsp;have&nbsp;the&nbsp;given&nbsp;status.&nbsp;Valid&nbsp;values:&nbsp;'active',&nbsp;'canceled'.&nbsp;Optional.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;active&nbsp;-&nbsp;Event&nbsp;is&nbsp;currently&nbsp;active.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;canceled&nbsp;-&nbsp;Event&nbsp;is&nbsp;currently&nbsp;canceled.<br>
 &nbsp;&nbsp;modifyDateMax:&nbsp;string,&nbsp;Filters&nbsp;out&nbsp;all&nbsp;events&nbsp;modified&nbsp;later&nbsp;than&nbsp;given&nbsp;date.&nbsp;Optional.&nbsp;Defaults&nbsp;to&nbsp;24&nbsp;hours&nbsp;after&nbsp;modifyDateMin,&nbsp;if&nbsp;modifyDateMin&nbsp;is&nbsp;explicitly&nbsp;set.<br>
 &nbsp;&nbsp;eventDateMin:&nbsp;string,&nbsp;Filters&nbsp;out&nbsp;all&nbsp;events&nbsp;earlier&nbsp;than&nbsp;given&nbsp;date.&nbsp;Optional.&nbsp;Defaults&nbsp;to&nbsp;24&nbsp;hours&nbsp;from&nbsp;current&nbsp;date/time.<br>
 &nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Max&nbsp;number&nbsp;of&nbsp;offers&nbsp;to&nbsp;return&nbsp;in&nbsp;this&nbsp;page.&nbsp;Optional.&nbsp;Defaults&nbsp;to&nbsp;20.<br>
 &nbsp;&nbsp;chargeType:&nbsp;string,&nbsp;Filters&nbsp;out&nbsp;all&nbsp;charge&nbsp;events&nbsp;that&nbsp;are&nbsp;not&nbsp;of&nbsp;the&nbsp;given&nbsp;charge&nbsp;type.&nbsp;Valid&nbsp;values:&nbsp;'other',&nbsp;'slotting_fee',&nbsp;'monthly_minimum',&nbsp;'tier_bonus',&nbsp;'credit',&nbsp;'debit'.&nbsp;Optional.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;credit&nbsp;-&nbsp;A&nbsp;credit&nbsp;increases&nbsp;the&nbsp;publisher's&nbsp;payout&nbsp;amount&nbsp;and&nbsp;decreases&nbsp;the&nbsp;advertiser's&nbsp;invoice&nbsp;amount.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;debit&nbsp;-&nbsp;A&nbsp;debit&nbsp;reduces&nbsp;the&nbsp;publisher's&nbsp;payout&nbsp;and&nbsp;increases&nbsp;the&nbsp;advertiser's&nbsp;invoice&nbsp;amount.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;monthly_minimum&nbsp;-&nbsp;A&nbsp;payment&nbsp;made&nbsp;to&nbsp;Google&nbsp;by&nbsp;an&nbsp;advertiser&nbsp;as&nbsp;a&nbsp;minimum&nbsp;monthly&nbsp;network&nbsp;fee.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;other&nbsp;-&nbsp;Catch&nbsp;all.&nbsp;Default&nbsp;if&nbsp;unset<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;slotting_fee&nbsp;-&nbsp;A&nbsp;one&nbsp;time&nbsp;payment&nbsp;made&nbsp;from&nbsp;an&nbsp;advertiser&nbsp;to&nbsp;a&nbsp;publisher.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;tier_bonus&nbsp;-&nbsp;A&nbsp;payment&nbsp;from&nbsp;an&nbsp;advertiser&nbsp;to&nbsp;a&nbsp;publisher&nbsp;for&nbsp;the&nbsp;publisher&nbsp;maintaining&nbsp;a&nbsp;high&nbsp;tier&nbsp;level<br>
 &nbsp;&nbsp;eventDateMax:&nbsp;string,&nbsp;Filters&nbsp;out&nbsp;all&nbsp;events&nbsp;later&nbsp;than&nbsp;given&nbsp;date.&nbsp;Optional.&nbsp;Defaults&nbsp;to&nbsp;24&nbsp;hours&nbsp;after&nbsp;eventMin.<br>
 &nbsp;&nbsp;memberId:&nbsp;string,&nbsp;Caret(^)&nbsp;delimited&nbsp;list&nbsp;of&nbsp;member&nbsp;IDs.&nbsp;Filters&nbsp;out&nbsp;all&nbsp;events&nbsp;that&nbsp;do&nbsp;not&nbsp;reference&nbsp;one&nbsp;of&nbsp;the&nbsp;given&nbsp;member&nbsp;IDs.&nbsp;Optional.<br>
 &nbsp;&nbsp;publisherId:&nbsp;string,&nbsp;Caret(^)&nbsp;delimited&nbsp;list&nbsp;of&nbsp;publisher&nbsp;IDs.&nbsp;Filters&nbsp;out&nbsp;all&nbsp;events&nbsp;that&nbsp;do&nbsp;not&nbsp;reference&nbsp;one&nbsp;of&nbsp;the&nbsp;given&nbsp;publishers&nbsp;IDs.&nbsp;Only&nbsp;used&nbsp;when&nbsp;under&nbsp;advertiser&nbsp;role.&nbsp;Optional.<br>
 &nbsp;<br>
 Returns:<br>
 &nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
 &nbsp;<br>
 &nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"nextPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;'pageToken'&nbsp;to&nbsp;pass&nbsp;to&nbsp;the&nbsp;next&nbsp;request&nbsp;to&nbsp;get&nbsp;the&nbsp;next&nbsp;page,&nbsp;if&nbsp;there&nbsp;are&nbsp;more&nbsp;to&nbsp;retrieve.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;event&nbsp;list.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;An&nbsp;EventResource.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"networkFee":&nbsp;{&nbsp;#&nbsp;An&nbsp;ApiMoneyProto.&nbsp;#&nbsp;Fee&nbsp;that&nbsp;the&nbsp;advertiser&nbsp;paid&nbsp;to&nbsp;the&nbsp;Google&nbsp;Affiliate&nbsp;Network.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"amount":&nbsp;3.14,&nbsp;#&nbsp;The&nbsp;amount&nbsp;of&nbsp;money.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currencyCode":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;3-letter&nbsp;code&nbsp;of&nbsp;the&nbsp;currency&nbsp;in&nbsp;question.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"advertiserName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;advertiser&nbsp;for&nbsp;this&nbsp;event.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"gan#event",&nbsp;#&nbsp;The&nbsp;kind&nbsp;for&nbsp;one&nbsp;event.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"modifyDate":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;date-time&nbsp;this&nbsp;event&nbsp;was&nbsp;last&nbsp;modified&nbsp;as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;date-time&nbsp;value.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;event&nbsp;(action|transaction|charge).<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"orderId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;order&nbsp;ID&nbsp;for&nbsp;this&nbsp;event.&nbsp;Only&nbsp;returned&nbsp;for&nbsp;conversion&nbsp;events.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"publisherName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;publisher&nbsp;for&nbsp;this&nbsp;event.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"memberId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;member&nbsp;attached&nbsp;to&nbsp;this&nbsp;event.&nbsp;Only&nbsp;returned&nbsp;for&nbsp;conversion&nbsp;events.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"advertiserId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ID&nbsp;of&nbsp;advertiser&nbsp;for&nbsp;this&nbsp;event.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Status&nbsp;of&nbsp;the&nbsp;event&nbsp;(active|canceled).&nbsp;Only&nbsp;returned&nbsp;for&nbsp;charge&nbsp;and&nbsp;conversion&nbsp;events.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"chargeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;charge&nbsp;ID&nbsp;for&nbsp;this&nbsp;event.&nbsp;Only&nbsp;returned&nbsp;for&nbsp;charge&nbsp;events.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"products":&nbsp;[&nbsp;#&nbsp;Products&nbsp;associated&nbsp;with&nbsp;the&nbsp;event.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"networkFee":&nbsp;{&nbsp;#&nbsp;An&nbsp;ApiMoneyProto.&nbsp;#&nbsp;Fee&nbsp;that&nbsp;the&nbsp;advertiser&nbsp;paid&nbsp;to&nbsp;the&nbsp;Google&nbsp;Affiliate&nbsp;Network&nbsp;for&nbsp;this&nbsp;product.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"amount":&nbsp;3.14,&nbsp;#&nbsp;The&nbsp;amount&nbsp;of&nbsp;money.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currencyCode":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;3-letter&nbsp;code&nbsp;of&nbsp;the&nbsp;currency&nbsp;in&nbsp;question.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sku":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Sku&nbsp;of&nbsp;this&nbsp;product.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"categoryName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;category&nbsp;this&nbsp;product&nbsp;belongs&nbsp;to.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"skuName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Sku&nbsp;name&nbsp;of&nbsp;this&nbsp;product.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"publisherFee":&nbsp;{&nbsp;#&nbsp;An&nbsp;ApiMoneyProto.&nbsp;#&nbsp;Fee&nbsp;that&nbsp;the&nbsp;advertiser&nbsp;paid&nbsp;to&nbsp;the&nbsp;publisehr&nbsp;for&nbsp;this&nbsp;product.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"amount":&nbsp;3.14,&nbsp;#&nbsp;The&nbsp;amount&nbsp;of&nbsp;money.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currencyCode":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;3-letter&nbsp;code&nbsp;of&nbsp;the&nbsp;currency&nbsp;in&nbsp;question.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"earnings":&nbsp;{&nbsp;#&nbsp;An&nbsp;ApiMoneyProto.&nbsp;#&nbsp;Amount&nbsp;earned&nbsp;by&nbsp;the&nbsp;publisher&nbsp;on&nbsp;this&nbsp;product.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"amount":&nbsp;3.14,&nbsp;#&nbsp;The&nbsp;amount&nbsp;of&nbsp;money.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currencyCode":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;3-letter&nbsp;code&nbsp;of&nbsp;the&nbsp;currency&nbsp;in&nbsp;question.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"unitPrice":&nbsp;{&nbsp;#&nbsp;An&nbsp;ApiMoneyProto.&nbsp;#&nbsp;Price&nbsp;per&nbsp;unit&nbsp;of&nbsp;this&nbsp;product.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"amount":&nbsp;3.14,&nbsp;#&nbsp;The&nbsp;amount&nbsp;of&nbsp;money.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currencyCode":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;3-letter&nbsp;code&nbsp;of&nbsp;the&nbsp;currency&nbsp;in&nbsp;question.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"categoryId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Id&nbsp;of&nbsp;the&nbsp;category&nbsp;this&nbsp;product&nbsp;belongs&nbsp;to.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"quantity":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Quantity&nbsp;of&nbsp;this&nbsp;product&nbsp;bought/exchanged.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"earnings":&nbsp;{&nbsp;#&nbsp;An&nbsp;ApiMoneyProto.&nbsp;#&nbsp;Earnings&nbsp;by&nbsp;the&nbsp;publisher.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"amount":&nbsp;3.14,&nbsp;#&nbsp;The&nbsp;amount&nbsp;of&nbsp;money.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currencyCode":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;3-letter&nbsp;code&nbsp;of&nbsp;the&nbsp;currency&nbsp;in&nbsp;question.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"chargeType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Charge&nbsp;type&nbsp;of&nbsp;the&nbsp;event&nbsp;(other|slotting_fee|monthly_minimum|tier_bonus|debit|credit).&nbsp;Only&nbsp;returned&nbsp;for&nbsp;charge&nbsp;events.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"publisherFee":&nbsp;{&nbsp;#&nbsp;An&nbsp;ApiMoneyProto.&nbsp;#&nbsp;Fee&nbsp;that&nbsp;the&nbsp;advertiser&nbsp;paid&nbsp;to&nbsp;the&nbsp;publisher.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"amount":&nbsp;3.14,&nbsp;#&nbsp;The&nbsp;amount&nbsp;of&nbsp;money.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currencyCode":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;3-letter&nbsp;code&nbsp;of&nbsp;the&nbsp;currency&nbsp;in&nbsp;question.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"commissionableSales":&nbsp;{&nbsp;#&nbsp;An&nbsp;ApiMoneyProto.&nbsp;#&nbsp;Amount&nbsp;of&nbsp;money&nbsp;exchanged&nbsp;during&nbsp;the&nbsp;transaction.&nbsp;Only&nbsp;returned&nbsp;for&nbsp;charge&nbsp;and&nbsp;conversion&nbsp;events.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"amount":&nbsp;3.14,&nbsp;#&nbsp;The&nbsp;amount&nbsp;of&nbsp;money.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currencyCode":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;3-letter&nbsp;code&nbsp;of&nbsp;the&nbsp;currency&nbsp;in&nbsp;question.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"publisherId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;publisher&nbsp;for&nbsp;this&nbsp;event.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"eventDate":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;date-time&nbsp;this&nbsp;event&nbsp;was&nbsp;initiated&nbsp;as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;date-time&nbsp;value.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"gan#events",&nbsp;#&nbsp;The&nbsp;kind&nbsp;for&nbsp;a&nbsp;page&nbsp;of&nbsp;events.<br>
 &nbsp;&nbsp;}</tt></dd></dl>

 <dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
 &nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
 &nbsp;<br>
 Returns:<br>
 &nbsp;&nbsp;A&nbsp;request&nbsp;object&nbsp;that&nbsp;you&nbsp;can&nbsp;call&nbsp;'execute()'&nbsp;on&nbsp;to&nbsp;request&nbsp;the&nbsp;next<br>
 &nbsp;&nbsp;page.&nbsp;Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in&nbsp;the&nbsp;collection.</tt></dd></dl>

 <hr>
 Data descriptors defined here:<br>
 <dl><dt><strong>__dict__</strong></dt>
 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 <dl><dt><strong>__weakref__</strong></dt>
 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 </td></tr></table>
 </body></html>

	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	<html><head><title>Python: class Resource</title>
	</head><body bgcolor="#f0f0f8">
	<p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#ffc8d8">
	<td colspan=3 valign=bottom> <br>
	<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>

	<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>
	<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
	<tr><td> </td>
	<td width="100%">Methods defined here:<br>
	<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>

	<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves event data for a given advertiser/publisher.<br>
	<br>
	Args:<br>
	orderId: string, Caret(^) delimited list of order IDs. Filters out all events that do not reference one of the given order IDs. Optional.<br>
	linkId: string, Caret(^) delimited list of link IDs. Filters out all events that do not reference one of the given link IDs. Optional.<br>
	advertiserId: string, Caret(^) delimited list of advertiser IDs. Filters out all events that do not reference one of the given advertiser IDs. Only used when under publishers role. Optional.<br>
	sku: string, Caret(^) delimited list of SKUs. Filters out all events that do not reference one of the given SKU. Optional.<br>
	roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
	productCategory: string, Caret(^) delimited list of product categories. Filters out all events that do not reference a product in one of the given product categories. Optional.<br>
	pageToken: string, The value of 'nextPageToken' from the previous page. Optional.<br>
	role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)<br>
	Allowed values<br>
	advertisers - The requester is requesting as an advertiser.<br>
	publishers - The requester is requesting as a publisher.<br>
	modifyDateMin: string, Filters out all events modified earlier than given date. Optional. Defaults to 24 hours before the current modifyDateMax, if modifyDateMax is explicitly set.<br>
	type: string, Filters out all events that are not of the given type. Valid values: 'action', 'transaction', 'charge'. Optional.<br>
	Allowed values<br>
	action - The completion of an application, sign-up, or other process. For example, an action occurs if a user clicks an ad for a credit card and completes an application for that card.<br>
	charge - A charge event is typically a payment between an advertiser, publisher or Google.<br>
	transaction - A conversion event, typically an e-commerce transaction. Some advertisers use a transaction to record other types of events, such as magazine subscriptions.<br>
	status: string, Filters out all events that do not have the given status. Valid values: 'active', 'canceled'. Optional.<br>
	Allowed values<br>
	active - Event is currently active.<br>
	canceled - Event is currently canceled.<br>
	modifyDateMax: string, Filters out all events modified later than given date. Optional. Defaults to 24 hours after modifyDateMin, if modifyDateMin is explicitly set.<br>
	eventDateMin: string, Filters out all events earlier than given date. Optional. Defaults to 24 hours from current date/time.<br>
	maxResults: integer, Max number of offers to return in this page. Optional. Defaults to 20.<br>
	chargeType: string, Filters out all charge events that are not of the given charge type. Valid values: 'other', 'slotting_fee', 'monthly_minimum', 'tier_bonus', 'credit', 'debit'. Optional.<br>
	Allowed values<br>
	credit - A credit increases the publisher's payout amount and decreases the advertiser's invoice amount.<br>
	debit - A debit reduces the publisher's payout and increases the advertiser's invoice amount.<br>
	monthly_minimum - A payment made to Google by an advertiser as a minimum monthly network fee.<br>
	other - Catch all. Default if unset<br>
	slotting_fee - A one time payment made from an advertiser to a publisher.<br>
	tier_bonus - A payment from an advertiser to a publisher for the publisher maintaining a high tier level<br>
	eventDateMax: string, Filters out all events later than given date. Optional. Defaults to 24 hours after eventMin.<br>
	memberId: string, Caret(^) delimited list of member IDs. Filters out all events that do not reference one of the given member IDs. Optional.<br>
	publisherId: string, Caret(^) delimited list of publisher IDs. Filters out all events that do not reference one of the given publishers IDs. Only used when under advertiser role. Optional.<br>
	<br>
	Returns:<br>
	An object of the form<br>
	<br>
	{<br>
	"nextPageToken": "A String", # The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.<br>
	"items": [ # The event list.<br>
	{ # An EventResource.<br>
	"networkFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the Google Affiliate Network.<br>
	"amount": 3.14, # The amount of money.<br>
	"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
	},<br>
	"advertiserName": "A String", # The name of the advertiser for this event.<br>
	"kind": "gan#event", # The kind for one event.<br>
	"modifyDate": "A String", # The date-time this event was last modified as a <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time value.<br>
	"type": "A String", # Type of the event (action\|transaction\|charge).<br>
	"orderId": "A String", # The order ID for this event. Only returned for conversion events.<br>
	"publisherName": "A String", # The name of the publisher for this event.<br>
	"memberId": "A String", # The ID of the member attached to this event. Only returned for conversion events.<br>
	"advertiserId": "A String", # The ID of advertiser for this event.<br>
	"status": "A String", # Status of the event (active\|canceled). Only returned for charge and conversion events.<br>
	"chargeId": "A String", # The charge ID for this event. Only returned for charge events.<br>
	"products": [ # Products associated with the event.<br>
	{<br>
	"networkFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the Google Affiliate Network for this product.<br>
	"amount": 3.14, # The amount of money.<br>
	"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
	},<br>
	"sku": "A String", # Sku of this product.<br>
	"categoryName": "A String", # Name of the category this product belongs to.<br>
	"skuName": "A String", # Sku name of this product.<br>
	"publisherFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the publisehr for this product.<br>
	"amount": 3.14, # The amount of money.<br>
	"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
	},<br>
	"earnings": { # An ApiMoneyProto. # Amount earned by the publisher on this product.<br>
	"amount": 3.14, # The amount of money.<br>
	"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
	},<br>
	"unitPrice": { # An ApiMoneyProto. # Price per unit of this product.<br>
	"amount": 3.14, # The amount of money.<br>
	"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
	},<br>
	"categoryId": "A String", # Id of the category this product belongs to.<br>
	"quantity": "A String", # Quantity of this product bought/exchanged.<br>
	},<br>
	],<br>
	"earnings": { # An ApiMoneyProto. # Earnings by the publisher.<br>
	"amount": 3.14, # The amount of money.<br>
	"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
	},<br>
	"chargeType": "A String", # Charge type of the event (other\|slotting_fee\|monthly_minimum\|tier_bonus\|debit\|credit). Only returned for charge events.<br>
	"publisherFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the publisher.<br>
	"amount": 3.14, # The amount of money.<br>
	"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
	},<br>
	"commissionableSales": { # An ApiMoneyProto. # Amount of money exchanged during the transaction. Only returned for charge and conversion events.<br>
	"amount": 3.14, # The amount of money.<br>
	"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
	},<br>
	"publisherId": "A String", # The ID of the publisher for this event.<br>
	"eventDate": "A String", # The date-time this event was initiated as a <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time value.<br>
	},<br>
	],<br>
	"kind": "gan#events", # The kind for a page of events.<br>
	}</tt></dd></dl>

	<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
	<br>
	Args:<br>
	previous_request: The request for the previous page.<br>
	previous_response: The response from the request for the previous page.<br>
	<br>
	Returns:<br>
	A request object that you can call 'execute()' on to request the next<br>
	page. Returns None if there are no more items in the collection.</tt></dd></dl>

	<hr>
	Data descriptors defined here:<br>
	<dl><dt><strong>__dict__</strong></dt>
	<dd><tt>dictionary for instance variables (if defined)</tt></dd>
	</dl>
	<dl><dt><strong>__weakref__</strong></dt>
	<dd><tt>list of weak references to the object (if defined)</tt></dd>
	</dl>
	</td></tr></table>
	</body></html>