Servicio de sitio

Artículo
10/15/2024

Un sitio (también denominado grupo de selección de ubicación) proporciona una forma de agrupar las ubicaciones con fines de administración. La calidad del anuncio y la categorización del inventario se pueden establecer en el nivel de sitio, por lo que no es necesario duplicarlo entre ubicaciones. Cada sitio pertenece a un publicador y cada ubicación debe pertenecer a un sitio.

Al crear un publicador, se crea automáticamente un sitio. A continuación, puede modificar ese sitio como desee o crear más sitios.

API de REST

Http (método)	Endpoint	Description
`POST`	`https://api.appnexus.com/site?publisher_id=PUBLISHER_ID` (JSON del sitio)	Agregue un sitio.
`PUT`	`https://api.appnexus.com/site?id=SITE_ID&publisher_id=PUBLISHER_ID` `https://api.appnexus.com/site?id=SITE_ID` (JSON del sitio)	Modifique un sitio existente.
`DELETE`	`https://api.appnexus.com/site?id=SITE_ID&publisher_id=PUBLISHER_ID` `https://api.appnexus.com/site?code=SITE_CODE&publisher_code=PUBLISHER_CODE`	Eliminar un sitio.
`GET`	`https://api.appnexus.com/site`	Ver todos los sitios de los publicadores.
`GET`	`https://api.appnexus.com/site?publisher_id=PUBLISHER_ID`	Vea todos los sitios de uno de los publicadores.
`GET`	`https://api.appnexus.com/site?id=SITE_ID&publisher_id=PUBLISHER_ID` `https://api.appnexus.com/site?id=SITE_ID`	Vea un sitio específico para uno de los publicadores.
`GET`	`https://api.appnexus.com/site?id=1,2,3`	Vea varios sitios por identificador mediante una lista separada por comas.

Nota:

publisher_code y code se pueden usar indistintamente con publisher_id y id, respectivamente.

Campos JSON

Campo	Tipo	Descripción
`id`	Entero	Identificador Xandr asignado por la API para hacer referencia a este sitio. Obligatorio activado: `PUT`, en la cadena de consulta
`code`	string (100)	Código opcional para este sitio.
`name`	string (100)	Nombre asociado al sitio. Obligatorio activado: `PUT`, `POST`
`state`	enumeración	Estado de este sitio. Valores posibles: `active` o `inactive`. Valor predeterminado: `active`
`url`	string (255)	Dirección URL de este sitio.
`publisher_id`	Entero	Identificador del publicador al que pertenece este sitio. Obligatorio activado: `POST`/`PUT`, en la cadena de consulta
`primary_content_category_id`	Entero	Los usuarios pueden especificar opcionalmente una categoría de contenido principal para una selección de ubicación (consulte los ejemplos siguientes). Esta categoría se puede usar para la selección de destino y aparecerá en los informes. Las categorías de contenido se pueden establecer en el nivel de sitio o en el nivel de ubicación, pero no en ambos.
`last_modified`	Timestamp	Marca de tiempo de la última actividad en esta ubicación.
`placements`	matriz de objetos	Identificadores de ubicaciones asociadas a este sitio. Consulte Colocaciones a continuación para obtener más detalles.
`content_categories`	matriz	Opcionalmente, los usuarios pueden especificar una o varias categorías de contenido para una selección de ubicación. Estas categorías se pueden usar para la selección de destino y se pueden establecer tanto en el nivel de sitio como en el de ubicación. Como máximo, se pueden establecer 20 categorías en un sitio. Consulte Categorías de contenido a continuación para obtener más detalles.
`intended_audience`	enumeración	La audiencia prevista del sitio. No debe ser `null` si `'audited'` es `true`. Posibles valores: - `children` - `young_adult` - `general` - `mature` Valor predeterminado: `null`
`inventory_attributes`	matriz	Los atributos confidenciales contenidos en el sitio; si se establece en el nivel de sitio, `inventory_attributes` también influirá en los objetos en el nivel de ubicación. La asignación de identificadores a atributos se puede encontrar a continuación. El formato de la matriz también se incluye a continuación. Valor predeterminado: `null`
`audited`	booleano	Si el sitio se ha auditado.
`publisher_join`	matriz
`publisher_name`	string (100)	Nombre del publicador en el que se encuentra el sitio
`supply_type`	string	En desuso. Aunque este campo seguirá siendo el valor predeterminado de "web", su valor se omite a medida que Xandr detecta automáticamente el tipo de suministro en cada subasta. Los usuarios deben confiar en la detección automática de Xandr en lugar de especificar manualmente el tipo de suministro. Valor predeterminado: `web`
`creative_format_action`	string	- `exclude`: permite que todos los formatos creativos sirvan en este sitio excepto los especificados en la `creative_formats` matriz. - `include`: solo todas las creatividades a las que se va a servir cuyo formato se incluye en la lista especificada en `creative_formats` Valor predeterminado: `exclude`. Algunos orígenes de suministro de aplicaciones móviles no admiten todos los formatos creativos disponibles en Xandr.
`creative_formats`	matriz de cadenas	Los formatos creativos que se van a excluir o incluir en este sitio. Valor predeterminado: `text`
`allowed_click_actions`	matriz de cadenas	Indica al comprador qué tipos de acciones de clic se admiten en las creatividades. Las aplicaciones y web móviles suelen permitir acciones de clic adicionales más allá de hacer clic en un sitio web, como hacer clic para llamar, hacer clic en sms, hacer clic en correo electrónico y hacer clic para asignar. Valor predeterminado: `click-to-web only`
`marketplace_map`	objeto	Informa al comprador qué tipos de marketplaces son accesibles (rendimiento, RTB, ofertas). Consulte Mapa de Marketplace a continuación para obtener definiciones de campos internos.
`mobile_app_instance`	multiobjeto	Instancia de aplicación móvil asociada a este sitio. Este campo solo se puede establecer cuando `supply_type` es `mobile_app`. Consulte Instancia de aplicación móvil a continuación para obtener las definiciones de campo internas. Obligatorio en: `POST`, para sitios con un `supply_type` de `mobile_app`.
`mobile_app_instance_id`	Entero	Identificador de la instancia de aplicación móvil asociada a este sitio. Este campo solo está asociado a sitios con un `supply_type` de `mobile_app`.

