Method: customers.customerSkAdNetworkConversionValueSchemas.mutate

Creates or updates the CustomerSkAdNetworkConversionValueSchema.

List of thrown errors: AuthenticationError AuthorizationError FieldError InternalError MutateError

HTTP request

POST https://googleads.googleapis.com/v17/customers/{customerId}/customerSkAdNetworkConversionValueSchemas:mutate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

The ID of the customer whose shared sets are being modified.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "operation": {
    object (CustomerSkAdNetworkConversionValueSchemaOperation)
  },
  "validateOnly": boolean,
  "enableWarnings": boolean
}
Fields
operation

object (CustomerSkAdNetworkConversionValueSchemaOperation)

The operation to perform.
validateOnly

boolean

If true, the request is validated but not executed. Only errors are returned, not results.
enableWarnings

boolean

Optional. If true, enables returning warnings. Warnings return error messages and error codes without blocking the execution of the mutate operation.

Response body

Response message for customerSkAdNetworkConversionValueSchemas.mutate.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "result": {
    object (MutateCustomerSkAdNetworkConversionValueSchemaResult)
  },
  "warning": {
    object (Status)
  }
}
Fields
result

object (MutateCustomerSkAdNetworkConversionValueSchemaResult)

All results for the mutate.
warning

object (Status)

Non blocking errors that provides schema validation failure details. Returned only when enableWarnings = true.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CustomerSkAdNetworkConversionValueSchemaOperation

A single update operation for a CustomerSkAdNetworkConversionValueSchema.

JSON representation 
{
  "update": {
    object (CustomerSkAdNetworkConversionValueSchema)
  }
}
Fields
update

object (CustomerSkAdNetworkConversionValueSchema)

Update operation: The schema is expected to have a valid resource name.

CustomerSkAdNetworkConversionValueSchema

A CustomerSkAdNetworkConversionValueSchema.

JSON representation 
{
  "resourceName": string,
  "schema": {
    object (SkAdNetworkConversionValueSchema)
  }
}
Fields
resourceName

string

Output only. The resource name of the schema. CustomerSkAdNetworkConversionValueSchema resource names have the form: customers/{customerId}/customerSkAdNetworkConversionValueSchemas/{accountLinkId}
schema

object (SkAdNetworkConversionValueSchema)

Output only. The schema for the specified resource.

SkAdNetworkConversionValueSchema

The CustomerLink specific SkAdNetworkConversionValueSchema.

JSON representation 
{
  "appId": string,
  "measurementWindowHours": integer,
  "fineGrainedConversionValueMappings": [
    {
      object (FineGrainedConversionValueMappings)
    }
  ],
  "postbackMappings": [
    {
      object (PostbackMapping)
    }
  ]
}
Fields
appId

string

Required. Output only. Apple App Store app ID.
measurementWindowHours

integer

Output only. A time window (measured in hours) post-install, after which the App Attribution Partner or advertiser stops calling updateConversionValue.
fineGrainedConversionValueMappings[]

object (FineGrainedConversionValueMappings)

Output only. Fine grained conversion value mappings. For SkAdNetwork versions >= 4.0 that support multiple conversion windows, fine grained conversion value mappings are only applicable to the first postback.
postbackMappings[]

object (PostbackMapping)

Output only. Per-postback conversion value mappings for postbacks in multiple conversion windows. Only applicable for SkAdNetwork versions >= 4.0.

FineGrainedConversionValueMappings

Mappings for fine grained conversion value.

JSON representation 
{
  "fineGrainedConversionValue": integer,
  "conversionValueMapping": {
    object (ConversionValueMapping)
  }
}
Fields
fineGrainedConversionValue

integer

Output only. Fine grained conversion value. Valid values are in the inclusive range [0,63].
conversionValueMapping

object (ConversionValueMapping)

Output only. Conversion events the fine grained conversion value maps to.

ConversionValueMapping

Represents mapping from one conversion value to one or more conversion events.

JSON representation 
{
  "minTimePostInstallHours": string,
  "maxTimePostInstallHours": string,
  "mappedEvents": [
    {
      object (Event)
    }
  ]
}
Fields
minTimePostInstallHours

string (int64 format)

Output only. The minimum of the time range in which a user was last active during the measurement window.
maxTimePostInstallHours

string (int64 format)

Output only. The maximum of the time range in which a user was last active during the measurement window.
mappedEvents[]

object (Event)

Output only. The conversion value may be mapped to multiple events with various attributes.

