Premiers pas

Documents de référence

Pour utiliser Business Manager, une entreprise doit disposer d’au moins une page, un·e admin, un nom d’entreprise et une adresse e-mail valide.

Le nom d’entreprise n’est utilisé que pour votre entreprise et toutes celles avec lesquelles vous choisissez de partager des objets. Une fois que vous avez créé cette entreprise, vous pouvez ajouter des pages, des comptes publicitaires, des applications, des objets de suivi des conversions hors site et d’autres éléments liés aux publicités.

Conditions requises

Créer un Business Manager

Créez un Business Manager pour représenter votre entreprise. Ne créez un Business Manager que si vous le configurez pour vous-même ou pour votre clientèle. Si vous avez besoin d’un autre compte publicitaire ou d’un accès à une autre page, utilisez vos autorisations de gestionnaire et de ressources existantes. La suppression d’un Business Manager n’est pas autorisée.

Vous pouvez par exemple créer un Business Manager avec une requête 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"

Conditions requises

Pour créer une entreprise, il vous faut les éléments suivants :

  • Un token d’accès
  • Un ID de Page
  • Un secteur d’activité
  • Un identifiant utilisateur spécifique à l’application

L’ID de Page que vous fournissez doit correspondre à la page principale de votre entreprise. Cette page représente publiquement votre entreprise sur Facebook. Le gestionnaire de cette page est le créateur ou la créatrice de l’entreprise. Si aucune page ne représente votre entreprise sur Facebook, créez-en une.

Le secteur d’activité correspond à l’une des constantes de chaîne suivantes :

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

Pour voir les propriétés d’une entreprise, utilisez son ID :

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

Vous pouvez également voir la liste des Business Manager auxquels vous avez accès :

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

Les champs de réponse comprennent :

Nom Description

name

type : chaîne

Nom de l’entreprise

timezone_id

type : nombre entier

ID du fuseau horaire de l’entreprise

primary_page

type : objet JSON

Objet de la page principale associée à ce Business Manager.

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

id

type : long

ID du Business Manager

update_time

type : chaîne

Date de la dernière mise à jour de ce Business Manager

updated_by

type : objet JSON

Dernière personne, par nom et ID, à avoir mis à jour ce gestionnaire

creation_time

type : chaîne

Date de création de cette entreprise

created_by

type : objet JSON

Nom et ID de la personne ayant créé ce gestionnaire

Mettre à jour les Business Manager

Mettez à jour les champs du Business Manager en envoyant une requête POST à https://graph.facebook.com/{API_VERSION}/{BUSINESS_ID}. Par exemple, pour changer le nom de l’entreprise :

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

Changez le secteur d’activité de l’entreprise en envoyant la requête POST suivante :

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

Les options suivantes sont disponibles :

Nom Description

name

Obligatoire.

Nom de l’entreprise

primary_page

ID de la page principale associée à ce Business Manager.

Vous pouvez mettre à jour la page principale en envoyant la requête POST suivante. La page principale doit appartenir au Business Manager.

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

Vous pouvez également mettre à jour tout ce qui précède dans une seule requête 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>/"

Gérer les personnes et les rôles

Deux types de rôles sont proposés dans Business Manager :

Nom Constante d’API Description

Admin

ADMIN

  • L’admin peut contrôler tous les aspects de l’entreprise, y compris la modification ou la suppression du compte, ainsi que l’ajout ou la suppression d’employé·es.
  • L’admin dispose des accès READ et WRITE à tous les éléments associés au Business Manager.

Employé·e

EMPLOYEE

  • L’employé·e peut voir toutes les informations dans les paramètres de l’entreprise et se voir attribuer des rôles par les admins de cette dernière. L’employé·e n’est pas habilité·e à apporter des modifications, sauf pour ajouter à l’entreprise des Pages ou des comptes publicitaires qu’il ou elle administre.
  • L’employé·e dispose d’un accès READ à tous les éléments associés au Business Manager.

Pour plus d’informations sur les rôles, consultez la page Configurer des rôles de catalogue dans Business Manager.

Au départ, la personne qui crée l’entreprise est la seule utilisatrice de l’entreprise et son admin.

Inviter des personnes

Pour ajouter des collègues à votre entreprise, vous devez les inviter. Pour inviter une personne, indiquez une adresse e-mail valide à laquelle elle a accès. Le nombre de requêtes qu’il est possible d’envoyer pour ajouter des employé·es à un Business Manager est limité. Lorsque vous atteignez la limite fixée, un code d’erreur 17 s’affiche. Vous devez attendre 24 heures avant de poursuivre.

Pour inviter une personne en tant qu’admin, envoyez une requête 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"

Pour inviter une personne en tant qu’employé·e, envoyez une requête 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 envoie une invitation à l’adresse e-mail professionnelle que vous avez indiquée. La personne invitée doit vérifier sa messagerie et suivre le processus d’inscription. Une fois qu’elle a terminé, elle apparaît sur votre liste d’utilisateur·ices.

Personnes sur Business Manager

À partir de la version 2.11, des points de terminaison distincts sont utilisés pour récupérer des utilisateur·ices en fonction de leur statut. Envoyez une requête GET pour récupérer chaque groupe d’utilisateur·ices. Pour récupérer toutes les personnes de l’entreprise (notez que l’accès Avancé est requis) :

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

Pour récupérer les utilisateur·ices système, avec un accès au niveau du système :

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

Pour récupérer les utilisateur·ices en attente invité·es à accéder à une entreprise, mais qui n’ont pas encore accepté :

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

Les points de terminaison renvoient les personnes actives, en attente ou système de votre entreprise. Par exemple :

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

Les résultats pour les utilisateur·ices en attente ressemblent à ce qui suit :

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

Description des champs renvoyés :

Nom Description

