Package google.ads.searchads360.v0.resources

インデックス

AccessibleBiddingStrategy

顧客が所有し、共有している入札戦略のビューを表します。

BiddingStrategy とは対照的に、このリソースには、この顧客が所有する戦略に加え、顧客のマネージャーが所有し、この顧客と共有している戦略が含まれます。このリソースでは、指標は提供されず、 BiddingStrategy 属性の限定されたサブセットのみが公開されます。

フィールド
resource_name

string

アクセス可能な入札戦略のリソース名。AccessibleBidStrategy リソース名の形式は次のとおりです。

customers/{customer_id}/accessibleBiddingStrategies/{bidding_strategy_id}

id

int64

入札戦略の ID。

name

string

入札戦略の名前。

type

BiddingStrategyType

入札戦略のタイプ。

owner_customer_id

int64

入札戦略を所有する顧客の ID。

owner_descriptive_name

string

description_name は、入札戦略を所有する顧客の名前です。

共用体フィールド scheme。入札スキーム。

設定できるのは 1 つのみです。scheme は次のいずれかになります。

maximize_conversion_value

MaximizeConversionValue

予算を消化しながらキャンペーンのコンバージョン値を最大化するための自動入札戦略。

maximize_conversions

MaximizeConversions

指定の予算を消化しつつキャンペーンのコンバージョン数を最大化できる自動入札戦略。

target_cpa

TargetCpa

指定した目標コンバージョン単価(CPA)でコンバージョンを最大限に獲得できるように入札単価を設定する入札戦略。

target_impression_share

TargetImpressionShare

選択したインプレッションの割合を重視して自動的に最適化する入札戦略。

target_roas

TargetRoas

特定の目標広告費用対効果(ROAS)を平均しながら収益を最大化できる入札戦略。

target_spend

TargetSpend

予算内でクリック数を最大化できるように入札単価を設定する入札戦略です。

MaximizeConversionValue

予算を消化しながらキャンペーンのコンバージョン値を最大化するための自動入札戦略。

フィールド
target_roas

double

目標広告費用対効果(LTV)オプション。設定した場合、入札戦略では目標広告費用対効果を平均化しながら、収益を最大化します。目標広告費用対効果が高い場合、入札戦略では予算全額を使用できない可能性があります。目標広告費用対効果が設定されていない場合、入札戦略では予算に対して可能な限り高い広告費用対効果を達成することを目指します。

MaximizeConversions

指定の予算を消化しつつキャンペーンのコンバージョン数を最大化できる自動入札戦略。

フィールド
target_cpa

int64

目標コンバージョン単価(CPA)オプション。これは、顧客獲得 1 回あたりに費やす平均金額です。

target_cpa_micros

int64

目標コンバージョン単価(CPA)オプション。これは、顧客獲得 1 回あたりに費やす平均金額です。

TargetCpa

指定した目標コンバージョン単価(CPA)でコンバージョンを最大限に獲得できるように入札単価を設定する自動入札戦略。

フィールド
target_cpa_micros

int64

平均 CPA の目標値。この目標は、アカウントの通貨に基づき、請求可能な最小単位以上である必要があります。

TargetImpressionShare

検索広告の一定割合が最初のページの上部(または他のターゲット地域)の上部に表示されるように入札単価を設定する自動入札戦略。

フィールド
location

TargetImpressionShareLocation

検索結果ページの対象地域。

location_fraction_micros

int64

ターゲット地域に表示される広告の選択した割合(マイクロ単位)。たとえば、1% は 10,000 です。

cpc_bid_ceiling_micros

int64

自動入札システムで指定できる、最も高いクリック単価。これは上限を設定する広告主が入力する必須項目で、ローカルのマイクロ秒単位で指定します。

TargetRoas

特定の目標広告費用対効果(ROAS)を平均しながら収益を最大化できる自動入札戦略。

フィールド
target_roas

double

コンバージョン データに基づいて選択された費用単位あたりの収益。

TargetSpend

予算内でクリック数を最大化できるように入札単価を設定する自動入札戦略。

フィールド
target_spend_micros
(deprecated)

int64

クリック数を最大化するための目標予算。目標予算の入札者は、この値と、自然なスロットリング予算額のうち、少ない方の金額を支出しようとします。指定しない場合、予算が目標予算として使用されます。このフィールドは非推奨のため使用不可です。詳しくは、https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html をご覧ください。

cpc_bid_ceiling_micros

int64

入札戦略で設定可能な入札単価の上限。この制限は、この戦略で管理するすべてのキーワードに適用されます。

広告

フィールド
resource_name

string

広告のリソース名。広告リソース名の形式は次のとおりです。

customers/{customer_id}/ads/{ad_id}

final_urls[]

string

広告のすべてのクロスドメイン リダイレクトの後に可能性のある最終ページ URL のリスト。

type

AdType

広告タイプ。

id

int64

広告の ID です。

display_url

string

一部の広告フォーマットの広告説明に表示される URL。

name

string

広告の名前。広告を識別するためにのみ使用されます。一意である必要はなく、配信される広告には影響しません。name フィールドは現在、DisplayUploadAd、ImageAd、ShoppingComparisonListingAd、VideoAd でのみサポートされています。

共用体フィールド ad_data。広告タイプに関する詳細。値を 1 つだけ設定する必要があります。ad_data は次のいずれかになります。
text_ad

SearchAds360TextAdInfo

テキスト広告に関する詳細。

expanded_text_ad

SearchAds360ExpandedTextAdInfo

拡張テキスト広告に関する詳細。

responsive_search_ad

SearchAds360ResponsiveSearchAdInfo

レスポンシブ検索広告に関する詳細。

product_ad

SearchAds360ProductAdInfo

商品広告に関する詳細。

expanded_dynamic_search_ad

SearchAds360ExpandedDynamicSearchAdInfo

拡張動的検索広告に関する詳細。

広告グループ

広告グループ。

フィールド
resource_name

string

広告グループのリソース名。広告グループのリソース名の形式は次のとおりです。

customers/{customer_id}/adGroups/{ad_group_id}

status

AdGroupStatus

広告グループのステータス。

type

AdGroupType

広告グループのタイプ。

ad_rotation_mode

AdGroupAdRotationMode

広告グループの広告のローテーション モード。

creation_time

string

この ad_group が作成されたときのタイムスタンプ。このタイムスタンプは、顧客のタイムゾーンを「yyyy-MM-dd HH:mm:ss」形式で指定します。

targeting_setting

TargetingSetting

ターゲティング関連の機能の設定です。

labels[]

string

この広告グループに適用されているラベルのリソース名。

engine_id

string

外部エンジン アカウントの広告グループの ID。このフィールドは、Google 広告アカウント以外のアカウントにのみ使用できます(Yahoo! Japan、Microsoft、Baidu など)。Google 広告エンティティの場合は、代わりに「ad_group.id」を使用します。

start_date

string

この広告グループの広告配信を開始する日付。デフォルトでは、広告グループの開始日は、現在または開始日のいずれか遅い方になります。このフィールドを設定した場合、ユーザーのタイムゾーンで指定の日付の開始時間に広告グループが開始されます。このフィールドは、Microsoft Advertising アカウントと Facebook ゲートウェイ アカウントでのみ使用できます。

形式: YYYY-MM-DD 例: 2019-03-14

end_date

string

広告グループの広告配信を終了する日付。デフォルトでは、広告グループは広告グループの終了日に終了します。このフィールドが設定されている場合、ユーザーのタイムゾーンで指定の日付に広告グループが終了します。このフィールドは、Microsoft Advertising アカウントと Facebook ゲートウェイ アカウントでのみ使用できます。

形式: YYYY-MM-DD 例: 2019-03-14

language_code

string

広告グループ内の広告とキーワードの言語。このフィールドは、Microsoft Advertising アカウントでのみ使用できます。詳細: https://docs.microsoft.com/en-us/advertising/guides/ad-languages?view=bingads-13#adlanguage

last_modified_time

string

この広告グループが最後に変更された日時。日時は、顧客のタイムゾーンの「yyyy-MM-dd HH:mm:ss.ssssss」形式です。

id

int64

広告グループの ID です。

name

string

広告グループの名前です。

新しい広告グループを作成する場合は、このフィールドは必須です。空にすることはできません。

含めることができる文字は、UTF-8 の全角で 255 文字未満にする必要があります。

null(コードポイント 0x0)、NL ラインフィード(コードポイント 0xA)、改行(コードポイント 0xD)の文字を含めることはできません。

cpc_bid_micros

int64

最大 CPC(クリック単価)入札。

engine_status

AdGroupEngineStatus

広告グループのエンジン ステータス。

AdGroupAd

広告グループの広告です。

フィールド
resource_name

string

広告のリソース名。広告グループの広告のリソース名の形式は次のとおりです。

customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}

status

AdGroupAdStatus

広告のステータスです。

ad

Ad

広告。

creation_time

string

この ad_group_ad が作成されたときのタイムスタンプ。日時は、顧客のタイムゾーンの「yyyy-MM-dd HH:mm:ss.ssssss」形式です。

labels[]

string

この広告グループの広告に適用されているラベルのリソース名。

