1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
<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_v4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v4.billingProfiles.html">billingProfiles</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="#get">get(profileId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Gets one billing profile by ID.</p>
<p class="toc_element">
<code><a href="#list">list(profileId, currency_code=None, ids=None, maxResults=None, name=None, onlySuggestion=None, pageToken=None, sortField=None, sortOrder=None, status=None, subaccountIds=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of billing profiles, possibly filtered. This method supports paging.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing billing profile.</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="get">get(profileId, id, x__xgafv=None)</code>
<pre>Gets one billing profile by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Billing Profile ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a Campaign Manager Billing Profile.
"consolidatedInvoice": True or False, # Consolidated invoice option for this billing profile. Used to get a single, consolidated invoice across the chosen invoice level.
"countryCode": "A String", # Country code of this billing profile.This is a read-only field.
"currencyCode": "A String", # Billing currency code in ISO 4217 format.This is a read-only field.
"id": "A String", # ID of this billing profile. This is a read-only, auto-generated field.
"invoiceLevel": "A String", # Invoice level for this billing profile. Used to group fees into separate invoices by account, advertiser, or campaign.
"isDefault": True or False, # True if the billing profile is the account default profile. This is a read-only field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#billingProfile".
"name": "A String", # Name of this billing profile. This is a required field and must be less than 256 characters long and must be unique among billing profile in the same account.
"paymentsAccountId": "A String", # The ID of the payment account the billing profile belongs to. This is a read-only field.
"paymentsCustomerId": "A String", # The ID of the payment customer the billing profile belongs to. This is a read-only field.
"purchaseOrder": "A String", # Purchase order (PO) for this billing profile. This PO number is used in the invoices for all of the advertisers in this billing profile.
"secondaryPaymentsCustomerId": "A String", # The ID of the secondary payment customer the billing profile belongs to. This is a read-only field.
"status": "A String", # Status of this billing profile.This is a read-only field.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, currency_code=None, ids=None, maxResults=None, name=None, onlySuggestion=None, pageToken=None, sortField=None, sortOrder=None, status=None, subaccountIds=None, x__xgafv=None)</code>
<pre>Retrieves a list of billing profiles, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
currency_code: string, Select only billing profile with currency.
ids: string, Select only billing profile with these IDs. (repeated)
maxResults: integer, Maximum number of results to return.
name: string, Allows searching for billing profiles by name. Wildcards (*) are allowed. For example, "profile*2020" will return objects with names like "profile June 2020", "profile April 2020", or simply "profile 2020". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "profile" will match objects with name "my profile", "profile 2021", or simply "profile".
onlySuggestion: boolean, Select only billing profile which is suggested for the currency_code & subaccount_id using the Billing Suggestion API.
pageToken: string, Value of the nextPageToken from the previous result page.
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
status: string, Select only billing profile with the specified status. (repeated)
Allowed values
UNDER_REVIEW -
ACTIVE -
ARCHIVED -
subaccountIds: string, Select only billing profile with the specified subaccount.When only_suggestion is true, only a single subaccount_id is supported. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Billing profile List Response
"billingProfiles": [ # Billing profiles collection.
{ # Contains properties of a Campaign Manager Billing Profile.
"consolidatedInvoice": True or False, # Consolidated invoice option for this billing profile. Used to get a single, consolidated invoice across the chosen invoice level.
"countryCode": "A String", # Country code of this billing profile.This is a read-only field.
"currencyCode": "A String", # Billing currency code in ISO 4217 format.This is a read-only field.
"id": "A String", # ID of this billing profile. This is a read-only, auto-generated field.
"invoiceLevel": "A String", # Invoice level for this billing profile. Used to group fees into separate invoices by account, advertiser, or campaign.
"isDefault": True or False, # True if the billing profile is the account default profile. This is a read-only field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#billingProfile".
"name": "A String", # Name of this billing profile. This is a required field and must be less than 256 characters long and must be unique among billing profile in the same account.
"paymentsAccountId": "A String", # The ID of the payment account the billing profile belongs to. This is a read-only field.
"paymentsCustomerId": "A String", # The ID of the payment customer the billing profile belongs to. This is a read-only field.
"purchaseOrder": "A String", # Purchase order (PO) for this billing profile. This PO number is used in the invoices for all of the advertisers in this billing profile.
"secondaryPaymentsCustomerId": "A String", # The ID of the secondary payment customer the billing profile belongs to. This is a read-only field.
"status": "A String", # Status of this billing profile.This is a read-only field.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#billingProfilesListResponse".
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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="update">update(profileId, body=None, x__xgafv=None)</code>
<pre>Updates an existing billing profile.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of a Campaign Manager Billing Profile.
"consolidatedInvoice": True or False, # Consolidated invoice option for this billing profile. Used to get a single, consolidated invoice across the chosen invoice level.
"countryCode": "A String", # Country code of this billing profile.This is a read-only field.
"currencyCode": "A String", # Billing currency code in ISO 4217 format.This is a read-only field.
"id": "A String", # ID of this billing profile. This is a read-only, auto-generated field.
"invoiceLevel": "A String", # Invoice level for this billing profile. Used to group fees into separate invoices by account, advertiser, or campaign.
"isDefault": True or False, # True if the billing profile is the account default profile. This is a read-only field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#billingProfile".
"name": "A String", # Name of this billing profile. This is a required field and must be less than 256 characters long and must be unique among billing profile in the same account.
"paymentsAccountId": "A String", # The ID of the payment account the billing profile belongs to. This is a read-only field.
"paymentsCustomerId": "A String", # The ID of the payment customer the billing profile belongs to. This is a read-only field.
"purchaseOrder": "A String", # Purchase order (PO) for this billing profile. This PO number is used in the invoices for all of the advertisers in this billing profile.
"secondaryPaymentsCustomerId": "A String", # The ID of the secondary payment customer the billing profile belongs to. This is a read-only field.
"status": "A String", # Status of this billing profile.This is a read-only field.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a Campaign Manager Billing Profile.
"consolidatedInvoice": True or False, # Consolidated invoice option for this billing profile. Used to get a single, consolidated invoice across the chosen invoice level.
"countryCode": "A String", # Country code of this billing profile.This is a read-only field.
"currencyCode": "A String", # Billing currency code in ISO 4217 format.This is a read-only field.
"id": "A String", # ID of this billing profile. This is a read-only, auto-generated field.
"invoiceLevel": "A String", # Invoice level for this billing profile. Used to group fees into separate invoices by account, advertiser, or campaign.
"isDefault": True or False, # True if the billing profile is the account default profile. This is a read-only field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#billingProfile".
"name": "A String", # Name of this billing profile. This is a required field and must be less than 256 characters long and must be unique among billing profile in the same account.
"paymentsAccountId": "A String", # The ID of the payment account the billing profile belongs to. This is a read-only field.
"paymentsCustomerId": "A String", # The ID of the payment customer the billing profile belongs to. This is a read-only field.
"purchaseOrder": "A String", # Purchase order (PO) for this billing profile. This PO number is used in the invoices for all of the advertisers in this billing profile.
"secondaryPaymentsCustomerId": "A String", # The ID of the secondary payment customer the billing profile belongs to. This is a read-only field.
"status": "A String", # Status of this billing profile.This is a read-only field.
}</pre>
</div>
</body></html>
|