id

type : long

ID de la personne en lien avec cette entreprise.

name

type : chaîne

Nom de la personne dans l’entreprise

business

type : objet JSON

Business Manager auquel cette personne appartient

first_name

type : chaîne

Prénom de la personne dans l’entreprise

last_name

type : chaîne

Nom de famille de la personne dans l’entreprise

title

type : chaîne

Fonction de la personne dans l’entreprise

role

type : chaîne

Le rôle de la personne dans l’entreprise (EMPLOYEE ou ADMIN)

email

type : chaîne

Adresse e-mail de la personne

Modifier les rôles

Pour modifier le rôle d’une personne active dans votre entreprise, indiquez son identifiant utilisateur. Par exemple, vous pouvez attribuer le rôle d’admin à un·e employé·e avec cette requête POST :

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

Pour attribuer le rôle d’employé·e à un·e admin, utilisez la requête POST suivante :

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

Vous pouvez modifier le rôle d’une personne en attente avec cette requête POST :

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

Supprimer des utilisateur·ices

Supprimez les autorisations accordées à une personne en fonction de son adhésion à vos Business Manager. Limitez l’accès aux comptes publicitaires et aux pages. Si l’utilisateur·ice a accès à des comptes publicitaires ou à des pages en dehors de votre Business Manager, ces autorisations restent inchangées. Par exemple, une personne peut s’être ajoutée elle-même ou avoir accès via un autre Business Manager

Pour supprimer une personne active de votre entreprise, envoyez une requête DELETE :

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

Pour annuler un·e utilisateur·ice en attente, envoyez une requête DELETE :

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

Cette opération supprime les utilisateur·ices de votre entreprise et leur accès aux ressources de cette dernière.

Récupérer des objets de connexion

Documents de référence

Les objets de connexion sont les objets Facebook (par exemple, les pages, les applications, etc.) gérés par un·e admin. Un·e admin peut être un·e utilisateur·ice ou une entreprise, ou, dans le cas d’applications, un·e développeur·se ou un annonceur. Les types d’objets de connexion sont les suivants :

  • Pages et lieux
  • Évènements
  • Applications
  • Domaines

Consultez un exemple de requêtes et apprenez-en plus sur la page Objets de connexion.

Factures

Documents de référence

L’API Business Manager vous permet d’afficher et de gérer les sources de crédit associées à une entreprise. Elle récupère toutes les factures visibles par un Business Manager. En d’autres termes, toutes les factures gérées par ce Business Manager sont visibles via l’API, et pas seulement celles appartenant à un ID d’entreprise particulier.

Ligne de crédit normale détenue par Business Manager

Pour les partenaires de l’API Marketing qui ont activé la facturation, vous pouvez profiter de la ligne de crédit normale détenue par Business Manager.

Les partenaires marketing Facebook (FBMP) doivent contacter leur représentant commercial pour configurer Business Manager pour le crédit. Assurez-vous de demander une ligne de crédit normale détenue par Business Manager. Une fois la configuration effectuée, vous pouvez utiliser l’API de création de compte publicitaire pour commencer à créer des comptes publicitaires. Les frais seront imputés sur votre ligne de crédit Business Manager.

Pour les comptes publicitaires créés via l’API, nous répartissons de manière dynamique le crédit entre les comptes et mettons à jour les limites de crédit et les dépenses pour éviter d’atteindre les limites. Vous pouvez également voir le récapitulatif de crédit disponible et le montant du crédit pour chaque compte publicitaire.

Pour l’heure, nous gérons seulement la responsabilité normale. La responsabilité séquentielle n’est pas prise en charge. Le processus de configuration reste inchangé.

Facturation de fin de mois

Une fois votre ligne de crédit configurée pour une entreprise et utilisée pour diffuser des publicités, des factures de fin de mois sont générées pour le compte business. Pour voir ces factures, vous devez disposer d’un rôle financier. Pour les admins et les employé·es d’une entreprise, vous pouvez attribuer des autorisations dans la section People de Business Manager. Vous pouvez également attribuer des autorisations financières aux utilisateur·ices système à l’aide de Business Manager.

Pour récupérer les factures sous un compte business à l’aide de l’API, envoyez une requête 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"

Exemple de résultats :

{
  "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"
}

Cette requête vous permet d’obtenir les détails de la facture au niveau d’une campagne :

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 réponse ressemble à ce qui suit :

{
  "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"
}

Vous pouvez également récupérer les champs de facturation supplémentaires :

  • invoice_date : date de création de la facture par Facebook
  • due_date : date d’échéance de la facture
  • payment_status : indique si la facture est Paid, Unpaid ou Partially Paid
  • amount_due : montant de la facture actuellement dû et en souffrance
  • download_uri : téléchargez la facture au format PDF à cette URI

API Funding Source

Pour récupérer la source d’approvisionnement du crédit étendu associée à un Business Manager, envoyez cette requête GET.

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

Pour configurer une source d’approvisionnement pour une entreprise, allez à la section Paramètres de votre entreprise dans Business Manager.

Dynamic Credit Allocation

Dynamic Credit Allocation, également connu sous le nom de DCAF, est notre système d’allocation de crédit qui permet d’ajuster périodiquement le crédit disponible en fonction de chaque compte publicitaire. Environ toutes les 30 minutes, notre script automatisé répartit votre crédit disponible uniformément sur tous vos comptes actifs activés pour DCAF. Le crédit disponible comprend le crédit total approuvé moins le solde total dû. Cela vous aide à gérer les dépenses au niveau de votre compte publicitaire et à allouer des fonds pour chaque compte publicitaire.

Une entreprise peut également « désactiver » un compte publicitaire facturé et le supprimer de la liste associée au crédit. Elle n’a plus besoin d’attendre que Facebook s’en charge.