Event

Defines a Google conversion event that the conversion value is mapped to.

JSON representation 
{
  "mappedEventName": string,
  "currencyCode": string,

  // Union field revenue_rate can be only one of the following:
  "eventRevenueRange": {
    object (RevenueRange)
  },
  "eventRevenueValue": number
  // End of list of possible types for union field revenue_rate.

  // Union field event_rate can be only one of the following:
  "eventOccurrenceRange": {
    object (EventOccurrenceRange)
  },
  "eventCounter": string
  // End of list of possible types for union field event_rate.
}
Fields
mappedEventName

string

Output only. Google event name represented by this conversion value.
currencyCode

string

Output only. The reported currency for the event_revenue. ISO 4217 three-letter currency code, for example, "USD"
Union field revenue_rate. Either a range or specific value for event revenue. revenue_rate can be only one of the following:
eventRevenueRange

object (RevenueRange)

Output only. The event revenue range.
eventRevenueValue

number

Output only. The specific event revenue value.
Union field event_rate. Either a range or specific value for event counter. event_rate can be only one of the following:
eventOccurrenceRange

object (EventOccurrenceRange)

Output only. The event counter range.
eventCounter

string (int64 format)

Output only. For specific event counter values.

RevenueRange

Defines a range for revenue values.

JSON representation 
{
  "minEventRevenue": number,
  "maxEventRevenue": number
}
Fields
minEventRevenue

number

Output only. For revenue ranges, the minimum value in currencyCode for which this conversion value would be updated. A value of 0 will be treated as unset.
maxEventRevenue

number

Output only. For revenue ranges, the maximum value in currencyCode for which this conversion value would be updated. A value of 0 will be treated as unset.

EventOccurrenceRange

Defines a range for event counter values.

JSON representation 
{
  "minEventCount": string,
  "maxEventCount": string
}
Fields
minEventCount

string (int64 format)

Output only. For event counter ranges, the minimum of the defined range. A value of 0 will be treated as unset.
maxEventCount

string (int64 format)

Output only. For event counter ranges, the maximum of the defined range. A value of 0 will be treated as unset.

PostbackMapping

Mappings for each postback in multiple conversion windows.

JSON representation 
{
  "postbackSequenceIndex": integer,
  "coarseGrainedConversionValueMappings": {
    object (CoarseGrainedConversionValueMappings)
  },

  // Union field lock_window_trigger can be only one of the following:
  "lockWindowCoarseConversionValue": enum (SkAdNetworkCoarseConversionValue),
  "lockWindowFineConversionValue": integer,
  "lockWindowEvent": string
  // End of list of possible types for union field lock_window_trigger.
}
Fields
postbackSequenceIndex

integer

Output only. 0-based index that indicates the order of postback. Valid values are in the inclusive range [0,2].
coarseGrainedConversionValueMappings

object (CoarseGrainedConversionValueMappings)

Output only. Conversion value mappings for all coarse grained conversion values.
Union field lock_window_trigger. Event or conversion value used for locking conversion window. lock_window_trigger can be only one of the following:
lockWindowCoarseConversionValue

enum (SkAdNetworkCoarseConversionValue)

Output only. Coarse grained conversion value that triggers conversion window lock.
lockWindowFineConversionValue

integer

Output only. Fine grained conversion value that triggers conversion window lock.
lockWindowEvent

string

Output only. Event name that triggers conversion window lock.

CoarseGrainedConversionValueMappings

Mappings for coarse grained conversion values.

JSON representation 
{
  "lowConversionValueMapping": {
    object (ConversionValueMapping)
  },
  "mediumConversionValueMapping": {
    object (ConversionValueMapping)
  },
  "highConversionValueMapping": {
    object (ConversionValueMapping)
  }
}
Fields
lowConversionValueMapping

object (ConversionValueMapping)

Output only. Mapping for "low" coarse conversion value.
mediumConversionValueMapping

object (ConversionValueMapping)

Output only. Mapping for "medium" coarse conversion value.
highConversionValueMapping

object (ConversionValueMapping)

Output only. Mapping for "high" coarse conversion value.

MutateCustomerSkAdNetworkConversionValueSchemaResult

The result for the CustomerSkAdNetworkConversionValueSchema mutate.

JSON representation 
{
  "resourceName": string,
  "appId": string
}
Fields
resourceName

string

Resource name of the customer that was modified.
appId

string

App ID of the SkanConversionValue modified.