engine_id

string

外部エンジン アカウントの広告の ID。このフィールドは検索広告 360 アカウント(Yahoo、Microsoft、Baidu など)専用です。検索広告 360 以外のエンティティの場合は、「ad_group_ad.ad.id」を使用しますしてください。

engine_status

AdGroupAdEngineStatus

外部エンジン アカウントの広告の追加ステータス。外部アカウントの種類によって、アクティブ、有効、確認待ちなどのステータスが表示されます。

last_modified_time

string

この広告グループの広告が最後に変更された日時。日時は、顧客のタイムゾーンの「yyyy-MM-dd HH:mm:ss.ssssss」形式です。

AdGroupAdLabel

広告グループの広告とラベルの関係。

フィールド
resource_name

string

広告グループ広告ラベルのリソース名です。広告グループの広告ラベルのリソース名の形式は customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id} です。

ad_group_ad

string

ラベルが添付される広告グループ広告。

label

string

広告グループ広告に割り当てられるラベル。

AdGroupAsset

広告グループとアセット間のリンクです。

フィールド
resource_name

string

広告グループ アセットのリソース名。AdGroupAsset リソース名の形式は次のとおりです。

customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}

ad_group

string

必須。アセットがリンクされている広告グループ。

asset

string

必須。広告グループにリンクされているアセットです。

status

AssetLinkStatus

広告グループのアセットのステータス。

AdGroupAssetSet

AdGroupAssetSet は、広告グループとアセットセットをリンクしたものです。AdGroupAssetSet を作成すると、アセットセットと広告グループがリンクされます。

フィールド
resource_name

string

広告グループのアセットセットのリソース名。広告グループのアセットセットのリソース名の形式は次のとおりです。

customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}

ad_group

string

このアセットセットがリンクされている広告グループ。

asset_set

string

広告グループにリンクされているアセットセット。

status

AssetSetLinkStatus

広告グループのアセットセットのステータス。読み取り専用です。

AdGroupAudienceView

広告グループのオーディエンス ビュー。ディスプレイ ネットワーク広告と YouTube ネットワーク広告のインタレスト リストやリマーケティング リスト、検索広告向けリマーケティング リスト(RLSA)について、オーディエンス単位で集計した掲載結果データが含まれます。

フィールド
resource_name

string

広告グループのオーディエンス ビューのリソース名。広告グループのオーディエンス ビューのリソース名の形式は次のとおりです。

customers/{customer_id}/adGroupAudienceViews/{ad_group_id}~{criterion_id}

AdGroupBidModifier

広告グループの入札単価調整比を表します。

フィールド
resource_name

string

広告グループの入札単価調整比のリソース名。広告グループの入札単価調整比のリソース名の形式は次のとおりです。

customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}

bid_modifier

double

条件が一致した場合の入札の修飾子。修飾子は 0.1 ~ 10.0 の範囲内にする必要があります。PreferredContent の範囲は 1.0~6.0 です。デバイスタイプをオプトアウトするには、0 を使用します。

共用体フィールド criterion。この広告グループの入札単価調整比の条件。

V5 以降の作成オペレーションでは必須です。criterion は次のいずれかになります。

device

DeviceInfo

デバイスの条件です。

AdGroupCriterion

広告グループの条件。ad_group_criterion レポートでは、広告グループに明示的に追加された条件のみが返されます。

フィールド
resource_name

string

広告グループの条件のリソース名。広告グループの条件のリソース名の形式は次のとおりです。

customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}

creation_time

string

この広告グループの条件が作成された時点のタイムスタンプ。このタイムスタンプは、顧客のタイムゾーンを「yyyy-MM-dd HH:mm:ss」形式で指定します。

status

AdGroupCriterionStatus

条件のステータス。

これは、クライアントが設定した広告グループの条件エンティティのステータスです。注: UI レポートには、条件を実行できるかどうかに影響する追加情報が含まれている場合があります。API では「削除済み」である条件でも、管理画面では有効と表示されることがあります。たとえば、除外していない限り、デフォルトですべての年齢層のユーザーにキャンペーンが表示されます。対象の年齢層は広告が表示されるため、UI には「有効」と表示されます。しかし、非除外条件が追加されていないため、AdGroupCriterion.status には「removed」と表示されます。

quality_info

QualityInfo

基準の品質に関する情報。

type

CriterionType

条件のタイプ。

labels[]

string

この広告グループの条件に適用されているラベルのリソース名。

position_estimates

PositionEstimates

さまざまな掲載位置におけるクライテリアの入札単価の見積もりです。

final_urls[]

string

広告のすべてのクロスドメイン リダイレクトの後に可能性のある最終ページ URL のリスト。

engine_id

string

外部エンジン アカウントの広告グループの条件の ID。このフィールドは、Google 広告アカウント以外のアカウントにのみ使用できます(Yahoo! Japan、Microsoft、Baidu など)。Google 広告エンティティの場合は、「ad_group_criterion.criterion_id」を使用します。してください。

last_modified_time

string

この広告グループの条件が最後に変更された日時。日時は、顧客のタイムゾーンの「yyyy-MM-dd HH:mm:ss.ssssss」形式です。

criterion_id

int64

条件の ID。

ad_group

string

条件が属する広告グループです。

negative

bool

条件をターゲティング(false)するか除外(true)するかを指定します。

このフィールドは変更できません。評価基準を肯定的なものから否定的なものに切り替えるには、条件を削除してから再度追加します。

bid_modifier

double

条件が一致した場合の入札の修飾子。修飾子は 0.1 ~ 10.0 の範囲内にする必要があります。対象とする条件タイプのほとんどで、修飾子がサポートされています。

cpc_bid_micros

int64

クリック単価(CPC)。

effective_cpc_bid_micros

int64

有効 CPC(クリック単価)入札。

engine_status

AdGroupCriterionEngineStatus

広告グループのエンジン ステータスの条件。

final_url_suffix

string

パラメータを最終ページ URL に追加するための URL テンプレート。

tracking_url_template

string

トラッキング URL を作成するための URL テンプレート。

共用体フィールド criterion。広告グループの条件。

1 つのみを設定する必要があります。criterion は次のいずれかになります。

keyword

KeywordInfo

キーワード。

listing_group

ListingGroupInfo

リスティング グループ。

age_range

AgeRangeInfo

年齢層。

gender

GenderInfo

性別。

user_list

UserListInfo

ユーザーリスト。

webpage

WebpageInfo

ウェブページ

location

LocationInfo

位置情報] をタップします。

PositionEstimates

さまざまな掲載位置におけるクライテリアの入札単価の見積もりです。

フィールド
top_of_page_cpc_micros

int64

検索結果の最初のページの上部に広告を表示するために必要なクリック単価の見積もりです。

QualityInfo

広告グループの条件の品質情報のコンテナ。

フィールド
quality_score

int32

品質スコア。

Google が値を決定するための十分な情報を持っていない場合は、このフィールドに値が入力されないことがあります。

AdGroupCriterionLabel

広告グループの条件とラベルの関係。

フィールド
resource_name

string

広告グループの条件ラベルのリソース名。広告グループの条件ラベルのリソース名の形式は、customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id} です。

ad_group_criterion

string

ラベルが添付される広告グループ条件。

label

string

広告グループの条件に割り当てられているラベル。

AdGroupLabel

広告グループとラベルの関係。

フィールド
resource_name

string

広告グループラベルのリソース名。広告グループラベルのリソース名の形式は customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id} です。

ad_group

string

ラベルが添付される広告グループ。

label

string

広告グループに割り当てられているラベル。

AgeRangeView

年齢層のビュー。

フィールド
resource_name

string

年齢層ビューのリソース名。年齢層ビューのリソース名の形式は次のとおりです。

customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}

アセット

アセットは、複数の広告で共有できる広告の一部です。画像(ImageAsset)、動画(YouTubeVideoAsset)などを使用できます。アセットは不変であり、削除できません。アセットの配信を停止するには、そのアセットを使用しているエンティティからアセットを削除してください。

フィールド
resource_name

string

アセットのリソース名。アセット リソース名の形式は次のとおりです。

customers/{customer_id}/assets/{asset_id}

type

AssetType

アセットのタイプ。

final_urls[]

string

すべてのクロスドメイン リダイレクト後の最終ページ URL のリスト。

status

AssetStatus

アセットのステータス。

creation_time

string

この求人が作成されたときのタイムスタンプ。このタイムスタンプは、顧客のタイムゾーンを「yyyy-MM-dd HH:mm:ss」形式で指定します。

last_modified_time

string

このアセットが最後に変更された日時。日時は、顧客のタイムゾーンの「yyyy-MM-dd HH:mm:ss.ssssss」形式です。

id

int64

アセットの ID です。

name

string

アセットの名前(省略可)。

tracking_url_template

string

トラッキング URL を作成するための URL テンプレート。

engine_status

AssetEngineStatus

アセットのエンジン ステータス。

共用体フィールド asset_data。アセットの具体的なタイプ。asset_data は次のいずれかになります。
youtube_video_asset

YoutubeVideoAsset

YouTube 動画アセット。

