Introducción al Meta Business SDK

En este documento se explica cómo instalar el Meta Business SDK y cómo probar la instalación. Los SDK están disponibles para Java, JavaScript, PHP, Python y Ruby. Si ya tienes instalada la API de marketing, puedes obtener información sobre cómo llevar a cabo la actualización al Meta Business SDK.

Antes de empezar

Necesitarás acceso a:

• Una cuenta de desarrollador de Meta.
• Una aplicación de Meta registrada con la configuración básica establecida.
• La clave secreta de la aplicación.
• Una cuenta publicitaria.
• Un identificador de acceso a la página.

Java

En el caso de las aplicaciones de Java, puedes usar el entorno de desarrollo que prefieras, pero debe admitir las compilaciones de Maven.

Instalar el SDK

En el proyecto de Maven, añade el siguiente código XML a la sección dependency del archivo pom.xml:

<!-- https://mvnrepository.com/artifact/com.facebook.business.sdk/facebook-java-business-sdk -->
<dependency>
    <groupId>com.facebook.business.sdk</groupId>
    <artifactId>facebook-java-business-sdk</artifactId> 
    <version>[8.0.3,)</version>
</dependency>

Crear una clase de Java

En src/main/java, crea una clase de Java llamada TestFBJavaSDK y añade el siguiente código. Asegúrate de reemplazar {access-token}, {appsecret} y {adaccount-id} por los valores correspondientes.

import com.facebook.ads.sdk.APIContext;
import com.facebook.ads.sdk.APINodeList;
import com.facebook.ads.sdk.AdAccount;
import com.facebook.ads.sdk.Campaign;

