Search Ads 360 Reporting API . customers . keywordPlanCampaignKeywords

close()

Close httplib2 connections.

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

Creates, updates, or removes Keyword Plan campaign keywords. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [KeywordPlanAdGroupKeywordError]() [KeywordPlanCampaignKeywordError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()

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

{ # Request message for KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords.
  "operations": [ # Required. The list of operations to perform on individual Keyword Plan campaign keywords.
    { # A single operation (create, update, remove) on a Keyword Plan campaign keyword.
      "create": { # A Keyword Plan Campaign keyword. Only negative keywords are supported for Campaign Keyword. # Create operation: No resource name is expected for the new Keyword Plan campaign keyword.
        "id": "A String", # Output only. The ID of the Keyword Plan negative keyword.
        "keywordPlanCampaign": "A String", # The Keyword Plan campaign to which this negative keyword belongs.
        "matchType": "A String", # The keyword match type.
        "negative": True or False, # Immutable. If true, the keyword is negative. Must be set to true. Only negative campaign keywords are supported.
        "resourceName": "A String", # Immutable. The resource name of the Keyword Plan Campaign keyword. KeywordPlanCampaignKeyword resource names have the form: `customers/{customer_id}/keywordPlanCampaignKeywords/{kp_campaign_keyword_id}`
        "text": "A String", # The keyword text.
      },
      "remove": "A String", # Remove operation: A resource name for the removed Keyword Plan campaign keywords expected in this format: `customers/{customer_id}/keywordPlanCampaignKeywords/{kp_campaign_keyword_id}`
      "update": { # A Keyword Plan Campaign keyword. Only negative keywords are supported for Campaign Keyword. # Update operation: The Keyword Plan campaign keyword expected to have a valid resource name.
        "id": "A String", # Output only. The ID of the Keyword Plan negative keyword.
        "keywordPlanCampaign": "A String", # The Keyword Plan campaign to which this negative keyword belongs.
        "matchType": "A String", # The keyword match type.
        "negative": True or False, # Immutable. If true, the keyword is negative. Must be set to true. Only negative campaign keywords are supported.
        "resourceName": "A String", # Immutable. The resource name of the Keyword Plan Campaign keyword. KeywordPlanCampaignKeyword resource names have the form: `customers/{customer_id}/keywordPlanCampaignKeywords/{kp_campaign_keyword_id}`
        "text": "A String", # The keyword text.
      },
      "updateMask": "A String", # The 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.
  "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 Keyword Plan campaign keyword 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 Keyword Plan campaign keyword mutate.
      "resourceName": "A String", # Returned for successful operations.
    },
  ],
}