Upsert Google campaign

Create or update a full Google Ads campaign structure

PUT https://services.leadconnectorhq.com/ad-publishing/google/ads

Autorización

Authorization

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

Version

string

default:"2021-07-28"

required

Versión de la API.

Body

string

Campaign identifier

name

string

default:"My Campaign"

required

Campaign name

locationId

string

default:"loc_abc123"

required

Account identifier

advertisingChannelType

string

required

Advertising channel Posibles valores: ‘SEARCH’, ‘DISCOVERY’, ‘DISPLAY’, ‘HOTEL’, ‘LOCAL’, ‘MULTI_CHANNEL’, ‘PERFORMANCE_MAX’, ‘DEMAND_GEN’

advertisingChannelSubType

string

Channel sub type Posibles valores: ‘DEMAND_GEN’

goalType

string

Goal type Posibles valores: ‘WEBSITE_TRAFFIC’, ‘LEAD’

budget

object

Campaign budget

audience

object

Campaign audience targeting

networkSettings

object

Network settings

biddingStrategy

object

Bidding strategy config

assets

object

Campaign assets

isEuPoliticalAds

boolean

default:"False"

EU political ads flag

adGroups

object[]

Campaign ad groups

Show cada item

string

Ad group identifier

adGroupId

string

Google ad group identifier

name

string

default:"Ad Group 1"

Ad group name

adCampaignId

string

Ad campaign identifier

adContent

object[]

Ad content items

Show cada item

string

Ad identifier

name

string

Ad name

mediaType

string

Media type Posibles valores: ‘IMAGE’, ‘VIDEO’, ‘CAROUSEL’

headlines

string[]

Ad headlines

longHeadlines

string[]

Long headlines

descriptions

string[]

Ad descriptions

finalUrl

string

default:"https://example.com"

Final URL

path1

string

default:"products"

Display path 1

path2

string

default:"deals"

Display path 2

isDeleted

boolean

Whether the ad is soft-deleted

adError

string

Ad-level error message from Google

publishingStatus

string

Ad publishing status Posibles valores: ‘DRAFT’, ‘SCHEDULED’, ‘PUBLISHED’, ‘PUBLISHING’, ‘FAILED’, ‘IN_REVIEW’, ‘PAUSED’, ‘ARCHIVED’, ‘WITH_ISSUES’, ‘REJECTED’

adId

string

Internal ad identifier

adCampaignId

string

Ad campaign identifier

adGroupId

string

Ad group identifier

googleAdId

string

Google Ads ad resource ID

media

object[]

Ad media items

Show cada item

type

string

Media type Posibles valores: ‘IMAGE’

src

string

default:"https://example.com/image.jpg"

Media source URL

isLogo

boolean

default:"False"

Is logo flag

error

string

Error message if media failed

url

string

Public URL of the media

imageType

string

Image type classification

callToActionLabel

string

Call to action label Posibles valores: ‘AUTOMATED’, ‘LEARN_MORE’, ‘GET_QUOTE’, ‘APPLY_NOW’, ‘SIGN_UP’, ‘CONTACT_US’, ‘SUBSCRIBE’, ‘DOWNLOAD’, ‘BOOK_NOW’, ‘SHOP_NOW’, ‘BUY_NOW’, ‘DONATE_NOW’, ‘ORDER_NOW’, ‘PLAY_NOW’, ‘SEE_MORE’

businessName

string

default:"Acme Corp"

Business name

youtubeVideoLinks

object[]

YouTube video links

Show cada item

youtubeVideoId

string

required

YouTube video ID

carouselCards

object[]

Carousel cards

Show cada item

headline

string

default:"Shop Now"

Card headline

finalUrl

string

default:"https://example.com"

Card final URL

callToActionLabel

string

Call to action label

media

object[]

Card media items

Show cada item

type

string

Media type Posibles valores: ‘IMAGE’

src

string

default:"https://example.com/image.jpg"

Media source URL

isLogo

boolean

default:"False"

Is logo flag

error

string

Error message if media failed

url

string

Public URL of the media

imageType

string

Image type classification

placements

string[]

Channel placements

customChannels

boolean

Custom channels flag

keywords

object

Keyword targeting

publishingStatus

string

Ad group publishing status Posibles valores: ‘DRAFT’, ‘SCHEDULED’, ‘PUBLISHED’, ‘PUBLISHING’, ‘FAILED’, ‘IN_REVIEW’, ‘PAUSED’, ‘ARCHIVED’, ‘WITH_ISSUES’, ‘REJECTED’

adGroupError

string

Ad group-level error from Google

googleAdGroupId

string

Google Ads ad group resource ID

customChannels

boolean

Custom channels flag

selectedChannels

string[]

Selected channel placements

googleAudienceId

string

Google audience resource ID

audience

object

Ad group audience targeting

campaignGoal

object

Campaign goal config

adSchedule

object[]

Ad schedule rules

Show cada item

dayOfWeek

string

required

Day of week Posibles valores: ‘FRIDAY’, ‘MONDAY’, ‘SATURDAY’, ‘SUNDAY’, ‘THURSDAY’, ‘TUESDAY’, ‘UNKNOWN’, ‘UNSPECIFIED’, ‘WEDNESDAY’, ‘ALL_DAYS’, ‘MONDAY_TO_FRIDAY’, ‘SATURDAY_AND_SUNDAY’

