Debian Codegraph @

docs/dyn/dfareporting_v5.billingProfiles.html

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