This document provides the API specifications for the Ads Management system on the SmartNews Ads Platform. It is intended for developers who use the API to automate advertising operations.
To use the SmartNews Ads API, you must agree to the SmartNews Ads API Terms of Service.
API Help Page: https://help-ads.smartnews.com/item-4207/
For inquiries, please contact us through the following link: https://smartnews-ads.zendesk.com/hc/ja/requests/new?ticket_form_id=&u=1723081408
August 2024 - Initial release.
October 2024
conversion_attribution_mode
and added new fields click_attribution_window
and vimp_attribution_window
.metadata_ad_creative_format
and metrics_spent_before_this_month
to fields.county
to breakdown_type.INSTALL_WITH_IN_APP_EVENT
for optimization_goal.dynamic_ads_config (targeting_type, recency_days)
.catalog_image_creative_info
to creative.sort_by
, sort_order
, offset
, limit
.frequency_control
from audience
object in response.November 2024
locations
and iab_interest_categories
endpoints for use with AdGroup targeting./api/oauth/v1/access_tokens
.The base URL for all API requests is https://ads.smartnews.com/
.
For example, to call the GET Campaign endpoint, the request URL will be https://ads.smartnews.com/api/ma/v2/ad_accounts/{ad_account_id}/campaigns/{campaign_id}
To set the JWT token in the HTTP header based on the provided OpenAPI definition, please include the Authorization header with the following format:
Authorization: Bearer <access token>
Access tokens are generated using the OAuth API. Please refer to the OAuth API for more information.
Generate an access token for the developer application
grant_type required | string The grant type of the request. It should be 'client_credentials'. |
client_id required | integer <int64> The client id(developer app id) of the developer app. |
client_secret required | string The client secret of the developer app. Client secret is a credential generated when the developer app is created. |
{- "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
- "expires_in": 86400,
- "token_type": "Bearer",
- "scope": "ads-manager"
}
Revoke all active access tokens for the developer application
client_id required | integer <int64> The client id(developer app id) of the developer app. |
client_secret required | string The client secret of the developer app. Client secret is a credential generated when the developer app is created. |
{- "error": {
- "message": "string",
- "retriable": true
}
}
Get a list of metadata and metrics information for objects matching the query for the specified layer (Campaign/AdGroup/Ad).
The fields to include in the response must be specified by the API caller, using the fields
parameter.
Note: Only Ads Manager v2 objects can be retrieved by this API.
ad_account_id required | integer <int64> |
layer required | string (Layer) Enum: "campaigns" "ad_groups" "ads" |
since required | string <date-time> Example: since=2024-08-15T15:00:00Z Only include metrics from this datetime (inclusive). It must be specified in ISO 8601 format with UTC timezone (ends with |
until | string <date-time> Example: until=2024-08-15T15:00:00Z Only include metrics until this datetime (inclusive). It must be specified in ISO 8601 format with UTC timezone (ends with |
fields required | Array of strings (Field) Items Enum: "metadata_name" "metadata_created_at" "metadata_updated_at" "metadata_configured_status" "metadata_campaign_id" "metadata_campaign_name" "metadata_ad_group_id" "metadata_ad_group_name" "metadata_delivery_status" "metadata_is_migrated_from_v1" "metadata_has_any_video_ads" "metadata_objective" "metadata_optimization_event" "metadata_optimization_goal" "metadata_start_date_time" "metadata_end_date_time" "metadata_daily_budget_amount_micro" "metadata_daily_budget_amount" "metadata_ready_for_delivery" "metadata_is_large_unit_ads" "metadata_spending_limit" "metadata_thumbnails" "metadata_video" "metadata_moderation_status" "metadata_submission_status" "metadata_ad_headline" "metadata_ad_description" "metadata_ad_creative_format" "metrics_viewable_impression" "metrics_click" "metrics_ctr" "metrics_cpc" "metrics_cpm" "metrics_count_web_conversion" "metrics_cvr_web_conversion" "metrics_cpa_web_conversion" "metrics_count_purchase" "metrics_cvr_purchase" "metrics_cpa_purchase" "metrics_count_add_to_cart" "metrics_cvr_add_to_cart" "metrics_cpa_add_to_cart" "metrics_count_initiate_checkout" "metrics_cvr_initiate_checkout" "metrics_cpa_initiate_checkout" "metrics_count_submit_form" "metrics_cvr_submit_form" "metrics_cpa_submit_form" "metrics_count_subscribe" "metrics_cvr_subscribe" "metrics_cpa_subscribe" "metrics_count_complete_registration" "metrics_cvr_complete_registration" "metrics_cpa_complete_registration" "metrics_count_contact" "metrics_cvr_contact" "metrics_cpa_contact" "metrics_count_sign_up" "metrics_cvr_sign_up" "metrics_cpa_sign_up" "metrics_count_view_content" "metrics_cvr_view_content" "metrics_cpa_view_content" "metrics_count_add_payment_info" "metrics_cvr_add_payment_info" "metrics_cpa_add_payment_info" "metrics_count_add_to_wish_list" "metrics_cvr_add_to_wish_list" "metrics_cpa_add_to_wish_list" "metrics_count_visit_cart" "metrics_cvr_visit_cart" "metrics_cpa_visit_cart" "metrics_count_customize_product" "metrics_cvr_customize_product" "metrics_cpa_customize_product" "metrics_count_search" "metrics_cvr_search" "metrics_cpa_search" "metrics_count_booking" "metrics_cvr_booking" "metrics_cpa_booking" "metrics_count_download" "metrics_cvr_download" "metrics_cpa_download" "metrics_count_start_trial" "metrics_cvr_start_trial" "metrics_cpa_start_trial" "metrics_count_share" "metrics_cvr_share" "metrics_cpa_share" "metrics_count_login" "metrics_cvr_login" "metrics_cpa_login" "metrics_count_donate" "metrics_cvr_donate" "metrics_cpa_donate" "metrics_count_find_location" "metrics_cvr_find_location" "metrics_cpa_find_location" "metrics_count_time_spent" "metrics_cvr_time_spent" "metrics_cpa_time_spent" "metrics_count_install" "metrics_cvr_install" "metrics_cpa_install" "metrics_count_d1_retention" "metrics_cvr_d1_retention" "metrics_cpa_d1_retention" "metrics_budget_spent" "metrics_lifetime_spent" "metrics_spent_before_this_month" "metrics_video_views" "metrics_video_views_p25" "metrics_video_views_p50" "metrics_video_views_p75" "metrics_video_views_p95" "metrics_video_views_completed" "metrics_reach" "metrics_frequency" The fields to include in the response. For a detailed description of each field, see the response section under The prefix indicates whether the field will be present in the
Layer Specific Metadata fieldsCampaign
Ad Group
Ad
|
breakdown_type | string (BreakdownType) Enum: "age" "gender" "age_and_gender" "prefecture" "city" "connection_type" "os" "device_type" "carrier_type" "state" "county" Example: breakdown_type=age When specified, the report is broken down by the specified audience breakdown type. The breakdown can be found inside the |
breakdown_period | string (BreakdownPeriod) Enum: "hour" "day" Example: breakdown_period=hour The time period to breakdown the report by. The breakdown can be found inside the This option combines with the |
include_deleted | boolean (IncludeDeleted) Default: false Boolean flag for including deleted objects in the response. |
conversion_attribution_mode | string (ConversionAttributionMode) Deprecated Enum: "all" "click_through" Please use |
mobile_app_attribution_mode | string (MobileAppAttributionMode) Enum: "all" "mmp_only" The mobile app attribution mode for counting conversions of app campaigns only. The mobile app attribution mode will not be applied for web campaigns.
The counting conversions for web campaigns is affected by |
click_attribution_window | string (ClickAttributionWindow) Enum: "days_30" "days_14" "days_7" "day_1" The attribution window for counting conversions. Calculate the conversions that occur within the specified time window after a click. The default value is 30 days. |
vimp_attribution_window | string (VimpAttributionWindow) Enum: "day_1" "none" The attribution window for counting conversions. Calculate the conversions that occur within the specified time window after a viewable impression. The default value is 1 day. |
target_ids | Array of integers <int64> [ items <int64 > ] Filter by target id(s) (campaign_id for Campaign, ad_group_id for AdGroup, ad_id for Ad)
Only the ad object id of the specified layer (determined by the |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
{- "data": [
- {
- "type": "CAMPAIGN",
- "id": 0,
- "metadata": {
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "configured_status": "ACTIVE",
- "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "objective": "TRAFFIC",
- "optimization_event": "PURCHASE",
- "optimization_goal": "CLICKS",
- "start_date_time": "2046-01-07T16:02:00Z",
- "end_date_time": "2046-02-07T16:02:00Z",
- "daily_budget_amount_micro": 10000000000,
- "daily_budget_amount": "123.4",
- "ready_for_delivery": true,
- "has_any_video_ads": true,
- "is_migrated_from_v1": true,
- "is_large_unit_ads": true,
- "spending_limit": "123.4"
}, - "metrics": {
- "viewable_impression": 0,
- "click": 0,
- "ctr": "0.03",
- "cpc": "1.2",
- "cpm": "2.34",
- "count_web_conversion": 0,
- "cvr_web_conversion": "2.34",
- "cpa_web_conversion": "1.2",
- "count_purchase": 0,
- "cvr_purchase": "2.34",
- "cpa_purchase": "2.34",
- "count_add_to_cart": 0,
- "cvr_add_to_cart": "2.34",
- "cpa_add_to_cart": "2.34",
- "count_initiate_checkout": 0,
- "cvr_initiate_checkout": "2.34",
- "cpa_initiate_checkout": "2.34",
- "count_submit_form": 0,
- "cvr_submit_form": "2.34",
- "cpa_submit_form": "2.34",
- "count_subscribe": 0,
- "cvr_subscribe": "2.34",
- "cpa_subscribe": "2.34",
- "count_complete_registration": 0,
- "cvr_complete_registration": "2.34",
- "cpa_complete_registration": "2.34",
- "count_contact": 0,
- "cvr_contact": "2.34",
- "cpa_contact": "2.34",
- "count_sign_up": 0,
- "cvr_sign_up": "2.34",
- "cpa_sign_up": "2.34",
- "count_view_content": 0,
- "cvr_view_content": "2.34",
- "cpa_view_content": "2.34",
- "count_add_payment_info": 0,
- "cvr_add_payment_info": "2.34",
- "cpa_add_payment_info": "2.34",
- "count_add_to_wish_list": 0,
- "cvr_add_to_wish_list": "2.34",
- "cpa_add_to_wish_list": "2.34",
- "count_visit_cart": 0,
- "cvr_visit_cart": "2.34",
- "cpa_visit_cart": "2.34",
- "count_customize_product": 0,
- "cvr_customize_product": "2.34",
- "cpa_customize_product": "2.34",
- "count_search": 0,
- "cvr_search": "2.34",
- "cpa_search": "2.34",
- "count_booking": 0,
- "cvr_booking": "2.34",
- "cpa_booking": "2.34",
- "count_download": 0,
- "cvr_download": "2.34",
- "cpa_download": "2.34",
- "count_start_trial": 0,
- "cvr_start_trial": "2.34",
- "cpa_start_trial": "2.34",
- "count_share": 0,
- "cvr_share": "2.34",
- "cpa_share": "2.34",
- "count_login": 0,
- "cvr_login": "2.34",
- "cpa_login": "2.34",
- "count_donate": 0,
- "cvr_donate": "2.34",
- "cpa_donate": "2.34",
- "count_find_location": 0,
- "cvr_find_location": "2.34",
- "cpa_find_location": "2.34",
- "count_time_spent": 0,
- "cvr_time_spent": "2.34",
- "cpa_time_spent": "2.34",
- "count_install": 0,
- "cvr_install": "2.34",
- "cpa_install": "2.34",
- "count_d1_retention": 0,
- "cvr_d1_retention": "2.34",
- "cpa_d1_retention": "2.34",
- "budget_spent": "123.4",
- "lifetime_spent": "123.4",
- "spent_before_this_month": "123.4",
- "video_views": 0,
- "video_views_p25": 0,
- "video_views_p50": 0,
- "video_views_p75": 0,
- "video_views_p95": 0,
- "video_views_completed": 0,
- "reach": 0,
- "frequency": "0.2"
}, - "metrics_breakdown": [
- {
- "segment_name": "21-24 & MALE",
- "period": "2023-11-28, 2023-11-28 12:00",
- "viewable_impression": 0,
- "click": 0,
- "ctr": "0.03",
- "cpc": "1.2",
- "cpm": "2.34",
- "count_web_conversion": 0,
- "cvr_web_conversion": "2.34",
- "cpa_web_conversion": "1.2",
- "count_purchase": 0,
- "cvr_purchase": "2.34",
- "cpa_purchase": "2.34",
- "count_add_to_cart": 0,
- "cvr_add_to_cart": "2.34",
- "cpa_add_to_cart": "2.34",
- "count_initiate_checkout": 0,
- "cvr_initiate_checkout": "2.34",
- "cpa_initiate_checkout": "2.34",
- "count_submit_form": 0,
- "cvr_submit_form": "2.34",
- "cpa_submit_form": "2.34",
- "count_subscribe": 0,
- "cvr_subscribe": "2.34",
- "cpa_subscribe": "2.34",
- "count_complete_registration": 0,
- "cvr_complete_registration": "2.34",
- "cpa_complete_registration": "2.34",
- "count_contact": 0,
- "cvr_contact": "2.34",
- "cpa_contact": "2.34",
- "count_sign_up": 0,
- "cvr_sign_up": "2.34",
- "cpa_sign_up": "2.34",
- "count_view_content": 0,
- "cvr_view_content": "2.34",
- "cpa_view_content": "2.34",
- "count_add_payment_info": 0,
- "cvr_add_payment_info": "2.34",
- "cpa_add_payment_info": "2.34",
- "count_add_to_wish_list": 0,
- "cvr_add_to_wish_list": "2.34",
- "cpa_add_to_wish_list": "2.34",
- "count_visit_cart": 0,
- "cvr_visit_cart": "2.34",
- "cpa_visit_cart": "2.34",
- "count_customize_product": 0,
- "cvr_customize_product": "2.34",
- "cpa_customize_product": "2.34",
- "count_search": 0,
- "cvr_search": "2.34",
- "cpa_search": "2.34",
- "count_booking": 0,
- "cvr_booking": "2.34",
- "cpa_booking": "2.34",
- "count_download": 0,
- "cvr_download": "2.34",
- "cpa_download": "2.34",
- "count_start_trial": 0,
- "cvr_start_trial": "2.34",
- "cpa_start_trial": "2.34",
- "count_share": 0,
- "cvr_share": "2.34",
- "cpa_share": "2.34",
- "count_login": 0,
- "cvr_login": "2.34",
- "cpa_login": "2.34",
- "count_donate": 0,
- "cvr_donate": "2.34",
- "cpa_donate": "2.34",
- "count_find_location": 0,
- "cvr_find_location": "2.34",
- "cpa_find_location": "2.34",
- "count_time_spent": 0,
- "cvr_time_spent": "2.34",
- "cpa_time_spent": "2.34",
- "count_install": 0,
- "cvr_install": "2.34",
- "cpa_install": "2.34",
- "count_d1_retention": 0,
- "cvr_d1_retention": "2.34",
- "cpa_d1_retention": "2.34",
- "budget_spent": "123.4",
- "lifetime_spent": "123.4",
- "spent_before_this_month": "123.4",
- "video_views": 0,
- "video_views_p25": 0,
- "video_views_p50": 0,
- "video_views_p75": 0,
- "video_views_p95": 0,
- "video_views_completed": 0,
- "reach": 0,
- "frequency": "0.2"
}
], - "parent": {
- "id": 0,
- "type": "CAMPAIGN",
- "name": "string",
- "objective": "TRAFFIC",
- "optimization_event": "PURCHASE",
- "ready_for_delivery": true,
- "parent": { }
}
}
]
}
Get aggregated metrics information for objects matching the query for the specified layer (Campaign/AdGroup/Ad).
The fields to include in the response must be specified by the API caller, using the fields
parameter.
Note: Only Ads Manager v2 metrics can be retrieved by this API.
ad_account_id required | integer <int64> |
layer required | string (Layer) Enum: "campaigns" "ad_groups" "ads" |
since required | string <date-time> Show only records after and including this datetime; datetime must be specified in ISO 8601 format |
until | string <date-time> Show only records before and including this datetime; date must be specified in ISO 8601 format |
fields | Array of strings (Field) Items Enum: "metadata_name" "metadata_created_at" "metadata_updated_at" "metadata_configured_status" "metadata_campaign_id" "metadata_campaign_name" "metadata_ad_group_id" "metadata_ad_group_name" "metadata_delivery_status" "metadata_is_migrated_from_v1" "metadata_has_any_video_ads" "metadata_objective" "metadata_optimization_event" "metadata_optimization_goal" "metadata_start_date_time" "metadata_end_date_time" "metadata_daily_budget_amount_micro" "metadata_daily_budget_amount" "metadata_ready_for_delivery" "metadata_is_large_unit_ads" "metadata_spending_limit" "metadata_thumbnails" "metadata_video" "metadata_moderation_status" "metadata_submission_status" "metadata_ad_headline" "metadata_ad_description" "metadata_ad_creative_format" "metrics_viewable_impression" "metrics_click" "metrics_ctr" "metrics_cpc" "metrics_cpm" "metrics_count_web_conversion" "metrics_cvr_web_conversion" "metrics_cpa_web_conversion" "metrics_count_purchase" "metrics_cvr_purchase" "metrics_cpa_purchase" "metrics_count_add_to_cart" "metrics_cvr_add_to_cart" "metrics_cpa_add_to_cart" "metrics_count_initiate_checkout" "metrics_cvr_initiate_checkout" "metrics_cpa_initiate_checkout" "metrics_count_submit_form" "metrics_cvr_submit_form" "metrics_cpa_submit_form" "metrics_count_subscribe" "metrics_cvr_subscribe" "metrics_cpa_subscribe" "metrics_count_complete_registration" "metrics_cvr_complete_registration" "metrics_cpa_complete_registration" "metrics_count_contact" "metrics_cvr_contact" "metrics_cpa_contact" "metrics_count_sign_up" "metrics_cvr_sign_up" "metrics_cpa_sign_up" "metrics_count_view_content" "metrics_cvr_view_content" "metrics_cpa_view_content" "metrics_count_add_payment_info" "metrics_cvr_add_payment_info" "metrics_cpa_add_payment_info" "metrics_count_add_to_wish_list" "metrics_cvr_add_to_wish_list" "metrics_cpa_add_to_wish_list" "metrics_count_visit_cart" "metrics_cvr_visit_cart" "metrics_cpa_visit_cart" "metrics_count_customize_product" "metrics_cvr_customize_product" "metrics_cpa_customize_product" "metrics_count_search" "metrics_cvr_search" "metrics_cpa_search" "metrics_count_booking" "metrics_cvr_booking" "metrics_cpa_booking" "metrics_count_download" "metrics_cvr_download" "metrics_cpa_download" "metrics_count_start_trial" "metrics_cvr_start_trial" "metrics_cpa_start_trial" "metrics_count_share" "metrics_cvr_share" "metrics_cpa_share" "metrics_count_login" "metrics_cvr_login" "metrics_cpa_login" "metrics_count_donate" "metrics_cvr_donate" "metrics_cpa_donate" "metrics_count_find_location" "metrics_cvr_find_location" "metrics_cpa_find_location" "metrics_count_time_spent" "metrics_cvr_time_spent" "metrics_cpa_time_spent" "metrics_count_install" "metrics_cvr_install" "metrics_cpa_install" "metrics_count_d1_retention" "metrics_cvr_d1_retention" "metrics_cpa_d1_retention" "metrics_budget_spent" "metrics_lifetime_spent" "metrics_spent_before_this_month" "metrics_video_views" "metrics_video_views_p25" "metrics_video_views_p50" "metrics_video_views_p75" "metrics_video_views_p95" "metrics_video_views_completed" "metrics_reach" "metrics_frequency" The fields to include in the response. For a detailed description of each field, see the response section under Note: only fields beginning with |
include_deleted | boolean (IncludeDeleted) Default: false Boolean flag for including deleted objects in the response. |
conversion_attribution_mode | string (ConversionAttributionMode) Deprecated Enum: "all" "click_through" Please use |
mobile_app_attribution_mode | string (MobileAppAttributionMode) Enum: "all" "mmp_only" The mobile app attribution mode for counting conversions of app campaigns only. The mobile app attribution mode will not be applied for web campaigns.
The counting conversions for web campaigns is affected by |
click_attribution_window | string (ClickAttributionWindow) Enum: "days_30" "days_14" "days_7" "day_1" The attribution window for counting conversions. Calculate the conversions that occur within the specified time window after a click. The default value is 30 days. |
vimp_attribution_window | string (VimpAttributionWindow) Enum: "day_1" "none" The attribution window for counting conversions. Calculate the conversions that occur within the specified time window after a viewable impression. The default value is 1 day. |
target_ids | Array of integers <int64> [ items <int64 > ] Filter by target id(s) (campaign_id for Campaign, ad_group_id for AdGroup, ad_id for Ad)
Only the ad object id of the specified layer (determined by the |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
{- "total_objects": 0,
- "data": {
- "metadata": {
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "configured_status": "ACTIVE",
- "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "objective": "TRAFFIC",
- "optimization_event": "PURCHASE",
- "optimization_goal": "CLICKS",
- "start_date_time": "2046-01-07T16:02:00Z",
- "end_date_time": "2046-02-07T16:02:00Z",
- "daily_budget_amount_micro": 10000000000,
- "daily_budget_amount": "123.4",
- "ready_for_delivery": true,
- "has_any_video_ads": true,
- "is_migrated_from_v1": true,
- "is_large_unit_ads": true,
- "spending_limit": "123.4"
}, - "metrics": {
- "viewable_impression": 0,
- "click": 0,
- "ctr": "0.03",
- "cpc": "1.2",
- "cpm": "2.34",
- "count_web_conversion": 0,
- "cvr_web_conversion": "2.34",
- "cpa_web_conversion": "1.2",
- "count_purchase": 0,
- "cvr_purchase": "2.34",
- "cpa_purchase": "2.34",
- "count_add_to_cart": 0,
- "cvr_add_to_cart": "2.34",
- "cpa_add_to_cart": "2.34",
- "count_initiate_checkout": 0,
- "cvr_initiate_checkout": "2.34",
- "cpa_initiate_checkout": "2.34",
- "count_submit_form": 0,
- "cvr_submit_form": "2.34",
- "cpa_submit_form": "2.34",
- "count_subscribe": 0,
- "cvr_subscribe": "2.34",
- "cpa_subscribe": "2.34",
- "count_complete_registration": 0,
- "cvr_complete_registration": "2.34",
- "cpa_complete_registration": "2.34",
- "count_contact": 0,
- "cvr_contact": "2.34",
- "cpa_contact": "2.34",
- "count_sign_up": 0,
- "cvr_sign_up": "2.34",
- "cpa_sign_up": "2.34",
- "count_view_content": 0,
- "cvr_view_content": "2.34",
- "cpa_view_content": "2.34",
- "count_add_payment_info": 0,
- "cvr_add_payment_info": "2.34",
- "cpa_add_payment_info": "2.34",
- "count_add_to_wish_list": 0,
- "cvr_add_to_wish_list": "2.34",
- "cpa_add_to_wish_list": "2.34",
- "count_visit_cart": 0,
- "cvr_visit_cart": "2.34",
- "cpa_visit_cart": "2.34",
- "count_customize_product": 0,
- "cvr_customize_product": "2.34",
- "cpa_customize_product": "2.34",
- "count_search": 0,
- "cvr_search": "2.34",
- "cpa_search": "2.34",
- "count_booking": 0,
- "cvr_booking": "2.34",
- "cpa_booking": "2.34",
- "count_download": 0,
- "cvr_download": "2.34",
- "cpa_download": "2.34",
- "count_start_trial": 0,
- "cvr_start_trial": "2.34",
- "cpa_start_trial": "2.34",
- "count_share": 0,
- "cvr_share": "2.34",
- "cpa_share": "2.34",
- "count_login": 0,
- "cvr_login": "2.34",
- "cpa_login": "2.34",
- "count_donate": 0,
- "cvr_donate": "2.34",
- "cpa_donate": "2.34",
- "count_find_location": 0,
- "cvr_find_location": "2.34",
- "cpa_find_location": "2.34",
- "count_time_spent": 0,
- "cvr_time_spent": "2.34",
- "cpa_time_spent": "2.34",
- "count_install": 0,
- "cvr_install": "2.34",
- "cpa_install": "2.34",
- "count_d1_retention": 0,
- "cvr_d1_retention": "2.34",
- "cpa_d1_retention": "2.34",
- "budget_spent": "123.4",
- "lifetime_spent": "123.4",
- "spent_before_this_month": "123.4",
- "video_views": 0,
- "video_views_p25": 0,
- "video_views_p50": 0,
- "video_views_p75": 0,
- "video_views_p95": 0,
- "video_views_completed": 0,
- "reach": 0,
- "frequency": "0.2"
}
}
}
Create a campaign object. An ad account can only have up to 1,000 campaigns.
When the number of campaigns exceed the limit, the API returns a Business Error.
ad_account_id required | integer <int64> |
source | string (Source) Value: "copy" The way how this campaign object is created. This parameter is used to distinguish whether the campaign is created normally ( |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
name required | string (Name) [ 1 .. 256 ] characters The name of the campaign. Note: The maximum length is calculated by our standard length calculation rules: See details | |||||||||||||||||||||||||||
objective required | string (CampaignObjective) Enum: "TRAFFIC" "SALES" "AWARENESS" "APP_PROMOTION" The objective of the campaign. It defines the business goal that customers pursue during a campaign.\ Note: Only | |||||||||||||||||||||||||||
website_tracking_tag | string or null (WebsiteTrackingTag) The pixel tag id that is used to report web events generated through a campaign. This field is not updatable when | |||||||||||||||||||||||||||
daily_budget_amount_micro required | integer <int64> (DailyBudgetAmountMicro) The average budget per day in micros of the ad account currency base unit.
The API will return an error if the provided value is not divisible by the minimum unit. | |||||||||||||||||||||||||||
bid_strategy required | string (BidStrategy) Enum: "MANUAL" "HIGHEST_VOLUME" "TARGET_COST" The strategy that defines how the amount of bid is decided.
| |||||||||||||||||||||||||||
target_cost_micro | integer or null <int64> (TargetCostMicro) The cost per acquisition in micros of the ad account currency base unit.
The API will return an error if the provided value is not divisible by the minimum unit. | |||||||||||||||||||||||||||
bid_amount_micro | integer or null <int64> (BidAmountMicro) The bidding amount for
The API will return an error if the provided value is not divisible by the minimum unit. | |||||||||||||||||||||||||||
billing_event required | string Enum: "CLICK" "VIEWABLE_IMPRESSION" The type of event that the ad account wants to pay for the campaign.
This field is not updatable when | |||||||||||||||||||||||||||
optimization_goal | string or null (OptimizationGoal) Enum: "CLICKS" "OFFSITE_CONVERSIONS" "VIEWABLE_IMPRESSIONS" "INSTALL" "INSTALL_WITH_IN_APP_EVENT" Optimization goal defines how the campaign is optimized. This is required and configurable unless bidding strategy is
This field is not updatable when | |||||||||||||||||||||||||||
delivery_type | string or null (DeliveryType) Enum: "STANDARD" "ACCELERATED" Delivery type adjusts the speed of budget spending throughout the day. If
| |||||||||||||||||||||||||||
optimization_event | string or null (OptimizationEvent) Enum: "PURCHASE" "ADD_TO_CART" "INITIATE_CHECKOUT" "SUBMIT_FORM" "SUBSCRIBE" "COMPLETE_REGISTRATION" "CONTACT" "SIGN_UP" "VIEW_CONTENT" "ADD_PAYMENT_INFO" "ADD_TO_WISH_LIST" "VISIT_CART" "CUSTOMIZE_PRODUCT" "SEARCH" "BOOKING" "DOWNLOAD" "START_TRIAL" "SHARE" "LOGIN" "DONATE" "FIND_LOCATION" "TIME_SPENT" "INSTALL" "D1_RETENTION" Optimization event defines which conversion event the campaign is optimized for.
This field is not updatable when | |||||||||||||||||||||||||||
start_date_time required | string <date-time> (StartDateTime) The date-time at which the campaign is scheduled to start. Minimum value: ≥ today (ad account based timezone) The API rejects the value if seconds / milliseconds are specified except 0. This field is not updatable when | |||||||||||||||||||||||||||
end_date_time | string or null <date-time> (EndDateTime) The date-time at which the campaign is scheduled to end. Minimum value: max( The API rejects the value if seconds / milliseconds are specified except 0. This field is nullable. When it is set to | |||||||||||||||||||||||||||
configured_status required | string (ConfiguredStatus) Enum: "ACTIVE" "PAUSED" "DELETED" The status of the object configured by an ad operator. | |||||||||||||||||||||||||||
spending_limit_micro | integer <int64> (SpendingLimitMicro) The life-time spending limit in micros of the ad account currency base unit. Null means there is no limit.
The API will return an error if the provided value is not divisible by the minimum unit.
After the creation, please refer to the | |||||||||||||||||||||||||||
object (ViewabilityMeasurement) Configuration for 3rd party viewability measurement provider. It is not editable when the campaign is ready for delivery. Currently, only MOAT is supported. | ||||||||||||||||||||||||||||
click_destination_type | string or null (ClickDestinationType) Enum: "WEB_VIEW" "BROWSER" "APP" "APP_STORE" This defines which components SmartNews opens after an ad is clicked. If click_destination_type = null when creating campaign then default value is set as below:
| |||||||||||||||||||||||||||
is_large_unit_ads | boolean (IsLargeUnitAds) A boolean flag that indicates whether ads from this campaign are displayed in the app using the large unit format. Currently Only effective for awareness campaigns.\ Note: This field is not settable for US region ad accounts. | |||||||||||||||||||||||||||
is_multi_order_attribution | boolean (IsMultiOrderAttribution) If enabled, multiple Purchase event postbacks generated from the same click are recorded as separate Purchase events. Otherwise, only the first postback will be recorded. The default value is Note: only usable when campaign objective is | |||||||||||||||||||||||||||
is_dynamic_ads | boolean (IsDynamicAds) Default: false A boolean flag that indicates whether the campaign is dynamic ads or standard ads.\ Note: The US region ad accounts are not allowed to create dynamic ads campaigns. Currently supported objectives for dynamic ads campaigns:
| |||||||||||||||||||||||||||
object (DynamicAdsInfo) Configuration specific to dynamic ads campaigns. If | ||||||||||||||||||||||||||||
budget_auto_target_cpa_micro | integer or null <int64> (BudgetAutoTargetCpaMicro) Default: null Budget Auto-adjustment Expected CPA in micros of the ad account currency base unit. This value is only able to be set when campaign objective is | |||||||||||||||||||||||||||
object (AppPromotionInfo) Configuration specific to App Promotion objective campaigns. It is required when |
{- "name": "string",
- "objective": "TRAFFIC",
- "website_tracking_tag": "89d2b4523c7245ee9ec773a8",
- "daily_budget_amount_micro": 10000000000,
- "bid_strategy": "MANUAL",
- "target_cost_micro": 0,
- "bid_amount_micro": 0,
- "billing_event": "CLICK",
- "optimization_goal": "CLICKS",
- "delivery_type": "STANDARD",
- "optimization_event": "PURCHASE",
- "start_date_time": "2046-01-07T16:02:00Z",
- "end_date_time": "2046-02-07T16:02:00Z",
- "configured_status": "ACTIVE",
- "spending_limit_micro": 10000000000,
- "viewability_measurement": {
- "vendor_type": "MOAT",
- "vendor_key": "string",
- "verification_parameters": "{\"campaign_name\": \"{campaign_name}\"}",
}, - "click_destination_type": "WEB_VIEW",
- "is_large_unit_ads": true,
- "is_multi_order_attribution": false,
- "is_dynamic_ads": false,
- "dynamic_ads_info": {
- "catalog_id": 0
}, - "budget_auto_target_cpa_micro": 10000000000,
- "app_promotion_info": {
- "promotion_type": "INSTALL",
- "operating_system": "IOS",
- "store_id": "string",
- "mmp_type": "ADJUST",
- "mmp_tracking_url": "string"
}
}
{- "name": "string",
- "objective": "TRAFFIC",
- "website_tracking_tag": "89d2b4523c7245ee9ec773a8",
- "daily_budget_amount_micro": 10000000000,
- "bid_strategy": "MANUAL",
- "target_cost_micro": 0,
- "bid_amount_micro": 0,
- "billing_event": "CLICK",
- "optimization_goal": "CLICKS",
- "delivery_type": "STANDARD",
- "optimization_event": "PURCHASE",
- "start_date_time": "2046-01-07T16:02:00Z",
- "end_date_time": "2046-02-07T16:02:00Z",
- "configured_status": "ACTIVE",
- "spending_limit_micro": 10000000000,
- "viewability_measurement": {
- "vendor_type": "MOAT",
- "vendor_key": "string",
- "verification_parameters": "{\"campaign_name\": \"{campaign_name}\"}",
}, - "click_destination_type": "WEB_VIEW",
- "is_large_unit_ads": true,
- "is_multi_order_attribution": false,
- "is_dynamic_ads": false,
- "dynamic_ads_info": {
- "catalog_id": 0
}, - "budget_auto_target_cpa_micro": 10000000000,
- "app_promotion_info": {
- "promotion_type": "INSTALL",
- "operating_system": "IOS",
- "store_id": "string",
- "mmp_type": "ADJUST",
- "mmp_tracking_url": "string"
}, - "campaign_id": 0,
- "ad_account_id": 0,
- "buying_type": "AUCTION",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ready_for_delivery": true,
- "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "total_spending": "10000",
- "minimal_spending_limit_micro": 10000000000,
- "has_any_video_ads": true,
- "is_migrated_from_v1": true
}
Get an array of campaign objects.
ad_account_id required | integer <int64> |
include_deleted | boolean (IncludeDeleted) Default: false Boolean flag for including deleted campaigns in the response. |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
{- "data": [
- {
- "name": "string",
- "objective": "TRAFFIC",
- "website_tracking_tag": "89d2b4523c7245ee9ec773a8",
- "daily_budget_amount_micro": 10000000000,
- "bid_strategy": "MANUAL",
- "target_cost_micro": 0,
- "bid_amount_micro": 0,
- "billing_event": "CLICK",
- "optimization_goal": "CLICKS",
- "delivery_type": "STANDARD",
- "optimization_event": "PURCHASE",
- "start_date_time": "2046-01-07T16:02:00Z",
- "end_date_time": "2046-02-07T16:02:00Z",
- "configured_status": "ACTIVE",
- "spending_limit_micro": 10000000000,
- "viewability_measurement": {
- "vendor_type": "MOAT",
- "vendor_key": "string",
- "verification_parameters": "{\"campaign_name\": \"{campaign_name}\"}",
}, - "click_destination_type": "WEB_VIEW",
- "is_large_unit_ads": true,
- "is_multi_order_attribution": false,
- "is_dynamic_ads": false,
- "dynamic_ads_info": {
- "catalog_id": 0
}, - "budget_auto_target_cpa_micro": 10000000000,
- "app_promotion_info": {
- "promotion_type": "INSTALL",
- "operating_system": "IOS",
- "store_id": "string",
- "mmp_type": "ADJUST",
- "mmp_tracking_url": "string"
}, - "campaign_id": 0,
- "ad_account_id": 0,
- "buying_type": "AUCTION",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ready_for_delivery": true,
- "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "total_spending": "10000",
- "minimal_spending_limit_micro": 10000000000,
- "has_any_video_ads": true,
- "is_migrated_from_v1": true
}
]
}
Get a single campaign object.
ad_account_id required | integer <int64> |
campaign_id required | integer <int64> |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
{- "name": "string",
- "objective": "TRAFFIC",
- "website_tracking_tag": "89d2b4523c7245ee9ec773a8",
- "daily_budget_amount_micro": 10000000000,
- "bid_strategy": "MANUAL",
- "target_cost_micro": 0,
- "bid_amount_micro": 0,
- "billing_event": "CLICK",
- "optimization_goal": "CLICKS",
- "delivery_type": "STANDARD",
- "optimization_event": "PURCHASE",
- "start_date_time": "2046-01-07T16:02:00Z",
- "end_date_time": "2046-02-07T16:02:00Z",
- "configured_status": "ACTIVE",
- "spending_limit_micro": 10000000000,
- "viewability_measurement": {
- "vendor_type": "MOAT",
- "vendor_key": "string",
- "verification_parameters": "{\"campaign_name\": \"{campaign_name}\"}",
}, - "click_destination_type": "WEB_VIEW",
- "is_large_unit_ads": true,
- "is_multi_order_attribution": false,
- "is_dynamic_ads": false,
- "dynamic_ads_info": {
- "catalog_id": 0
}, - "budget_auto_target_cpa_micro": 10000000000,
- "app_promotion_info": {
- "promotion_type": "INSTALL",
- "operating_system": "IOS",
- "store_id": "string",
- "mmp_type": "ADJUST",
- "mmp_tracking_url": "string"
}, - "campaign_id": 0,
- "ad_account_id": 0,
- "buying_type": "AUCTION",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ready_for_delivery": true,
- "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "total_spending": "10000",
- "minimal_spending_limit_micro": 10000000000,
- "has_any_video_ads": true,
- "is_migrated_from_v1": true
}
Update an existing campaign by using the JSON Merge Patch specification, described in RFC 7396.
ad_account_id required | integer <int64> |
campaign_id required | integer <int64> |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
name | string (Name) [ 1 .. 256 ] characters The name of the campaign. Note: The maximum length is calculated by our standard length calculation rules: See details | |||||||||||||||||||||||||||
configured_status | string (ConfiguredStatus) Enum: "ACTIVE" "PAUSED" "DELETED" The status of the object configured by an ad operator. | |||||||||||||||||||||||||||
daily_budget_amount_micro | integer <int64> (DailyBudgetAmountMicro) The average budget per day in micros of the ad account currency base unit.
The API will return an error if the provided value is not divisible by the minimum unit. | |||||||||||||||||||||||||||
website_tracking_tag | string or null (WebsiteTrackingTag) The pixel tag id that is used to report web events generated through a campaign. This field is not updatable when | |||||||||||||||||||||||||||
optimization_event | string or null (OptimizationEvent) Enum: "PURCHASE" "ADD_TO_CART" "INITIATE_CHECKOUT" "SUBMIT_FORM" "SUBSCRIBE" "COMPLETE_REGISTRATION" "CONTACT" "SIGN_UP" "VIEW_CONTENT" "ADD_PAYMENT_INFO" "ADD_TO_WISH_LIST" "VISIT_CART" "CUSTOMIZE_PRODUCT" "SEARCH" "BOOKING" "DOWNLOAD" "START_TRIAL" "SHARE" "LOGIN" "DONATE" "FIND_LOCATION" "TIME_SPENT" "INSTALL" "D1_RETENTION" Optimization event defines which conversion event the campaign is optimized for.
This field is not updatable when | |||||||||||||||||||||||||||
start_date_time | string <date-time> (StartDateTime) The date-time at which the campaign is scheduled to start. Minimum value: ≥ today (ad account based timezone) The API rejects the value if seconds / milliseconds are specified except 0. This field is not updatable when | |||||||||||||||||||||||||||
end_date_time | string or null <date-time> (EndDateTime) The date-time at which the campaign is scheduled to end. Minimum value: max( The API rejects the value if seconds / milliseconds are specified except 0. This field is nullable. When it is set to | |||||||||||||||||||||||||||
bid_strategy | string (BidStrategy) Enum: "MANUAL" "HIGHEST_VOLUME" "TARGET_COST" The strategy that defines how the amount of bid is decided.
| |||||||||||||||||||||||||||
target_cost_micro | integer or null <int64> (TargetCostMicro) The cost per acquisition in micros of the ad account currency base unit.
The API will return an error if the provided value is not divisible by the minimum unit. | |||||||||||||||||||||||||||
bid_amount_micro | integer or null <int64> (BidAmountMicro) The bidding amount for
The API will return an error if the provided value is not divisible by the minimum unit. | |||||||||||||||||||||||||||
optimization_goal | string or null (OptimizationGoal) Enum: "CLICKS" "OFFSITE_CONVERSIONS" "VIEWABLE_IMPRESSIONS" "INSTALL" "INSTALL_WITH_IN_APP_EVENT" Optimization goal defines how the campaign is optimized. This is required and configurable unless bidding strategy is
This field is not updatable when | |||||||||||||||||||||||||||
delivery_type | string or null (DeliveryType) Enum: "STANDARD" "ACCELERATED" Delivery type adjusts the speed of budget spending throughout the day. If
| |||||||||||||||||||||||||||
spending_limit_micro | integer <int64> (SpendingLimitMicro) The life-time spending limit in micros of the ad account currency base unit. Null means there is no limit.
The API will return an error if the provided value is not divisible by the minimum unit.
After the creation, please refer to the | |||||||||||||||||||||||||||
object (ViewabilityMeasurement) Configuration for 3rd party viewability measurement provider. It is not editable when the campaign is ready for delivery. Currently, only MOAT is supported. | ||||||||||||||||||||||||||||
click_destination_type | string or null (ClickDestinationType) Enum: "WEB_VIEW" "BROWSER" "APP" "APP_STORE" This defines which components SmartNews opens after an ad is clicked. If click_destination_type = null when creating campaign then default value is set as below:
| |||||||||||||||||||||||||||
is_large_unit_ads | boolean (IsLargeUnitAds) A boolean flag that indicates whether ads from this campaign are displayed in the app using the large unit format. Currently Only effective for awareness campaigns.\ Note: This field is not settable for US region ad accounts. | |||||||||||||||||||||||||||
is_multi_order_attribution | boolean (IsMultiOrderAttribution) If enabled, multiple Purchase event postbacks generated from the same click are recorded as separate Purchase events. Otherwise, only the first postback will be recorded. The default value is Note: only usable when campaign objective is | |||||||||||||||||||||||||||
budget_auto_target_cpa_micro | integer or null <int64> (BudgetAutoTargetCpaMicro) Default: null Budget Auto-adjustment Expected CPA in micros of the ad account currency base unit. This value is only able to be set when campaign objective is | |||||||||||||||||||||||||||
object (PatchAppPromotionInfo) It contains the fields of AppPromotionInfo which are updatable. |
{- "name": "string",
- "configured_status": "ACTIVE",
- "daily_budget_amount_micro": 10000000000,
- "website_tracking_tag": "89d2b4523c7245ee9ec773a8",
- "optimization_event": "PURCHASE",
- "start_date_time": "2046-01-07T16:02:00Z",
- "end_date_time": "2046-02-07T16:02:00Z",
- "bid_strategy": "MANUAL",
- "target_cost_micro": 0,
- "bid_amount_micro": 0,
- "optimization_goal": "CLICKS",
- "delivery_type": "STANDARD",
- "spending_limit_micro": 10000000000,
- "viewability_measurement": {
- "vendor_type": "MOAT",
- "vendor_key": "string",
- "verification_parameters": "{\"campaign_name\": \"{campaign_name}\"}",
}, - "click_destination_type": "WEB_VIEW",
- "is_large_unit_ads": true,
- "is_multi_order_attribution": false,
- "budget_auto_target_cpa_micro": 10000000000,
- "app_promotion_info": {
- "mmp_type": "ADJUST",
- "mmp_tracking_url": "string"
}
}
{- "name": "string",
- "objective": "TRAFFIC",
- "website_tracking_tag": "89d2b4523c7245ee9ec773a8",
- "daily_budget_amount_micro": 10000000000,
- "bid_strategy": "MANUAL",
- "target_cost_micro": 0,
- "bid_amount_micro": 0,
- "billing_event": "CLICK",
- "optimization_goal": "CLICKS",
- "delivery_type": "STANDARD",
- "optimization_event": "PURCHASE",
- "start_date_time": "2046-01-07T16:02:00Z",
- "end_date_time": "2046-02-07T16:02:00Z",
- "configured_status": "ACTIVE",
- "spending_limit_micro": 10000000000,
- "viewability_measurement": {
- "vendor_type": "MOAT",
- "vendor_key": "string",
- "verification_parameters": "{\"campaign_name\": \"{campaign_name}\"}",
}, - "click_destination_type": "WEB_VIEW",
- "is_large_unit_ads": true,
- "is_multi_order_attribution": false,
- "is_dynamic_ads": false,
- "dynamic_ads_info": {
- "catalog_id": 0
}, - "budget_auto_target_cpa_micro": 10000000000,
- "app_promotion_info": {
- "promotion_type": "INSTALL",
- "operating_system": "IOS",
- "store_id": "string",
- "mmp_type": "ADJUST",
- "mmp_tracking_url": "string"
}, - "campaign_id": 0,
- "ad_account_id": 0,
- "buying_type": "AUCTION",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ready_for_delivery": true,
- "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "total_spending": "10000",
- "minimal_spending_limit_micro": 10000000000,
- "has_any_video_ads": true,
- "is_migrated_from_v1": true
}
Delete an existing campaign and all of its ad-groups and ads. The API returns a business error if the campaign cannot be deleted due to business logic constraints.
ad_account_id required | integer <int64> |
campaign_id required | integer <int64> |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
{- "error": {
- "type": "UNAUTHORIZED",
- "message": "string",
- "retriable": true
}
}
Get a single Ad Group object.
ad_account_id required | integer <int64> |
ad_group_id required | integer <int64> |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
{- "name": "string",
- "audience": {
- "ages": [
- "AGE_UNDER_20"
], - "genders": [
- "MALE"
], - "locations": [
- 0
], - "operating_system": {
- "type": "IOS",
- "since_version": "string"
}, - "custom_audiences": {
- "include": [
- 0
], - "exclude": [
- 0
]
}, - "connection_types": [
- "WIFI"
], - "carrier_types": [
- "DOCOMO"
], - "interests": [
- 0
], - "media_types": [
- "SMART_VIEW"
], - "channel_alias_labels": [
- "CR_JA_TOP"
], - "automated_targeting": {
- "age_unbreakable": false,
- "gender_unbreakable": false,
- "location_unbreakable": false,
- "custom_audience_unbreakable": false,
- "carrier_unbreakable": false,
- "connection_type_unbreakable": false,
- "os_version_unbreakable": false
}
}, - "frequency_control": {
- "interval": "LAST_1_DAY",
- "threshold": 0
}, - "configured_status": "ACTIVE",
- "dynamic_ads_config": {
- "targeting_type": "RETARGETING",
- "recency_days": "LAST_1_DAY"
}, - "campaign_id": 0,
- "ad_group_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "parent": {
- "id": 0,
- "type": "CAMPAIGN",
- "name": "string",
- "objective": "TRAFFIC",
- "optimization_event": "PURCHASE",
- "ready_for_delivery": true,
- "parent": { }
}, - "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "has_any_video_ads": true,
- "is_migrated_from_v1": true
}
Update an existing ad group by using the JSON Merge Patch specification, described in RFC 7396.
ad_account_id required | integer <int64> |
ad_group_id required | integer <int64> |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
name | string (AdGroupSchemas_Name) [ 1 .. 256 ] characters The name of the ad group. Note: The maximum length is calculated by our standard length calculation rules: See details |
configured_status | string (ConfiguredStatus) Enum: "ACTIVE" "PAUSED" "DELETED" The status of the object configured by an ad operator. |
object or null (FrequencyControl) Frequency control settings for the ads to be delivered. Only available for Awareness campaign. Note: This field is not settable for US region ad accounts. | |
object (AudienceRequest) In Patch Request, if you omit the property, the data will remain unchanged. If you want to remove the current settings, set individual fields to either e.g. This will remove the current settings of ages and genders, while keeping the locations and other audience fields unchanged:
| |
object (DynamicAdsConfigSchema) The Configuration of the dynamic ads. If campaign is for dynamic ads, this object is required. |
{- "name": "string",
- "configured_status": "ACTIVE",
- "frequency_control": {
- "interval": "LAST_1_DAY",
- "threshold": 0
}, - "audience": {
- "ages": [
- "AGE_UNDER_20"
], - "genders": [
- "MALE"
], - "locations": [
- 0
], - "operating_system": {
- "type": "IOS",
- "since_version": "string"
}, - "custom_audiences": {
- "include": [
- 0
], - "exclude": [
- 0
]
}, - "connection_types": [
- "WIFI"
], - "carrier_types": [
- "DOCOMO"
], - "interests": [
- 0
], - "media_types": [
- "SMART_VIEW"
], - "channel_alias_labels": [
- "CR_JA_TOP"
], - "automated_targeting": {
- "age_unbreakable": false,
- "gender_unbreakable": false,
- "location_unbreakable": false,
- "custom_audience_unbreakable": false,
- "carrier_unbreakable": false,
- "connection_type_unbreakable": false,
- "os_version_unbreakable": false
}
}, - "dynamic_ads_config": {
- "targeting_type": "RETARGETING",
- "recency_days": "LAST_1_DAY"
}
}
{- "name": "string",
- "audience": {
- "ages": [
- "AGE_UNDER_20"
], - "genders": [
- "MALE"
], - "locations": [
- 0
], - "operating_system": {
- "type": "IOS",
- "since_version": "string"
}, - "custom_audiences": {
- "include": [
- 0
], - "exclude": [
- 0
]
}, - "connection_types": [
- "WIFI"
], - "carrier_types": [
- "DOCOMO"
], - "interests": [
- 0
], - "media_types": [
- "SMART_VIEW"
], - "channel_alias_labels": [
- "CR_JA_TOP"
], - "automated_targeting": {
- "age_unbreakable": false,
- "gender_unbreakable": false,
- "location_unbreakable": false,
- "custom_audience_unbreakable": false,
- "carrier_unbreakable": false,
- "connection_type_unbreakable": false,
- "os_version_unbreakable": false
}
}, - "frequency_control": {
- "interval": "LAST_1_DAY",
- "threshold": 0
}, - "configured_status": "ACTIVE",
- "dynamic_ads_config": {
- "targeting_type": "RETARGETING",
- "recency_days": "LAST_1_DAY"
}, - "campaign_id": 0,
- "ad_group_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "parent": {
- "id": 0,
- "type": "CAMPAIGN",
- "name": "string",
- "objective": "TRAFFIC",
- "optimization_event": "PURCHASE",
- "ready_for_delivery": true,
- "parent": { }
}, - "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "has_any_video_ads": true,
- "is_migrated_from_v1": true
}
Delete an existing ad-group and its children(ad). The API returns a business error if the ad-group has any ads that cannot be deleted.
ad_account_id required | integer <int64> |
ad_group_id required | integer <int64> |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
{- "error": {
- "type": "UNAUTHORIZED",
- "message": "string",
- "retriable": true
}
}
Get an array of adgroup under a specified ad account
ad_account_id required | integer <int64> |
include_deleted | boolean (IncludeDeleted) Default: false Boolean flag for including deleted ad groups in the response. |
Accept-Language | string |
{- "data": [
- {
- "name": "string",
- "audience": {
- "ages": [
- "AGE_UNDER_20"
], - "genders": [
- "MALE"
], - "locations": [
- 0
], - "operating_system": {
- "type": "IOS",
- "since_version": "string"
}, - "custom_audiences": {
- "include": [
- 0
], - "exclude": [
- 0
]
}, - "connection_types": [
- "WIFI"
], - "carrier_types": [
- "DOCOMO"
], - "interests": [
- 0
], - "media_types": [
- "SMART_VIEW"
], - "channel_alias_labels": [
- "CR_JA_TOP"
], - "automated_targeting": {
- "age_unbreakable": false,
- "gender_unbreakable": false,
- "location_unbreakable": false,
- "custom_audience_unbreakable": false,
- "carrier_unbreakable": false,
- "connection_type_unbreakable": false,
- "os_version_unbreakable": false
}
}, - "frequency_control": {
- "interval": "LAST_1_DAY",
- "threshold": 0
}, - "configured_status": "ACTIVE",
- "dynamic_ads_config": {
- "targeting_type": "RETARGETING",
- "recency_days": "LAST_1_DAY"
}, - "campaign_id": 0,
- "ad_group_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "parent": {
- "id": 0,
- "type": "CAMPAIGN",
- "name": "string",
- "objective": "TRAFFIC",
- "optimization_event": "PURCHASE",
- "ready_for_delivery": true,
- "parent": { }
}, - "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "has_any_video_ads": true,
- "is_migrated_from_v1": true
}
]
}
Create an ad group object. A campaign can only have up to 1,000 ad groups.
When the number of ad groups exceed the limit, the API returns a Business Error.
ad_account_id required | integer <int64> |
campaign_id required | integer <int64> |
source | string (Source) Value: "copy" The way how this ad group object is created. This parameter is used to distinguish whether the campaign is created normally ( |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
name required | string (AdGroupSchemas_Name) [ 1 .. 256 ] characters The name of the ad group. Note: The maximum length is calculated by our standard length calculation rules: See details |
object (AudienceRequest) In Patch Request, if you omit the property, the data will remain unchanged. If you want to remove the current settings, set individual fields to either e.g. This will remove the current settings of ages and genders, while keeping the locations and other audience fields unchanged:
| |
object or null (FrequencyControl) Frequency control settings for the ads to be delivered. Only available for Awareness campaign. Note: This field is not settable for US region ad accounts. | |
configured_status required | string (ConfiguredStatus) Enum: "ACTIVE" "PAUSED" "DELETED" The status of the object configured by an ad operator. |
object (DynamicAdsConfigSchema) The Configuration of the dynamic ads. If campaign is for dynamic ads, this object is required. |
{- "name": "string",
- "audience": {
- "ages": [
- "AGE_UNDER_20"
], - "genders": [
- "MALE"
], - "locations": [
- 0
], - "operating_system": {
- "type": "IOS",
- "since_version": "string"
}, - "custom_audiences": {
- "include": [
- 0
], - "exclude": [
- 0
]
}, - "connection_types": [
- "WIFI"
], - "carrier_types": [
- "DOCOMO"
], - "interests": [
- 0
], - "media_types": [
- "SMART_VIEW"
], - "channel_alias_labels": [
- "CR_JA_TOP"
], - "automated_targeting": {
- "age_unbreakable": false,
- "gender_unbreakable": false,
- "location_unbreakable": false,
- "custom_audience_unbreakable": false,
- "carrier_unbreakable": false,
- "connection_type_unbreakable": false,
- "os_version_unbreakable": false
}
}, - "frequency_control": {
- "interval": "LAST_1_DAY",
- "threshold": 0
}, - "configured_status": "ACTIVE",
- "dynamic_ads_config": {
- "targeting_type": "RETARGETING",
- "recency_days": "LAST_1_DAY"
}
}
{- "name": "string",
- "audience": {
- "ages": [
- "AGE_UNDER_20"
], - "genders": [
- "MALE"
], - "locations": [
- 0
], - "operating_system": {
- "type": "IOS",
- "since_version": "string"
}, - "custom_audiences": {
- "include": [
- 0
], - "exclude": [
- 0
]
}, - "connection_types": [
- "WIFI"
], - "carrier_types": [
- "DOCOMO"
], - "interests": [
- 0
], - "media_types": [
- "SMART_VIEW"
], - "channel_alias_labels": [
- "CR_JA_TOP"
], - "automated_targeting": {
- "age_unbreakable": false,
- "gender_unbreakable": false,
- "location_unbreakable": false,
- "custom_audience_unbreakable": false,
- "carrier_unbreakable": false,
- "connection_type_unbreakable": false,
- "os_version_unbreakable": false
}
}, - "frequency_control": {
- "interval": "LAST_1_DAY",
- "threshold": 0
}, - "configured_status": "ACTIVE",
- "dynamic_ads_config": {
- "targeting_type": "RETARGETING",
- "recency_days": "LAST_1_DAY"
}, - "campaign_id": 0,
- "ad_group_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "parent": {
- "id": 0,
- "type": "CAMPAIGN",
- "name": "string",
- "objective": "TRAFFIC",
- "optimization_event": "PURCHASE",
- "ready_for_delivery": true,
- "parent": { }
}, - "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "has_any_video_ads": true,
- "is_migrated_from_v1": true
}
Get an array of adgroup under a specified campaign_id.
ad_account_id required | integer <int64> |
campaign_id required | integer <int64> |
include_deleted | boolean (IncludeDeleted) Default: false If |
Accept-Language | string (AcceptLanguage) Example: en-US Controls the language of response text. |
{- "data": [
- {
- "name": "string",
- "audience": {
- "ages": [
- "AGE_UNDER_20"
], - "genders": [
- "MALE"
], - "locations": [
- 0
], - "operating_system": {
- "type": "IOS",
- "since_version": "string"
}, - "custom_audiences": {
- "include": [
- 0
], - "exclude": [
- 0
]
}, - "connection_types": [
- "WIFI"
], - "carrier_types": [
- "DOCOMO"
], - "interests": [
- 0
], - "media_types": [
- "SMART_VIEW"
], - "channel_alias_labels": [
- "CR_JA_TOP"
], - "automated_targeting": {
- "age_unbreakable": false,
- "gender_unbreakable": false,
- "location_unbreakable": false,
- "custom_audience_unbreakable": false,
- "carrier_unbreakable": false,
- "connection_type_unbreakable": false,
- "os_version_unbreakable": false
}
}, - "frequency_control": {
- "interval": "LAST_1_DAY",
- "threshold": 0
}, - "configured_status": "ACTIVE",
- "dynamic_ads_config": {
- "targeting_type": "RETARGETING",
- "recency_days": "LAST_1_DAY"
}, - "campaign_id": 0,
- "ad_group_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "parent": {
- "id": 0,
- "type": "CAMPAIGN",
- "name": "string",
- "objective": "TRAFFIC",
- "optimization_event": "PURCHASE",
- "ready_for_delivery": true,
- "parent": { }
}, - "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "has_any_video_ads": true,
- "is_migrated_from_v1": true
}
]
}
Get an array of ads under one ad account
ad_account_id required | integer <int64> |
include_deleted | boolean (IncludeDeleted) Default: false When |
Accept-Language | string |
{- "data": [
- {
- "name": "string",
- "landing_page_url": "string",
- "cta_label": "BOOK_NOW",
- "configured_status": "ACTIVE",
- "ad_id": 0,
- "click_destination_type": "WEB_VIEW",
- "moderation_status": "NOT_REVIEWED",
- "rejection_reasons": [
- {
- "policy": "医薬品、医薬部外品、医療機器",
- "description": "[LP]医療関係者等の推薦にあたるためNG",
- "element_type": {
- "object": "AD",
- "field": "LANDING_PAGE_URL"
}, - "element_id": 0
}
], - "submission_status": "BEFORE_SUBMISSION",
- "creative": {
- "format": "IMAGE",
- "creative_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "image_creative_info": {
- "headline": "stringstri",
- "description": "stringstri",
- "sponsored_name": "string",
- "media_files": [
- {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
]
}, - "video_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "media_files": [
- {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
]
}, - "carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "carousel_cards": [
- {
- "caption": "string",
- "media_file": {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": null,
- "height": null,
- "url": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "image_scale": null,
- "created_at": null
}, - "half": {
- "width": null,
- "height": null,
- "url": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "image_scale": null,
- "created_at": null
}, - "original": {
- "width": null,
- "height": null,
- "url": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "image_scale": null,
- "created_at": null
}
}, - "videos": {
- "high": {
- "width": null,
- "height": null,
- "url": null,
- "length": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "video_quality": null,
- "created_at": null
}, - "middle": {
- "width": null,
- "height": null,
- "url": null,
- "length": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "video_quality": null,
- "created_at": null
}, - "low": {
- "width": null,
- "height": null,
- "url": null,
- "length": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "video_quality": null,
- "created_at": null
}, - "original": {
- "width": null,
- "height": null,
- "url": null,
- "length": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "video_quality": null,
- "created_at": null
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
}
]
}, - "catalog_carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string"
}, - "catalog_image_creative_info": {
- "sponsored_name": "string"
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "parent": {
- "id": 0,
- "type": "CAMPAIGN",
- "name": "string",
- "objective": "TRAFFIC",
- "optimization_event": "PURCHASE",
- "ready_for_delivery": true,
- "parent": { }
}, - "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "is_migrated_from_v1": true
}
]
}
Create an ad object. A single Ad Group can have up to 100 ads.
When the number of ads exceed the limit, the API returns a Business Error.
ad_account_id required | integer <int64> |
ad_group_id required | integer <int64> |
source | string (Source) Value: "copy" The way how this ad object is created. This parameter is used to distinguish whether the campaign is created normally ( |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
name required | string (AdSchemas_Name) [ 1 .. 256 ] characters Name of an Ad. It is only used by customers to distinguish their Ads on Ads Manager. Note: Our standard length calculation rules apply to length validation: See details |
landing_page_url | string (LandingPageUrl) [ 1 .. 1024 ] characters URL of the Website which is opened when an Ad is clicked.
|
cta_label | string or null (CtaLabel) Enum: "BOOK_NOW" "START_BOOKING" "CONTACT_US" "CALL_US" "REGISTER" "SIGN_UP" "SHOP_NOW" "START_ORDER" "SEE_MORE" "LEARN_MORE" "WATCH_MORE" "REPLY" "APPLY_NOW" "REQUEST_CATALOG" "RESPOND_TO_SURVEY" "PLAY_GAME" "USE_APP" "DOWNLOAD" "INSTALL" "LAUNCH_APP" If specified, a call to action button with the specified option is displayed on the ad (may not be displayed in all placements). |
configured_status required | string (ConfiguredStatus) Enum: "ACTIVE" "PAUSED" "DELETED" The status of the object configured by an ad operator. |
object or null (AdImpressionMeasurement) Configuration for 3rd party ad impression measurement Note: This field is not settable for US region ad accounts. | |
required | object The Depending on the format, the corresponding For example, if |
{- "name": "string",
- "landing_page_url": "string",
- "cta_label": "BOOK_NOW",
- "configured_status": "ACTIVE",
- "creative": {
- "format": "IMAGE",
- "image_creative_info": {
- "headline": "stringstri",
- "description": "stringstri",
- "sponsored_name": "string",
- "media_file_ids": [
- 0
]
}, - "video_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "media_file_ids": [
- 0
]
}, - "carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "carousel_cards": [
- {
- "caption": "string",
- "media_file_id": 0
}, - {
- "caption": "string",
- "media_file_id": 0
}, - {
- "caption": "string",
- "media_file_id": 0
}
]
}, - "catalog_carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string"
}, - "catalog_image_creative_info": {
- "sponsored_name": "string"
}
}
}
{- "name": "string",
- "landing_page_url": "string",
- "cta_label": "BOOK_NOW",
- "configured_status": "ACTIVE",
- "ad_id": 0,
- "click_destination_type": "WEB_VIEW",
- "moderation_status": "NOT_REVIEWED",
- "rejection_reasons": [
- {
- "policy": "医薬品、医薬部外品、医療機器",
- "description": "[LP]医療関係者等の推薦にあたるためNG",
- "element_type": {
- "object": "AD",
- "field": "LANDING_PAGE_URL"
}, - "element_id": 0
}
], - "submission_status": "BEFORE_SUBMISSION",
- "creative": {
- "format": "IMAGE",
- "creative_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "image_creative_info": {
- "headline": "stringstri",
- "description": "stringstri",
- "sponsored_name": "string",
- "media_files": [
- {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
]
}, - "video_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "media_files": [
- {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
]
}, - "carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "carousel_cards": [
- {
- "caption": "string",
- "media_file": {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
}
]
}, - "catalog_carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string"
}, - "catalog_image_creative_info": {
- "sponsored_name": "string"
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "parent": {
- "id": 0,
- "type": "CAMPAIGN",
- "name": "string",
- "objective": "TRAFFIC",
- "optimization_event": "PURCHASE",
- "ready_for_delivery": true,
- "parent": { }
}, - "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "is_migrated_from_v1": true
}
Get an array of ad objects.
ad_account_id required | integer <int64> |
ad_group_id required | integer <int64> |
include_deleted | boolean (IncludeDeleted) Default: false Boolean flag for including deleted ads in the response. |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
{- "data": [
- {
- "name": "string",
- "landing_page_url": "string",
- "cta_label": "BOOK_NOW",
- "configured_status": "ACTIVE",
- "ad_id": 0,
- "click_destination_type": "WEB_VIEW",
- "moderation_status": "NOT_REVIEWED",
- "rejection_reasons": [
- {
- "policy": "医薬品、医薬部外品、医療機器",
- "description": "[LP]医療関係者等の推薦にあたるためNG",
- "element_type": {
- "object": "AD",
- "field": "LANDING_PAGE_URL"
}, - "element_id": 0
}
], - "submission_status": "BEFORE_SUBMISSION",
- "creative": {
- "format": "IMAGE",
- "creative_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "image_creative_info": {
- "headline": "stringstri",
- "description": "stringstri",
- "sponsored_name": "string",
- "media_files": [
- {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
]
}, - "video_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "media_files": [
- {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
]
}, - "carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "carousel_cards": [
- {
- "caption": "string",
- "media_file": {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": null,
- "height": null,
- "url": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "image_scale": null,
- "created_at": null
}, - "half": {
- "width": null,
- "height": null,
- "url": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "image_scale": null,
- "created_at": null
}, - "original": {
- "width": null,
- "height": null,
- "url": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "image_scale": null,
- "created_at": null
}
}, - "videos": {
- "high": {
- "width": null,
- "height": null,
- "url": null,
- "length": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "video_quality": null,
- "created_at": null
}, - "middle": {
- "width": null,
- "height": null,
- "url": null,
- "length": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "video_quality": null,
- "created_at": null
}, - "low": {
- "width": null,
- "height": null,
- "url": null,
- "length": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "video_quality": null,
- "created_at": null
}, - "original": {
- "width": null,
- "height": null,
- "url": null,
- "length": null,
- "filesize": null,
- "aspect_ratio_type": null,
- "video_quality": null,
- "created_at": null
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
}
]
}, - "catalog_carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string"
}, - "catalog_image_creative_info": {
- "sponsored_name": "string"
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "parent": {
- "id": 0,
- "type": "CAMPAIGN",
- "name": "string",
- "objective": "TRAFFIC",
- "optimization_event": "PURCHASE",
- "ready_for_delivery": true,
- "parent": { }
}, - "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "is_migrated_from_v1": true
}
]
}
Get a single ad object.
ad_account_id required | integer <int64> |
ad_id required | integer <int64> |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
{- "name": "string",
- "landing_page_url": "string",
- "cta_label": "BOOK_NOW",
- "configured_status": "ACTIVE",
- "ad_id": 0,
- "click_destination_type": "WEB_VIEW",
- "moderation_status": "NOT_REVIEWED",
- "rejection_reasons": [
- {
- "policy": "医薬品、医薬部外品、医療機器",
- "description": "[LP]医療関係者等の推薦にあたるためNG",
- "element_type": {
- "object": "AD",
- "field": "LANDING_PAGE_URL"
}, - "element_id": 0
}
], - "submission_status": "BEFORE_SUBMISSION",
- "creative": {
- "format": "IMAGE",
- "creative_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "image_creative_info": {
- "headline": "stringstri",
- "description": "stringstri",
- "sponsored_name": "string",
- "media_files": [
- {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
]
}, - "video_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "media_files": [
- {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
]
}, - "carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "carousel_cards": [
- {
- "caption": "string",
- "media_file": {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
}
]
}, - "catalog_carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string"
}, - "catalog_image_creative_info": {
- "sponsored_name": "string"
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "parent": {
- "id": 0,
- "type": "CAMPAIGN",
- "name": "string",
- "objective": "TRAFFIC",
- "optimization_event": "PURCHASE",
- "ready_for_delivery": true,
- "parent": { }
}, - "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "is_migrated_from_v1": true
}
Update an existing Ad by using the JSON Merge Patch specification, described in RFC 7396.
The API returns an business error when a request updates one or more of the following fields when the submission_status before this API call is SUBMITTED\
ad_account_id required | integer <int64> |
ad_id required | integer <int64> |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
name | string (AdSchemas_Name) [ 1 .. 256 ] characters Name of an Ad. It is only used by customers to distinguish their Ads on Ads Manager. Note: Our standard length calculation rules apply to length validation: See details |
configured_status | string (ConfiguredStatus) Enum: "ACTIVE" "PAUSED" "DELETED" The status of the object configured by an ad operator. |
landing_page_url | string (LandingPageUrl) [ 1 .. 1024 ] characters URL of the Website which is opened when an Ad is clicked.
|
cta_label | string or null (CtaLabel) Enum: "BOOK_NOW" "START_BOOKING" "CONTACT_US" "CALL_US" "REGISTER" "SIGN_UP" "SHOP_NOW" "START_ORDER" "SEE_MORE" "LEARN_MORE" "WATCH_MORE" "REPLY" "APPLY_NOW" "REQUEST_CATALOG" "RESPOND_TO_SURVEY" "PLAY_GAME" "USE_APP" "DOWNLOAD" "INSTALL" "LAUNCH_APP" If specified, a call to action button with the specified option is displayed on the ad (may not be displayed in all placements). |
submission_status | string (SubmissionStatus) Enum: "BEFORE_SUBMISSION" "SUBMITTED" This is the status of the ad to know whether our customers submit the ad to moderation or not. |
object (CreativePatchRequest) | |
object or null (AdImpressionMeasurement) Configuration for 3rd party ad impression measurement Note: This field is not settable for US region ad accounts. |
{- "name": "string",
- "configured_status": "ACTIVE",
- "landing_page_url": "string",
- "cta_label": "BOOK_NOW",
- "submission_status": "BEFORE_SUBMISSION",
- "creative": {
- "image_creative_info": {
- "headline": "stringstri",
- "description": "stringstri",
- "sponsored_name": "string",
- "media_file_ids": [
- 0
]
}, - "video_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "media_file_ids": [
- 0
]
}, - "carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "carousel_cards": [
- {
- "caption": "string",
- "media_file_id": 0
}, - {
- "caption": "string",
- "media_file_id": 0
}, - {
- "caption": "string",
- "media_file_id": 0
}
]
}, - "catalog_carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string"
}, - "catalog_image_creative_info": {
- "sponsored_name": "string"
}
},
}
{- "name": "string",
- "landing_page_url": "string",
- "cta_label": "BOOK_NOW",
- "configured_status": "ACTIVE",
- "ad_id": 0,
- "click_destination_type": "WEB_VIEW",
- "moderation_status": "NOT_REVIEWED",
- "rejection_reasons": [
- {
- "policy": "医薬品、医薬部外品、医療機器",
- "description": "[LP]医療関係者等の推薦にあたるためNG",
- "element_type": {
- "object": "AD",
- "field": "LANDING_PAGE_URL"
}, - "element_id": 0
}
], - "submission_status": "BEFORE_SUBMISSION",
- "creative": {
- "format": "IMAGE",
- "creative_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "image_creative_info": {
- "headline": "stringstri",
- "description": "stringstri",
- "sponsored_name": "string",
- "media_files": [
- {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
]
}, - "video_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "media_files": [
- {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
]
}, - "carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string",
- "carousel_cards": [
- {
- "caption": "string",
- "media_file": {
- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
}
]
}, - "catalog_carousel_creative_info": {
- "headline": "stringstri",
- "sponsored_name": "string"
}, - "catalog_image_creative_info": {
- "sponsored_name": "string"
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "parent": {
- "id": 0,
- "type": "CAMPAIGN",
- "name": "string",
- "objective": "TRAFFIC",
- "optimization_event": "PURCHASE",
- "ready_for_delivery": true,
- "parent": { }
}, - "delivery_status": {
- "status": "DELETED",
- "reason": "CAMPAIGN_DELETED",
- "description": "string"
}, - "is_migrated_from_v1": true
}
Delete an existing ad.
ad_account_id required | integer <int64> |
ad_id required | integer <int64> |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
{- "error": {
- "type": "UNAUTHORIZED",
- "message": "string",
- "retriable": true
}
}
Create a Media File which can be used in Ad Creatives.
ad_account_id required | integer <int64> |
Accept-Language | string (AcceptLanguage) Example: en-US The language to use for system generated text within API responses. The currently supported languages are English ( |
file_name required | string The filename of the uploaded file. | ||||||||||||||||||||
media_type required | string (MediaType) Enum: "IMAGE" "VIDEO" The type of the media file. | ||||||||||||||||||||
media_file required | string <binary> If the same file has been uploaded under the same ad account in the past, the existing media file will be returned. There are 2 types of media which can be uploaded:
1. IMAGEActual Image file to be uploaded to represent the visual image.
Allowed Format
2. VIDEOActual Video file to be uploaded to represent the visual video. Videos that pass the below conditions are allowed to upload:
Allowed Format
|
{- "media_file_id": 0,
- "ad_account_id": 0,
- "media_type": "IMAGE",
- "file_name": "string",
- "images": {
- "full": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "half": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "image_scale": "FULL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "videos": {
- "high": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "middle": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "low": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}, - "original": {
- "width": 0,
- "height": 0,
- "url": "string",
- "length": 0,
- "filesize": 0,
- "aspect_ratio_type": "ASPECT_RATIO_1_1",
- "video_quality": "ORIGINAL",
- "created_at": "2019-08-24T14:15:22Z"
}
}, - "thumbnail_media_file_id": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
Returns an array of locations for the specified region (prefectures for JP
, states for US
).
Each location contains an array of children
objects, representing cities inside that prefecture for JP
, and counties inside that state for US
.
Display names are provided in Japanese and English via the ja
and en
fields.
region | string (Region) Enum: "JP" "US" The region to obtain locations for. There are currently two regions:
If a value is not specified, the default is |
[- {
- "location_id": 70149,
- "ja": "北海道",
- "en": "Hokkaido",
- "children": [
- {
- "location_id": 70196,
- "ja": "札幌市",
- "en": "Sapporo"
}, - {
- "location_id": 70197,
- "ja": "函館市",
- "en": "Hakodate"
}
]
}
]
Returns an array of IAB interest categories which can be used for AdGroup level interest targeting.
[- {
- "iab_interest_category_id": 100,
- "iab_interest_category_name": "Food",
- "display_name": {
- "en": "Food",
- "ja": "食べ物"
}, - "parent_iab_interest_category_id": 1
}
]