from

string

default:"09:00"

required

Start time (HH:MM)

string

default:"17:00"

required

End time (HH:MM)

publishingStatus

string

Publishing status Posibles valores: ‘DRAFT’, ‘SCHEDULED’, ‘PUBLISHED’, ‘PUBLISHING’, ‘FAILED’, ‘IN_REVIEW’, ‘PAUSED’, ‘ARCHIVED’, ‘WITH_ISSUES’, ‘REJECTED’

googleAdAccountId

string

Google Ad account identifier

unpublishedChanges

boolean

Whether the campaign has unpublished changes

maximumCpc

number

Maximum CPC bid in micros

googleCampaignId

string

Google Ads campaign resource ID

source

string

default:"WEBSITE"

Traffic source

advancedOptions

object

Advanced options

Respuestas

200 - Response

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X PUT 'https://services.leadconnectorhq.com/ad-publishing/google/ads' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "string",
  "name": "My Campaign",
  "locationId": "loc_abc123",
  "advertisingChannelType": "SEARCH",
  "advertisingChannelSubType": "DEMAND_GEN",
  "goalType": "WEBSITE_TRAFFIC",
  "isEuPoliticalAds": false,
  "adGroups": [
    {
      "id": "string",
      "adGroupId": "string",
      "name": "Ad Group 1",
      "adCampaignId": "string",
      "adContent": [
        {}
      ],
      "publishingStatus": "DRAFT",
      "adGroupError": "string",
      "googleAdGroupId": "string",
      "customChannels": true,
      "selectedChannels": [
        "GMAIL"
      ],
      "googleAudienceId": "string"
    }
  ],
  "adSchedule": [
    {
      "dayOfWeek": "FRIDAY",
      "from": "09:00",
      "to": "17:00"
    }
  ],
  "publishingStatus": "DRAFT",
  "googleAdAccountId": "string",
  "unpublishedChanges": true,
  "maximumCpc": 0,
  "googleCampaignId": "string",
  "source": "WEBSITE",
  "advancedOptions": {}
}'

const response = await fetch('https://services.leadconnectorhq.com/ad-publishing/google/ads', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"id": "string", "name": "My Campaign", "locationId": "loc_abc123", "advertisingChannelType": "SEARCH", "advertisingChannelSubType": "DEMAND_GEN", "goalType": "WEBSITE_TRAFFIC", "isEuPoliticalAds": false, "adGroups": [{"id": "string", "adGroupId": "string", "name": "Ad Group 1", "adCampaignId": "string", "adContent": [{}], "publishingStatus": "DRAFT", "adGroupError": "string", "googleAdGroupId": "string", "customChannels": true, "selectedChannels": ["GMAIL"], "googleAudienceId": "string"}], "adSchedule": [{"dayOfWeek": "FRIDAY", "from": "09:00", "to": "17:00"}], "publishingStatus": "DRAFT", "googleAdAccountId": "string", "unpublishedChanges": true, "maximumCpc": 0, "googleCampaignId": "string", "source": "WEBSITE", "advancedOptions": {}}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'PUT',
    'https://services.leadconnectorhq.com/ad-publishing/google/ads',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"id": "string", "name": "My Campaign", "locationId": "loc_abc123", "advertisingChannelType": "SEARCH", "advertisingChannelSubType": "DEMAND_GEN", "goalType": "WEBSITE_TRAFFIC", "isEuPoliticalAds": false, "adGroups": [{"id": "string", "adGroupId": "string", "name": "Ad Group 1", "adCampaignId": "string", "adContent": [{}], "publishingStatus": "DRAFT", "adGroupError": "string", "googleAdGroupId": "string", "customChannels": true, "selectedChannels": ["GMAIL"], "googleAudienceId": "string"}], "adSchedule": [{"dayOfWeek": "FRIDAY", "from": "09:00", "to": "17:00"}], "publishingStatus": "DRAFT", "googleAdAccountId": "string", "unpublishedChanges": true, "maximumCpc": 0, "googleCampaignId": "string", "source": "WEBSITE", "advancedOptions": {}},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/ad-publishing/google/ads');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode({'id': 'string', 'name': 'My Campaign', 'locationId': 'loc_abc123', 'advertisingChannelType': 'SEARCH', 'advertisingChannelSubType': 'DEMAND_GEN', 'goalType': 'WEBSITE_TRAFFIC', 'isEuPoliticalAds': false, 'adGroups': [{'id': 'string', 'adGroupId': 'string', 'name': 'Ad Group 1', 'adCampaignId': 'string', 'adContent': [{}], 'publishingStatus': 'DRAFT', 'adGroupError': 'string', 'googleAdGroupId': 'string', 'customChannels': true, 'selectedChannels': ['GMAIL'], 'googleAudienceId': 'string'}], 'adSchedule': [{'dayOfWeek': 'FRIDAY', 'from': '09:00', 'to': '17:00'}], 'publishingStatus': 'DRAFT', 'googleAdAccountId': 'string', 'unpublishedChanges': true, 'maximumCpc': 0, 'googleCampaignId': 'string', 'source': 'WEBSITE', 'advancedOptions': {}}),
]);
$data = json_decode(curl_exec($ch), true);

​Autorización

​Body

​Respuestas

​Ejemplo

Autorización

Body

Respuestas

Ejemplo