Reports API Version 2 PPC
Introduction
These reports display PPC Accounts and Networks config.
List PPC Accounts
Lists all IGRP PPC accounts
Request:
GET /reports/v2/igrps/{IGRP SPECIFIER}/ppc/networks/{networkCode}/accounts
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
- networkCode (spec) - Identifies the paid search network. Pass “all” to see accounts for all networks.
GET Params
- filter (array) OPTIONAL - One or more filters.
- sort (array) OPTIONAL - One or more sorting params.
- limit (integer) OPTIONAL - Limit on the result set.
- offset (integer) OPTIONAL - Offset of the result set.
Filter and Sort Fields
All Response are filterable and sortable
Response:
- accountRef (int) - External account reference.
- accountName (string) - Account name.
- networkCode (string) - Code of this account’s network (gaw - Google AdWords, mac - Microsoft Bing Ads, ysm - Yahoo Search Marketing.
- accountStatus (int) - Account status (200 OK, 410 GONE).
- currencyCode (string) - The three-letter ISO-4217 currency code that this account uses for reporting.
- timezone (string) - The timezone that this account uses for reporting.
Read PPC Accounts
Read one PPC Account row
Request:
GET /reports/v2/igrps/{IGRP SPECIFIER}/ppc/networks/{networkCode}/accounts/{accountRef}
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
- networkCode (spec) - Identifies the paid search network.
- accountRef (spec) - Account reference ID (accountRef).
Response:
- accountRef (int) - External account reference ID.
- accountName (string) - Account name.
- networkCode (string) - Identifies the paid search network (gaw - Google AdWords, mac - Microsoft Bing Ads, ysm - Yahoo Search Marketing.
- accountStatus (int) - Account status (200 OK, 410 GONE).
- currencyCode (string) - The three-letter ISO-4217 currency code that this account uses for reporting.
- timezone (string) - The timezone that this account uses for reporting.
List PPC Networks
Lists all available PPC networks
Request:
GET /reports/v2/ppc/networks
GET Params
- filter (array) OPTIONAL - One or more filters.
- sort (array) OPTIONAL - One or more sorting params.
- limit (integer) OPTIONAL - Limit on the result set.
- offset (integer) OPTIONAL - Offset of the result set.
Filter and Sort Fields
All Response are filterable and sortable
Response:
- networkCode (string) - Identifies the paid search network (gaw - Google AdWords, mac - Microsoft Bing Ads, ysm - Yahoo Search Marketing.
- networkName (string) - Friendly name for the paid search network.
- oauth2AppCode (string) - Identifies the oAuth2 config settings to use for this network.
Read PPC Networks
Read one PPC Networks row
Request:
GET /reports/v2/ppc/networks/{networkCode}
URL Path Params
- networkCode (spec) - Identifies the paid search network.
Response:
- networkCode (string) - Identifies the paid search network (gaw - Google AdWords, mac - Microsoft Bing Ads, ysm - Yahoo Search Marketing.
- networkName (string) - Friendly name for the paid search network.
- oauth2AppCode (string) - Identifies the oAuth2 config settings to use for this network.