Package google.ads.searchads360.v0.services

索引

CustomColumnService

カスタム列を管理するサービス。

GetCustomColumn

rpc GetCustomColumn(GetCustomColumnRequest) returns (CustomColumn)

リクエストされたカスタム列をすべて返します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/doubleclicksearch
ListCustomColumns

rpc ListCustomColumns(ListCustomColumnsRequest) returns (ListCustomColumnsResponse)

顧客に関連付けられているすべてのカスタム列の詳細を返します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/doubleclicksearch

CustomerService

顧客を管理するサービス。

ListAccessibleCustomers

rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)

呼び出しを認証するユーザーが直接アクセスできる顧客のリソース名を返します。

スローされるエラーのリスト: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/doubleclicksearch

SearchAds360FieldService

Search Ads 360 API のフィールドを取得するためのサービス。

GetSearchAds360Field

rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field)

リクエストされたフィールドのみを返します。

スローされるエラーのリスト: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/doubleclicksearch
SearchSearchAds360Fields

rpc SearchSearchAds360Fields(SearchSearchAds360FieldsRequest) returns (SearchSearchAds360FieldsResponse)

検索クエリに一致するすべてのフィールドを返します。

スローされるエラーのリスト: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/doubleclicksearch

SearchAds360Service

リソース全体のデータと指標を取得するサービス。

検索

rpc Search(SearchSearchAds360Request) returns (SearchSearchAds360Response)

検索クエリに一致するすべての行を返します。

スローされるエラーのリスト: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/doubleclicksearch
SearchStream

rpc SearchStream(SearchSearchAds360StreamRequest) returns (SearchSearchAds360StreamResponse)

検索ストリーム クエリに一致するすべての行を返します。

スローされるエラーのリスト: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/doubleclicksearch

ConversionCustomDimensionHeader

コンバージョンのカスタム ディメンション ヘッダーのメッセージ。

フィールド
id

int64

コンバージョンのカスタム ディメンション ID。

name

string

コンバージョン カスタム ディメンションのユーザー定義の名前。

ConversionCustomMetricHeader

コンバージョンのカスタム指標ヘッダーのメッセージ。

フィールド
id

int64

コンバージョンのカスタム指標 ID。

name

string

コンバージョンのカスタム指標のユーザー定義の名前。

CustomColumnHeader

カスタム列ヘッダーのメッセージ。

フィールド
id

int64

カスタム列の ID。

name

string

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

references_metrics

bool

カスタム列が指標を参照する場合は true。

GetCustomColumnRequest

CustomColumnService.GetCustomColumn のリクエスト メッセージです。

フィールド
resource_name

string

必須。取得するカスタム列のリソース名。

GetSearchAds360FieldRequest

SearchAds360FieldService.GetSearchAds360Field のリクエスト メッセージです。

フィールド
resource_name

string

必須。取得するフィールドのリソース名。

ListAccessibleCustomersRequest

このタイプにはフィールドがありません。

CustomerService.ListAccessibleCustomers のリクエスト メッセージです。

ListAccessibleCustomersResponse

CustomerService.ListAccessibleCustomers に対するレスポンス メッセージです。

フィールド
resource_names[]

string

通話を認証するユーザーが直接アクセスできる顧客のリソース名。

ListCustomColumnsRequest

CustomColumnService.ListCustomColumns に対するリクエスト メッセージ

フィールド
customer_id

string

必須。CustomColumn リスト オペレーションを適用する顧客の ID。

ListCustomColumnsResponse

顧客に関連付けられているすべてのカスタム列を取得するためのレスポンス メッセージ。

フィールド
custom_columns[]

CustomColumn

指定された顧客が所有する CustomColumns。

RawEventConversionDimensionHeader

未加工のイベント コンバージョン ディメンション ヘッダーのメッセージ。

フィールド
id

int64

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

name

string

未加工のイベント ディメンションのユーザー定義の名前。

RawEventConversionMetricHeader

未加工のイベント コンバージョン指標のヘッダーのメッセージ。

フィールド
id

int64

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

name

string

未加工のイベント指標のユーザー定義名。

SearchAds360Row

クエリから返された行。

フィールド
ad_group

AdGroup

クエリで参照されている広告グループ。

ad_group_ad

AdGroupAd

クエリで参照されている広告。

ad_group_ad_label

AdGroupAdLabel

クエリで参照される広告グループの広告ラベル。

ad_group_asset

AdGroupAsset

クエリで参照される広告グループのアセット。

ad_group_asset_set

AdGroupAssetSet

クエリで参照されている広告グループのアセットセット。

ad_group_audience_view

AdGroupAudienceView

クエリで参照されている広告グループのオーディエンス ビュー。

