Search Ads 360 Reporting API . customers . recommendationSubscriptions

close()

Close httplib2 connections.

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

Mutates given subscription with corresponding apply parameters. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RecommendationError]() [RecommendationSubscriptionError]() [RequestError]() [UrlFieldError]()

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

{ # Request message for RecommendationSubscriptionService.MutateRecommendationSubscription
  "operations": [ # Required. The list of create or update operations.
    { # A single operation (create, update) on a recommendation subscription. RecommendationSubscriptionService.MutateRecommendationSubscription
      "create": { # Recommendation Subscription resource # Create operation: No resource name is expected for the new subscription.
        "createDateTime": "A String", # Output only. Time in seconds when the subscription was first created. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
        "modifyDateTime": "A String", # Output only. Contains the time in microseconds, when the Recommendation Subscription was last updated. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
        "resourceName": "A String", # Immutable. The resource name of the recommendation subscription. `customers/{customer_id}/recommendationSubscriptions/{recommendation_type}`
        "status": "A String", # Required. Status of the subscription, either enabled or paused.
        "type": "A String", # Required. Immutable. The type of recommendation subscribed to.
      },
      "update": { # Recommendation Subscription resource # Update operation: The subscription is expected to have a valid resource name.
        "createDateTime": "A String", # Output only. Time in seconds when the subscription was first created. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
        "modifyDateTime": "A String", # Output only. Contains the time in microseconds, when the Recommendation Subscription was last updated. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
        "resourceName": "A String", # Immutable. The resource name of the recommendation subscription. `customers/{customer_id}/recommendationSubscriptions/{recommendation_type}`
        "status": "A String", # Required. Status of the subscription, either enabled or paused.
        "type": "A String", # Required. Immutable. The type of recommendation subscribed to.
      },
      "updateMask": "A String", # Optional. FieldMask that determines which resource fields are modified in an update.
    },
  ],
  "partialFailure": True or False, # If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
  "responseContentType": "A String", # The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation. The mutable resource will only be returned if the resource has the appropriate response field. For example, MutateCampaignResult.campaign.
  "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 RecommendationSubscriptionService.MutateRecommendationSubscription
  "partialFailureError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Errors that pertain to operation failures in the partial failure mode. Returned only when partial_failure = true and all errors occur inside the operations. If any errors occur outside the operations (for example, auth errors) we return the RPC level error.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "results": [ # Results, one per operation.
    { # Result message for RecommendationSubscriptionService.MutateRecommendationSubscription
      "recommendationSubscription": { # Recommendation Subscription resource # The mutated recommendation subscription with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
        "createDateTime": "A String", # Output only. Time in seconds when the subscription was first created. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
        "modifyDateTime": "A String", # Output only. Contains the time in microseconds, when the Recommendation Subscription was last updated. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
        "resourceName": "A String", # Immutable. The resource name of the recommendation subscription. `customers/{customer_id}/recommendationSubscriptions/{recommendation_type}`
        "status": "A String", # Required. Status of the subscription, either enabled or paused.
        "type": "A String", # Required. Immutable. The type of recommendation subscribed to.
      },
      "resourceName": "A String", # Resource name of the subscription that was modified.
    },
  ],
}