image_asset

ImageAsset

画像アセット。

text_asset

TextAsset

テキスト アセット。

callout_asset

UnifiedCalloutAsset

統一コールアウト アセット。

page_feed_asset

UnifiedPageFeedAsset

統合されたページフィード アセット。

mobile_app_asset

MobileAppAsset

モバイルアプリ アセット。

call_asset

UnifiedCallAsset

統一された電話番号アセットです。

call_to_action_asset

CallToActionAsset

行動を促すフレーズのアセット。

location_asset

UnifiedLocationAsset

統合された住所アセット。

AssetGroup

アセット グループAssetGroupAsset は、アセットをアセット グループにリンクするために使用します。AssetGroupSignal は、シグナルをアセット グループに関連付けるために使用されます。

フィールド
resource_name

string

アセット グループのリソース名。アセット グループのリソース名の形式は次のとおりです。

customers/{customer_id}/assetGroups/{asset_group_id}

id

int64

アセット グループの ID

campaign

string

このアセット グループが関連付けられているキャンペーン。アセット グループにリンクされているアセット。

name

string

必須。アセット グループの名前。必須。最小文字数は 1、最大文字数は 128 です。キャンペーン内で一意である必要があります。

final_urls[]

string

すべてのクロスドメイン リダイレクト後の最終ページ URL のリスト。P-MAX では、無効にしている場合を除き、URL はデフォルトで拡張の対象となります。

final_mobile_urls[]

string

すべてのクロスドメイン リダイレクト後のモバイルの最終ページ URL のリスト。P-MAX では、オプトアウトしていない限り、デフォルトで URL の拡張が有効になります。

status

AssetGroupStatus

アセット グループのステータス。

path1

string

広告に表示される URL に表示されるテキストの最初の部分です。

path2

string

広告に表示される URL に追加されるテキストの 2 番目の部分です。このフィールドは、path1 が設定されている場合にのみ設定できます。

ad_strength

AdStrength

このアセット グループの全体的な広告の有効性。

AssetGroupAsset

AssetGroupAsset は、アセットとアセット グループ間のリンクです。AssetGroupAsset を追加すると、アセットとアセット グループがリンクされます。

フィールド
resource_name

string

アセット グループ アセットのリソース名。アセット グループのアセットのリソース名の形式:

customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}

asset_group

string

このアセット グループのアセットがリンクしているアセット グループです。

asset

string

このアセット グループのアセットがリンクしているアセット。

field_type

AssetFieldType

アセット グループ内のアセットのプレースメントの説明。例: HEADLINE、YOUTUBE_VIDEO など

status

AssetLinkStatus

アセットとアセット グループ間のリンクのステータス。

AssetGroupAssetCombinationData

アセット グループのアセットの組み合わせのデータ

フィールド
asset_combination_served_assets[]

AssetUsage

配信されたアセット。

AssetGroupListingGroupFilter

AssetGroupListingGroupFilter は、アセット グループ内のリスティング グループのフィルタツリーノードを表します。

フィールド
resource_name

string

アセット グループのリスティング グループ フィルタのリソース名。アセット グループのリスティング グループのフィルタのリソース名の形式は次のとおりです。

customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}

asset_group

string

このアセット グループのリスティング グループ フィルタが含まれているアセット グループ。

id

int64

ListingGroupFilter の ID。

type

ListingGroupFilterType

リスティング グループのフィルタノードのタイプ。

vertical

ListingGroupFilterVertical

現在のノードツリーが表すカテゴリ。同じツリー内のすべてのノードは同じカテゴリに属している必要があります。

case_value

ListingGroupFilterDimension

このリスティング グループの親を絞り込む際のディメンション値。ルートグループに対して未定義です。

parent_listing_group_filter

string

親リスティング グループの区分のリソース名。ルート リスティング グループのフィルタノードの null。

path

ListingGroupFilterDimensionPath

このリスティング グループのフィルタを定義するディメンションのパス。

AssetGroupSignal

AssetGroupSignal は、アセット グループのシグナルを表します。コンバージョンが発生する可能性が最も高い P-MAX キャンペーンには、シグナルが存在するかどうかがわかります。P-MAX では、シグナルを使用して、検索、ディスプレイ、動画などのさまざまなネットワークでコンバージョンを獲得するために、購買意向が似ているユーザーや購買意向が強い新しいユーザーを探します。

フィールド
resource_name

string

アセット グループ シグナルのリソース名。アセット グループ シグナルのリソース名の形式:

customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}

asset_group

string

このアセット グループのシグナルが属するアセット グループです。

共用体フィールド signal。アセット グループのシグナル。signal は次のいずれかになります。
audience

AudienceInfo

P-MAX キャンペーンで使用するオーディエンス シグナル。

AssetGroupTopCombinationView

広告グループの広告アセットの組み合わせの使用状況が表示されます。

フィールド
resource_name

string

アセット グループの最上位の組み合わせビューのリソース名。AssetGroup の上位の組み合わせビューのリソース名の形式は、「customers/{customer_id}/assetGroupTopCombinationViews/{asset_group_id}~{asset_combination_category}」です。

asset_group_top_combinations[]

AssetGroupAssetCombinationData

一緒に配信されたアセットの上位の組み合わせ。

AssetSet

アセットのコレクションを表すアセットセット。AssetSetAsset を使用して、アセットをアセットセットにリンクします。

フィールド
id

int64

アセットセットの ID。

resource_name

string

アセットセットのリソース名。アセットセットのリソース名の形式は次のとおりです。

customers/{customer_id}/assetSets/{asset_set_id}

AssetSetAsset

AssetSetAsset は、アセットとアセットセット間のリンクです。AssetSetAsset を追加すると、アセットをアセットセットとリンクさせることができます。

フィールド
resource_name

string

アセットセット アセットのリソース名。アセットセットのアセット リソース名の形式は次のとおりです。

customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}

asset_set

string

このアセットセットのアセットがリンクしているアセットセット。

asset

string

このアセットセットのアセットがリンクしているアセット。

status

AssetSetAssetStatus

アセットセット アセットのステータス。読み取り専用です。

オーディエンス

オーディエンスは効果的なターゲティング オプションです。さまざまなセグメント属性(詳しいユーザー属性やアフィニティなど)を組み合わせて、ターゲット セグメントの各セクションを表すオーディエンスを作成できます。

フィールド
resource_name

string

オーディエンスのリソース名。オーディエンス名の形式は、次のとおりです。

customers/{customer_id}/audiences/{audience_id}

id

int64

オーディエンスの ID。

name

string

必須。オーディエンスの名前。すべてのオーディエンスで一意である必要があります。最小文字数は 1、最大文字数は 255 です。

description

string

このオーディエンスの説明。

BiddingStrategy

入札戦略。

フィールド
resource_name

string

入札戦略のリソース名。入札戦略のリソース名の形式は次のとおりです。

customers/{customer_id}/biddingStrategies/{bidding_strategy_id}

status

BiddingStrategyStatus

入札戦略のステータス。

このフィールドは読み取り専用です。

type

BiddingStrategyType

入札戦略のタイプ。入札スキームを設定して入札戦略を作成します。

このフィールドは読み取り専用です。

currency_code

string

入札戦略で使用される通貨(ISO 4217 の 3 文字のコード)。

MCC クライアントの入札戦略の場合、この通貨は作成時に設定でき、デフォルトで MCC 顧客の通貨に設定されます。サービスを提供するお客様の場合、このフィールドは設定できません。サービスを提供するお客様のすべての戦略で、そのお客様の通貨が暗黙的に使用されます。すべての場合で、effective_currency_code フィールドはこの戦略で使用されている通貨を返します。

id

int64

入札戦略の ID。

name

string

入札戦略の名前。アカウント内のすべての入札戦略は、それぞれ別の名前にする必要があります。

この文字列の長さは UTF-8 バイトで 1~255 の値にする必要があります(切り詰められます)。

effective_currency_code

string

入札戦略で使用される通貨(ISO 4217 の 3 文字のコード)。

クライアント センター(MCC)顧客の入札戦略の場合、これは戦略の作成時に広告主が設定した通貨です。顧客にサービスを提供する場合は、顧客の currency_code になります。

入札戦略の指標はこの通貨でレポートに表示されます。

このフィールドは読み取り専用です。

campaign_count

int64

この入札戦略に関連付けられているキャンペーンの数。

このフィールドは読み取り専用です。

non_removed_campaign_count

int64

この入札戦略に関連付けられている、削除されていないキャンペーンの数です。

このフィールドは読み取り専用です。

共用体フィールド scheme。入札スキーム。

設定できるのは 1 つのみです。scheme は次のいずれかになります。

enhanced_cpc

EnhancedCpc

コンバージョンにつながる可能性が高いクリックについては入札単価を引き上げ、可能性が低いと思われるクリックについては引き下げる入札戦略です。

maximize_conversion_value

MaximizeConversionValue

予算を消化しながらキャンペーンのコンバージョン値を最大化するための自動入札戦略。

maximize_conversions

MaximizeConversions

指定の予算を消化しつつキャンペーンのコンバージョン数を最大化できる自動入札戦略。

