Search Ads 360 Reporting API . customers . customerSkAdNetworkConversionValueSchemas

Instance Methods

close()

Close httplib2 connections.

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

Creates or updates the CustomerSkAdNetworkConversionValueSchema. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [InternalError]() [MutateError]()

Method Details

close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates or updates the CustomerSkAdNetworkConversionValueSchema. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [InternalError]() [MutateError]()

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

{ # Request message for CustomerSkAdNetworkConversionValueSchemaService.MutateCustomerSkAdNetworkConversionValueSchema.
  "enableWarnings": True or False, # Optional. If true, enables returning warnings. Warnings return error messages and error codes without blocking the execution of the mutate operation.
  "operation": { # A single update operation for a CustomerSkAdNetworkConversionValueSchema. # The operation to perform.
    "update": { # A CustomerSkAdNetworkConversionValueSchema. # Update operation: The schema is expected to have a valid resource name.
      "resourceName": "A String", # Output only. The resource name of the schema. CustomerSkAdNetworkConversionValueSchema resource names have the form: customers/{customer_id}/customerSkAdNetworkConversionValueSchemas/{account_link_id}
      "schema": { # The CustomerLink specific SkAdNetworkConversionValueSchema. # Output only. The schema for the specified resource.
        "appId": "A String", # Required. Output only. Apple App Store app ID.
        "fineGrainedConversionValueMappings": [ # Output only. Fine grained conversion value mappings.
          { # Mappings for fine grained conversion value.
            "conversionValueMapping": { # Represents mapping from one conversion value to one or more conversion events. # Output only. Conversion events the fine grained conversion value maps to.
              "mappedEvents": [ # Output only. The conversion value may be mapped to multiple events with various attributes.
                { # Defines a Google conversion event that the conversion value is mapped to.
                  "currencyCode": "A String", # Output only. The reported currency for the event_revenue. ISO 4217 three-letter currency code, for example, "USD"
                  "eventCounter": "A String", # Output only. For specific event counter values.
                  "eventOccurrenceRange": { # Defines a range for event counter values. # Output only. The event counter range.
                    "maxEventCount": "A String", # Output only. For event counter ranges, the maximum of the defined range. A value of 0 will be treated as unset.
                    "minEventCount": "A String", # Output only. For event counter ranges, the minimum of the defined range. A value of 0 will be treated as unset.
                  },
                  "eventRevenueRange": { # Defines a range for revenue values. # Output only. The event revenue range.
                    "maxEventRevenue": 3.14, # Output only. For revenue ranges, the maximum value in `currency_code` for which this conversion value would be updated. A value of 0 will be treated as unset.
                    "minEventRevenue": 3.14, # Output only. For revenue ranges, the minimum value in `currency_code` for which this conversion value would be updated. A value of 0 will be treated as unset.
                  },
                  "eventRevenueValue": 3.14, # Output only. The specific event revenue value.
                  "mappedEventName": "A String", # Output only. Google event name represented by this conversion value.
                },
              ],
              "maxTimePostInstallHours": "A String", # Output only. The maximum of the time range in which a user was last active during the measurement window.
              "minTimePostInstallHours": "A String", # Output only. The minimum of the time range in which a user was last active during the measurement window.
            },
            "fineGrainedConversionValue": 42, # Output only. Fine grained conversion value. Valid values are in the inclusive range [0,63].
          },
        ],
        "measurementWindowHours": 42, # Output only. A time window (measured in hours) post-install, after which the App Attribution Partner or advertiser stops calling [updateConversionValue] (https://developer.apple.com/documentation/storekit/skadnetwork/3566697-updateconversionvalue).
        "postbackMappings": [ # Output only. Per-postback conversion value mappings for postbacks in multiple conversion windows. Only applicable for SkAdNetwork versions >= 4.0.
          { # Mappings for each postback in multiple conversion windows.
            "coarseGrainedConversionValueMappings": { # Mappings for coarse grained conversion values. # Output only. Conversion value mappings for all coarse grained conversion values.
              "highConversionValueMapping": { # Represents mapping from one conversion value to one or more conversion events. # Output only. Mapping for "high" coarse conversion value.
                "mappedEvents": [ # Output only. The conversion value may be mapped to multiple events with various attributes.
                  { # Defines a Google conversion event that the conversion value is mapped to.
                    "currencyCode": "A String", # Output only. The reported currency for the event_revenue. ISO 4217 three-letter currency code, for example, "USD"
                    "eventCounter": "A String", # Output only. For specific event counter values.
                    "eventOccurrenceRange": { # Defines a range for event counter values. # Output only. The event counter range.
                      "maxEventCount": "A String", # Output only. For event counter ranges, the maximum of the defined range. A value of 0 will be treated as unset.
                      "minEventCount": "A String", # Output only. For event counter ranges, the minimum of the defined range. A value of 0 will be treated as unset.
                    },
                    "eventRevenueRange": { # Defines a range for revenue values. # Output only. The event revenue range.
                      "maxEventRevenue": 3.14, # Output only. For revenue ranges, the maximum value in `currency_code` for which this conversion value would be updated. A value of 0 will be treated as unset.
                      "minEventRevenue": 3.14, # Output only. For revenue ranges, the minimum value in `currency_code` for which this conversion value would be updated. A value of 0 will be treated as unset.
                    },
                    "eventRevenueValue": 3.14, # Output only. The specific event revenue value.
                    "mappedEventName": "A String", # Output only. Google event name represented by this conversion value.
                  },
                ],
                "maxTimePostInstallHours": "A String", # Output only. The maximum of the time range in which a user was last active during the measurement window.
                "minTimePostInstallHours": "A String", # Output only. The minimum of the time range in which a user was last active during the measurement window.
              },
              "lowConversionValueMapping": { # Represents mapping from one conversion value to one or more conversion events. # Output only. Mapping for "low" coarse conversion value.
                "mappedEvents": [ # Output only. The conversion value may be mapped to multiple events with various attributes.
                  { # Defines a Google conversion event that the conversion value is mapped to.
                    "currencyCode": "A String", # Output only. The reported currency for the event_revenue. ISO 4217 three-letter currency code, for example, "USD"
                    "eventCounter": "A String", # Output only. For specific event counter values.
                    "eventOccurrenceRange": { # Defines a range for event counter values. # Output only. The event counter range.
                      "maxEventCount": "A String", # Output only. For event counter ranges, the maximum of the defined range. A value of 0 will be treated as unset.
                      "minEventCount": "A String", # Output only. For event counter ranges, the minimum of the defined range. A value of 0 will be treated as unset.
                    },
                    "eventRevenueRange": { # Defines a range for revenue values. # Output only. The event revenue range.
                      "maxEventRevenue": 3.14, # Output only. For revenue ranges, the maximum value in `currency_code` for which this conversion value would be updated. A value of 0 will be treated as unset.
                      "minEventRevenue": 3.14, # Output only. For revenue ranges, the minimum value in `currency_code` for which this conversion value would be updated. A value of 0 will be treated as unset.
                    },
                    "eventRevenueValue": 3.14, # Output only. The specific event revenue value.
                    "mappedEventName": "A String", # Output only. Google event name represented by this conversion value.
                  },
                ],
                "maxTimePostInstallHours": "A String", # Output only. The maximum of the time range in which a user was last active during the measurement window.
                "minTimePostInstallHours": "A String", # Output only. The minimum of the time range in which a user was last active during the measurement window.
              },
              "mediumConversionValueMapping": { # Represents mapping from one conversion value to one or more conversion events. # Output only. Mapping for "medium" coarse conversion value.
                "mappedEvents": [ # Output only. The conversion value may be mapped to multiple events with various attributes.
                  { # Defines a Google conversion event that the conversion value is mapped to.
                    "currencyCode": "A String", # Output only. The reported currency for the event_revenue. ISO 4217 three-letter currency code, for example, "USD"
                    "eventCounter": "A String", # Output only. For specific event counter values.
                    "eventOccurrenceRange": { # Defines a range for event counter values. # Output only. The event counter range.
                      "maxEventCount": "A String", # Output only. For event counter ranges, the maximum of the defined range. A value of 0 will be treated as unset.
                      "minEventCount": "A String", # Output only. For event counter ranges, the minimum of the defined range. A value of 0 will be treated as unset.
                    },
                    "eventRevenueRange": { # Defines a range for revenue values. # Output only. The event revenue range.
                      "maxEventRevenue": 3.14, # Output only. For revenue ranges, the maximum value in `currency_code` for which this conversion value would be updated. A value of 0 will be treated as unset.
                      "minEventRevenue": 3.14, # Output only. For revenue ranges, the minimum value in `currency_code` for which this conversion value would be updated. A value of 0 will be treated as unset.
                    },
                    "eventRevenueValue": 3.14, # Output only. The specific event revenue value.
                    "mappedEventName": "A String", # Output only. Google event name represented by this conversion value.
                  },
                ],
                "maxTimePostInstallHours": "A String", # Output only. The maximum of the time range in which a user was last active during the measurement window.
                "minTimePostInstallHours": "A String", # Output only. The minimum of the time range in which a user was last active during the measurement window.
              },
            },
            "lockWindowCoarseConversionValue": "A String", # Output only. Coarse grained conversion value that triggers conversion window lock.
            "lockWindowEvent": "A String", # Output only. Event name that triggers conversion window lock.
            "lockWindowFineConversionValue": 42, # Output only. Fine grained conversion value that triggers conversion window lock.
            "postbackSequenceIndex": 42, # Output only. 0-based index that indicates the order of postback. Valid values are in the inclusive range [0,2].
          },
        ],
      },
    },
  },
  "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 MutateCustomerSkAdNetworkConversionValueSchema.
  "result": { # The result for the CustomerSkAdNetworkConversionValueSchema mutate. # All results for the mutate.
    "appId": "A String", # App ID of the SkanConversionValue modified.
    "resourceName": "A String", # Resource name of the customer that was modified.
  },
  "warning": { # 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). # Non blocking errors that provides schema validation failure details. Returned only when enable_warnings = true.
    "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.
  },
}