Pesquisa de direcionamento

Direcione conjuntos de anúncios com base em diferentes critérios fornecidos por você nas especificações de direcionamento. A maioria dos direcionamentos consiste em valores predefinidos, como país "Japão" ou cidade "Tóquio".

Encontre os valores válidos com API de Marketing, Pesquisa de direcionamento: https://graph.facebook.com/{API_VERSION}/search. Insira a string de consulta no formato UTF8.

Status da opção de direcionamento

Para verificar o status atual e/ou planejado dos objetos de direcionamento, use o parâmetro targeting_option_list:

curl -G \
  -d 'targeting_option_list=[<TARGETING_OPTION_ ID>,<TARGETING_OPTION_ID>]' 
  -d 'type=targetingoptionstatus'  
  https://graph.facebook.com/<API_VERSION>/search

A resposta:

{"data":[{"id":"<TARGETING_OPTION_ ID>","current_status":"NON-DELIVERABLE"},{"id":"<TARGETING_OPTION_ID>","current_status":"NON-DELIVERABLE","future_plan":[{"key":"2018-05-10T00:00:00+0000","value":"DEPRECATING"}]}]

Campos de retorno

Geografia

Pesquise o direcionamento por país, grupo de países, cidade, estado, código postal e outras áreas geográficas em type=adgeolocation. Você pode especificar parâmetros opcionais com type=adgeolocation. Para encontrar o código do país dos Estados Unidos:

curl -G \
  -d 'location_types=["country"]' \
  -d 'type=adgeolocation' \
  -d 'q=un' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta:

{
  "data": [
    {
      "key": "GB", 
      "name": "United Kingdom", 
      "type": "country", 
      "supports_city": false, 
      "supports_region": false
    }, 
    {
      "key": "AE", 
      "name": "United Arab Emirates", 
      "type": "country", 
      "supports_city": false, 
      "supports_region": false
    }, 
    {
      "key": "UM", 
      "name": "United States Minor Outlying Islands", 
      "type": "country", 
      "supports_city": false, 
      "supports_region": false
    }
  ]
}

key é um número fixo único por categoria, como países ou grupos de países. Outros campos, incluindo name, estão sujeitos a alterações. Use key para definir as especificações de direcionamento.

Na resposta:

• Se supports_region for true, o país terá códigos de regiões.
• Se supports_city for true, o país terá códigos de cidades.

Países

Cada país que pode ser usado no direcionamento apresenta um código do país. Parâmetros opcionais para type=adgeolocation&location_types=['country']:

Grupo de países

Todos os grupos de países possuem um código para realizar a pesquisa e obter uma lista de países. Para todos os grupos de países denominados mercosur:

curl -G \
  -d 'location_types=["country_group"]' \
  -d 'type=adgeolocation' \
  -d 'q=mercosur' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta:

{
  "data": [
    {
      "key": "mercosur",
      "name": "Mercosur",
      "type": "country_group",
      "country_codes": [
        "BR",
        "AR",
        "UY",
        "PY",
        "VE"
      ],
      "is_worldwide": false,
      "supports_region": true,
      "supports_city": true
    }
  ]
}

Se is_worldwide for true, o grupo de países será mundial. Se supports_region for true, o grupo de países terá códigos de regiões. Se supports_city for true, o grupo terá códigos de cidades.

Regiões

Para pesquisar todas as regiões que iniciam com o código al:

curl -G \
  -d 'location_types=["region"]' \
  -d 'type=adgeolocation' \
  -d 'q=al' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta:

{
  "data": [
    {
      "key": "3843",
      "name": "Alabama",
      "type": "region",
      "country_code": "US",
      "country_name": "United States",
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "3844",
      "name": "Alaska",
      "type": "region",
      "country_code": "US",
      "country_name": "United States",
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "527",
      "name": "Alberta",
      "type": "region",
      "country_code": "CA",
      "country_name": "Canada",
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "1089",
      "name": "Alsace",
      "type": "region",
      "country_code": "FR",
      "country_name": "France",
      "supports_region": true,
      "supports_city": true
    }
  ]
}

Opções para type=adgeolocation&location_types=['region']:

Se o parâmetro supports_region for true, você poderá fazer o direcionamento para essa região. Se supports_city for true, a região terá códigos de cidades.

Cidades

Desde março de 2019, reclassificamos várias cidades para outras funções, mas você pode continuar usando city. A pesquisa retornará resultados que antes eram cidades.

Para pesquisar os códigos de todas as cidades que começam por Manhattan:

curl -G \
     -d 'location_types=["city"]' \
     -d 'type=adgeolocation' \
     -d 'q=Manhattan' \
     -d 'access_token=ACCESS_TOKEN' \
     https://graph.facebook.com/VERSION/search

A resposta:

{
  "data": [
    {
      "key": "2447439",
      "name": "Manhattan",
      "type": "city",
      "country_code": "US",
      "country_name": "United States",
      "region": "Kansas",
      "region_id": 3859,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "2439596",
      "name": "Manhattan",
      "type": "city",
      "country_code": "US",
      "country_name": "United States",
      "region": "Illinois",
      "region_id": 3856,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "2479541",
      "name": "Manhattan",
      "type": "city",
      "country_code": "US",
      "country_name": "United States",
      "region": "Montana",
      "region_id": 3869,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "2428908",
      "name": "Manhattan",
      "type": "city",
      "country_code": "US",
      "country_name": "United States",
      "region": "Florida",
      "region_id": 3852,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "2703980",
      "name": "Manhattan",
      "type": "subcity",
      "country_code": "US",
      "country_name": "United States",
      "region": "New York",
      "region_id": 3875,
      "supports_region": true,
      "supports_city": true,
      "geo_hierarchy_level": "SUBCITY",
      "geo_hierarchy_name": "BOROUGH"
    },
   ...

Se supports_region for verdadeiro, a região dessa cidade estará disponível para direcionamento. Se o parâmetro supports_city for definido como true, essa cidade estará disponível para direcionamento.

Áreas geográficas

É possível usar outras áreas geográficas no direcionamento. Algumas dessas áreas ainda não estão definidas, como observado abaixo.

A hierarquia das áreas geográficas é a seguinte, da maior para a menor:

• REGION
• LARGE_GEO_AREA
• MEDIUM_GEO_AREA
• SMALL_GEO_AREA
• METRO_AREA
• CITY
• SUBCITY
• NEIGHBORHOOD
• SUBNEIGHBORHOOD

Código postal

Também é possível pesquisar códigos postais para direcionamento no Facebook. Para fazer a pesquisa por código postal, recomendamos usar adgeolocation com location_types=['zip']. Se quiser consultar a lista de países com códigos postais compatíveis, acesse a Central de Ajuda da Meta .

Para pesquisar códigos postais que começam por 9:

curl -G \
  -d 'location_types=["zip"]' \
  -d 'type=adgeolocation' \
  -d 'q=9' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/LATEST-API-VERSION/search

A resposta:

{
  "data": [
    {
      "key": "US:90028",
      "name": "90028",
      "type": "zip",
      "country_code": "US",
      "country_name": "United States",
      "region": "California",
      "region_id": 3847,
      "primary_city": "Los Angeles",
      "primary_city_id": 2420379,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "US:94110",
      "name": "94110",
      "type": "zip",
      "country_code": "US",
      "country_name": "United States",
      "region": "California",
      "region_id": 3847,
      "primary_city": "San Francisco",
      "primary_city_id": 2421836,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "US:94501",
      "name": "94501",
      "type": "zip",
      "country_code": "US",
      "country_name": "United States",
      "region": "California",
      "region_id": 3847,
      "primary_city": "Alameda",
      "primary_city_id": 2417628,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "US:95190",
      "name": "95190",
      "type": "zip",
      "country_code": "US",
      "country_name": "United States",
      "region": "California",
      "region_id": 3847,
      "primary_city": "San Jose",
      "primary_city_id": 2421846,
      "supports_region": true,
      "supports_city": true
    }
  ]
}

Localidades

Localidades para as quais é possível direcionar anúncios por códigos de localidades. Para pesquisar todas as localidades que começam por en:

curl -G \
  -d 'type=adlocale' \
  -d 'q=en' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta:

{
{
      "data": [
        {
          "key": 51, 
          "name": "English (Upside Down)"
        }, 
        {
          "key": 6, 
          "name": "English (US)"
        }, 
        {
          "key": 24, 
          "name": "English (UK)"
        }
      ]
    }
}

Códigos DMA

Para obter esses códigos, especifique type=adgeolocation e location_types=['geo_market'] na sua consulta. Para pesquisar códigos DMA que começam por "New" (Nova):

curl -G \
  -d 'location_types=["geo_market"]' \
  -d 'type=adgeolocation' \
  -d 'q=New' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

O resultado:

{
  "data": [
    {
      "key": "DMA:622",
      "name": "New Orleans",
      "type": "geo_market",
      "country_code": "US",
      "country_name": "United States",
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "DMA:501",
      "name": "New York",
      "type": "geo_market",
      "country_code": "US",
      "country_name": "United States",
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "DMA:533",
      "name": "Hartford & New Haven",
      "type": "geo_market",
      "country_code": "US",
      "country_name": "United States",
      "supports_region": true,
      "supports_city": true
    },
    {
....
    }
  ]
}

Distritos eleitorais

Para pesquisar municípios eleitorais para direcionamento, especifique type=adgeolocation e location_types=['electoral_district']. Para pesquisar distritos eleitorais na Califórnia:

curl -G \
  -d 'location_types=["electoral_district"]' \
  -d 'type=adgeolocation' \
  -d 'q=California' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta:

{
  "data": [
    {
      "key": "US:CA14",
      "name": "California's 14th District",
      "type": "electoral_district",
      "country_code": "US",
      "country_name": "United States",
      "region": "California",
      "region_id": 3847,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "US:CA02",
      "name": "California's 2nd District",
      "type": "electoral_district",
      "country_code": "US",
      "country_name": "United States",
      "region": "California",
      "region_id": 3847,
      "supports_region": true,
      "supports_city": true
    },
 ...
}

Metadados de localizações geográficas

Você pode usar outros parâmetros opcionais com type=adgeolocationmeta:

curl -G \
  -d 'cities=[2418779]' \
  -d 'zips=["US:90210"]' \
  -d 'countries=["US","JP"]' \
  -d 'regions=[10]' \
  -d 'type=adgeolocationmeta' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta é um objeto JSON com metadados das localizações geográficas especificadas:

{
  "data": {
    "countries": {
      "US": {
        "key": "US", 
        "type": "country", 
        "name": "United States", 
        "supports_city": true, 
        "supports_region": true
      }, 
      "JP": {
        "key": "JP", 
        "type": "country", 
        "name": "Japan", 
        "supports_city": true, 
        "supports_region": true
      }
    }, 
    "regions": {
      "10": {
        "key": "10", 
        "type": "region", 
        "name": "Dubai", 
        "country_code": "AE", 
        "supports_city": true, 
        "supports_region": false
      }
    }, 
    "cities": {
      "2418779": {
        "key": "2418779", 
        "type": "city", 
        "name": "Danville", 
        "region_id": 3847, 
        "region": "California", 
        "country_code": "US", 
        "supports_city": true, 
        "supports_region": true
      }
    }, 
    "zips": {
      "US:90210": {
        "key": "US:90210", 
        "type": "zip", 
        "name": "90210", 
        "primary_city": "Beverly Hills", 
        "region_id": 3847, 
        "region": "California", 
        "country_code": "US", 
        "supports_city": true, 
        "supports_region": true
      }
    }
  }
}

Opções:

Sugestões de raio

Para fazer o direcionamento em torno de uma localização específica, use suggested_radius para alcançar pessoas suficientes em um raio sugerido:

curl -G \
  -d 'latitude=37.449478' \
  -d 'longitude=-122.173016' \
  -d 'type=adradiussuggestion' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta é um objeto JSON com suggested_radius e distance_unit.

{
  "data": [
    {
      "suggested_radius": 10,
      "distance_unit": "mile"
    }
  ]
}

Exemplo de busca por suggested_radius com uma distance_unit especificada:

curl -G \
  -d 'latitude=37.449478' \
  -d 'longitude=-122.173016' \
  -d 'type=adradiussuggestion' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

{
  "data": [
    {
      "suggested_radius": 16,
      "distance_unit": "kilometer"
    }
  ]
}

Use estes parâmetros:

Além disso, saiba como usar os anúncios de Divulgação nas Imediações com sugestões.

Interesses

Envie uma solicitação GET ao ponto de extremidade /search. Além disso, defina type como adinterest e q como o interesse específico a ser pesquisado:

curl -G \
  -d 'type=adinterest' \
  -d 'q=baseball' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta retornará os campos a seguir:

Sugestões de interesses

Envie uma solicitação GET ao ponto de extremidade /search e configure type como adinterestsuggestion para obter uma lista de interesses sugeridos relacionados ao seu interesse.

Exemplo de consulta

curl -G \
  -d 'interest_list=["Basketball"]' \
  -d 'type=adinterestsuggestion' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<API_VERSION>/search

Exemplo de resposta

{
  "data": [
    {
      "id": "6003598240487",
      "name": "la biblia",
      "audience_size": 7419780,
      "path": [
  ],
      "description": null
   },
   {
      "id": "6003022269556",
      "name": "Rugby football",
      "audience_size": 13214830,
      "path": [
  ],
      "description": null
   },
   {
      "id": "6003146664949",
      "name": "Netball",
      "audience_size": 4333770,
      "path": [
  ],
"description": null
   },
   {
      "id": "6003013291881",
      "name": "Kaizer Chiefs F.C.",
      "audience_size": 1812850,
      "path": [
  ],
      "description": null
  },
  ....
  {
      "id": "6003400886535",
      "name": "espn sportscenter",
      "audience_size": 222960,
      "path": [
  ],
     "description": null
  },
  {
     "id": "6002925969459",
     "name": "watching movies",
     "audience_size": 4630950,
     "path": [
  ],
     "description": null
  },
  {
     "id": "6003214125247",
     "name": "lakers",
     "audience_size": 340360,
     "path": [
  ],
     "description": null
  }

As opções incluem:

Limitações

• Nem todos os interesses disponíveis serão retornados em uma pesquisa.
• Os interesses podem ser renomeados a qualquer momento. A validação por nome poderá falhar quando isso acontecer. Por isso, recomendamos validar interesses por interest_fbid_list em vez de nome. Verifique se os termos são válidos ao fazer a consulta com type=adinterestvalid e com o interesse que será validado:

curl -G \
  -d 'interest_list=["Japan","nonexistantkeyword"]' \
  -d 'type=adinterestvalid' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta:

{
  "data": [
    {
      "name": "Japan",
      "valid": true,
      "id": 6003700426513,
      "audience_size": 68310258
    },
    {
      "name": "nonexistantkeyword",
      "valid": false
    }
  ]
}

Opções:

Interesses

Para pesquisar interesses em potencial para o direcionamento, envie uma solicitação GET ao ponto de extremidade /search com type definido como adTargetingCategory e class como interests.

curl -G \
  -d 'type=adTargetingCategory' \
  -d 'class=interests' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

Limitações

• Nem todos os interesses disponíveis serão retornados em uma pesquisa.

Comportamentos

Direcione anúncios com base nas ações ou no comportamento de compra anterior de um usuário. Recupere todas as opções possíveis de direcionamento por comportamento com type=adTargetingCategory&class=behaviors.

curl -G \
  -d 'type=adTargetingCategory' \
  -d 'class=behaviors' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta contém o seguinte:

Dados demográficos

Inclui o local de trabalho, educação, tipos de cargo e tipos de status de relacionamento. Você também pode direcionar pela data mais recente de um acontecimento: 3 meses, 6 meses e 1 ano. Pode fazer referência a uma instituição de ensino para direcionar por ID e nome.

Para pesquisar todas as instituições que começam por ha:

curl -G \
  -d 'type=adeducationschool' \
  -d 'q=ha' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta:

 {
  "data": [
    {
      "name": "Harvard University", 
      "id": 105930651606,
      "coverage": 8395398,
      "subtext": "Cambridge, Massachusetts"
    }, 
    {
      "name": "Hajvery University", 
      "id": 148971135122588,
      "coverage": 124162
    }, 
    {
      "name": "Harvard-Westlake School", 
      "id": 107799365910274,
      "coverage": 14106
    }
  ]
}

Cursos de graduação

Faça o direcionamento de cursos de graduação por ID e nome. Para pesquisar todos os cursos de graduação que iniciam por ph:

curl -G \
  -d 'type=adeducationmajor' \
  -d 'q=ph' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta:

{
  "data": [
    {
      "name": "Photography", 
      "id": 108170975877442,
      "coverage": 613618
    }, 
    {
      "name": "Physics", 
      "id": 109279729089828,
      "coverage": 942491
    }, 
    {
      "name": "Philosophy", 
      "id": 108026662559095,
      "coverage": 701271
    }
  ]
}

Empregador

Faça referência a empregadores que podem ser direcionados de acordo com ID e nome. Para pesquisar todos os empregadores que começam por mic:

curl -G \
  -d 'type=adworkemployer' \
  -d 'q=mic' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta:

{
  "data": [
    {
      "name": "Western Michigan University", 
      "id": 10022826163,
      "coverage": 24366
    }, 
    {
      "name": "University of Michigan", 
      "id": 21105780752,
      "coverage": 17357
    }, 
    {
      "name": "Michigan State University - SPARTANS", 
      "id": 8891783019,
      "coverage": 65853
    }
  ]
}

Cargo

Todo cargo informado pelo usuário disponível para direcionamento tem uma identificação e um nome. Para obter todos os cargos que incluem Business Analyst:

curl -G \
  -d 'type=adworkposition' \
  -d 'q=Business Analyst' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

A resposta:

{
   "data": [
    {
      "name": "Business Analyst", 
      "id": 105763692790962,
      "coverage": 282124
    }, 
    {
      "name": "Financial Analyst", 
      "id": 112930925387573,
      "coverage": 212889
    }
  ]
}

A resposta contém estes campos:

Os parâmetros a seguir são comuns para essa API. Para obter os tipos específicos de parâmetro de entrada, veja os detalhes abaixo.

Com base na categoria de dados com preenchimento automático, insira o type apropriado. Para recuperar as localidades, especifique type=adlocale. As categorias válidas são:

Navegação por dados demográficos

Recupere todas as opções possíveis de direcionamento demográfico com type=adTargetingCategory e uma class.

A resposta contém estes campos: