Search Ads 360 Reporting API . customers . keywordPlanCampaigns

close()

Close httplib2 connections.

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

Creates, updates, or removes Keyword Plan campaigns. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [KeywordPlanCampaignError]() [KeywordPlanError]() [ListOperationError]() [MutateError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]()

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

{ # Request message for KeywordPlanCampaignService.MutateKeywordPlanCampaigns.
  "operations": [ # Required. The list of operations to perform on individual Keyword Plan campaigns.
    { # A single operation (create, update, remove) on a Keyword Plan campaign.
      "create": { # A Keyword Plan campaign. Max number of keyword plan campaigns per plan allowed: 1. # Create operation: No resource name is expected for the new Keyword Plan campaign.
        "cpcBidMicros": "A String", # A default max cpc bid in micros, and in the account currency, for all ad groups under the campaign. This field is required and should not be empty when creating Keyword Plan campaigns.
        "geoTargets": [ # The geo targets. Max number allowed: 20.
          { # A geo target.
            "geoTargetConstant": "A String", # Required. The resource name of the geo target.
          },
        ],
        "id": "A String", # Output only. The ID of the Keyword Plan campaign.
        "keywordPlan": "A String", # The keyword plan this campaign belongs to.
        "keywordPlanNetwork": "A String", # Targeting network. This field is required and should not be empty when creating Keyword Plan campaigns.
        "languageConstants": [ # The languages targeted for the Keyword Plan campaign. Max allowed: 1.
          "A String",
        ],
        "name": "A String", # The name of the Keyword Plan campaign. This field is required and should not be empty when creating Keyword Plan campaigns.
        "resourceName": "A String", # Immutable. The resource name of the Keyword Plan campaign. KeywordPlanCampaign resource names have the form: `customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_id}`
      },
      "remove": "A String", # Remove operation: A resource name for the removed Keyword Plan campaign is expected, in this format: `customers/{customer_id}/keywordPlanCampaigns/{keywordPlan_campaign_id}`
      "update": { # A Keyword Plan campaign. Max number of keyword plan campaigns per plan allowed: 1. # Update operation: The Keyword Plan campaign is expected to have a valid resource name.
        "cpcBidMicros": "A String", # A default max cpc bid in micros, and in the account currency, for all ad groups under the campaign. This field is required and should not be empty when creating Keyword Plan campaigns.
        "geoTargets": [ # The geo targets. Max number allowed: 20.
          { # A geo target.
            "geoTargetConstant": "A String", # Required. The resource name of the geo target.
          },
        ],
        "id": "A String", # Output only. The ID of the Keyword Plan campaign.
        "keywordPlan": "A String", # The keyword plan this campaign belongs to.
        "keywordPlanNetwork": "A String", # Targeting network. This field is required and should not be empty when creating Keyword Plan campaigns.
        "languageConstants": [ # The languages targeted for the Keyword Plan campaign. Max allowed: 1.
          "A String",
        ],
        "name": "A String", # The name of the Keyword Plan campaign. This field is required and should not be empty when creating Keyword Plan campaigns.
        "resourceName": "A String", # Immutable. The resource name of the Keyword Plan campaign. KeywordPlanCampaign resource names have the form: `customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_id}`
      },
      "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 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 mutate.
      "resourceName": "A String", # Returned for successful operations.
    },
  ],
}