ad_group_bid_modifier

AdGroupBidModifier

クエリで参照されている入札単価調整比。

ad_group_criterion

AdGroupCriterion

クエリで参照されている条件。

ad_group_criterion_label

AdGroupCriterionLabel

クエリで参照される広告グループの条件ラベル。

ad_group_label

AdGroupLabel

クエリで参照される広告グループのラベル。

age_range_view

AgeRangeView

クエリで参照される年齢層ビュー。

asset

Asset

クエリで参照されるアセット。

asset_group_asset

AssetGroupAsset

クエリで参照されるアセット グループのアセット。

asset_group_signal

AssetGroupSignal

クエリで参照されるアセット グループのシグナル。

asset_group_listing_group_filter

AssetGroupListingGroupFilter

クエリで参照されるアセット グループのリスティング グループのフィルタ。

asset_group_top_combination_view

AssetGroupTopCombinationView

クエリで参照されているアセット グループの上位の組み合わせのビュー。

asset_group

AssetGroup

クエリで参照されるアセット グループ。

asset_set_asset

AssetSetAsset

クエリで参照されるアセットセットのアセット。

asset_set

AssetSet

クエリで参照されるアセットセット。

bidding_strategy

BiddingStrategy

クエリで参照されている入札戦略。

campaign_budget

CampaignBudget

クエリで参照されるキャンペーン予算。

campaign

Campaign

クエリで参照されているキャンペーン。

campaign_asset

CampaignAsset

クエリで参照されるキャンペーン アセット。

campaign_asset_set

CampaignAssetSet

クエリで参照されているキャンペーンのアセットセット。

campaign_audience_view

CampaignAudienceView

クエリで参照されているキャンペーンのオーディエンス ビュー。

campaign_criterion

CampaignCriterion

クエリで参照されているキャンペーンの条件。

campaign_label

CampaignLabel

クエリで参照されるキャンペーン ラベル。

cart_data_sales_view

CartDataSalesView

クエリで参照されるカートデータのセールスビュー。

audience

Audience

クエリで参照されているオーディエンス。

conversion_action

ConversionAction

クエリで参照されるコンバージョン アクション。

conversion_custom_variable

ConversionCustomVariable

クエリで参照されるコンバージョン カスタム変数。

customer

Customer

クエリで参照されている顧客。

customer_asset

CustomerAsset

クエリで参照される顧客アセット。

customer_asset_set

CustomerAssetSet

クエリで参照される顧客アセットセット。

accessible_bidding_strategy

AccessibleBiddingStrategy

クエリで参照されているアクセス可能な入札戦略。

customer_client

CustomerClient

クエリで参照される CustomerClient。

dynamic_search_ads_search_term_view

DynamicSearchAdsSearchTermView

クエリで参照されている動的検索広告の検索語句ビュー。

gender_view

GenderView

クエリで参照される性別ビュー。

geo_target_constant

GeoTargetConstant

クエリで参照されている地域ターゲティングの定数。

keyword_view

KeywordView

クエリで参照されているキーワード ビュー。

label

Label

クエリで参照されるラベル。

language_constant

LanguageConstant

クエリで参照される言語定数。

location_view

LocationView

クエリで参照されるロケーション ビュー。

product_bidding_category_constant

ProductBiddingCategoryConstant

クエリで参照されている商品の入札カテゴリ。

product_group_view

ProductGroupView

クエリで参照される商品グループのビュー。

shopping_performance_view

ShoppingPerformanceView

クエリで参照されるショッピングのパフォーマンス ビュー。

user_list

UserList

クエリで参照されるユーザーリスト。

webpage_view

WebpageView

クエリで参照されるウェブページ ビュー。

visit

Visit

クエリで参照されるイベントレベルの訪問。

conversion

Conversion

クエリで参照されるイベント単位のコンバージョン。

metrics

Metrics

指標。

segments

Segments

セグメント。

custom_columns[]

Value

カスタム列。

SearchSearchAds360FieldsRequest

SearchAds360FieldService.SearchSearchAds360Fields のリクエスト メッセージです。

フィールド
query

string

必須。クエリ文字列。

page_token

string

取得するページのトークン。指定しない場合、結果の最初のページが返されます。結果の次のページをリクエストするには、前のレスポンスの next_page_token から取得した値を使用します。

page_size

int32

1 ページで取得する要素の数。大きすぎるページがリクエストされた場合、サーバーは返されるリソースの数をさらに制限する場合があります。

SearchSearchAds360FieldsResponse

SearchAds360FieldService.SearchSearchAds360Fields に対するレスポンス メッセージです。

フィールド
results[]

SearchAds360Field