target_cpa

TargetCpa

指定した目標コンバージョン単価(CPA)でコンバージョンを最大限に獲得できるように入札単価を設定する入札戦略。

target_impression_share

TargetImpressionShare

選択したインプレッションの割合を重視して自動的に最適化する入札戦略。

target_outrank_share

TargetOutrankShare

特定の競合他社よりも上位に掲載する必要があるオークションの割合に基づいて、入札単価を設定する入札戦略。このフィールドのサポートは終了しています。このフィールドで新しい入札戦略を作成したり、このフィールドを指定した入札戦略をキャンペーンに適用したりすることはできません。このスキームがすでに入力されている戦略への変更は許可されます。

target_roas

TargetRoas

特定の目標広告費用対効果(ROAS)を平均しながら収益を最大化できる入札戦略。

target_spend

TargetSpend

予算内でクリック数を最大化できるように入札単価を設定する入札戦略です。

キャンペーン

キャンペーン。

フィールド
resource_name

string

キャンペーンのリソース名。キャンペーンのリソース名の形式は次のとおりです。

customers/{customer_id}/campaigns/{campaign_id}

status

CampaignStatus

キャンペーンのステータス。

新しいキャンペーンが追加されると、ステータスはデフォルトで「有効」になります。

serving_status

CampaignServingStatus

キャンペーンの広告配信ステータスです。

bidding_strategy_system_status

BiddingStrategySystemStatus

キャンペーンの入札戦略のシステム ステータス。

ad_serving_optimization_status

AdServingOptimizationStatus

キャンペーンの広告配信の最適化ステータス。

advertising_channel_type

AdvertisingChannelType

キャンペーン内の広告のメインの配信ターゲット。ターゲティング オプションは network_settings で絞り込むことができます。

新しいキャンペーンを作成する場合、このフィールドは必須です。空にすることはできません。

キャンペーンの作成時にのみ設定できます。キャンペーンを作成した後は変更できません。

advertising_channel_sub_type

AdvertisingChannelSubType

必要に応じて advertising_channel_type の絞り込み。親チャネルタイプの有効なサブタイプを指定してください。

キャンペーンの作成時にのみ設定できます。キャンペーンを作成した後は変更できません。

url_custom_parameters[]

CustomParameter

tracking_url_templatefinal_urlsmobile_final_urls でカスタム パラメータ タグの置換に使用するマッピングのリスト。

real_time_bidding_setting

RealTimeBiddingSetting

リアルタイム ビッダーの設定。この機能は、Ad Exchange ネットワークをターゲットとするキャンペーンでのみご利用いただけます。

network_settings

NetworkSettings

キャンペーンの掲載ネットワークの設定です。

dynamic_search_ads_setting

DynamicSearchAdsSetting

動的検索広告(DSA)を管理するための設定。

shopping_setting

ShoppingSetting

ショッピング キャンペーンを管理するための設定です。

geo_target_type_setting

GeoTargetTypeSetting

広告の地域ターゲティングの設定。

labels[]

string

このキャンペーンに適用されたラベルのリソース名。

bidding_strategy_type

BiddingStrategyType

入札戦略のタイプ。

入札戦略を作成するには、標準入札戦略を作成する入札スキームを設定するか、ポートフォリオ入札戦略を作成する bidding_strategy フィールドを設定します。

このフィールドは読み取り専用です。

accessible_bidding_strategy

string

AccessibleBiddingStrategy のリソース名。「bidding_strategy」で識別される、接続されているポートフォリオ入札戦略の無制限の属性の読み取り専用ビューです。キャンペーンでポートフォリオ戦略を使用していない場合は空になります。制限のない戦略属性は、戦略を共有しているすべてのお客様が利用でき、AccessibleBiddingStrategy リソースから読み取られます。これに対して、制限付きの属性は、戦略のオーナーである顧客とそのマネージャーのみが使用できます。制限付き属性は、BidStrategy リソースからのみ読み取ることができます。

frequency_caps[]

FrequencyCapEntry

各ユーザーにこのキャンペーンの広告が表示される頻度を制限するリスト。

selective_optimization

SelectiveOptimization

このキャンペーンの選択的最適化の設定。このキャンペーンの最適化で重視するコンバージョン アクションが含まれます。この機能は、MULTI_CHANNEL を AdvertisingChannelType として使用し、APP_CAMPAIGN または APP_CAMPAIGN_FOR_ENGAGEMENT を AdvertisingChannelSubType として使用するアプリ キャンペーンにのみ適用されます。

optimization_goal_setting

OptimizationGoalSetting

このキャンペーンの最適化目標の設定です。一連の最適化の目標タイプが含まれます。

tracking_setting

TrackingSetting

トラッキング情報に関するキャンペーン単位の設定。

engine_id

string

外部エンジン アカウントのキャンペーンの ID。このフィールドは、Google 広告アカウント以外のアカウントにのみ使用できます(Yahoo! Japan、Microsoft、Baidu など)。Google 広告エンティティの場合は、代わりに「campaign.id」を使用します。

excluded_parent_asset_field_types[]

AssetFieldType

このキャンペーンから除外するアセット フィールド タイプ。これらの項目タイプのアセットリンクは、このキャンペーンに上位レベルから継承されません。

create_time

string

このキャンペーンが作成されたときのタイムスタンプ。タイムスタンプの形式は、顧客のタイムゾーンの「yyyy-MM-dd HH:mm:ss」です。使用できます。create_time は v1 で非推奨となります。代わりに create_time を使用してください。

creation_time

string

このキャンペーンが作成されたときのタイムスタンプ。このタイムスタンプは、顧客のタイムゾーンを「yyyy-MM-dd HH:mm:ss」形式で指定します。

last_modified_time

string

このキャンペーンが最後に変更された日時。日時は、顧客のタイムゾーンの「yyyy-MM-dd HH:mm:ss.ssssss」形式です。

id

int64

キャンペーンの ID です。

name

string

キャンペーンの名前です。

新しいキャンペーンを作成する場合、このフィールドは必須です。空にすることはできません。

null(コードポイント 0x0)、NL ラインフィード(コードポイント 0xA)、改行(コードポイント 0xD)の文字を含めることはできません。

tracking_url_template

string

トラッキング URL を作成するための URL テンプレート。

campaign_budget

string

キャンペーンの予算。

start_date

string

お客様のタイムゾーンでキャンペーンが配信を開始した日付(YYYY-MM-DD 形式)。

end_date

string

ユーザーのタイムゾーンで配信されるキャンペーンの最終日(YYYY-MM-DD 形式)。作成時にはデフォルトで 2037-12-30 に設定され、キャンペーンは無期限に実行されます。既存のキャンペーンを無期限で行うように設定するには、このフィールドを 2037-12-30 に設定します。

final_url_suffix

string

並行トラッキングで配信されるランディング ページにクエリ パラメータを追加するために使用するサフィックス。

url_expansion_opt_out

bool

よりターゲットを絞った URL への URL の拡張を無効にすることを表します。無効(true)にすると、アセット グループの最終ページ URL、または広告主様の Google Merchant Center かビジネスデータ フィードで指定された URL のみがターゲットになります。オプトイン(false)すると、ドメイン全体がターゲットに設定されます。このフィールドは P-MAX キャンペーンでのみ設定でき、デフォルト値は false です。

共用体フィールド campaign_bidding_strategy。キャンペーンの入札戦略。

ポートフォリオ(入札戦略サービスで作成)または標準(キャンペーンに組み込まれているもの)のいずれかである必要があります。campaign_bidding_strategy は次のいずれかになります。

bidding_strategy

string

キャンペーンで使用されるポートフォリオ入札戦略。

manual_cpa

ManualCpa

標準の個別コンバージョン単価入札戦略。広告主が指定したアクションごとに入札単価を設定できる個別単価設定。ローカル サービス キャンペーンのみでサポートされます。

manual_cpc

ManualCpc

標準の個別クリック単価入札戦略。ユーザーがクリックごとに支払う、個別クリックベースの入札。

manual_cpm

ManualCpm

標準の個別インプレッション単価入札戦略。インプレッションに基づく手動入札。1,000 回のインプレッションごとにユーザーが支払います。

maximize_conversions

MaximizeConversions

予算を消化しつつコンバージョン数を自動的に最大化できる、標準の「コンバージョン数の最大化」入札戦略。

maximize_conversion_value

MaximizeConversionValue

予算を消化しつつ収益を最大化するように入札単価を自動的に設定する、標準の「コンバージョン値の最大化」入札戦略。

target_cpa

TargetCpa

標準の「目標コンバージョン単価」入札戦略では、指定した目標コンバージョン単価(CPA)でコンバージョンを最大限に獲得できるように入札単価が自動的に設定されます。

target_impression_share

TargetImpressionShare

目標インプレッション シェア入札戦略。指定した割合のインプレッションを達成できるように入札単価を設定する自動入札戦略。

target_roas

TargetRoas

標準の目標広告費用対効果入札戦略。特定の目標広告費用対効果(ROAS)の平均値を設定しながら、収益を自動的に最大化します。

target_spend

TargetSpend

