Search Ads 360 Reporting API . customers . accountBudgetProposals

close()

Close httplib2 connections.

mutate(customerId, body=None, x__xgafv=None)

Creates, updates, or removes account budget proposals. Operation statuses are returned. List of thrown errors: [AccountBudgetProposalError]() [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DateError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]() [StringLengthError]()

Args:
  customerId: string, Required. The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for AccountBudgetProposalService.MutateAccountBudgetProposal.
  "operation": { # A single operation to propose the creation of a new account-level budget or edit/end/remove an existing one. # Required. The operation to perform on an individual account-level budget proposal.
    "create": { # An account-level budget proposal. All fields prefixed with 'proposed' may not necessarily be applied directly. For example, proposed spending limits may be adjusted before their application. This is true if the 'proposed' field has an 'approved' counterpart, for example, spending limits. Note that the proposal type (proposal_type) changes which fields are required and which must remain empty. # Create operation: A new proposal to create a new budget, edit an existing budget, end an actively running budget, or remove an approved budget scheduled to start in the future. No resource name is expected for the new proposal.
      "accountBudget": "A String", # Immutable. The resource name of the account-level budget associated with this proposal.
      "approvalDateTime": "A String", # Output only. The date time when this account-level budget was approved, if applicable.
      "approvedEndDateTime": "A String", # Output only. The approved end date time in yyyy-mm-dd hh:mm:ss format.
      "approvedEndTimeType": "A String", # Output only. The approved end date time as a well-defined type, for example, FOREVER.
      "approvedSpendingLimitMicros": "A String", # Output only. The approved spending limit in micros. One million is equivalent to one unit.
      "approvedSpendingLimitType": "A String", # Output only. The approved spending limit as a well-defined type, for example, INFINITE.
      "approvedStartDateTime": "A String", # Output only. The approved start date time in yyyy-mm-dd hh:mm:ss format.
      "billingSetup": "A String", # Immutable. The resource name of the billing setup associated with this proposal.
      "creationDateTime": "A String", # Output only. The date time when this account-level budget proposal was created, which is not the same as its approval date time, if applicable.
      "id": "A String", # Output only. The ID of the proposal.
      "proposalType": "A String", # Immutable. The type of this proposal, for example, END to end the budget associated with this proposal.
      "proposedEndDateTime": "A String", # Immutable. The proposed end date time in yyyy-mm-dd hh:mm:ss format.
      "proposedEndTimeType": "A String", # Immutable. The proposed end date time as a well-defined type, for example, FOREVER.
      "proposedName": "A String", # Immutable. The name to assign to the account-level budget.
      "proposedNotes": "A String", # Immutable. Notes associated with this budget.
      "proposedPurchaseOrderNumber": "A String", # Immutable. A purchase order number is a value that enables the user to help them reference this budget in their monthly invoices.
      "proposedSpendingLimitMicros": "A String", # Immutable. The proposed spending limit in micros. One million is equivalent to one unit.
      "proposedSpendingLimitType": "A String", # Immutable. The proposed spending limit as a well-defined type, for example, INFINITE.
      "proposedStartDateTime": "A String", # Immutable. The proposed start date time in yyyy-mm-dd hh:mm:ss format.
      "proposedStartTimeType": "A String", # Immutable. The proposed start date time as a well-defined type, for example, NOW.
      "resourceName": "A String", # Immutable. The resource name of the proposal. AccountBudgetProposal resource names have the form: `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}`
      "status": "A String", # Output only. The status of this proposal. When a new proposal is created, the status defaults to PENDING.
    },
    "remove": "A String", # Remove operation: A resource name for the removed proposal is expected, in this format: `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}` A request may be cancelled iff it is pending.
    "updateMask": "A String", # FieldMask that determines which budget fields are modified. While budgets may be modified, proposals that propose such modifications are final. Therefore, update operations are not supported for proposals. Proposals that modify budgets have the 'update' proposal type. Specifying a mask for any other proposal type is considered an error.
  },
  "validateOnly": True or False, # If true, the request is validated but not executed. Only errors are returned, not results.
}

  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 account-level budget mutate operations.
  "result": { # The result for the account budget proposal mutate. # The result of the mutate.
    "resourceName": "A String", # Returned for successful operations.
  },
}