Primeros pasos

Documentos de referencia

Para utilizar el administrador comercial, una empresa necesita al menos una página, un administrador, el nombre de una empresa y una dirección de correo electrónico válida.

El nombre de la empresa se utiliza exclusivamente para tu negocio y cualquier otro negocio con el que elijas compartir objetos. Después de crear este negocio, puedes agregar páginas, cuentas de anuncios, app, objetos de seguimiento de conversiones fuera del sitio y otros recursos relacionados con anuncios que pertenecen a un negocio.

Requisitos

Crear un nuevo administrador comercial

Crear un nuevo administrador comercial para representar tu negocio. Solo crea un nuevo administrador comercial si configuras un nuevo para ti o tus clientes. Si necesitas otra cuenta publicitaria o acceso a otra página, debes utilizar tus permisos de administrador y a recursos anteriores. No se permite eliminar un administrador comercial.

Por ejemplo, crear un nuevo administrador comercial con un POST:

curl \
  -F "name=Pomni Media" \
  -F "vertical=ADVERTISING" \
  -F "primary_page=<PAGE_ID>" \
  -F "timezone_id=1" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<USER_ID>/businesses"

Requisitos

Para crear un negocio, necesitas lo siguiente:

  • Un token de acceso
  • A identificador de página
  • Un sector
  • Un identificador de usuario específico de la app

El identificador de página que proporcionas debe ser la página principal de tu negocio. Esta página representa públicamente tu negocio en Facebook. El que crea el negocio será el administrador de esta página. Si no tienes una página para representar tu negocio en Facebook, crea una.

El sector es una de estas constantes de cadena:

ADVERTISING , AUTOMOTIVE , CONSUMER_PACKAGED_GOODS , ECOMMERCE , EDUCATION , ENERGY_AND_UTILITIES , ENTERTAINMENT_AND_MEDIA , FINANCIAL_SERVICES , GAMING , GOVERNMENT_AND_POLITICS ,MARKETING , ORGANIZATIONS_AND_ASSOCIATIONS , PROFESSIONAL_SERVICES , RETAIL , TECHNOLOGY , TELECOM , TRAVEL , OTHER

Si deseas ver propiedades de un negocio, usa su identificador:

curl "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>?access_token=<ACCESS_TOKEN>"

Puedes ver también una lista de los administradores comerciales a los que puedes acceder:

curl "https://graph.facebook.com/<API_VERSION>/me/businesses?access_token=<ACCESS_TOKEN>"

Los campos de respuesta incluyen los siguientes elementos:

Nombre Descripción

name

Tipo: cadena

Nombre del negocio

timezone_id

Tipo: número entero

Identificador de la zona horaria del negocio

primary_page

Tipo: objeto JSON

Objeto de la página primaria asociada con este administrador comercial.

{ "category": "App page", "name": "Sample Primary Page", "id": "123456789" }

id

Tipo: largo

Identificador del administrador comercial

update_time

Tipo: cadena

La última actualización del administrador comercial

updated_by

Tipo: objeto JSON

Último usuario, ordenado por nombre e identificador, que actualizó este administrador

creation_time

Tipo: cadena

Tiempo en que se creó este negocio

created_by

Tipo: objeto JSON

Nombre de usuario e identificador de quien creó este administrador

Actualizar administradores comerciales

Actualizar campos en el administrador comercial utilizando una solicitud POST enviada a https://graph.facebook.com/{API_VERSION}/{BUSINESS_ID}. Por ejemplo, cambia el nombre de la empresa:

curl \
-F "name=My Actual Business Name" \
-F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/"

Cambia el sector comercial haciendo la siguiente solicitud POST:

curl \
-F "vertical=RETAIL" \
-F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/"

Dispones de estas opciones:

Nombre Descripción

name

Obligatorio.

El nombre del negocio

primary_page

El identificador de la página principal asociada con este administrador comercial.

Puedes actualizar la página principal haciendo la siguiente solicitud POST. La página principal debe ser propiedad del administrador comercial.

curl \
  -F "primary_page=<PAGE_ID>" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/"

