View Source GoogleAds (GoogleAds v0.1.2)

Documentation for GoogleAds.

Summary

Functions

Append Local Services Lead Conversation resources to Local Services Lead resources.

Paginates the results of a paginated function.

Returns all rows that match the search query.

Types

access_token()

@type access_token() :: String.t()

append_lead_conversation_response()

@type append_lead_conversation_response() :: {:ok, map()} | error_response()

customer_id()

@type customer_id() :: String.t()

developer_token()

@type developer_token() :: String.t()

error_response()

@type error_response() ::
  {:error, :invalid_credentials | :invalid_permissions | any()}

paginated_function()

@type paginated_function() :: (pagination_options() ->
                           {:ok, map()} | error_response())

pagination_options()

@type pagination_options() :: [{:pageToken, String.t()}]

pagination_result()

@type pagination_result() :: {:ok, list()} | error_response()

request_body()

@type request_body() :: map()

search_response()

@type search_response() :: {:ok, map()} | error_response()

Functions

append_lead_conversation(developer_token, access_token, customer_id, request_body)

@spec append_lead_conversation(
  developer_token(),
  access_token(),
  customer_id(),
  request_body()
) :: append_lead_conversation_response()

Append Local Services Lead Conversation resources to Local Services Lead resources.

https://developers.google.com/google-ads/api/rest/reference/rest/v18/customers.localServices/appendLeadConversation

paginate(fun)

@spec paginate(paginated_function()) :: pagination_result()

Paginates the results of a paginated function.

Example:

GoogleAds.paginate(fn pagination_options ->
  GoogleAds.search(developer_token, token, customer_id, request_body, pagination_options)
end)

search(developer_token, access_token, customer_id, request_body)

Returns all rows that match the search query.

https://developers.google.com/google-ads/api/rest/reference/rest/v18/customers.googleAds/search

search(developer_token, access_token, customer_id, request_body, pagination_options)