Mapa de Marketplace

Parámetro	Tipo	Descripción
`an_audit_perf_only`	Booleano	Solo lectura. Si el sitio solo es apto para la demanda de CPA/CPC en función de nuestra auditoría. Si `true`es , entonces sí. Valor predeterminado: `false`
`rtb`	Booleano	Designa si el inventario asociado al sitio (y todas sus ubicaciones) forma parte de RTB Marketplace (es decir, apto para la demanda de CPM). - Si `true`es , todo el inventario asociado a las ubicaciones de este sitio se va a revender en el Marketplace de RTB. - El campo no se puede establecer `true` en si alguna de las ubicaciones dentro del sitio admite el tipo de medio que se puede expandir. Consulte el Servicio de selección de ubicación para obtener más información sobre los tipos de medios y los campos de subtipos. - Si `false`es , las ubicaciones que se pueden expandir dentro del sitio no se pueden mover a un sitio donde el campo es `true`. - Si se establece en `false` todo el inventario asociado a las ubicaciones de este sitio solo está disponible para las campañas directas. No se revenderá ningún inventario asociado a las ubicaciones de este grupo de selección de ubicación. Valor predeterminado: `true`
`performance`	Booleano	Si el sitio es apto para la demanda de CPA/CPC mediante el marketplace de rendimiento actualizado. Si `true`es , entonces sí. Valor predeterminado: `false`
`deals_allowed`	Booleano	Especifica si las ofertas pueden servir en este sitio. Valor predeterminado: `true`
`rtb_suspended`	Booleano	Solo lectura. Indica que todo el inventario asociado a este sitio y sus ubicaciones está bloqueado para que no participe en el Marketplace rtb. Valor predeterminado: `false`
`deals_suspended`	Booleano	Solo lectura. Indica que todas las ofertas están suspendidas para servir en este sitio. Valor predeterminado: `false`

Instancia de aplicación móvil

