Servicio de invalidaciones de ritmo por hora
El servicio de invalidaciones de ritmo por hora se usa para personalizar la distribución presupuestaria del elemento de línea en un día. Esto se puede establecer para días específicos de la semana o fechas específicas. A través de este servicio de API, puede crear una estrategia de ritmo individual (curva de gasto personalizada) para definir y modificar el ritmo de los elementos de línea para una fecha o día determinados de la semana. También puede crear varias estrategias de ritmo a través de este servicio de API para personalizar aún más el ritmo de varias fechas o días de la semana.
RETS API
Http (método) | Endpoint | Description |
---|---|---|
GET |
https://api.appnexus.com/pacing-strategy?line_item_id=LINE_ITEM_ID_1,LINE_ITEM_ID_2 |
Ver estrategias de ritmo para uno o varios elementos de línea. |
PUT |
https://api.appnexus.com/pacing-strategy?line_item_id=LINE_ITEM_ID |
Agregue una estrategia de ritmo para un solo elemento de línea. |
PUT |
https://api.appnexus.com/pacing-strategy?line_item_id=LINE_ITEM_ID |
Modificar una estrategia de ritmo existente. |
DELETE |
https://api.appnexus.com/pacing-strategy?line_item_id=LINE_ITEM_ID&when=WHEN |
Elimine una estrategia de ritmo. |
Campos JSON
Campo | Tipo | Description |
---|---|---|
line_item_id |
Entero | Identificador del elemento de línea. Obligatorio en: GET , PUT y DELETE . |
pacing_strategies |
matriz de objetos | Estrategias de ritmo asociadas al elemento de línea. La pacing_strategies matriz de objetos se define en la tabla siguiente. Obligatorio activado: PUT |
Estrategias de ritmo
El pacing_strategies
objeto se usa para definir una estrategia de ritmo personalizada para el elemento de línea. Puede personalizar el ritmo en un solo día y en una sola hora.
Campo | Tipo | Descripción |
---|---|---|
pacing_weights |
object | Los campos de este objeto determinan cuánto gastar por hora en estrategias personalizadas. Los pesos se definen como una proporción del presupuesto diario del elemento de línea. Hay veinticuatro campos disponibles, uno para cada hora del día. Los posibles valores de peso por hora están entre 0 y 100 y las asignaciones de peso en todas las horas deben ser iguales a 100. Vea el ejemplo. Valor predeterminado: null Obligatorio activado: PUT |
strategy_type |
string | Indica cómo el elemento de línea marca el ritmo en un solo día. Los posibles valores son: - asap : gasta tu presupuesto diario lo más rápido posible.- custom : defina la cantidad que desea gastar por hora con pesos. Nota: Los pesos se definen como una proporción del presupuesto diario del elemento de línea.- intelligent : gasta de forma óptima tu presupuesto diario en función de la dinámica del mercado de Xandr.Si los destinos de Daypart (vea daypart_targets en Servicio de perfil) se establecen en el perfil de elemento de línea, la estrategia de ritmo se adaptará automáticamente a las horas aptas.Valor predeterminado: N/A Obligatorio activado: PUT |
when |
string | Cuando la estrategia de ritmo debe estar activa. Los posibles valores son: - always Un solo día de la semana: sunday , , monday , wednesday tuesday , thursday , friday o saturday .Una sola fecha ( "YYYY-MM-DD" por ejemplo: "2019-09-01" ).Valor predeterminado: N/A Obligatorio activado: PUT |
Ejemplo para pacing_weights
[
{
"line_item_id": 13827815,
"pacing_strategies": [
{
"strategy_type": "custom",
"when": "2021-01-22",
"pacing_weights": {
"0": 1.67,
"1": 1.33,
"2": 1.21,
"3": 1.25,
"4": 1.57,
"5": 2.33,
"6": 3.18,
"7": 4.05,
"8": 4.76,
"9": 5,
"10": 5.22,
"11": 4.95,
"12": 5.09,
"13": 5.12,
"14": 5.23,
"15": 5.26,
"16": 5.67,
"17": 5.99,
"18": 5.92,
"19": 6.26,
"20": 6.58,
"21": 5.69,
"22": 4,
"23": 2.67
}
}
]
}
]
Método de carga de archivos
También puede leer o escribir estrategias de ritmo mediante un archivo .csv.
Nota:
Excel da formato automáticamente a las fechas como MM/DD/AAAA. Al escribir valores en la columna when del archivo .csv, pacing Strategy Service espera fechas en el formato AAAA-MM-DD.
line_item_id | strategy_type | Cuando | Hora | weight |
---|---|---|---|---|
1234567 | Inteligente | Siempre | ||
2931292 | Inteligente | Siempre | ||
2931292 | Personalizado | 2019-09-01 | 0 | 33.3 |
2931292 | Personalizado | 2019-09-01 | 1 | 33.35 |
2931292 | Personalizado | 2019-09-01 | 2 | 33.35 |
8123952 | Asap | Siempre | ||
8123952 | Personalizado | Lunes | 0 | 33.35 |
8123952 | Personalizado | Lunes | 1 | 33.35 |
8123952 | Personalizado | Lunes | 2 | 33.3 |
Ejemplos
Ver los detalles de la estrategia de ritmo de un elemento de línea
$ curl -b cookies -c cookies -X GET -H 'Accept: application/json' "https://api.appnexus.com/pacing-strategy?line_item_id=1234567"
[
{
"line_item_id": 1234567,
"pacing_strategies": [
{
"strategy_type": "intelligent",
"when": "always"
}
]
}
]
Ver los detalles de la estrategia de ritmo de varios elementos de línea
$ curl -b cookies -c cookies -X GET -H 'Accept: application/json' "https://api.appnexus.com/pacing-strategy?line_item_id=1234567,2345678"
[
{
"line_item_id": 1234567,
"pacing_strategies": [
{
"strategy_type": "intelligent",
"when": "always"
}
]
},
{
"line_item_id": 2345678,
"pacing_strategies": [
{
"strategy_type": "intelligent",
"when": "always"
},
{
"strategy_type": "custom",
"when": "2019-12-30",
"pacing_weights": {
"0": 1.67,
"1": 1.33,
"2": 1.21,
"3": 1.25,
"4": 1.57,
"5": 2.33,
"6": 3.18,
"7": 4.05,
"8": 4.76,
"9": 5,
"10": 5.22,
"11": 4.95,
"12": 5.09,
"13": 5.12,
"14": 5.23,
"15": 5.26,
"16": 5.67,
"17": 5.99,
"18": 5.92,
"19": 6.26,
"20": 6.58,
"21": 5.69,
"22": 4,
"23": 2.67
}
}
]
}
]
Entrega siempre lo antes posible
$ cat always_asap.json
[
{
"line_item_id": 1234567,
"pacing_strategies": [
{
"strategy_type": "asap",
"when": "always"
}
]
}
]
$ curl -b cookies -c cookies -X PUT -H 'Content-Type: application/json' -d @always_asap.json "https://api.appnexus.com/pacing-strategy?line_item_id=1234567"
Uso de una estrategia de ritmo personalizada en una sola fecha
$ cat custom_date.json
[{
"line_item_id": 1234567,
"pacing_strategies": [{
"strategy_type": "custom",
"when": "2019-12-15",
"pacing_weights": {
"0": 1.67,
"1": 1.33,
"2": 1.21,
"3": 1.25,
"4": 1.57,
"5": 2.33,
"6": 3.18,
"7": 4.05,
"8": 4.76,
"9": 5,
"10": 5.22,
"11": 4.95,
"12": 5.09,
"13": 5.12,
"14": 5.23,
"15": 5.26,
"16": 5.67,
"17": 5.99,
"18": 5.92,
"19": 6.26,
"20": 6.58,
"21": 5.69,
"22": 4,
"23": 2.67
}
}]
}]
$ curl -b cookies -c cookies -X PUT -H 'Content-Type: application/json' -d @custom_date.json "https://api.appnexus.com/pacing-strategy?line_item_id=1234567"
Usar una estrategia de ritmo personalizada en un día determinado de la semana
$ cat custom_dow.json
[{
"line_item_id": 1234567,
"pacing_strategies": [{
"strategy_type": "custom",
"when": "tuesday",
"pacing_weights": {
"0": 1.67,
"1": 1.33,
"2": 1.21,
"3": 1.25,
"4": 1.57,
"5": 2.33,
"6": 3.18,
"7": 4.05,
"8": 4.76,
"9": 5,
"10": 5.22,
"11": 4.95,
"12": 5.09,
"13": 5.12,
"14": 5.23,
"15": 5.26,
"16": 5.67,
"17": 5.99,
"18": 5.92,
"19": 6.26,
"20": 6.58,
"21": 5.69,
"22": 4,
"23": 2.67
}
}]
}]
$ curl -b cookies -c cookies -X PUT -H 'Content-Type: application/json' -d @custom_dow.json "https://api.appnexus.com/pacing-strategy?line_item_id=1234567"
Entrega lo antes posible en un día determinado de la semana
$ cat asap_date.json
[
{
"line_item_id": 1234567,
"pacing_strategies": [
{
"strategy_type": "asap",
"when": "2019-12-15"
}
]
}
]
$ curl -b cookies -c cookies -X PUT -H 'Content-Type: application/json' -d @asap_date.json "https://api.appnexus.com/pacing-strategy?line_item_id=1234567"
(no JSON response, just HTTP 200 OK)
Definir varias estrategias de ritmo para varios elementos de línea
$ cat multiple_strategies.json
[{
"line_item_id": 1234567,
"pacing_strategies": [{
"strategy_type": "asap",
"when": "2019-12-31"
},
{
"strategy_type": "custom",
"when": "monday",
"pacing_weights": {
"0": 1.67,
"1": 1.33,
"2": 1.21,
"3": 1.25,
"4": 1.57,
"5": 2.33,
"6": 3.18,
"7": 4.05,
"8": 4.76,
"9": 5,
"10": 5.22,
"11": 4.95,
"12": 5.09,
"13": 5.12,
"14": 5.23,
"15": 5.26,
"16": 5.67,
"17": 5.99,
"18": 5.92,
"19": 6.26,
"20": 6.58,
"21": 5.69,
"22": 4,
"23": 2.67
}
}
]
},
{
"line_item_id": 2345678,
"pacing_strategies": [{
"strategy_type": "asap",
"when": "always"
},
{
"strategy_type": "custom",
"when": "2019-12-31",
"pacing_weights": {
"0": 1.67,
"1": 1.33,
"2": 1.21,
"3": 1.25,
"4": 1.57,
"5": 2.33,
"6": 3.18,
"7": 4.05,
"8": 4.76,
"9": 5,
"10": 5.22,
"11": 4.95,
"12": 5.09,
"13": 5.12,
"14": 5.23,
"15": 5.26,
"16": 5.67,
"17": 5.99,
"18": 5.92,
"19": 6.26,
"20": 6.58,
"21": 5.69,
"22": 4,
"23": 2.67
}
}
]
}
]
$ curl -b cookies -c cookies -X PUT -H 'Content-Type: application/json' -d @multiple_strategies.json "https://api.appnexus.com/pacing-strategy?line_item_id=1234567&line_item_id=2345678"
Definición de varias estrategias de ritmo para varios elementos de línea mediante un .csv
archivo
$ cat custom_spend_strategies.csv
line_item_id,strategy_type,when,hour,weight
1234567,asap,monday,,
1234567,custom,2022-12-25,0,4
1234567,custom,2022-12-25,1,4
1234567,custom,2022-12-25,2,4
1234567,custom,2022-12-25,3,4
1234567,custom,2022-12-25,4,4
1234567,custom,2022-12-25,5,5
1234567,custom,2022-12-25,6,4
1234567,custom,2022-12-25,7,4
1234567,custom,2022-12-25,8,4
1234567,custom,2022-12-25,9,4
1234567,custom,2022-12-25,10,4
1234567,custom,2022-12-25,11,5
1234567,custom,2022-12-25,12,4
1234567,custom,2022-12-25,13,4
1234567,custom,2022-12-25,14,4
1234567,custom,2022-12-25,15,4
1234567,custom,2022-12-25,16,4
1234567,custom,2022-12-25,17,5
1234567,custom,2022-12-25,18,4
1234567,custom,2022-12-25,19,4
1234567,custom,2022-12-25,20,4
1234567,custom,2022-12-25,21,4
1234567,custom,2022-12-25,22,4
1234567,custom,2022-12-25,23,5
2345678,asap,always,,
2345678,custom,2022-12-25,0,0
2345678,custom,2022-12-25,1,0
2345678,custom,2022-12-25,2,0
2345678,custom,2022-12-25,3,0
2345678,custom,2022-12-25,4,9
2345678,custom,2022-12-25,5,4
2345678,custom,2022-12-25,6,4
2345678,custom,2022-12-25,7,4
2345678,custom,2022-12-25,8,4
2345678,custom,2022-12-25,9,9
2345678,custom,2022-12-25,10,4
2345678,custom,2022-12-25,11,4
2345678,custom,2022-12-25,12,4
2345678,custom,2022-12-25,13,4
2345678,custom,2022-12-25,14,9
2345678,custom,2022-12-25,15,4
2345678,custom,2022-12-25,16,4
2345678,custom,2022-12-25,17,4
2345678,custom,2022-12-25,18,4
2345678,custom,2022-12-25,19,9
2345678,custom,2022-12-25,20,4
2345678,custom,2022-12-25,21,4
2345678,custom,2022-12-25,22,4
2345678,custom,2022-12-25,23,4
$ curl -b cookies -c cookies -X PUT -H 'Content-Type: text/csv' -H 'Accept: application/json' --data-binary '@custom_spend_strategies.csv' 'https://api.appnexus.com/pacing-strategy/upload-csv'
Eliminar la estrategia de ritmo de un elemento de línea
$ curl -b cookies -c cookies -X DELETE -H 'Accept: application/json' "https://api.appnexus.com/pacing-strategy?line_item_id=1234567&when=always"
{
"line_item_id": 1234567,
"pacing_strategies": [
{
"strategy_type": "asap",
"when": "always"
}
]
}
$ curl -b cookies -c cookies -X DELETE -H 'Accept: application/json' "https://api.appnexus.com/pacing-strategy?line_item_id=1234567&when=2019-12-31"
{
"line_item_id": 1234567,
"pacing_strategies": [{
"strategy_type": "custom",
"when": "2019-12-31",
"pacing_weights": {
"0": 1.67,
"1": 1.33,
"2": 1.21,
"3": 1.25,
"4": 1.57,
"5": 2.33,
"6": 3.18,
"7": 4.05,
"8": 4.76,
"9": 5,
"10": 5.22,
"11": 4.95,
"12": 5.09,
"13": 5.12,
"14": 5.23,
"15": 5.26,
"16": 5.67,
"17": 5.99,
"18": 5.92,
"19": 6.26,
"20": 6.58,
"21": 5.69,
"22": 4,
"23": 2.67
}
}]
}