予算内でクリック数を最大化できるように入札単価を自動的に設定する、標準の目標予算入札戦略です。

percent_cpc

PercentCpc

商品やサービスの広告価格に対する割合で入札する、標準のクリック単価入札戦略。

target_cpm

TargetCpm

インプレッション単価を自動的に最適化する入札戦略。

DynamicSearchAdsSetting

動的検索広告(DSA)を管理するための設定。

フィールド
domain_name

string

必須。この設定が表すインターネット ドメイン名(例: google.com)www.google.com などです。

language_code

string

必須。ドメインの言語を指定する言語コード(「en」など)。

use_supplied_urls_only

bool

キャンペーンで広告主提供の URL のみを使用するかどうか。

GeoTargetTypeSetting

広告の地域ターゲティングに関連する設定のコレクションを表します。

フィールド
positive_geo_target_type

PositiveGeoTargetType

この特定のキャンペーンで非除外の地域ターゲティングに使用される設定です。

negative_geo_target_type

NegativeGeoTargetType

この特定のキャンペーンの除外地域ターゲティングに使用される設定です。

NetworkSettings

キャンペーンの掲載ネットワークの設定です。

フィールド
target_search_network

bool

Google 検索ネットワークのパートナー サイトに広告を配信するかどうか(target_google_searchtrue にする必要があります)。

target_content_network

bool

Google ディスプレイ ネットワークの指定したプレースメントに広告を配信するかどうか。プレースメントは、プレースメント条件で指定します。

target_partner_search_network

bool

Google パートナー ネットワークで広告を配信するかどうか。この機能は、一部の Google パートナー アカウントでのみご利用いただけます。

OptimizationGoalSetting

このキャンペーンの最適化目標の設定です。一連の最適化の目標タイプが含まれます。

フィールド
optimization_goal_types[]

OptimizationGoalType

最適化の目標タイプのリスト。

SelectiveOptimization

このキャンペーンの選択的最適化の設定。このキャンペーンの最適化で重視するコンバージョン アクションが含まれます。この機能は、MULTI_CHANNEL を AdvertisingChannelType として使用し、APP_CAMPAIGN または APP_CAMPAIGN_FOR_ENGAGEMENT を AdvertisingChannelSubType として使用するアプリ キャンペーンにのみ適用されます。

フィールド
conversion_actions[]

string

このキャンペーンを最適化するために選択したコンバージョン アクションのセット。

ShoppingSetting

ショッピング キャンペーンの設定。キャンペーンで宣伝できる商品全体と、このキャンペーンが他のショッピング キャンペーンとどのように相互作用するかを定義します。

フィールド
feed_label

string

キャンペーンに含める商品のフィードラベル。設定できるのは、feed_label または sales_country のみです。sales_country の代わりに、feed_label フィールドには、同じ形式の国コードを指定できます(「XX」など)。それ以外の場合は、Google Merchant Center のフィードラベルに使用する任意の文字列を指定できます。

use_vehicle_inventory

bool

車両リスティングの広告枠をターゲットに設定するかどうか。

merchant_id

int64

Merchant Center アカウントの ID。このフィールドは、作成オペレーションに必要です。ショッピング キャンペーンの場合、このフィールドは変更できません。

sales_country

string

キャンペーンに含める商品の販売国。

campaign_priority

int32

キャンペーンの優先順位。優先度の数値が高いキャンペーンは、優先度の低いキャンペーンよりも優先されます。このフィールドはショッピング キャンペーンに必須で、値の範囲は 0 ~ 2 です。スマート ショッピング キャンペーンの場合、このフィールドは省略可能ですが、設定する場合は 3 に設定する必要があります。

enable_local

bool

ローカル商品を含めるかどうかを指定します。

TrackingSetting

トラッキング情報に関するキャンペーン単位の設定。

フィールド
tracking_url

string

動的トラッキングに使用する URL。

CampaignAsset

キャンペーンとアセット間のリンク。

フィールド
resource_name

string

キャンペーン アセットのリソース名。CampaignAsset リソース名の形式は次のとおりです。

customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}

status

AssetLinkStatus

キャンペーン アセットのステータス。

campaign

string

アセットがリンクされているキャンペーン。

asset

string

キャンペーンにリンクされているアセット。

CampaignAssetSet

CampaignAssetSet はキャンペーンとアセットセット間のリンクです。CampaignAssetSet を追加すると、アセットセットとキャンペーンがリンクされます。

フィールド
resource_name

string

キャンペーンのアセットセットのリソース名。アセットセットのアセット リソース名の形式は次のとおりです。

customers/{customer_id}/campaignAssetSets/{campaign_id}~{asset_set_id}

campaign

string

このアセットセットがリンクされているキャンペーン。

asset_set

string

キャンペーンにリンクされているアセットセット。

status

AssetSetLinkStatus

キャンペーンのアセットセットのアセットのステータス。読み取り専用です。

CampaignAudienceView

キャンペーンのオーディエンス ビュー。ディスプレイ ネットワーク広告と YouTube ネットワーク広告のインタレストとリマーケティング リスト、検索広告向けリマーケティング リスト(RLSA)について、キャンペーンやオーディエンスの条件ごとに集計した掲載結果データが含まれます。このビューには、キャンペーン単位で設定されたオーディエンスのみが含まれます。

フィールド
resource_name

string

キャンペーン オーディエンス ビューのリソース名。キャンペーンのオーディエンス ビューのリソース名の形式は次のとおりです。

customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}

CampaignBudget

キャンペーンの予算

フィールド
resource_name

string

キャンペーン予算のリソース名。キャンペーン予算のリソース名の形式は次のとおりです。

customers/{customer_id}/campaignBudgets/{campaign_budget_id}

delivery_method

BudgetDeliveryMethod

キャンペーン予算が消費される割合を決定する配信方法。

作成オペレーションで指定しない場合のデフォルトは STANDARD です。

period

BudgetPeriod

予算を消化する期間です。指定しない場合のデフォルトは DAILY です。

amount_micros

int64

アカウントに対する現地通貨での予算額。金額はマイクロ秒単位で指定します。ここで、100 万が 1 通貨単位に相当します。1 か月の費用の上限はこの金額の 30.4 倍です。

CampaignCriterion

キャンペーンの条件です。

フィールド
resource_name

string

キャンペーンの条件のリソース名。キャンペーンの条件のリソース名の形式は次のとおりです。

customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}

display_name

string

条件の表示名。

このフィールドはミューテーションの場合は無視されます。

type

CriterionType

条件のタイプ。

status

CampaignCriterionStatus

条件のステータス。

last_modified_time

string

このキャンペーン条件が最後に変更された日時。日時は、顧客のタイムゾーンの「yyyy-MM-dd HH:mm:ss.ssssss」形式です。

criterion_id

int64

条件の ID。

このフィールドは変更時に無視されます。

bid_modifier

float

条件が一致した場合の入札の修飾子。修飾子は 0.1 ~ 10.0 の範囲内にする必要があります。対象とする条件タイプのほとんどで、修飾子がサポートされています。デバイスタイプをオプトアウトするには、0 を使用します。

negative

bool

条件をターゲティング(false)するか除外(true)するかを指定します。

共用体フィールド criterion。キャンペーンの条件です。

1 つのみを設定する必要があります。criterion は次のいずれかになります。

keyword

KeywordInfo

キーワード。

location

LocationInfo

位置情報] をタップします。

device

DeviceInfo

デバイス] など)を選択します。

age_range

AgeRangeInfo

年齢層。

gender

GenderInfo

性別。

user_list

UserListInfo

ユーザーリスト。

language

LanguageInfo

学びました。

webpage

WebpageInfo

ウェブページ。

location_group

LocationGroupInfo

地域グループ

CampaignLabel

キャンペーンとラベルの関係を表します。

フィールド
resource_name

string

リソースの名前。キャンペーン ラベルのリソース名の形式: customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}

campaign

string

ラベルが添付されるキャンペーン。

label

string

キャンペーンに割り当てられるラベル。

CartDataSalesView

カートデータの販売ビュー。

フィールド
resource_name

string

カートデータの販売ビューのリソース名。カートデータの販売ビューのリソース名の形式は customers/{customer_id}/cartDataSalesView です。

コンバージョン

コンバージョン。

フィールド
resource_name

string

コンバージョンのリソース名。コンバージョン リソース名の形式は次のとおりです。

customers/{customer_id}/conversions/{ad_group_id}~{criterion_id}~{ds_conversion_id}

id

int64

コンバージョンの ID

criterion_id

int64

検索広告 360 の条件 ID。値 0 は、その条件が関連付けられていないことを示します。

merchant_id

int64

クリックされた商品を含む検索広告 360 在庫アカウント ID。検索広告 360 内で在庫アカウントをリンクすると、検索広告 360 でこの ID が生成されます。

ad_id

int64

広告 ID。値 0 は、広告が関連付けられていないことを示します。

click_id

string

コンバージョンが関連付けられている訪問の一意の文字列で、click id という URL パラメータとしてランディング ページに渡されます。

visit_id

int64

コンバージョンが関連付けられた検索広告 360 の訪問 ID。

advertiser_conversion_id

string

オフライン コンバージョンの場合は、広告主が提供する ID です。このような ID が広告主から指定されていない場合、検索広告 360 によって生成されます。オンライン コンバージョンの場合は、広告主の Floodlight 処理に応じて、id 列または floodlight_order_id 列と同じになります。

product_id

string

クリックされた商品の ID。

product_channel

ProductChannel

クリックされた商品の販売チャネル: オンラインまたはローカル。

product_language_code

string

商品に関するデータを含む Merchant Center フィードに設定されている言語(ISO-639-1)。

product_store_id

string

クリックされたローカル在庫広告のストア。この ID はローカル商品フィードで使用されているストア ID と一致する必要があります。

product_country_code

string

クリックされた商品を含む在庫フィードに登録されている国(ISO-3166 形式)。

attribution_type

AttributionType

コンバージョンが関連付けられた要素: 「訪問」または「キーワード + 広告」。

conversion_date_time

string

コンバージョン イベントのタイムスタンプ。

conversion_last_modified_date_time

string

コンバージョンが最後に変更された時刻のタイムスタンプ。

conversion_visit_date_time

string

コンバージョンが関連付けられた訪問のタイムスタンプ。

conversion_quantity

int64

コンバージョンで記録されたアイテムの数量で、qty という URL パラメータによって特定されます。広告主がパラメータ(コンバージョンで販売されたアイテム数など)を動的に入力する必要がありますが、入力しない場合、デフォルトで 1 になります。

conversion_revenue_micros

int64

コンバージョン イベントの調整された収益(マイクロ秒単位)。これは常に広告配信中アカウントの通貨で表示されます。

floodlight_original_revenue

int64

Floodlight 通貨指示の変更前の、Floodlight イベントに関連付けられた、変更されていない元の収益(現在のレポートの通貨)。

floodlight_order_id

string

コンバージョンに関して広告主から提供された Floodlight オーダー ID。

status

ConversionStatus

コンバージョンのステータス(ENABLED または REMOVED)

asset_id

int64

コンバージョン イベント中に接点があったアセットの ID。

asset_field_type

AssetFieldType

コンバージョン イベントのアセット フィールド タイプ。

ConversionAction

コンバージョン アクション。

フィールド
resource_name

string

コンバージョン アクションのリソース名。コンバージョン アクションのリソース名の形式は次のとおりです。

customers/{customer_id}/conversionActions/{conversion_action_id}

creation_time

string

Floodlight アクティビティの作成時点のタイムスタンプ(ISO 8601 形式)。

status

ConversionActionStatus

コンバージョン イベントの発生に関するこのコンバージョン アクションのステータス。

type

ConversionActionType

このコンバージョン アクションのタイプ。

category

ConversionActionCategory

このコンバージョン アクションについてレポートされたコンバージョンのカテゴリ。

value_settings

ValueSettings

このコンバージョン アクションに関連付けられたコンバージョン イベントの値に関連する設定。

attribution_model_settings

AttributionModelSettings

このコンバージョン アクションのアトリビューション モデルに関連する設定です。

floodlight_settings

FloodlightSettings

Floodlight コンバージョン タイプの Floodlight 設定。

id

int64

コンバージョン アクションの ID。

name

string

コンバージョン アクションの名前。

新しいコンバージョン アクションを作成する場合は、このフィールドは必須です。空にすることはできません。

primary_for_goal

bool

コンバージョン アクションの primary_for_goal ビットが false の場合、顧客のコンバージョン目標やキャンペーンのコンバージョン目標に関係なく、そのコンバージョン アクションはすべてのキャンペーンで入札できません。ただし、カスタム コンバージョン目標では primary_for_goal が考慮されないため、キャンペーンで primary_for_goal = false コンバージョン アクションのカスタム コンバージョン目標が設定されている場合、そのコンバージョン アクションは入札対象となります。デフォルトでは、設定しない場合、primary_for_goal が true になります。V9 では、primary_for_goal を false に設定できるのは「update」で作成された後のみです。オプションとして宣言されていないためです。

owner_customer

string

コンバージョン アクションのオーナーである顧客のリソース名。システム定義のコンバージョン アクションの場合は null。

include_in_client_account_conversions_metric

bool

このコンバージョン アクションを [client_account_conversions] に含めるかどうか表示されます。

include_in_conversions_metric

bool

このコンバージョン アクションを [コンバージョン] に含めるかどうか表示されます。

click_through_lookback_window_days

int64

インタラクション(クリックなど)からコンバージョン イベントの発生までの最大日数。

app_id

string

アプリ コンバージョン アクションのアプリ ID。

AttributionModelSettings

このコンバージョン アクションのアトリビューション モデルに関連する設定です。

フィールド
attribution_model

AttributionModel

このコンバージョン アクションのアトリビューション モデルタイプ。

data_driven_model_status

DataDrivenModelStatus

コンバージョン アクションのデータドリブン アトリビューション モデルのステータス。

FloodlightSettings

Floodlight コンバージョン アクションに関連する設定。

フィールド
activity_group_tag

string

コンバージョンのレポート時に Floodlight アクティビティ グループの識別に使用される文字列。

activity_tag

string

コンバージョンのレポート時に Floodlight アクティビティを識別するために使用される文字列。

activity_id

int64

DoubleClick Campaign Manager(DCM)の Floodlight アクティビティの ID。

ValueSettings

このコンバージョン アクションに関連付けられたコンバージョン イベントの値に関連する設定。

フィールド
default_value

double

このコンバージョン アクションのコンバージョン イベントが無効な値、許可されていない値、または欠落している値とともに送信された場合、またはこのコンバージョン アクションが常にデフォルト値を使用するように設定されている場合に使用する値です。

default_currency_code

string

このコンバージョン アクションのコンバージョン イベントが送信されたときに通貨コードが無効であるか、通貨コードが含まれていない場合、またはこのコンバージョン アクションが常にデフォルト値を使用するように設定されている場合に使用する通貨コード。

always_use_default_value

bool

このコンバージョン アクションのコンバージョン イベントで指定された値と通貨コードの代わりに、デフォルト値とデフォルトの通貨コードを使用するかどうかを指定します。

ConversionCustomVariable

コンバージョン カスタム変数。「検索広告 360 リニューアル版のカスタム Floodlight の指標とディメンションについて」をご覧くださいhttps://support.google.com/sa360/answer/13567857

フィールド
resource_name

string

コンバージョン カスタム変数のリソース名。コンバージョン カスタム変数のリソース名の形式は次のとおりです。

customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}

id

int64

コンバージョン カスタム変数の ID。

name

string

必須。コンバージョン カスタム変数の名前。一意の名前にしてください。名前の最大長は 100 文字です。前後に余分なスペースを入れないでください。

tag

string

必須。コンバージョン カスタム変数のタグ。タグは一意で、「u」で構成されている必要がありますその直後に 100 以下の数字が続きます。例: 「u4」。

status

ConversionCustomVariableStatus

コンバージョン イベントの発生に関するコンバージョン カスタム変数のステータス。

owner_customer

string

コンバージョン カスタム変数を所有する顧客のリソース名。

family

ConversionCustomVariableFamily

コンバージョン カスタム変数のファミリー。

cardinality

ConversionCustomVariableCardinality

コンバージョン カスタム変数の基数。

floodlight_conversion_custom_variable_info

FloodlightConversionCustomVariableInfo

検索広告 360 Floodlight コンバージョン カスタム変数のフィールド。

custom_column_ids[]

int64

このコンバージョン カスタム変数を使用するカスタム列の ID。

FloodlightConversionCustomVariableInfo

検索広告 360 の Floodlight コンバージョン カスタム変数に関する情報

フィールド
floodlight_variable_type

FloodlightVariableType

検索広告 360 で定義された Floodlight 変数タイプ。

floodlight_variable_data_type

FloodlightVariableDataType

検索広告 360 で定義されている Floodlight 変数のデータ型。

ConversionTrackingSetting

検索広告 360 のコンバージョン トラッキングに関連する、顧客全体の設定のコレクション。

フィールド
accepted_customer_data_terms

bool

お客様が顧客データに関する規約に同意したかどうか。クロスアカウント コンバージョン トラッキングを使用している場合、この値は MCC アカウントから継承されます。このフィールドは読み取り専用です。詳しくは、https://support.google.com/adspolicy/answer/7475709 をご覧ください。

conversion_tracking_status

ConversionTrackingStatus

コンバージョン トラッキングのステータス。顧客がコンバージョン トラッキングを使用しているかどうか、またこの顧客のコンバージョン トラッキングの所有者は誰なのかが表示されます。この顧客がクロスアカウント コンバージョン トラッキングを使用している場合、返される値はリクエストの login-customer-id によって異なります。

enhanced_conversions_for_leads_enabled

bool

お客様がリードの拡張コンバージョンを有効にしているかどうか。クロスアカウント コンバージョン トラッキングを使用している場合、この値は MCC アカウントから継承されます。このフィールドは読み取り専用です。

google_ads_conversion_customer

string

コンバージョンの作成と管理が行われる顧客のリソース名。このフィールドは読み取り専用です。

