tests/testthat/test-integration-tests.R

In facebookresearch/Radlibrary: Facebook Ad Library API Tool

# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
#
# This source code is licensed under the license found in the
# LICENSE file in the root directory of this source tree.

integration_test <- function(token, ...) {
  fields <- c(
    "id", "ad_creation_time", "ad_creative_bodies", "ad_creative_link_captions",
    "ad_creative_link_descriptions", "ad_creative_link_titles", "ad_delivery_start_time",
    "ad_delivery_stop_time", "ad_snapshot_url", "bylines", "currency",
    "languages", "page_id", "page_name", "publisher_platforms", "estimated_audience_size",
    "impressions", "spend"
  )
  adlib_build_query(..., fields = fields) |>
    adlib_get(token = token) |>
    as_tibble(censor_access_token = TRUE) |>
    dplyr::select(sort(tidyselect::peek_vars()))
}

test_that("searching by keyword works as expected", {
  skip_on_cran()
  skip_if_not(token_exists_in_env())
  token <- Sys.getenv("FB_GRAPH_API_TOKEN")
  search_by_keyword <- integration_test(token,
    ad_reached_countries = "US",
    ad_delivery_date_min = "2022-01-01",
    ad_delivery_date_max = "2022-01-01",
    search_terms = "biden",
    limit = 10
  )
  expect_snapshot(dplyr::glimpse(search_by_keyword))
})

test_that("searching by page_id as expected", {
  skip_on_cran()
  skip_if_not(token_exists_in_env())
  token <- Sys.getenv("FB_GRAPH_API_TOKEN")
  search_by_page <- integration_test(token,
    ad_reached_countries = "US",
    ad_delivery_date_min = "2023-10-20",
    ad_delivery_date_max = "2023-10-26",
    search_page_ids = "7860876103",
    limit = 20
  )
  expect_snapshot(dplyr::glimpse(search_by_page))
})

test_that("Parsing responses works correctly", {
  skip_on_cran()
  skip_if_not(token_exists_in_env())
  token <- Sys.getenv("FB_GRAPH_API_TOKEN")
  data_response <- adlib_build_query(
    ad_reached_countries = "US",
    search_terms = "Facebook",
    limit = 5
  ) %>%
    adlib_get(token)
  expect_equal(data_response$fields, c(
    "id", "ad_creation_time", "ad_creative_bodies", "ad_creative_link_captions",
    "ad_creative_link_descriptions", "ad_creative_link_titles", "ad_delivery_start_time",
    "ad_delivery_stop_time", "ad_snapshot_url", "bylines", "currency",
    "estimated_audience_size", "impressions", "languages", "page_id",
    "page_name", "publisher_platforms", "spend"
  ))
  expect_equal(length(data_response$data), 5)
})

test_that("Converting to ad table works", {
  skip_on_cran()
  skip_if_not(token_exists_in_env())
  token <- Sys.getenv("FB_GRAPH_API_TOKEN")
  data_response <- adlib_build_query(
    ad_reached_countries = "US",
    search_terms = "Facebook",
    estimated_audience_size_max = 1e5L,
    unmask_removed_content = TRUE,
    limit = 100
  ) %>%
    adlib_get(token)
  tbl <- as_tibble(data_response, censor_access_token = TRUE) |>
    dplyr::select(sort(tidyselect::peek_vars()))
  expect_s3_class(tbl, "tbl_df")
  expect_equal(
    vctrs::vec_ptype(tbl),
    structure(list(
      ad_creation_time = character(0), ad_creative_bodies = list(),
      ad_creative_link_captions = list(), ad_creative_link_descriptions = list(),
      ad_creative_link_titles = list(), ad_delivery_start_time = character(0),
      ad_delivery_stop_time = character(0), ad_snapshot_url = character(0),
      bylines = character(0), currency = character(0), estimated_audience_size_lower = numeric(0),
      estimated_audience_size_upper = numeric(0), id = character(0),
      impressions_lower = numeric(0), impressions_upper = numeric(0),
      languages = list(), page_id = character(0), page_name = character(0),
      publisher_platforms = list(), spend_lower = numeric(0), spend_upper = numeric(0)
    ), class = c(
      "tbl_df",
      "tbl", "data.frame"
    ), row.names = integer(0))
  )
})