También puedes actualizar todos los elementos mencionados en una sola solicitud POST:

curl \
  -F "name=My Actual Business Name" \
  -F "vertical=RETAIL" \
  -F "primary_page=<PAGE_ID>" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/"

Administrar personas y roles

Hay dos tipos de roles en el administrador comercial:

Nombre Constante de API Descripción

Administrador

ADMIN

  • Puede controlar todos los aspectos de un negocio, lo que incluye modificar o eliminar la cuenta o agregar personas en la lista de empleados o eliminarlas de dicha lista.
  • Tiene acceso READ y WRITE a todos los recursos a los que se encuentra conectado el administrador comercial.

Empleado

EMPLOYEE

  • Puede ver toda la información de la configuración del negocio y el administrador comercial puede asignarle roles. No se pueden hacer cambios, excepto agregar páginas o cuentas de anuncios de las que este usuario es administrador del negocio.
  • Tiene acceso READ a todos los recursos a los que se encuentra conectado el administrador comercial.

Para obtener más información sobre los roles, consulta Configurar roles de catálogo en el administrador comercial.

Inicialmente, el creador de la empresa es el único usuario del negocio y administrador.

Invitar personas

Si deseas agregar a tus colegas a tu negocio, debes invitarlos. Para invitar a alguien, proporciona una dirección de correo electrónico válida a la que tengan acceso. Se encuentra limitada la posibilidad de enviar solicitudes para agregar empleados a un administrador comercial. Cuando alcanzas este límite, se mostrará el código de error 17. Deberás reanudar las actividades 24 horas después.

Para invitar a alguien como administrador, envía una solicitud POST:

curl \
-F "email=some@email.com" \
-F "role=ADMIN" \
-F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_users"

Para invitar a alguien como empleado, envíe una solicitud POST:

curl \
-F "email=some@email.com" \
-F "role=EMPLOYEE" \
-F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_users"

Facebook envía una invitación por correo electrónico a la dirección de correo electrónico de trabajo que se especificó. El invitado debe verificar el correo electrónico y seguir el proceso de registro. Una vez que esté listo, podrás verlo en tu lista de usuarios.

Personas en el administrador comercial

A partir de la versión 2.11, contamos con puntos de conexión separados para obtener usuarios en función de su estado. Realizar una solicitud GET para recuperar cada grupo de usuarios. Para obtener todos los usuarios comerciales (ten en cuenta que se requiere Acceso Avanzado).

curl "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_users?access_token=<ACCESS_TOKEN>"

Si deseas obtener usuarios del sistema con acceso a nivel de sistema:

curl "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/system_users?access_token=<ACCESS_TOKEN>"

Si deseas obtener usuarios pendientes que fueron invitados para que accedan al negocio, pero que aún no aceptaron la invitación:

curl "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/pending_users?access_token=<ACCESS_TOKEN>"

Los puntos de conexión devuelven usuarios activos, pendientes o de sistema para tu negocio. Por ejemplo:

{
  "data": [
    {
      "id": "<BUSINESS_ID>",
      "name": "Alpha MK",
      "email": "some@email.com",
      "role": "EMPLOYEE",
    }
  ]
}

Los resultados para los usuarios pendientes tienen el siguiente aspecto:

{
  "data": [
    {
      "id": "<BUSINESS_ID>",
      "email": "some@email.com",
      "role": "EMPLOYEE",
      "status": "PENDING",
      "owner": {
        "id": "USER_ID",
        "name": "Generic Emporium"
      }
    }
  ]
}

Las definiciones de los campos devueltos son las siguientes:

Nombre Descripción

id

Tipo: largo

Identificador de este usuario específico de este negocio.

name

Tipo: cadena

Nombre de este usuario en este negocio

business

Tipo: objeto JSON

Administrador comercial al que pertenece este usuario

first_name

Tipo: cadena

Primer nombre de este usuario en este negocio

last_name

Tipo: cadena

Apellido del usuario en este negocio

title

Tipo: cadena

Título de usuario en este negocio

role