conversion_tracking_id

int64

このアカウントで使用されているコンバージョン トラッキング ID。この ID は、顧客がコンバージョン トラッキングを使用しているかどうかを示すものではありません(conversion_tracking_status は使用します)。このフィールドは読み取り専用です。

google_ads_cross_account_conversion_tracking_id

int64

顧客の管理者のコンバージョン トラッキング ID。顧客がコンバージョン トラッキングを有効にした場合に設定され、conversion_tracking_id をオーバーライドします。この項目は Google 広告の管理画面でのみ管理できます。このフィールドは読み取り専用です。

cross_account_conversion_tracking_id

int64

顧客の管理者のコンバージョン トラッキング ID。これは、顧客がクロスアカウント コンバージョン トラッキングを有効にした場合に設定され、conversion_tracking_id をオーバーライドします。

CustomColumn

カスタム列。検索広告 360 のカスタム列について詳しくは、https://support.google.com/sa360/answer/9633916 をご覧ください。

フィールド
resource_name

string

カスタム列のリソース名。カスタム列のリソース名の形式は次のとおりです。

customers/{customer_id}/customColumns/{custom_column_id}

id

int64

カスタム列の ID です。

name

string

カスタム列のユーザー定義の名前。

description

string

カスタム列に関するユーザー定義の説明です。

value_type

CustomColumnValueType

カスタム列の結果値の型。

references_attributes

bool

カスタム列が 1 つ以上の属性を参照している場合は true。

references_metrics

bool

カスタム列が 1 つ以上の指標を参照している場合は true。

queryable

bool

カスタム列が SearchAds360Service.Search と SearchAds360Service.SearchStream のクエリで使用できる場合は true。

referenced_system_columns[]

string

このカスタム列の参照システム列のリストです。(例: 「インプレッション数とクリック数の合計」カスタム列)は {"metrics.clicks", "metrics.impressions"} のシステム列を参照しています。

顧客

お客様です。

フィールド
resource_name

string

顧客のリソース名。顧客のリソース名の形式は次のとおりです。

customers/{customer_id}

conversion_tracking_setting

ConversionTrackingSetting

顧客のコンバージョン トラッキング設定。

account_type

AccountType

エンジン アカウント タイプ(Google 広告、Microsoft Advertising、Yahoo! JAPAN、Baidu、Facebook、エンジン トラッキングなど)

double_click_campaign_manager_setting

DoubleClickCampaignManagerSetting

DoubleClick Campaign Manager(DCM)の設定です。

account_status

AccountStatus

アカウントのステータス(有効、一時停止、削除済みなど)。

last_modified_time

string

この顧客が最後に変更された日時。日時は、顧客のタイムゾーンの「yyyy-MM-dd HH:mm:ss.ssssss」形式です。

engine_id

string

外部エンジン アカウントのアカウント ID。

status

CustomerStatus

顧客のステータス。

creation_time

string

この顧客が作成されたときのタイムスタンプ。このタイムスタンプは、顧客のタイムゾーンを「yyyy-MM-dd HH:mm:ss」形式で指定します。

id

int64

顧客の ID。

descriptive_name

string

顧客の一意でないわかりやすい名前(省略可)。

currency_code

string

アカウントが運用されている通貨。ISO 4217 標準の通貨コードのサブセットがサポートされています。

time_zone

string

顧客のローカル タイムゾーン ID。

tracking_url_template

string

パラメータからトラッキング URL を作成するための URL テンプレート。

final_url_suffix

string

パラメータを最終ページ URL に追加するための URL テンプレート。

auto_tagging_enabled

bool

ユーザーに対して自動タグ設定が有効になっているかどうか。

manager

bool

お客様がマネージャーであるかどうか

CustomerAsset

顧客とアセット間のリンク。

フィールド
resource_name

string

顧客アセットのリソース名。CustomerAsset リソース名の形式は次のとおりです。

customers/{customer_id}/customerAssets/{asset_id}~{field_type}

asset

string

必須。顧客に関連付けられているアセット。

status

AssetLinkStatus

お客様のアセットのステータス。

CustomerAssetSet

CustomerAssetSet はお客様とアセットセット間のリンクです。CustomerAssetSet を追加すると、アセットセットがお客様とリンクされます。

フィールド
resource_name

string

顧客アセットセットのリソース名。アセットセットのアセット リソース名の形式は次のとおりです。

customers/{customer_id}/customerAssetSets/{asset_set_id}

asset_set

string

顧客に関連付けられているアセットセット。

customer

string

このアセットセットがリンクされている顧客。

status

AssetSetLinkStatus

お客様のアセットセット アセットのステータス。読み取り専用です。

CustomerClient

特定の顧客とクライアントの顧客間のリンク。CustomerClient は、マネージャーのお客様専用です。直接的および間接的なクライアントのすべての顧客と、マネージャー自体が含まれます。

フィールド
resource_name

string

顧客クライアントのリソース名。CustomerClient リソース名の形式は customers/{customer_id}/customerClients/{client_customer_id} です。

applied_labels[]

string

クライアントの顧客に適用され、リクエスト元の顧客が所有するラベルのリソース名。ラベルリソース名の形式は次のとおりです。

customers/{customer_id}/labels/{label_id}

status

CustomerStatus

クライアントの顧客のステータス。読み取り専用。

client_customer

string

特定の顧客にリンクされている顧客顧客のリソース名。読み取り専用。

hidden

bool

このアカウントが非表示であるかどうかを指定します。

読み取り専用。

level

int64

対象の顧客と顧客の距離セルフリンクの場合、レベルの値は 0 です。読み取り専用。

time_zone

string

クライアントのタイムゾーンを表す Common Locale Data Repository(CLDR)文字列表現(America/Los_Angeles など)。読み取り専用。

test_account

bool

クライアントがテスト アカウントかどうかを示します。読み取り専用。

manager

bool

クライアントがマネージャーかどうかを識別します。読み取り専用。

descriptive_name

string

クライアントのわかりやすい名前です。読み取り専用。

currency_code

string

クライアントの通貨コード(「USD」、「EUR」など)。読み取り専用。

id

int64

クライアントのお客様の ID。読み取り専用。

DoubleClickCampaignManagerSetting

DoubleClick Campaign Manager(DCM)の設定です。

フィールド
advertiser_id

int64

この顧客に関連付けられているキャンペーン マネージャー 広告主の ID。

network_id

int64

この顧客に関連付けられているキャンペーン マネージャー ネットワークの ID。

time_zone

string

この顧客に関連付けられているキャンペーン マネージャー ネットワークのタイムゾーン。IANA タイムゾーン データベース形式(America/New_York など)で指定します。

DynamicSearchAdsSearchTermView

動的検索広告の検索語句ビュー。

フィールド
resource_name

string

動的検索広告の検索語句ビューのリソース名。動的検索広告の検索語句ビューのリソース名の形式は次のとおりです。

customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}~{search_term_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}

landing_page

string

動的に選択されたインプレッションのランディング ページ URL。

このフィールドは読み取り専用です。

GenderView

性別のビュー。gender_view リソースは、追加された条件ではなく、有効なサービス提供状態を反映しています。性別の条件がない広告グループは、デフォルトですべての性別で表示されるため、すべての性別が統計情報とともに gender_view に表示されます。

フィールド
resource_name

string

性別ビューのリソース名。性別ビューのリソース名の形式は次のとおりです。

customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}

GeoTargetConstant

地域ターゲティングの定数。

フィールド
resource_name

string

地域ターゲティング定数のリソース名。地域ターゲティングの定数リソース名の形式は次のとおりです。

geoTargetConstants/{geo_target_constant_id}

status

GeoTargetConstantStatus

地域ターゲティングの定数ステータスです。

id

int64

地域ターゲティング定数の ID です。

name

string

地域ターゲティングの英語の表記(固定表示)。

country_code

string

ターゲット地域に関連付けられる国コード(ISO-3166-1 alpha-2)です。

target_type

string

地域ターゲティングの定数ターゲット タイプ。

canonical_name

string

ターゲットの名前と、その地域が属する親地域と国の名前で構成される英語の完全修飾名。

parent_geo_target

string

親の地域ターゲティング定数のリソース名。地域ターゲティングの定数リソース名の形式は次のとおりです。

geoTargetConstants/{parent_geo_target_constant_id}

KeywordView

キーワード ビュー。

フィールド
resource_name

string

キーワード ビューのリソース名。キーワード ビューのリソース名の形式は次のとおりです。

customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}

ラベル

ラベル。

フィールド
resource_name

string

リソースの名前。ラベルのリソース名の形式は customers/{customer_id}/labels/{label_id} です。

status

LabelStatus

ラベルのステータス。読み取り専用。

text_label

TextLabel

色付きの背景にテキストを表示するラベルの一種。

id

int64

ラベルの ID。読み取り専用。

name

string

ラベルの名前。

新しいラベルを作成する場合は、このフィールドは必須です。空にすることはできません。

この文字列の長さは 1~80 で指定します。

LanguageConstant

言語。

フィールド
resource_name

string

言語定数のリソース名。言語定数リソース名の形式は次のとおりです。

