Search Ads 360 Reporting API . customers . customerManagerLinks

close()

Close httplib2 connections.

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

Moves a client customer to a new manager customer. This simplifies the complex request that requires two operations to move a client customer to a new manager, for example: 1. Update operation with Status INACTIVE (previous manager) and, 2. Update operation with Status ACTIVE (new manager). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

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

{ # Request message for CustomerManagerLinkService.MoveManagerLink.
  "newManager": "A String", # Required. The resource name of the new manager customer that the client wants to move to. Customer resource names have the format: "customers/{customer_id}"
  "previousCustomerManagerLink": "A String", # Required. The resource name of the previous CustomerManagerLink. The resource name has the form: `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}`
  "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 CustomerManagerLink moveManagerLink.
  "resourceName": "A String", # Returned for successful operations. Represents a CustomerManagerLink resource of the newly created link between client customer and new manager customer.
}

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

Updates customer manager links. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [ManagerLinkError]() [MutateError]() [QuotaError]() [RequestError]()

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

{ # Request message for CustomerManagerLinkService.MutateCustomerManagerLink.
  "operations": [ # Required. The list of operations to perform on individual customer manager links.
    { # Updates the status of a CustomerManagerLink. The following actions are possible: 1. Update operation with status ACTIVE accepts a pending invitation. 2. Update operation with status REFUSED declines a pending invitation. 3. Update operation with status INACTIVE terminates link to manager.
      "update": { # Represents customer-manager link relationship. # Update operation: The link is expected to have a valid resource name.
        "managerCustomer": "A String", # Output only. The manager customer linked to the customer.
        "managerLinkId": "A String", # Output only. ID of the customer-manager link. This field is read only.
        "resourceName": "A String", # Immutable. Name of the resource. CustomerManagerLink resource names have the form: `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}`
        "startTime": "A String", # Output only. The timestamp when the CustomerManagerLink was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
        "status": "A String", # Status of the link between the customer and the manager.
      },
      "updateMask": "A String", # FieldMask that determines which resource fields are modified in an update.
    },
  ],
  "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 CustomerManagerLink mutate.
  "results": [ # A result that identifies the resource affected by the mutate request.
    { # The result for the customer manager link mutate.
      "resourceName": "A String", # Returned for successful operations.
    },
  ],
}