Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates or removes asset group signals. Operation statuses are returned.
close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates or removes asset group signals. Operation statuses are returned.
Args:
customerId: string, Required. The ID of the customer whose asset group signals are being modified. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for AssetGroupSignalService.MutateAssetGroupSignals.
"operations": [ # Required. The list of operations to perform on individual asset group signals.
{ # A single operation (create, remove) on an asset group signal.
"create": { # AssetGroupSignal represents a signal in an asset group. The existence of a signal tells the performance max campaign who's most likely to convert. Performance Max uses the signal to look for new people with similar or stronger intent to find conversions across Search, Display, Video, and more. # Create operation: No resource name is expected for the new asset group signal.
"approvalStatus": "A String", # Output only. Approval status is the output value for search theme signal after Google ads policy review. When using Audience signal, this field is not used and will be absent.
"assetGroup": "A String", # Immutable. The asset group which this asset group signal belongs to.
"audience": { # An audience criterion. # Immutable. The audience signal to be used by the performance max campaign.
"audience": "A String", # The Audience resource name.
},
"disapprovalReasons": [ # Output only. Computed for SearchTheme signals. When using Audience signal, this field is not used and will be absent.
"A String",
],
"resourceName": "A String", # Immutable. The resource name of the asset group signal. Asset group signal resource name have the form: `customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}`
"searchTheme": { # A Search Theme criterion only on Performance Max campaign. Represents a keyword-like advertiser input. # Immutable. The search_theme signal to be used by the performance max campaign. Mutate errors of search_theme criterion includes AssetGroupSignalError.UNSPECIFIED AssetGroupSignalError.UNKNOWN AssetGroupSignalError.TOO_MANY_WORDS AssetGroupSignalError.SEARCH_THEME_POLICY_VIOLATION FieldError.REQUIRED StringFormatError.ILLEGAL_CHARS StringLengthError.TOO_LONG ResourceCountLimitExceededError.RESOURCE_LIMIT
"text": "A String", # Each Search Theme has a value of a simple string, like keywords. There are limits on overall length, allowed characters, and number of words.
},
},
"exemptPolicyViolationKeys": [ # Optional. The list of policy violation keys that should not cause a PolicyViolationError to be reported. Not all policy violations are exemptable, refer to the is_exemptible field in the returned PolicyViolationError. Resources violating these polices will be saved, but will not be eligible to serve. They may begin serving at a later time due to a change in policies, re-review of the resource, or a change in advertiser certificates.
{ # Key of the violation. The key is used for referring to a violation when filing an exemption request.
"policyName": "A String", # Unique ID of the violated policy.
"violatingText": "A String", # The text that violates the policy if specified. Otherwise, refers to the policy in general (for example, when requesting to be exempt from the whole policy). If not specified for criterion exemptions, the whole policy is implied. Must be specified for ad exemptions.
},
],
"remove": "A String", # Remove operation: A resource name for the removed asset group signal is expected, in this format: `customers/{customer_id}/assetGroupSignals/{asset_group_id}~{criterion_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 group signal 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 group signal mutate.
"assetGroupSignal": { # AssetGroupSignal represents a signal in an asset group. The existence of a signal tells the performance max campaign who's most likely to convert. Performance Max uses the signal to look for new people with similar or stronger intent to find conversions across Search, Display, Video, and more. # The mutated AssetGroupSignal with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
"approvalStatus": "A String", # Output only. Approval status is the output value for search theme signal after Google ads policy review. When using Audience signal, this field is not used and will be absent.
"assetGroup": "A String", # Immutable. The asset group which this asset group signal belongs to.
"audience": { # An audience criterion. # Immutable. The audience signal to be used by the performance max campaign.
"audience": "A String", # The Audience resource name.
},
"disapprovalReasons": [ # Output only. Computed for SearchTheme signals. When using Audience signal, this field is not used and will be absent.
"A String",
],
"resourceName": "A String", # Immutable. The resource name of the asset group signal. Asset group signal resource name have the form: `customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}`
"searchTheme": { # A Search Theme criterion only on Performance Max campaign. Represents a keyword-like advertiser input. # Immutable. The search_theme signal to be used by the performance max campaign. Mutate errors of search_theme criterion includes AssetGroupSignalError.UNSPECIFIED AssetGroupSignalError.UNKNOWN AssetGroupSignalError.TOO_MANY_WORDS AssetGroupSignalError.SEARCH_THEME_POLICY_VIOLATION FieldError.REQUIRED StringFormatError.ILLEGAL_CHARS StringLengthError.TOO_LONG ResourceCountLimitExceededError.RESOURCE_LIMIT
"text": "A String", # Each Search Theme has a value of a simple string, like keywords. There are limits on overall length, allowed characters, and number of words.
},
},
"resourceName": "A String", # Returned for successful operations.
},
],
}