Search Ads 360 Reporting API . customers . conversionValueRules

Instance Methods

close()

Close httplib2 connections.

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

Creates, updates, or removes conversion value rules. Operation statuses are returned.

Method Details

close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates, or removes conversion value rules. Operation statuses are returned.

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

{ # Request message for ConversionValueRuleService.MutateConversionValueRules.
  "operations": [ # Required. The list of operations to perform on individual conversion value rules.
    { # A single operation (create, update, remove) on a conversion value rule.
      "create": { # A conversion value rule # Create operation: No resource name is expected for the new conversion value rule.
        "action": { # Action applied when rule is applied. # Action applied when the rule is triggered.
          "operation": "A String", # Specifies applied operation.
          "value": 3.14, # Specifies applied value.
        },
        "audienceCondition": { # Condition on Audience dimension. # Condition for audience that must be satisfied for the value rule to apply.
          "userInterests": [ # User Interests.
            "A String",
          ],
          "userLists": [ # User Lists.
            "A String",
          ],
        },
        "deviceCondition": { # Condition on Device dimension. # Condition for device type that must be satisfied for the value rule to apply.
          "deviceTypes": [ # Value for device type condition.
            "A String",
          ],
        },
        "geoLocationCondition": { # Condition on Geo dimension. # Condition for Geo location that must be satisfied for the value rule to apply.
          "excludedGeoMatchType": "A String", # Excluded Geo location match type.
          "excludedGeoTargetConstants": [ # Geo locations that advertisers want to exclude.
            "A String",
          ],
          "geoMatchType": "A String", # Included Geo location match type.
          "geoTargetConstants": [ # Geo locations that advertisers want to include.
            "A String",
          ],
        },
        "id": "A String", # Output only. The ID of the conversion value rule.
        "itineraryCondition": { # Condition on Itinerary dimension. # Condition for itinerary that must be satisfied for the value rule to apply.
          "advanceBookingWindow": { # Range for the number of days between the date of the booking and the start of the itinerary. # Range for the number of days between the date of the booking and the start of the itinerary.
            "maxDays": 42, # Maximum number of days between the date of the booking the start date.
            "minDays": 42, # Minimum number of days between the date of the booking the start date.
          },
          "travelLength": { # Range for the itinerary length in number of nights. # Range for the itinerary length in number of nights.
            "maxNights": 42, # Maximum number of days between the start date and the end date.
            "minNights": 42, # Minimum number of nights between the start date and the end date.
          },
          "travelStartDay": { # The days of the week on which an itinerary's travel can start. # The days of the week on which this itinerary's travel can start.
            "friday": True or False, # The travel can start on Friday.
            "monday": True or False, # The travel can start on Monday.
            "saturday": True or False, # The travel can start on Saturday.
            "sunday": True or False, # The travel can start on Sunday.
            "thursday": True or False, # The travel can start on Thursday.
            "tuesday": True or False, # The travel can start on Tuesday.
            "wednesday": True or False, # The travel can start on Wednesday.
          },
        },
        "ownerCustomer": "A String", # Output only. The resource name of the conversion value rule's owner customer. When the value rule is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
        "resourceName": "A String", # Immutable. The resource name of the conversion value rule. Conversion value rule resource names have the form: `customers/{customer_id}/conversionValueRules/{conversion_value_rule_id}`
        "status": "A String", # The status of the conversion value rule.
      },
      "remove": "A String", # Remove operation: A resource name for the removed conversion value rule is expected, in this format: `customers/{customer_id}/conversionValueRules/{conversion_value_rule_id}`
      "update": { # A conversion value rule # Update operation: The conversion value rule is expected to have a valid resource name.
        "action": { # Action applied when rule is applied. # Action applied when the rule is triggered.
          "operation": "A String", # Specifies applied operation.
          "value": 3.14, # Specifies applied value.
        },
        "audienceCondition": { # Condition on Audience dimension. # Condition for audience that must be satisfied for the value rule to apply.
          "userInterests": [ # User Interests.
            "A String",
          ],
          "userLists": [ # User Lists.
            "A String",
          ],
        },
        "deviceCondition": { # Condition on Device dimension. # Condition for device type that must be satisfied for the value rule to apply.
          "deviceTypes": [ # Value for device type condition.
            "A String",
          ],
        },
        "geoLocationCondition": { # Condition on Geo dimension. # Condition for Geo location that must be satisfied for the value rule to apply.
          "excludedGeoMatchType": "A String", # Excluded Geo location match type.
          "excludedGeoTargetConstants": [ # Geo locations that advertisers want to exclude.
            "A String",
          ],
          "geoMatchType": "A String", # Included Geo location match type.
          "geoTargetConstants": [ # Geo locations that advertisers want to include.
            "A String",
          ],
        },
        "id": "A String", # Output only. The ID of the conversion value rule.
        "itineraryCondition": { # Condition on Itinerary dimension. # Condition for itinerary that must be satisfied for the value rule to apply.
          "advanceBookingWindow": { # Range for the number of days between the date of the booking and the start of the itinerary. # Range for the number of days between the date of the booking and the start of the itinerary.
            "maxDays": 42, # Maximum number of days between the date of the booking the start date.
            "minDays": 42, # Minimum number of days between the date of the booking the start date.
          },
          "travelLength": { # Range for the itinerary length in number of nights. # Range for the itinerary length in number of nights.
            "maxNights": 42, # Maximum number of days between the start date and the end date.
            "minNights": 42, # Minimum number of nights between the start date and the end date.
          },
          "travelStartDay": { # The days of the week on which an itinerary's travel can start. # The days of the week on which this itinerary's travel can start.
            "friday": True or False, # The travel can start on Friday.
            "monday": True or False, # The travel can start on Monday.
            "saturday": True or False, # The travel can start on Saturday.
            "sunday": True or False, # The travel can start on Sunday.
            "thursday": True or False, # The travel can start on Thursday.
            "tuesday": True or False, # The travel can start on Tuesday.
            "wednesday": True or False, # The travel can start on Wednesday.
          },
        },
        "ownerCustomer": "A String", # Output only. The resource name of the conversion value rule's owner customer. When the value rule is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
        "resourceName": "A String", # Immutable. The resource name of the conversion value rule. Conversion value rule resource names have the form: `customers/{customer_id}/conversionValueRules/{conversion_value_rule_id}`
        "status": "A String", # The status of the conversion value rule.
      },
      "updateMask": "A String", # 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.
  "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 ConversionValueRuleService.MutateConversionValueRules.
  "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 conversion value rule mutate.
      "conversionValueRule": { # A conversion value rule # The mutated conversion value rule with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
        "action": { # Action applied when rule is applied. # Action applied when the rule is triggered.
          "operation": "A String", # Specifies applied operation.
          "value": 3.14, # Specifies applied value.
        },
        "audienceCondition": { # Condition on Audience dimension. # Condition for audience that must be satisfied for the value rule to apply.
          "userInterests": [ # User Interests.
            "A String",
          ],
          "userLists": [ # User Lists.
            "A String",
          ],
        },
        "deviceCondition": { # Condition on Device dimension. # Condition for device type that must be satisfied for the value rule to apply.
          "deviceTypes": [ # Value for device type condition.
            "A String",
          ],
        },
        "geoLocationCondition": { # Condition on Geo dimension. # Condition for Geo location that must be satisfied for the value rule to apply.
          "excludedGeoMatchType": "A String", # Excluded Geo location match type.
          "excludedGeoTargetConstants": [ # Geo locations that advertisers want to exclude.
            "A String",
          ],
          "geoMatchType": "A String", # Included Geo location match type.
          "geoTargetConstants": [ # Geo locations that advertisers want to include.
            "A String",
          ],
        },
        "id": "A String", # Output only. The ID of the conversion value rule.
        "itineraryCondition": { # Condition on Itinerary dimension. # Condition for itinerary that must be satisfied for the value rule to apply.
          "advanceBookingWindow": { # Range for the number of days between the date of the booking and the start of the itinerary. # Range for the number of days between the date of the booking and the start of the itinerary.
            "maxDays": 42, # Maximum number of days between the date of the booking the start date.
            "minDays": 42, # Minimum number of days between the date of the booking the start date.
          },
          "travelLength": { # Range for the itinerary length in number of nights. # Range for the itinerary length in number of nights.
            "maxNights": 42, # Maximum number of days between the start date and the end date.
            "minNights": 42, # Minimum number of nights between the start date and the end date.
          },
          "travelStartDay": { # The days of the week on which an itinerary's travel can start. # The days of the week on which this itinerary's travel can start.
            "friday": True or False, # The travel can start on Friday.
            "monday": True or False, # The travel can start on Monday.
            "saturday": True or False, # The travel can start on Saturday.
            "sunday": True or False, # The travel can start on Sunday.
            "thursday": True or False, # The travel can start on Thursday.
            "tuesday": True or False, # The travel can start on Tuesday.
            "wednesday": True or False, # The travel can start on Wednesday.
          },
        },
        "ownerCustomer": "A String", # Output only. The resource name of the conversion value rule's owner customer. When the value rule is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
        "resourceName": "A String", # Immutable. The resource name of the conversion value rule. Conversion value rule resource names have the form: `customers/{customer_id}/conversionValueRules/{conversion_value_rule_id}`
        "status": "A String", # The status of the conversion value rule.
      },
      "resourceName": "A String", # Returned for successful operations.
    },
  ],
}