Search Ads 360 Reporting API . customers . sharedSets

close()

Close httplib2 connections.

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

Creates, updates, or removes shared sets. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SharedSetError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()

Args:
  customerId: string, Required. The ID of the customer whose shared sets are being modified. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SharedSetService.MutateSharedSets.
  "operations": [ # Required. The list of operations to perform on individual shared sets.
    { # A single operation (create, update, remove) on an shared set.
      "create": { # SharedSets are used for sharing criterion exclusions across multiple campaigns. # Create operation: No resource name is expected for the new shared set.
        "id": "A String", # Output only. The ID of this shared set. Read only.
        "memberCount": "A String", # Output only. The number of shared criteria within this shared set. Read only.
        "name": "A String", # The name of this shared set. Required. Shared Sets must have names that are unique among active shared sets of the same type. The length of this string should be between 1 and 255 UTF-8 bytes, inclusive.
        "referenceCount": "A String", # Output only. The number of campaigns associated with this shared set. Read only.
        "resourceName": "A String", # Immutable. The resource name of the shared set. Shared set resource names have the form: `customers/{customer_id}/sharedSets/{shared_set_id}`
        "status": "A String", # Output only. The status of this shared set. Read only.
        "type": "A String", # Immutable. The type of this shared set: each shared set holds only a single kind of resource. Required. Immutable.
        "verticalAdsItemVerticalType": "A String", # Immutable. Shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST are associated with a particular vertical (e.g. hotels, things to do, flights, etc.). This field is required for shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST.
      },
      "remove": "A String", # Remove operation: A resource name for the removed shared set is expected, in this format: `customers/{customer_id}/sharedSets/{shared_set_id}`
      "update": { # SharedSets are used for sharing criterion exclusions across multiple campaigns. # Update operation: The shared set is expected to have a valid resource name.
        "id": "A String", # Output only. The ID of this shared set. Read only.
        "memberCount": "A String", # Output only. The number of shared criteria within this shared set. Read only.
        "name": "A String", # The name of this shared set. Required. Shared Sets must have names that are unique among active shared sets of the same type. The length of this string should be between 1 and 255 UTF-8 bytes, inclusive.
        "referenceCount": "A String", # Output only. The number of campaigns associated with this shared set. Read only.
        "resourceName": "A String", # Immutable. The resource name of the shared set. Shared set resource names have the form: `customers/{customer_id}/sharedSets/{shared_set_id}`
        "status": "A String", # Output only. The status of this shared set. Read only.
        "type": "A String", # Immutable. The type of this shared set: each shared set holds only a single kind of resource. Required. Immutable.
        "verticalAdsItemVerticalType": "A String", # Immutable. Shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST are associated with a particular vertical (e.g. hotels, things to do, flights, etc.). This field is required for shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST.
      },
      "updateMask": "A String", # 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.
  "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 a shared set mutate.
  "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 an 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": [ # All results for the mutate.
    { # The result for the shared set mutate.
      "resourceName": "A String", # Returned for successful operations.
      "sharedSet": { # SharedSets are used for sharing criterion exclusions across multiple campaigns. # The mutated shared set with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
        "id": "A String", # Output only. The ID of this shared set. Read only.
        "memberCount": "A String", # Output only. The number of shared criteria within this shared set. Read only.
        "name": "A String", # The name of this shared set. Required. Shared Sets must have names that are unique among active shared sets of the same type. The length of this string should be between 1 and 255 UTF-8 bytes, inclusive.
        "referenceCount": "A String", # Output only. The number of campaigns associated with this shared set. Read only.
        "resourceName": "A String", # Immutable. The resource name of the shared set. Shared set resource names have the form: `customers/{customer_id}/sharedSets/{shared_set_id}`
        "status": "A String", # Output only. The status of this shared set. Read only.
        "type": "A String", # Immutable. The type of this shared set: each shared set holds only a single kind of resource. Required. Immutable.
        "verticalAdsItemVerticalType": "A String", # Immutable. Shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST are associated with a particular vertical (e.g. hotels, things to do, flights, etc.). This field is required for shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST.
      },
    },
  ],
}