クエリに一致したフィールドのリスト。

next_page_token

string

結果の次のページを取得するために使用されるページ設定トークン。この文字列の内容を次のリクエストの page_token 属性として渡します。最後のページに対して next_page_token は返されません。

total_results_count

int64

LIMIT 句を無視したクエリに一致する結果の合計数。

SearchSearchAds360Request

SearchAds360Service.Search のリクエスト メッセージです。

フィールド
customer_id

string

必須。クエリ対象の顧客の ID。

query

string

必須。クエリ文字列。

page_token

string

取得するページのトークン。指定しない場合、結果の最初のページが返されます。結果の次のページをリクエストするには、前のレスポンスの next_page_token から取得した値を使用します。

page_size

int32

1 ページで取得する要素の数。大きすぎるページがリクエストされた場合、サーバーは返されるリソースの数をさらに制限する場合があります。

validate_only

bool

true の場合、リクエストは検証されますが、実行されません。

return_total_results_count

bool

true の場合、LIMIT 句を無視したクエリに一致する結果の合計数がレスポンスに含まれます。デフォルトは false です。

summary_row_setting

SummaryRowSetting

概要行を返すかどうかを決定します。デフォルトでは、概要行は返されません。リクエストされた場合、他のすべてのクエリ結果が返された後、概要行が単独でレスポンスで送信されます。

SearchSearchAds360Response

SearchAds360Service.Search に対するレスポンス メッセージです。

フィールド
results[]

SearchAds360Row

クエリに一致した行のリスト。

next_page_token

string

結果の次のページを取得するために使用されるページ設定トークン。この文字列の内容を次のリクエストの page_token 属性として渡します。最後のページに対して next_page_token は返されません。

total_results_count

int64

LIMIT 句を無視したクエリに一致する結果の合計数。

field_mask

FieldMask

ユーザーがリクエストしたフィールドを表す FieldMask。

summary_row

SearchAds360Row

結果の指標の概要を含む概要行。指標の概要とは、すべての結果についての指標の集計を意味します。集計とは、合計、平均、レートなどを指します。

custom_column_headers[]

CustomColumnHeader

結果のカスタム列のヘッダー。

conversion_custom_metric_headers[]

ConversionCustomMetricHeader

結果に含まれるコンバージョン カスタム指標のヘッダー。

conversion_custom_dimension_headers[]

ConversionCustomDimensionHeader

結果に含まれるコンバージョン カスタム ディメンションのヘッダー。

raw_event_conversion_metric_headers[]

RawEventConversionMetricHeader

結果に含まれる未加工のイベント コンバージョン指標のヘッダー。

raw_event_conversion_dimension_headers[]

RawEventConversionDimensionHeader

結果に含まれる未加工のイベント コンバージョン ディメンションのヘッダー。

SearchSearchAds360StreamRequest

SearchAds360Service.SearchStream のリクエスト メッセージです。

フィールド
customer_id

string

必須。クエリ対象の顧客の ID。

query

string

必須。クエリ文字列。

batch_size

int32

各ストリーム レスポンス バッチで返される行数。過度に大きいバッチがリクエストされた場合、サーバーは、返される行数をさらに制限することを決定することがあります。

summary_row_setting

SummaryRowSetting

概要行を返すかどうかを決定します。デフォルトでは、概要行は返されません。リクエストされた場合、他のすべてのクエリ結果が返された後、概要行が単独でレスポンスで送信されます。

SearchSearchAds360StreamResponse

SearchAds360Service.SearchStream に対するレスポンス メッセージです。

フィールド
results[]

SearchAds360Row

クエリに一致した行のリスト。

field_mask

FieldMask

ユーザーがリクエストしたフィールドを表す FieldMask。

summary_row

SearchAds360Row

結果の指標の概要を含む概要行。指標の概要とは、すべての結果についての指標の集計を意味します。集計とは、合計、平均、レートなどを指します。

custom_column_headers[]

CustomColumnHeader

結果のカスタム列のヘッダー。

conversion_custom_metric_headers[]

ConversionCustomMetricHeader

結果に含まれるコンバージョン カスタム指標のヘッダー。

conversion_custom_dimension_headers[]

ConversionCustomDimensionHeader

結果のコンバージョン カスタム ディメンションのヘッダー。

raw_event_conversion_metric_headers[]

RawEventConversionMetricHeader

結果に含まれる未加工のイベント コンバージョン指標のヘッダー。

raw_event_conversion_dimension_headers[]

RawEventConversionDimensionHeader

結果に含まれる未加工のイベント コンバージョン ディメンションのヘッダー。

request_id

string

デバッグ目的で使用されるリクエストの一意の ID。