Tipo: cadena

El rol que tiene esta persona en relación con este negocio. EMPLOYEE o ADMIN

email

Tipo: cadena

Dirección de correo electrónico del usuario

Cambiar roles

Para cambiar el rol activo de un usuario de tu negocio, proporciona el identificador del usuario. Por ejemplo, puedes actualizar del rol de empleado al rol de administrador, con esta solicitud POST:

curl \
  -F "role=ADMIN" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_SCOPED_USER_ID>"

Para cambiar a alguien del rol de administrador a empleado, realiza una solicitud POST:

curl \
  -F "role=EMPLOYEE" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_SCOPED_USER_ID>"

Puedes cambiar el rol de un usuario pendiente con esta solicitud de POST:

curl \
  -F "role=EMPLOYEE" \
    -F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<PENDING_USER_ID>"

Eliminar usuarios

Revocar permisos que se otorgaron a alguien en función de la membresía de los administradores comerciales. Limitar el acceso a las páginas y cuentas de anuncios. No cambian los permisos si el usuario tiene acceso a páginas o cuentas de anuncios fuera de su administrador comercial. Por ejemplo, es posible que alguien se haya agregado a sí mismo o que tenga acceso a través de otro administrador comercial.

Para eliminar un usuario activo de tu negocio, realiza una llamada DELETE:

curl \
  -X DELETE \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_SCOPED_USER_ID>"

Para cancelar un usuario pendiente con una solicitud DELETE:

curl \
  -X DELETE \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<PENDING_USER_ID>"

Esta solicitud elimina los usuarios del negocio y el acceso a los recursos de tu negocio.

Obtener objetos de conexión

Documentos de referencia

Son aquellos objetos de Facebook (por ejemplo, páginas, apps, etc.) que gestiona un administrador. Un administrador puede ser un usuario o un negocio, o, en el caso de las apps, un desarrollador o un anunciante. Estos son los tipos de objetos de conexión:

  • Páginas y lugares
  • Eventos
  • Apps
  • Dominios

Echa un vistazo a las consultas de ejemplo y obtén más información en Objetos de conexión.

Facturas

Documentos de referencia

La API del administrador comercial te permite ver y administrar orígenes de crédito asociados con un negocio. La API recupera todas las facturas que visualiza un administrador comercial. Esto significa que, mediante la API, el administrador comercial puede visualizar todas las facturas de las que es responsable, y no solo las que pertenecen a un identificador de negocio individual.

Línea de crédito normal propiedad del administrador comercial

En relación con los socios de API de marketing que tienen habilitada la facturación, puedes aprovechar línea de crédito normal propiedad del administrador comercial.

Los socios de marketing de Facebook (FBMP) deben contactar a su representante de ventas para configurar su cuenta de negocio para créditos. Asegúrate de pedir la línea de crédito normal propiedad del administrador comercial. Una vez que se haya realizado la configuración, podrás comenzar a utilizar la API de creación de cuentas de anuncios para comenzar a crear este tipo de cuentas. Los cargos se deducirán de la línea de crédito de tu administrador comercial.

En lo relativo a las cuentas de anuncios creadas mediante la siguiente API, distribuiremos dinámicamente el crédito entre las cuentas y actualizaremos los límites de crédito y el gasto para evitar alcanzar los límites de crédito. Podrás ver un resumen del crédito disponible y el importe de crédito de cada cuenta publicitaria.

Hoy solo admitimos la responsabilidad normal; la responsabilidad secuencial no se admite. El proceso para configurarla no sufrirá cambios.

Facturación de fin de mes

Una vez que se configura una línea de crédito para un negocio, y el negocio la utiliza para publicar anuncios, generamos facturas al final del mes relativas a la cuenta comercial. Para ver las facturas del negocio, necesitas un rol financiero. Para los empleados y los administradores normales de un negocio, puedes asignar permisos en People en el administrador comercial. También puedes asignar permisos financieros a usuarios del sistema por medio del administrador comercial.

Para recuperar facturas de una cuenta comercial con la API, envía una solicitud GET:

curl -G \
-d "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_invoices?start_date=2017-01-01&end_date=2017-04-01"

Los resultados de ejemplo tienen el siguiente aspecto:

{
  "business_invoices": {
    "data": [
      {
        "id": "1659175694099710",
        "billing_period": "2017-03-01"
      },
      {
        "id": "1303851778395619",
        "billing_period": "2017-01-01"
      },
      {
        "id": "1415846861611329",
        "billing_period": "2017-02-01"
      }
    ],
    "paging": {
      "cursors": {
        "before": "MAZDZD",
        "after": "MgZDZD"
      }
    }
  },
  "id": "249554531892085"
}

Puedes obtener detalles de la factura en el nivel de campaña con esta solicitud:

curl -G \
-d "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_invoices?fields=billed_amount_details,billing_period,entity,id,invoice_id,payment_term,type,campaigns&start_date=2019-06-01&end_date=2019-07-01"

La respuesta se asemeja a la siguiente:

{
  "business_invoices": {
    "data": [
      {
        "billed_amount_details": {
          "currency": "USD",
          "net_amount": "387.70",
          "tax_amount": "0.00",
          "total_amount": "387.70"
        },
        "billing_period": "2017-03-01",
        "entity": "FBUS",
        "id": "1659175694099710",
        "invoice_id": "22736800",
        "liability_type": "Normal",
        "invoice_type": "Invoice",
        "payment_term": "CUSTOMER",
        "type": "Invoice",
        "campaigns": {
          "data": [
            {
              "campaign_id": "6056967798500",
              "campaign_name": "Nhận ưu đãi",
              "tags": [
                "hello2"
              ],
              "billed_amount_details": {
                "currency": "USD",
                "net_amount": "207.62",
                "tax_amount": "0.00",
                "total_amount": "207.62"
              }
            },
            {
              "campaign_id": "6056958052500",
              "campaign_name": "Nhận ưu đãi",
              "billed_amount_details": {
                "currency": "USD",
                "net_amount": "180.08",
                "tax_amount": "0.00",
                "total_amount": "180.08"
              }
              "impressions": 100,
              "clicks": 50,
              "conversions": 30
            }
          ]
        }
      },
      {
        "billed_amount_details": {
          "currency": "USD",
          "net_amount": "382.99",
          "tax_amount": "0.00",
          "total_amount": "382.99"
        },
        ......
    "paging": {
      "cursors": {
        "before": "MAZDZD",
        "after": "MgZDZD"
      }
    }
  },
  "id": "1515766328651000"
}

También puedes recuperar los campos de facturación adicionales:

  • invoice_date: fecha en que Facebook generó la factura
  • due_date: fecha en la que se debe pagar la factura
  • payment_status: muestra si la factura está Paid, Unpaid o Partially Paid
  • amount_due: información de cuánto dinero se adeuda actualmente y falta abonar de la factura
  • download_uri: descargar un PDF de la factura en esta URI

API de origen de fondos

Con el fin de recuperar el origen de los fondos del crédito extendido vinculado al administrador comercial, envía esta solicitud GET.

curl "https://www.graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/extendedcredits"

Para configurar un origen de fondos para un negocio, ve a la sección de configuración de tu negocio en el administrador comercial.

Asignación dinámica de crédito

La asignación dinámica de crédito, también conocida como DCAF, es nuestro sistema de asignación de crédito para ajustar el crédito disponible de manera periódica en función de la base de la cuenta publicitaria. Nuestro script automático se ejecuta aproximadamente cada 30 minutos y toma tu crédito disponible y lo distribuye de manera uniforme entre todas tus cuentas activas habilitadas para DCAF. El crédito disponible incluye el crédito total aprobado menos el saldo total pendiente. De esta manera, es posible administrar los gastos en el nivel de la cuenta publicitaria y asignar fondos para cada una de estas cuentas.

Un negocio también puede "desactivar" una cuenta publicitaria facturada y eliminarla de la lista que necesita asignación de crédito. Los negocios ya no necesitan que Facebook administre este estado.