Parámetro	Tipo	Descripción
`id`	Entero	Identificador único de esta instancia de aplicación. Este campo es opcional en `POST`; si se envía, se usará para buscar y `bundle_idos_family_id`. Si este campo no está establecido en o `PUTPOST`, debe pasar los `bundle_id` campos y `os_family_id` y se creará un nuevo identificador de instancia de aplicación móvil.
`bundle_id`	Entero	Si no se pasa ningún `id` campo, `POST`este campo es obligatorio. Este campo representa el identificador de agrupación de la instancia de la aplicación móvil y se usa para buscar el identificador de instancia de aplicación móvil. Si no hay ningún identificador de instancia de aplicación asociado a este identificador de agrupación, se creará uno nuevo.
`os_family_id`	Entero	Si no se pasa ningún `id` campo en `PUT` o `POST`, este campo es obligatorio. Este campo representa el identificador único de la familia del sistema operativo al que está asociada esta instancia de la aplicación. Si no hay ningún identificador de instancia de aplicación asociado a este identificador de familia del sistema operativo, se creará uno nuevo.

Colocaciones

Parámetro	Tipo	Descripción
`id`	Entero	Identificador único de la ubicación. Puede usar el servicio de selección de ubicación para buscar identificadores de ubicación.
`code`	string	Código interno para la selección de ubicación.

Categorías de contenido

Parámetro	Tipo	Descripción
`id`	Entero	Identificador de la categoría de contenido. Puede usar el servicio categoría de contenido para buscar identificadores de categoría.
`is_system`	Booleano	Si la categoría de contenido es o no una categoría del sistema (`"universal"`).
`name`	string (100)	Nombre de la categoría.
`site`	matriz	Lista de identificadores que se encuentran en esta categoría de contenido.
`primary`	Booleano	Si la categoría es la categoría principal del sitio. Solo una categoría puede ser principal.

Atributos de inventario

Parámetro	Tipo	Descripción
`inventory_attribute_id`	Entero	Identificador del atributo de inventario.
`name`	string (50)	Solo lectura. Nombre del atributo de inventario.

Id. de atributos de inventario

Id	Nombre del atributo
`2`	Político
`4`	Redes sociales
`6`	Uso compartido de fotos & vídeo
`8`	Foros (moderados)
`10`	Foros (nomoderados)
`12`	Clics incentivados
`14`	Idiomas no ingleses
`16`	Streaming multimedia
`17`	Barras de herramientas, complementos o extensiones

Ejemplos

Adición de categorías de contenido a un sitio

$ cat site

{
    "site": {
        "content_categories": [
            {
                "id": 2561,
                "primary": true
            },
            {
                "id": 2558
            }
        ],
        "name": "Site 1"
    }
}

$ curl -b cookies -c cookies -X PUT -d @site 'https://api.appnexus.com/site?id=5822'

Visualización de todos los sitios para los publicadores

$ curl -b cookies -c cookies 'https://api.appnexus.com/site'

{
   "response":{
      "status":"OK",
      "sites":[
         {
            "id":2411,
            "code":null,
            "name":"[Default RTB Media Buy] - ROS",
            "state":"active",
            "url":"",
            "primary_content_category_id":null,
            "last_modified":"2010-05-12 22:46:42",
            "intended_audience":"general",
            "inventory_attributes":[
                {
                    "id":2,
                    "name":"Political"
                }
            ]
            "placements":[

            ],
            "content_categories": [
                {
                    "id": 2561,
                    "primary": true
                },
                {
                    "id": 2558
                }
            ],
         },
         {
            "id":2412,
            "code":null,
            "name":"[Weekdays Only] - ROS",
            "state":"active",
            "url":"",
            "media_buy_id":1559,
            "primary_content_category_id": 2561,
            "last_modified":"2010-05-12 23:28:40",
            "placements":[

            ],
            "content_categories":null
         },
         {
            "id":2413,
            "code":null,
            "name":"[Weekends Only] - ROS",
            "state":"active",
            "url":"",
            "media_buy_id":1560,
            "primary_content_category_id":null,
            "last_modified":"2010-05-12 23:28:52",
            "placements":[

            ],
            "content_categories":null
         },
         {
            "id":5775,
            "code":null,
            "name":"[Conversion Test] - ROS",
            "state":"active",
            "url":"",
            "media_buy_id":4732,
            "primary_content_category_id":null,
            "last_modified":"2010-06-15 20:09:38",
            "placements":[
               {
                  "id":"57851"
               }
            ],
            "content_categories":null
         }
      ],
      "count":4,
      "start_element":null,
      "num_elements":null
   }
}

