创建、更新或移除资源。此方法支持涉及多种类型的资源的原子事务。例如,您能够以原子方式创建广告系列和广告系列预算,或者以原子方式执行多达数千次 mutate 操作。
此方法本质上是一系列 mutate 方法的封装容器。与直接调用这些方法相比,它提供的唯一功能包括:
- 原子化事务
- 临时资源名称(如下所述)
- 在进行一系列 mutate 调用时,延迟时间稍微缩短了
注意:仅包含支持原子事务的资源,因此此方法无法替换对各个服务的所有调用。
原子交易的优势
原子性可以更轻松地处理错误。如果您进行了一系列更改,但其中一项更改失败,则可能会导致您的账号处于不一致状态。如果使用原子性,您可以直接达到所选状态,如果请求失败,您可以重试。
临时资源名称
临时资源名称是一种特殊类型的资源名称,用于创建资源并在同一请求中引用该资源。例如,如果创建广告系列预算时 resourceName
等于 customers/123/campaignBudgets/-1
,则该资源名称可在同一请求的 Campaign.budget
字段中重复使用。这样,这两个资源就会以原子方式创建和关联。
如需创建临时资源名称,请在服务器通常会分配的名称部分输入一个负数。
注意:
- 必须使用临时名称创建资源,然后才能重复使用该名称。例如,如果将 Mutate 顺序颠倒过来,则前面的 CampaignBudget+Campaign 示例将会失败。
- 系统不会跨请求记住临时名称。
- 请求中无临时名称数量限制。
- 即使资源类型不同,每个临时名称都必须使用唯一的负数。
延迟时间
请务必按资源类型对 mutate 进行分组,否则请求可能会超时并失败。延迟时间大致等于对各个 mutate 方法的一系列调用,其中资源类型中的每次更改都是一次新调用。例如,转变 10 个广告系列和 10 个广告组就相当于 2 次调用,而转变 1 个广告系列、1 个广告组、1 个广告系列和 1 个广告组则相当于 4 次调用。
AdCustomizerErrorAdErrorAdGroupAdErrorAdGroupCriterionErrorAdGroupErrorAssetErrorAuthenticationErrorAuthorizationErrorBiddingErrorCampaignBudgetErrorCampaignCriterionErrorCampaignErrorCampaignExperimentErrorCampaignSharedSetErrorCollectionSizeErrorContextErrorConversionActionErrorCriterionErrorCustomerFeedErrorDatabaseErrorDateErrorDateRangeErrorDistinctErrorExtensionFeedItemErrorExtensionSettingErrorFeedAttributeReferenceErrorFeedErrorFeedItemErrorFeedItemSetErrorFieldErrorFieldMaskErrorFunctionParsingErrorHeaderErrorImageErrorInternalErrorKeywordPlanAdGroupKeywordErrorKeywordPlanCampaignErrorKeywordPlanErrorLabelErrorListOperationErrorMediaUploadErrorMutateErrorNewResourceCreationErrorNullErrorOperationAccessDeniedErrorPolicyFindingErrorPolicyViolationErrorQuotaErrorRangeErrorRequestErrorResourceCountLimitExceededErrorSettingErrorSharedSetErrorSizeLimitErrorStringFormatErrorStringLengthErrorUrlFieldErrorUserListErrorYoutubeVideoRegistrationError
HTTP 请求
POST https://googleads.googleapis.com/v17/customers/{customerId}/googleAds:mutate
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
customerId |
必需。要修改其资源的客户的 ID。 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "mutateOperations": [ { object ( |
字段 | |
---|---|
mutateOperations[] |
必需。要对各个资源执行的操作的列表。 |
partialFailure |
如果值为 true,则系统将执行成功的操作,而无效操作将返回错误。如果为 false,则当且仅当所有操作都有效时,才会在一个事务中执行所有操作。默认值为 false。 |
validateOnly |
如果为 true,则系统会验证该请求,但不会执行该请求。仅返回错误,不返回结果。 |
responseContentType |
回复内容类型设置。确定在变更后返回可变资源还是仅返回资源名称。仅当可变资源具有适当的响应字段时,系统才会返回该资源。例如,MutateCampaignResult.campaign。 |
响应正文
GoogleAdsService.Mutate
的响应消息。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{ "partialFailureError": { object ( |
字段 | |
---|---|
partialFailureError |
与部分失败模式下的操作失败相关的错误。仅当 partialFailure = true 并且所有错误都发生在操作内部时,系统才会返回。如果在操作之外发生任何错误(例如,身份验证错误),我们将返回 RPC 级错误。 |
mutateOperationResponses[] |
mutate 的所有响应。 |
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/adwords
如需了解详情,请参阅 OAuth 2.0 概览。