Search Ads 360 Reporting API . customers . assetSetAssets

close()

Close httplib2 connections.

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

Creates, updates or removes asset set assets. Operation statuses are returned.

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

{ # Request message for AssetSetAssetService.MutateAssetSetAssets.
  "operations": [ # Required. The list of operations to perform on individual asset set assets.
    { # A single operation (create, remove) on an asset set asset.
      "create": { # AssetSetAsset is the link between an asset and an asset set. Adding an AssetSetAsset links an asset with an asset set. # Create operation: No resource name is expected for the new asset set asset
        "asset": "A String", # Immutable. The asset which this asset set asset is linking to.
        "assetSet": "A String", # Immutable. The asset set which this asset set asset is linking to.
        "resourceName": "A String", # Immutable. The resource name of the asset set asset. Asset set asset resource names have the form: `customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}`
        "status": "A String", # Output only. The status of the asset set asset. Read-only.
      },
      "remove": "A String", # Remove operation: A resource name for the removed asset set asset is expected, in this format: `customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}`
    },
  ],
  "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 an asset set asset 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 asset set asset mutate.
      "assetSetAsset": { # AssetSetAsset is the link between an asset and an asset set. Adding an AssetSetAsset links an asset with an asset set. # The mutated asset set asset with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
        "asset": "A String", # Immutable. The asset which this asset set asset is linking to.
        "assetSet": "A String", # Immutable. The asset set which this asset set asset is linking to.
        "resourceName": "A String", # Immutable. The resource name of the asset set asset. Asset set asset resource names have the form: `customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}`
        "status": "A String", # Output only. The status of the asset set asset. Read-only.
      },
      "resourceName": "A String", # Returned for successful operations.
    },
  ],
}