Gads

Supported Formats

json
>>>

GET /api/gads/accounts
Get list of Google Ads accounts

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
account_id
required

Business Account Id

Validations:

  • Must be a String
>>>

POST /api/gads/add_account
Add a new Google Ads account

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
page_url
required

Redirection url after permissions processing

Validations:

  • Must be a String
account_id
required

Business Account Id

Validations:

  • Must be a String
gads_account_id
required

Google Ads account id

Validations:

  • Must be a String
>>>

POST /api/gads/update_account
Update an existing Google Ads account

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
account_id
required

Business Account Id

Validations:

  • Must be a String
gads_account_id
required

Google Ads account id

Validations:

  • Must be a String
matched_domain_id
optional

Domain Id

Validations:

  • Must be a String
>>>

POST /api/gads/authorize
Authorize Google ads account

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Google Ads account not found
422 Unprocessable entry

Params

Param name Description
account_credential_id
required

Account Credential Id

Validations:

  • Must be a String
>>>

DELETE /api/gads/delete_account
Delete Google Ads account

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Google Ads account not found
422 Unprocessable entry

Params

Param name Description
account_credential_id
required

Account Credential Id

Validations:

  • Must be a String
>>>

GET /api/gads/campaigns
Get list of Google Ads campaigns

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
account_credential_id
required

Account Credential Id

Validations:

  • Must be a String
>>>

GET /api/gads/ad_groups
Get list of Google Ads ad groups

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
account_credential_id
required

Account Credential Id

Validations:

  • Must be a String
gads_campaign_id
required

Google Ads Campaign Id

Validations:

  • Must be a String
>>>

GET /api/gads/selected_text_ad_items
Get list of selected text ads

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
account_credential_id
required

Account Credential Id

Validations:

  • Must be a String
subscription_id
required

Subscription Id

Validations:

  • Must be a String
gads_campaigns
required

Google Ads Campaigns Array

Validations:

  • Must be an array of any type
>>>

GET /api/gads/exp_text_ad_items
Get list of expanded text ads

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
account_credential_id
required

Account Credential Id

Validations:

  • Must be a String
gads_ad_group_id
required

Google Ads Ad Group Id

Validations:

  • Must be a String
>>>

POST /api/gads/upload_exp_text_ad_orders
Upload new expanded text ad orders

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
language
required

Language

Validations:

  • Must be a String
account_credential_id
required

Account Credential Id

Validations:

  • Must be a String
gads_campaign_id
required

Google Ads Campaign Id

Validations:

  • Must be a String
gads_ad_group_id
required

Google Ads Ad Group Id

Validations:

  • Must be a String
gads_ad_ids
required

Google Ads ExpandedTextAd Ids

Validations:

  • Must be an array of any type
subscription_id
required

The Subscription Id

Validations:

  • Must be a String
>>>

GET /api/gads/subscriptions
Get list of subscriptions

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
>>>

GET /api/gads/goals
Get list of goals

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
>>>

GET /api/gads/samples
Get list of sample ads

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
content_order_id
required

Content Order Id

Validations:

  • Must be a String
>>>

POST /api/gads/order
Google Ads order wizard

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
account_id
required

Business Account Id

Validations:

  • Must be a String
page
required

Current page identifier

Validations:

  • Must be a String
direction
required

Next page direction: forward, back

Validations:

  • Must be a String
page_params
required

Order parameters for the page

Validations:

  • Must be a Hash