This function provides information about a campaign previously created in the system.
URL: /admin/adnet/pub/admin/pautas.html?op=v&o=xml
Mandatory parameter:
- pauta_id: campaign identifier.
Examples of URLs with parameter:
/admin/adnet/pub/admin/pautas.html?op=v&o=xml&pauta_id=5521
Response:
It contains an object <pauta>. The identifier is specified by the attribute pauta_id and the data presented are:
- nombre: campaign name
- anunciante_id: advertiser identifier
- anunciante: advertiser name
- ptestado_id: campaign status code. See references under “Campaign Status”
- tipoventa_id: tcampaign marketing type. See references under “Campaign marketing types”
- cantidad_total: total contracted amount (of impressions, clicks or conversions, depending on the type of sale). It's optional for sponsorship campaigns.
- cantidad_cumplida: completion of the contracted quantity.
- impresiones_cumplidas: amount of impressions accomplished.
- clicks_cumplidos: amount of clicks accomplished.
- peso: campaign weight (from 1 to 100)
- prioridad: campaign priority (from 1 to 10)
- ptmodo_id: delivery mode of the actions allotted to the campaign. See potential values in Annex “Campaign Delivery Mode”.
- fecha_inicio: campaign start date,
- fecha_fin: campaign end date. It is optional.
- fecha_alta: campaign creation date.
- fecha_baja: if the advertiser has been cleared, indicates the date it was deleted.
- target_sitio_id: listing of the sites identifiers associated to the campaign.
- target_espacio_id: listing of the ad spaces lidentifiers associated to the campaign.
- target_country: if the campaign is segmented by country, the tag will contain two more tags, otherwise the tag will appear empty:
-type: indicates the segmentation type by country, it shows te values 1, -1 and 2 to “Show in these countries”, “Do not show in these countries” and “Show campaign when country is unknown”, accordingly.
-countries: selected countries listing (see countries appendix). - target_perfil: if the campaign is segmented by profiles, the tag will contain one more tags, otherwise the tag will appear empty:
-perfil_id: it contains a profile IDs listing targeted in the campaign. - precio_venta_anunciante: if the advertiser will be billed, the tag will contain 2 more tags, otherwise, the tag will appear empty:
-tmodo: it shows the billing type to the advertiser, and may contain the values 0, 1 and 3 for “Not specified”, “Same price for all spaces and conversion codes” and “Set values per space”, accordingly.
-precio: it will appear if tmodo is 1 or 3.
- If it is 1, it will contain just one item, including the tags:
-precio: contains the assigned price.
-moneda-id: contains the assigned currency ID (see Currencies appendix).
-tprecio: price type, could be 1, 2, 3 or 4 fot CPM, CPC, CPA and Sponsor type, accordingly.
- If it is 3, it will contain an item listing corresponding to each space. Each of them will contain the same fields as in tmodo=1, and will add the following tags:
-nombre_espacio: it contains the complete name of the ad space.
-espacio_id: ad space identifier. - pago_sitio: the content of the field works as in precio_venta_anunciante.
- observaciones: campaign comments.
- target_keywords: if the keyword targeting is enabled, the tag will contain 2 more tags, otherwise the tag will appear empty:
-keywords: it contains an item listing, each item will include:- tkeyword_id: keyword identifier
- comparacion: it may contain the values 1, 2, 3, 4, or 5 for “Match whole words” or “List of values”, “Min Value”, “Max Value”, “Min and Max Value”, “Match word parts”, accordingly.
- Depending on the matching mode, more tags are added to the keyword content.
-If the matching mode is 2, the min_value tag is added. This tag will contain the minimum value indicated.
-If the matching mode is 3, the max_value tag is added. This tag will contain the maximum value indicated.
-If the matching mode is 4, the max_value and min_value tags are added.
-type: it indicates the keyword targeting type, it may contain the values 0 or 1 to “Match at least 1 keyword” and “Match all the keywords”, accordingly.
Response example:<pauta pauta_id=”123”>
<nombre>Septiembre Clicks</nombre>
<anunciante_id>5435</anunciante_id>
<anunciante>InSPect Tech</anunciante>
<tipoventa_id>2</tipoventa_id>
<custom_id>4432</custom_id>
<cantidad_total>5000</cantidad_total>
<cantidad_cumplida>524</cantidad_cumplida>
<impresiones_cumplidas>135912</impresiones_cumplidas>
<clicks_cumplidos>1652</clicks_cumplidos>
<fecha_inicio>2006-01-21 15:00:00</fecha_inicio>
<fecha_fin>2006-02-18 23:59:59</fecha_fin>
<fecha_alta>2006-01-21 13:45:35</fecha_alta>
<fecha_baja/>
<target_country>
<type>1</type>
<countries>
<item_id=”1”>AD</item>
<item_id=”2”>AF</item>
</countries>
</target_country>
<target_perfil>
<perfil_id>
<ítem_id=”1”>1358</ítem>
</perfil_id>
</target_perfil>
<target_keywords>
<keywords>
<ítem_id=”1”>
<tkeyword_id>112</tkeyword_id >
<values>
<ítem_id=”1”>1</ítem>
<item_id=”2”>4</item>
<item_id=”3”>6</item>
<item_id=”4”>7</item>
</values>
<comparacion>1</comparacion>
</item>
<item_id=”2”>
<tkeyword_id>113</tkeyword_id >
<values>
<item_id=”1”>PalabraClave1</item>
<item_id=”2”>PalabraClave2</item>
</values>
<comparacion>5</comparacion>
</item>
</keywords>
<type>0</type>
</target_keyword>
<pago_sitio>
<precio>
<item_id=”1”>
<precio>123123.0000</precio>
<moneda_id>1</moneda_id>
<tprecio>4</tprecio>
</item>
</precio>
<tmodo>1</tmodo>
</pago_sitio>
<precio_venta_anunciante>
<precio>
<item_id=”1”>
<nombre_espacio>Seccion_Deportes_
Espacio_1</nombre_espacio>
<precio>99999.0000</precio>
<moneda_id>5</moneda_id>
<tprecio>4<tprecio>
<espacio_id>28360</espacio_id>
</item>
<ítem_id=”2”>
<nombre_espacio>Seccion_Deportes_
Espacio_2</nombre_espacio>
<precio>123124.0000</precio>
<moneda_id>5</moneda_id>
<tprecio>4</tprecio>
<espacio_id>38989</espacio_id>
</item>
</precio>
<tmodo>3</tmodo>
</precio_venta_anunciante>
<observaciones>These are comments for the campaign</observaciones>
</pauta>