languageConstants/{criterion_id}

id

int64

言語定数の ID。

code

string

言語コード(「en_US」、「en_AU」、「es」、「fr」など)。

name

string

英語の正式名称(「英語(米国)」「スペイン語」など)。

targetable

bool

言語がターゲットに設定できるかどうか。

ListingGroupFilterDimension

アセット グループのリスティング グループ フィルタのリスティング ディメンション。

フィールド
共用体フィールド dimension。以下のいずれかのタイプのディメンションが常に存在します。dimension は次のいずれかになります。
product_bidding_category

ProductBiddingCategory

商品情報の入札カテゴリ。

product_brand

ProductBrand

商品情報のブランド。

product_channel

ProductChannel

商品情報の地域区分。

product_condition

ProductCondition

商品の状態。

product_custom_attribute

ProductCustomAttribute

商品情報のカスタム属性。

product_item_id

ProductItemId

商品情報の商品アイテム ID。

product_type

ProductType

商品情報のタイプ。

ProductBiddingCategory

特定のレベルの入札カテゴリの 1 つの要素です。最上位のカテゴリがレベル 1、その子がレベル 2 というように続きます。現時点では、最大 5 つのレベルがサポートされています。ユーザーは、カテゴリのレベルを示すディメンション タイプを指定する必要があります。同じ区分のケースはすべて、同じディメンション タイプ(カテゴリレベル)にする必要があります。

フィールド
level

ListingGroupFilterBiddingCategoryLevel

分類のカテゴリのレベルを示します。

id

int64

商品の入札カテゴリの ID。

この ID は、次の記事で説明されている google_product_category ID に相当します。詳しくは、https://support.google.com/merchants/answer/6324436 をご覧ください。

ProductBrand

商品のブランド。

フィールド
value

string

商品ブランドの文字列値。

ProductChannel

商品情報の地域区分。

フィールド
channel

ListingGroupFilterProductChannel

地域区分の値。

ProductCondition

商品の状態。

フィールド
condition

ListingGroupFilterProductCondition

条件の値。

ProductCustomAttribute

商品情報のカスタム属性。

フィールド
index

ListingGroupFilterCustomAttributeIndex

カスタム属性のインデックスを示します。

value

string

商品のカスタム属性の文字列値。

ProductItemId

商品情報の商品アイテム ID。

フィールド
value

string

ID の値。

ProductType

商品情報のタイプ。

フィールド
level

ListingGroupFilterProductTypeLevel

型のレベル。

value

string

型の値。

ListingGroupFilterDimensionPath

リスティング グループのフィルタを定義するディメンションを定義するパス。

フィールド
dimensions[]

ListingGroupFilterDimension

リスティング グループのフィルタ階層(ルートノードを除く)から、このリスティング グループ フィルタまでのディメンションの完全なパス。

LocationView

地域ビューには、地域条件別のキャンペーンのパフォーマンスの概要が表示されます。

フィールド
resource_name

string

ビジネス ビューのリソース名。ロケーション ビューのリソース名の形式は次のとおりです。

customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}

ProductBiddingCategoryConstant

商品の入札カテゴリ。

フィールド
resource_name

string

商品入札カテゴリのリソース名。商品入札カテゴリのリソース名の形式は次のとおりです。

productBiddingCategoryConstants/{country_code}~{level}~{id}

level

ProductBiddingCategoryLevel

商品の入札カテゴリのレベル。

status

ProductBiddingCategoryStatus

商品の入札カテゴリのステータス。

id

int64

商品の入札カテゴリの ID。

この ID は google_product_category ID に相当します(詳しくは https://support.google.com/merchants/answer/6324436 をご覧ください)。

country_code

string

商品の入札カテゴリの 2 文字の大文字の国コード。

product_bidding_category_constant_parent

string

親の商品の入札カテゴリのリソース名。

language_code

string

商品の入札カテゴリの言語コードです。

localized_name

string

言語コードに従ってローカライズされた商品の入札カテゴリの値を表示します。

ProductGroupView

商品グループビュー。

フィールド
resource_name

string

商品グループビューのリソース名。商品グループビューのリソース名の形式は次のとおりです。

customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}

SearchAds360Field

SearchAds360Service で使用されるフィールドまたはリソース(アーティファクト)。

フィールド
resource_name

string

アーティファクトのリソース名。アーティファクト リソース名の形式は次のとおりです。

SearchAds360Fields/{name}

category

SearchAds360FieldCategory

アーティファクトのカテゴリ。

selectable_with[]

string

記述されたアーティファクトで選択可能なすべてのリソース、セグメント、指標の名前。

attribute_resources[]

string

記述されたアーティファクトで選択可能なすべてのリソースの名前。検索クエリに含まれている場合、これらのリソースのフィールドは指標を分割されません。

このフィールドは、カテゴリが RESOURCE のアーティファクトにのみ設定されます。

metrics[]

string

このフィールドには、記述されたアーティファクトが FROM 句で使用されているときに、そのアーティファクトで選択可能なすべての指標の名前がリストされます。カテゴリが RESOURCE のアーティファクトにのみ設定されます。

segments[]

string

このフィールドには、セグメントか別のリソースかを問わず、検索クエリに含まれ、記述されたアーティファクトが FROM 句で使用されるときに指標をセグメント化するすべてのアーティファクトの名前がリストされます。カテゴリが RESOURCE のアーティファクトにのみ設定されます。

enum_values[]

string

ENUM 型のフィールドの場合にアーティファクトが仮定できる値。

このフィールドは、カテゴリ SEGMENT または ATTRIBUTE のアーティファクトにのみ設定されます。

data_type

SearchAds360FieldDataType

このフィールドにより、WHERE 句でアーティファクトで使用できる演算子が決まります。

name

string

アーティファクトの名前。

selectable

bool

検索クエリの SELECT 句でアーティファクトを使用できるかどうか。

filterable

bool

検索クエリの WHERE 句でアーティファクトを使用できるかどうか。

sortable

bool

検索クエリの ORDER BY 句でアーティファクトを使用できるかどうか。

type_url

string

アーティファクトのデータ型を記述する proto の URL。

is_repeated

bool

フィールド アーティファクトが繰り返されているかどうか。

ShoppingPerformanceView

ショッピングのパフォーマンス ビュー。複数の商品ディメンション レベルで集計されたショッピング キャンペーンの統計情報が表示されます。ブランド、カテゴリ、カスタム属性、商品の状態、商品カテゴリといった Merchant Center の商品ディメンションの値には、対応するイベントが記録された日時における各ディメンションの状態が反映されます。

フィールド
resource_name

string

ショッピングのパフォーマンス ビューのリソース名。ショッピングのパフォーマンス ビューのリソース名の形式は、customers/{customer_id}/shoppingPerformanceView です。

UserList

ユーザーリスト。これは、お客様がターゲットにできるユーザーのリストです。

フィールド
resource_name

string

ユーザーリストのリソース名。ユーザーリストのリソース名の形式は次のとおりです。

customers/{customer_id}/userLists/{user_list_id}

type

UserListType

このリストのタイプ。

このフィールドは読み取り専用です。

id

int64

ユーザーリストの ID。

name

string

このユーザー リストの名前。access_reason によっては、ユーザーリスト名が一意でない場合があります(access_reason=SHARED の場合など)。

アクセス

1 回の訪問です。

フィールド
resource_name

string

訪問のリソース名。訪問リソース名の形式は次のとおりです。

customers/{customer_id}/visits/{ad_group_id}~{criterion_id}~{ds_visit_id}

id

int64

訪問の ID。

criterion_id

int64

Search Ads 360 キーワード ID。値 0 は、キーワードが関連付けられていないことを示します。

merchant_id

int64

クリックされた商品を含む検索広告 360 在庫アカウント ID。検索広告 360 内で在庫アカウントをリンクすると、検索広告 360 でこの ID が生成されます。

ad_id

int64

広告 ID。値 0 は、広告が関連付けられていないことを示します。

click_id

string

クリック ID URL パラメータとしてランディング ページに渡される、訪問ごとの一意の文字列。

visit_date_time

string

訪問イベントのタイムスタンプ。このタイムスタンプは、顧客のタイムゾーンを「yyyy-MM-dd HH:mm:ss」形式で指定します。

product_id

string

クリックされた商品の ID。

product_channel

ProductChannel

クリックされた商品の販売チャネル: オンラインまたはローカル。

product_language_code

string

商品に関するデータを含む Merchant Center フィードに設定されている言語(ISO-639-1)。

product_store_id

string

クリックされたローカル在庫広告のストア。この ID はローカル商品フィードで使用されているストア ID と一致する必要があります。

product_country_code

string

クリックされた商品を含む在庫フィードに登録されている国(ISO-3166 形式)。

asset_id

int64

訪問イベント中に接点があったアセットの ID。

asset_field_type

AssetFieldType

訪問イベントのアセット フィールド タイプ。

WebpageView

ウェブページ ビュー。

フィールド
resource_name

string

ウェブページ ビューのリソース名。ウェブページビューのリソース名の形式は次のとおりです。

customers/{customer_id}/webpageViews/{ad_group_id}~{criterion_id}