test_that("Getting demographic data works", {
  skip_on_cran()
  skip_if_not(token_exists_in_env())
  token <- Sys.getenv("FB_GRAPH_API_TOKEN")
  data_response <- adlib_build_query(
    ad_reached_countries = "US",
    search_terms = "Facebook",
    fields = c("id", "demographic_distribution"),
    limit = 5
  ) %>%
    adlib_get(token)
  expect_s3_class(data_response, "adlib_data_response")
  expect_equal(data_response$fields, c("id", "demographic_distribution"))
})

test_that("searching by language works", {
  skip_on_cran()
  skip_if_not(token_exists_in_env())
  token <- Sys.getenv("FB_GRAPH_API_TOKEN")
  result <- adlib_build_query(
    ad_reached_countries = "BR",
    search_terms = "Facebook",
    fields = c("id", "languages", "delivery_by_region"),
    languages = c("en"),
    limit = 5
  ) %>%
    adlib_get(token) %>%
    as_tibble()
  expect_equal(vctrs::vec_ptype(result), structure(list(id = character(0), languages = list(), delivery_by_region = list()), class = c(
    "tbl_df",
    "tbl", "data.frame"
  ), row.names = integer(0)))
})

test_that("searching by region works", {
  skip_on_cran()
  skip_if_not(token_exists_in_env())
  token <- Sys.getenv("FB_GRAPH_API_TOKEN")
  result <- adlib_build_query(
    ad_reached_countries = "US",
    delivery_by_region = c("California", "New York"),
    search_terms = "Facebook",
    fields = c("id", "delivery_by_region"),
    limit = 5
  ) %>%
    adlib_get(token) %>%
    as_tibble()
  expect_equal(vctrs::vec_ptype(result), structure(list(id = character(0), delivery_by_region = list()), class = c(
    "tbl_df",
    "tbl", "data.frame"
  ), row.names = integer(0)))
})

test_that("searching for the age gender country breakdown works", {
  skip_on_cran()
  skip_if_not(token_exists_in_env())
  token <- Sys.getenv("FB_GRAPH_API_TOKEN")
  acgb <- adlib_build_query(
    ad_reached_countries = "DE",
    fields = c("id", "age_country_gender_reach_breakdown"),
    search_terms = "election", limit = 5, unmask_removed_content = FALSE
  ) |>
    adlib_get(token = token) |>
    as_tibble()
  expect_equal(
    vctrs::vec_ptype(acgb),
    tibble::tibble(id = character(0), age_country_gender_reach_breakdown = list())
  )
  expect_equal(
    vctrs::vec_ptype(tidyr::unnest(acgb, age_country_gender_reach_breakdown)),
    tibble::tibble(
      id = character(0),
      country = character(0),
      age_range = character(0),
      male = integer(0),
      female = integer(0),
      unknown = integer(0)
    )
  )
})

test_that("beneficiary_payers", {
  skip_on_cran()
  skip_if_not(token_exists_in_env())
  token <- Sys.getenv("FB_GRAPH_API_TOKEN")
  df <- adlib_build_query(
    ad_reached_countries = "DE",
    search_terms = "election",
    limit = 20,
    fields = c("id", "beneficiary_payers")
  ) |>
    adlib_get(token = token) |>
    tibble::as_tibble()
  expect_equal(vctrs::vec_ptype(df), tibble::tibble(id = character(), beneficiary_payers = list()))
  expect_equal(
    vctrs::vec_ptype(tidyr::unnest(df, beneficiary_payers)),
    tibble::tibble(
      id = character(), payer = character(), beneficiary = character(),
      current = logical()
    )
  )
})

test_that("All EU fields", {
  skip_on_cran()
  skip_if_not(token_exists_in_env())
  token <- Sys.getenv("FB_GRAPH_API_TOKEN")

  data <- adlib_build_query(
    ad_reached_countries = c("DE", "FR"), search_terms = "vote",
    limit = 20, fields = c(
      "id",
      "age_country_gender_reach_breakdown",
      "beneficiary_payers",
      "eu_total_reach",
      "target_ages",
      "target_gender",
      "target_locations"
    )
  ) |>
    adlib_get(token = token)
  expect_equal(data$fields, c(
    "id",
    "age_country_gender_reach_breakdown",
    "beneficiary_payers",
    "eu_total_reach",
    "target_ages",
    "target_gender",
    "target_locations"
  ))
  expect_setequal(
    colnames(as_tibble(data)),
    c(
      "id",
      "age_country_gender_reach_breakdown",
      "beneficiary_payers",
      "eu_total_reach",
      "target_ages",
      "target_gender",
      "target_locations"
    )
  )
})