Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dc6c1efea8e6c89afa94df984d9291359cb04797 / . / docs / dyn / gan_v1beta1.events.html
blob: 3831857b081d415af1a9408acc8b44b457e6e166 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="gan_v1beta1.html">Google Affiliate Network API</a> . <a href="gan_v1beta1.events.html">events</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#list">list(role, roleId, orderId=None, chargeType=None, linkId=None, advertiserId=None, sku=None, pageToken=None, productCategory=None, modifyDateMin=None, type=None, status=None, modifyDateMax=None, eventDateMin=None, maxResults=None, eventDateMax=None, memberId=None, publisherId=None)</a></code></p>
79<p class="firstline">Retrieves event data for a given advertiser/publisher.</p>
80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="list">list(role, roleId, orderId=None, chargeType=None, linkId=None, advertiserId=None, sku=None, pageToken=None, productCategory=None, modifyDateMin=None, type=None, status=None, modifyDateMax=None, eventDateMin=None, maxResults=None, eventDateMax=None, memberId=None, publisherId=None)</code>
86 <pre>Retrieves event data for a given advertiser/publisher.
87
88Args:
89 role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
90 Allowed values
91 advertisers - The requester is requesting as an advertiser.
92 publishers - The requester is requesting as a publisher.
93 roleId: string, The ID of the requesting advertiser or publisher. (required)
94 orderId: string, Caret(^) delimited list of order IDs. Filters out all events that do not reference one of the given order IDs. Optional.
95 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.
96 Allowed values
97 credit - A credit increases the publisher's payout amount and decreases the advertiser's invoice amount.
98 debit - A debit reduces the publisher's payout and increases the advertiser's invoice amount.
99 monthly_minimum - A payment made to Google by an advertiser as a minimum monthly network fee.
100 other - Catch all. Default if unset
101 slotting_fee - A one time payment made from an advertiser to a publisher.
102 tier_bonus - A payment from an advertiser to a publisher for the publisher maintaining a high tier level
103 linkId: string, Caret(^) delimited list of link IDs. Filters out all events that do not reference one of the given link IDs. Optional.
104 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.
105 sku: string, Caret(^) delimited list of SKUs. Filters out all events that do not reference one of the given SKU. Optional.
106 pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
107 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.
108 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.
109 type: string, Filters out all events that are not of the given type. Valid values: 'action', 'transaction', 'charge'. Optional.
110 Allowed values
111 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.
112 charge - A charge event is typically a payment between an advertiser, publisher or Google.
113 transaction - A conversion event, typically an e-commerce transaction. Some advertisers use a transaction to record other types of events, such as magazine subscriptions.
114 status: string, Filters out all events that do not have the given status. Valid values: 'active', 'canceled'. Optional.
115 Allowed values
116 active - Event is currently active.
117 canceled - Event is currently canceled.
118 modifyDateMax: string, Filters out all events modified later than given date. Optional. Defaults to 24 hours after modifyDateMin, if modifyDateMin is explicitly set.
119 eventDateMin: string, Filters out all events earlier than given date. Optional. Defaults to 24 hours from current date/time.
120 maxResults: integer, Max number of offers to return in this page. Optional. Defaults to 20.
121 eventDateMax: string, Filters out all events later than given date. Optional. Defaults to 24 hours after eventMin.
122 memberId: string, Caret(^) delimited list of member IDs. Filters out all events that do not reference one of the given member IDs. Optional.
123 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.
124
125Returns:
126 An object of the form:
127
128 {
129 "nextPageToken": "A String", # The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
130 "items": [ # The event list.
131 { # An EventResource.
132 "networkFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the Google Affiliate Network.
133 "amount": 3.14, # The amount of money.
134 "currencyCode": "A String", # The 3-letter code of the currency in question.
135 },
136 "advertiserName": "A String", # The name of the advertiser for this event.
137 "kind": "gan#event", # The kind for one event.
138 "modifyDate": "A String", # The date-time this event was last modified as a RFC 3339 date-time value.
139 "type": "A String", # Type of the event (action|transaction|charge).
140 "orderId": "A String", # The order ID for this event. Only returned for conversion events.
141 "publisherName": "A String", # The name of the publisher for this event.
142 "memberId": "A String", # The ID of the member attached to this event. Only returned for conversion events.
143 "advertiserId": "A String", # The ID of advertiser for this event.
144 "status": "A String", # Status of the event (active|canceled). Only returned for charge and conversion events.
145 "chargeId": "A String", # The charge ID for this event. Only returned for charge events.
146 "products": [ # Products associated with the event.
147 {
148 "networkFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the Google Affiliate Network for this product.
149 "amount": 3.14, # The amount of money.
150 "currencyCode": "A String", # The 3-letter code of the currency in question.
151 },
152 "sku": "A String", # Sku of this product.
153 "categoryName": "A String", # Name of the category this product belongs to.
154 "skuName": "A String", # Sku name of this product.
155 "publisherFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the publisehr for this product.
156 "amount": 3.14, # The amount of money.
157 "currencyCode": "A String", # The 3-letter code of the currency in question.
158 },
159 "earnings": { # An ApiMoneyProto. # Amount earned by the publisher on this product.
160 "amount": 3.14, # The amount of money.
161 "currencyCode": "A String", # The 3-letter code of the currency in question.
162 },
163 "unitPrice": { # An ApiMoneyProto. # Price per unit of this product.
164 "amount": 3.14, # The amount of money.
165 "currencyCode": "A String", # The 3-letter code of the currency in question.
166 },
167 "categoryId": "A String", # Id of the category this product belongs to.
168 "quantity": "A String", # Quantity of this product bought/exchanged.
169 },
170 ],
171 "earnings": { # An ApiMoneyProto. # Earnings by the publisher.
172 "amount": 3.14, # The amount of money.
173 "currencyCode": "A String", # The 3-letter code of the currency in question.
174 },
175 "chargeType": "A String", # Charge type of the event (other|slotting_fee|monthly_minimum|tier_bonus|debit|credit). Only returned for charge events.
176 "publisherFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the publisher.
177 "amount": 3.14, # The amount of money.
178 "currencyCode": "A String", # The 3-letter code of the currency in question.
179 },
180 "commissionableSales": { # An ApiMoneyProto. # Amount of money exchanged during the transaction. Only returned for charge and conversion events.
181 "amount": 3.14, # The amount of money.
182 "currencyCode": "A String", # The 3-letter code of the currency in question.
183 },
184 "publisherId": "A String", # The ID of the publisher for this event.
185 "eventDate": "A String", # The date-time this event was initiated as a RFC 3339 date-time value.
186 },
187 ],
188 "kind": "gan#events", # The kind for a page of events.
189 }</pre>
190</div>
191
192<div class="method">
193 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
194 <pre>Retrieves the next page of results.
195
196Args:
197 previous_request: The request for the previous page. (required)
198 previous_response: The response from the request for the previous page. (required)
199
200Returns:
201 A request object that you can call 'execute()' on to request the next
202 page. Returns None if there are no more items in the collection.
203 </pre>
204</div>
205
206</body></html>