Creación de un sitio con un tipo de suministro de aplicación móvil

En este ejemplo se crea un sitio diseñado para el suministro de aplicaciones móviles. También lo usaremos en nuestro siguiente ejemplo:

$ cat the-site.json
 
{"site":{"name":"One site to rule them all", "supply_type":"mobile_app"}}
 
$ curl -b cookies -X POST -d @the-site.json 'https://api.appnexus.com/site?publisher_id=102306'
 
{
    "response":{,
         "site":{
            "allowed_click_actions":[
                "click-to-web"
            ],
             "creative_formats":[
                "text"
            ],
             "inventory_attributes":null,
             "content_categories":null,
             "placements":null,
             "mobile_app_instance":null,
             "member_id":1309,
             "creative_format_action":"exclude",
             "supply_type":"mobile_app",
             "publisher_name":"RICH'S CRAZY RESELLER",
             "audited":false,
             "intended_audience":null,
             "last_modified":"2014-02-20 20:56:03",
             "primary_content_category_id":null,
             "publisher_id":102306,
             "url":"",
             "state":"active",
             "name":"One site to rule them all",
             "code":null,
             "id":273205
        },
         "num_elements":100,
         "start_element":0,
         "id":273205,
         "count":1,
         "status":"OK"
    }
}

Adición de una instancia de aplicación móvil a un sitio

En este ejemplo, tenemos un sitio preexistente con el tipo de suministro de aplicación móvil necesario. Hacemos una PUT llamada para asociar nuestro sitio a una instancia de aplicación móvil existente y podemos ver que funcionó viendo el objeto actualizado en la respuesta. Para obtener más información sobre las instancias de aplicaciones móviles, consulte Mobile App Instance Service.

$ cat update.json

{"site":{"supply_type":"mobile_app", "mobile_app_instance":{"id":62}}}
 
$ curl -b cookies -X PUT -d @update.json
 
{
    "response":{
        "site":{
            "allowed_click_actions":[
                "click-to-web"
            ],
            "creative_formats":[
                "text"
            ],
            "inventory_attributes":null,
            "content_categories":null,
            "placements":null,
            "mobile_app_instance":{
                "os_family_id":3,
                "bundle_id":"2342342345566666",
                "id":62
            },
            "member_id":1309,
            "creative_format_action":"exclude",
            "supply_type":"mobile_app",
            "publisher_name":"RICH'S CRAZY RESELLER",
            "audited":false,
            "intended_audience":null,
            "last_modified":"2014-02-20 21:18:15",
            "primary_content_category_id":null,
            "publisher_id":102306,
            "url":"",
            "state":"active",
            "name":"One site to rule them all",
            "code":null,
            "id":273205
        },
        "num_elements":100,
        "start_element":0,
        "id":"273205",
        "count":1,
        "status":"OK"
    }
}

Compartir a través de

Servicio de sitio

API de REST

Campos JSON

Mapa de Marketplace

Instancia de aplicación móvil

Colocaciones

Categorías de contenido

Atributos de inventario

Id. de atributos de inventario

Ejemplos

Adición de categorías de contenido a un sitio

Visualización de todos los sitios para los publicadores

Creación de un sitio con un tipo de suministro de aplicación móvil

Adición de una instancia de aplicación móvil a un sitio

Recursos adicionales

Compartir a través de

Servicio de sitio

API de REST

Campos JSON

Mapa de Marketplace

Instancia de aplicación móvil

Colocaciones

Categorías de contenido

Atributos de inventario

Id. de atributos de inventario

Ejemplos

Adición de categorías de contenido a un sitio

Visualización de todos los sitios para los publicadores

Creación de un sitio con un tipo de suministro de aplicación móvil

Adición de una instancia de aplicación móvil a un sitio

Temas relacionados

Recursos adicionales