public class TestFBJavaSDK
{
    public static final APIContext context = new APIContext(
            "{access-token}",
            "{appsecret}"
    );
    public static void main(String[] args)
    {
        AdAccount account = new AdAccount("act_{{adaccount-id}}", context);
        try {
            APINodeList<Campaign> campaigns = account.getCampaigns().requestAllFields().execute();
            for(Campaign campaign : campaigns) {
                System.out.println(campaign.getFieldName());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }}

Probar la instalación

Compila y ejecuta la aplicación. Deberías ver el resultado en la ventana de registro de la consola. Si se advierte de que un identificador ha caducado, solicita un nuevo identificador de acceso a la página y vuelve a intentarlo.

JavaScript (Node.js)

En el caso de las aplicaciones de JavaScript, el SDK se distribuye como un paquete de Node.js.

Abre una ventana del terminal de comandos y crea una nueva carpeta de proyecto. Crea, configura e instala el proyecto con el siguiente comando:

npm init

Para actualizar las configuraciones posteriormente, puedes editar el archivo package.json directamente.

Instalar el SDK

Instala el paquete del SDK con el siguiente comando:

npm install --save facebook-nodejs-business-sdk

Modificar el archivo del proyecto

Abre el archivo index.js y añade el siguiente código. Reemplaza {access-token} y {adaccount-id} por los valores correspondientes.

const bizSdk = require('facebook-nodejs-business-sdk');

const accessToken = '{access-token}';
const accountId = 'act_{{adaccount-id}}';

const FacebookAdsApi = bizSdk.FacebookAdsApi.init(accessToken);
const AdAccount = bizSdk.AdAccount;
const Campaign = bizSdk.Campaign;

const account = new AdAccount(accountId);
var campaigns;
    
account.read([AdAccount.Fields.name])
  .then((account) =>{
    return account.getCampaigns([Campaign.Fields.name], { limit: 10 }) // fields array and params
  })
  .then((result) =>{
    campaigns = result
    campaigns.forEach((campaign) =>console.log(campaign.name))  
  }).catch(console.error);

Probar la instalación

Prueba la instalación con el siguiente comando:

 node index.js

Deberías ver el resultado en la ventana del terminal. Si se advierte de que un identificador ha caducado, solicita un nuevo identificador de acceso a la página y vuelve a intentarlo.

PHP

En el caso de las aplicaciones de PHP, debes utilizar Composer para instalar el SDK.

Instalar el SDK

En una nueva carpeta de proyecto, crea composer.json con el siguiente contenido. Reemplaza {project-name}, {Your Name} y {your@email.com} por los valores correspondientes.

{
    "name": "name/{project-name}",
    "type": "project",
    "require": {
        "facebook/php-business-sdk": "^8.0.3"
    },
    "authors": [
        {
            "name": "{Your Name}",
            "email": "{your@email.com}"
        }
    ]
}

Instala el SDK con el siguiente comando en la ventana del terminal:

composer install

Crear un archivo de proyecto

Crea un archivo src/test.php con el siguiente contenido. Reemplaza {app-id}, {access-token}, {appsecret} y {adaccount-id} por los valores correspondientes.

<?php
require_once __DIR__ . '/../vendor/autoload.php';
use FacebookAds\Api;
use FacebookAds\Logger\CurlLogger;
use FacebookAds\Object\AdAccount;
use FacebookAds\Object\Campaign;
use FacebookAds\Object\Fields\CampaignFields;

$app_id = "{app-id}";
$app_secret = "{appsecret}";
$access_token = "{access-token}";
$account_id = "act_{{adaccount-id}}";

Api::init($app_id, $app_secret, $access_token);

$account = new AdAccount($account_id);
$cursor = $account->getCampaigns();

// Loop over objects
foreach ($cursor as $campaign) {
  echo $campaign->{CampaignFields::NAME}.PHP_EOL;
}

Probar la instalación

Prueba la instalación con el siguiente comando:

php src/test.php

Deberías ver el resultado en la ventana del terminal. Si se advierte de que un identificador ha caducado, solicita un nuevo identificador de acceso a la página y vuelve a intentarlo.

Python

En el caso de las aplicaciones de Python, el SDK se distribuye como un módulo pypi, por lo que debes asegurarte de haber instalado pip. En función del sistema, es posible que tengas que configurar virtualenv, pyenv o conda.

Instalar el SDK

Instala el SDK con el siguiente comando.

pip install facebook_business

Crear un archivo de proyecto

Crea el archivo test.py con el siguiente contenido. Reemplaza {app-id}, {access-token}, {appsecret} y {adaccount-id} por los valores correspondientes.

from facebook_business.api import FacebookAdsApi
from facebook_business.adobjects.adaccount import AdAccount

my_app_id = '{app-id}'
my_app_secret = '{appsecret}'
my_access_token = '{access-token}'
FacebookAdsApi.init(my_app_id, my_app_secret, my_access_token)
my_account = AdAccount('act_{{adaccount-id}}')
campaigns = my_account.get_campaigns()
print(campaigns)

Probar la instalación

Prueba la instalación con el siguiente comando:

python test.py

Deberías ver el resultado en la ventana del terminal. Si se advierte de que un identificador ha caducado, solicita un nuevo identificador de acceso a la página y vuelve a intentarlo.

Ruby

En el caso de Ruby, el SDK se distribuye como un paquete de RubyGem.

Instalar el SDK

En una ventana del terminal, ejecuta el siguiente comando desde la carpeta del proyecto a fin de instalar el Meta Business SDK para Ruby. En función del entorno, es posible que tengas que configurar rbenv o rvm, o usar sudo antes del comando.

gem install facebookbusiness

Crear un archivo de proyecto

Crea un archivo test.rb con el siguiente contenido. Reemplaza {access-token}, {appsecret} y {adaccount-id} por los valores correspondientes.

require 'facebookbusiness'
FacebookAds.configure do |config|
  config.access_token = '{access-token}'
  config.app_secret = '{appsecret}'
end

ad_account = FacebookAds::AdAccount.get('act_{{adaccount-id}}', 'name')
ad_account.campaigns(fields: 'name').each do |campaign|
  puts campaign.name
end

Probar la instalación

Prueba la instalación con el siguiente comando:

ruby test.rb

Deberías ver el resultado en la ventana del terminal. Si se advierte de que un identificador ha caducado, solicita un nuevo identificador de acceso a la página y vuelve a intentarlo.

Información para los usuarios actuales de la API de marketing

Para llevar a cabo la actualización al Meta Business SDK desde la API de marketing, sigue estos pasos.

Java

En el archivo pom.xml, haz lo siguiente:

• Actualiza groupId de com.facebook.ads.sdk a com.facebook.business.sdk.
• Actualiza artifactId de facebook-java-ads-sdk a facebook-java-business-sdk.
• Actualiza version a v8.0.3.

Node.js

En el archivo package.json, haz lo siguiente:

• Actualiza facebook-nodejs-ads-sdk a facebook-nodejs-business-sdk:v8.0.2.
• Actualiza todas las referencias del nombre de paquete facebook-nodejs-ads-sdk, como require('facebook-nodejs-ads-sdk'), a facebook-nodejs-business-sdk.
• Ejecuta npm install.

PHP

En el archivo composer.json, haz lo siguiente:

• Actualiza facebook-ads-sdk a facebook-business-sdk con la versión 8.0.3.

Python

• Ejecuta pip install facebook_business.
• Actualiza todas las referencias al espacio de nombres facebookads a facebook_business.
• Si tienes un archivo .egg-info, actualízalo de facebookads-*.egg-info al archivo egg-info instalado recientemente, como facebook_business-*.egg-info.

Ruby

• Ejecuta gem install facebookbusiness.
• Actualiza todas las referencias de require('facebook_ads') a require('facebookbusiness').

Más información

Puedes consultar el código fuente del Meta Business SDK en GitHub.