Search Ads 360 Reporting API . customers . campaignGroups

close()

Close httplib2 connections.

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

Creates, updates, or removes campaign groups. Operation statuses are returned.

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

{ # Request message for CampaignGroupService.MutateCampaignGroups.
  "operations": [ # Required. The list of operations to perform on individual campaign groups.
    { # A single operation (create, update, remove) on a campaign group.
      "create": { # A campaign group. # Create operation: No resource name is expected for the new campaign group.
        "id": "A String", # Output only. The ID of the campaign group.
        "name": "A String", # The name of the campaign group. This field is required and should not be empty when creating new campaign groups. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
        "resourceName": "A String", # Immutable. The resource name of the campaign group. Campaign group resource names have the form: `customers/{customer_id}/campaignGroups/{campaign_group_id}`
        "status": "A String", # The status of the campaign group. When a new campaign group is added, the status defaults to ENABLED.
      },
      "remove": "A String", # Remove operation: A resource name for the removed campaign group is expected, in this format: `customers/{customer_id}/campaignGroups/{campaign_group_id}`
      "update": { # A campaign group. # Update operation: The campaign group is expected to have a valid resource name.
        "id": "A String", # Output only. The ID of the campaign group.
        "name": "A String", # The name of the campaign group. This field is required and should not be empty when creating new campaign groups. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
        "resourceName": "A String", # Immutable. The resource name of the campaign group. Campaign group resource names have the form: `customers/{customer_id}/campaignGroups/{campaign_group_id}`
        "status": "A String", # The status of the campaign group. When a new campaign group is added, the status defaults to ENABLED.
      },
      "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 campaign group 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 campaign group mutate.
      "campaignGroup": { # A campaign group. # The mutated campaign group 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 the campaign group.
        "name": "A String", # The name of the campaign group. This field is required and should not be empty when creating new campaign groups. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
        "resourceName": "A String", # Immutable. The resource name of the campaign group. Campaign group resource names have the form: `customers/{customer_id}/campaignGroups/{campaign_group_id}`
        "status": "A String", # The status of the campaign group. When a new campaign group is added, the status defaults to ENABLED.
      },
      "resourceName": "A String", # Required. Returned for successful operations.
    },
  ],
}