| <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="searchads360_v23.html">Search Ads 360 Reporting API</a> . <a href="searchads360_v23.customers.html">customers</a> . <a href="searchads360_v23.customers.billingSetups.html">billingSetups</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="#mutate">mutate(customerId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a billing setup, or cancels an existing billing setup. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BillingSetupError]() [DateError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()</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="mutate">mutate(customerId, body=None, x__xgafv=None)</code> |
| <pre>Creates a billing setup, or cancels an existing billing setup. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BillingSetupError]() [DateError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]() |
| |
| Args: |
| customerId: string, Required. Id of the customer to apply the billing setup mutate operation to. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for billing setup mutate operations. |
| "operation": { # A single operation on a billing setup, which describes the cancellation of an existing billing setup. # Required. The operation to perform. |
| "create": { # A billing setup, which associates a payments account and an advertiser. A billing setup is specific to one advertiser. # Creates a billing setup. No resource name is expected for the new billing setup. |
| "endDateTime": "A String", # Output only. The end date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss format. |
| "endTimeType": "A String", # Output only. The end time as a type. The only possible value is FOREVER. |
| "id": "A String", # Output only. The ID of the billing setup. |
| "paymentsAccount": "A String", # Immutable. The resource name of the payments account associated with this billing setup. Payments resource names have the form: `customers/{customer_id}/paymentsAccounts/{payments_account_id}` When setting up billing, this is used to signup with an existing payments account (and then payments_account_info should not be set). When getting a billing setup, this and payments_account_info will be populated. |
| "paymentsAccountInfo": { # Container of payments account information for this billing. # Immutable. The payments account information associated with this billing setup. When setting up billing, this is used to signup with a new payments account (and then payments_account should not be set). When getting a billing setup, this and payments_account will be populated. |
| "paymentsAccountId": "A String", # Output only. A 16 digit id used to identify the payments account associated with the billing setup. This must be passed as a string with dashes, for example, "1234-5678-9012-3456". |
| "paymentsAccountName": "A String", # Immutable. The name of the payments account associated with the billing setup. This enables the user to specify a meaningful name for a payments account to aid in reconciling monthly invoices. This name will be printed in the monthly invoices. |
| "paymentsProfileId": "A String", # Immutable. A 12 digit id used to identify the payments profile associated with the billing setup. This must be passed in as a string with dashes, for example, "1234-5678-9012". |
| "paymentsProfileName": "A String", # Output only. The name of the payments profile associated with the billing setup. |
| "secondaryPaymentsProfileId": "A String", # Output only. A secondary payments profile id present in uncommon situations, for example, when a sequential liability agreement has been arranged. |
| }, |
| "resourceName": "A String", # Immutable. The resource name of the billing setup. BillingSetup resource names have the form: `customers/{customer_id}/billingSetups/{billing_setup_id}` |
| "startDateTime": "A String", # Immutable. The start date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss format. Only a future time is allowed. |
| "startTimeType": "A String", # Immutable. The start time as a type. Only NOW is allowed. |
| "status": "A String", # Output only. The status of the billing setup. |
| }, |
| "remove": "A String", # Resource name of the billing setup to remove. A setup cannot be removed unless it is in a pending state or its scheduled start time is in the future. The resource name looks like `customers/{customer_id}/billingSetups/{billing_id}`. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for a billing setup operation. |
| "result": { # Result for a single billing setup mutate. # A result that identifies the resource affected by the mutate request. |
| "resourceName": "A String", # Returned for successful operations. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
