Metadane zasobu

Możesz używać metody SearchAds360FieldService do dynamicznego wysyłania zapytania do katalogu dotyczącego zasobów, pól zasobów, kluczy segmentacji i danych dostępnych w metodach SearchAds360Service Search i SearchStream. Katalog zawiera metadane, których klienci interfejsu Search Ads 360 Reporting API mogą używać do sprawdzania i tworzenia instrukcji w języku zapytań Search Ads 360.

Przykładowe żądanie i odpowiedź HTTP

Żądanie składa się z HTTP GET do serwera interfejsu Search Ads 360 Reporting API pod adresem:

https://searchads360.googleapis.com/v0/searchAds360Fields/{resource_or_field}

Oto przykład żądania i odpowiedzi zwracanej przez interfejs SearchAds360FieldService dla zasobu ad_group:

Żądanie

https://searchads360.googleapis.com/v0/searchAds360Fields/ad_group

Odpowiedź

{
  "resourceName": "searchAds360Fields/ad_group",
  "name": "ad_group",
  "category": "RESOURCE",
  "selectable": false,
  "filterable": false,
  "sortable": false,
  "selectableWith": [
    "campaign",
    "customer",
    "metrics.average_cpc",
    "segments.device",
    ...
  ],
  "attributeResources": [
    "customer",
    "campaign"
  ],

  "metrics": [
    "metrics.conversions",
    "metrics.search_budget_lost_impression_share",
    "metrics.average_cost",
    "metrics.clicks",
    ...
  ],
  "segments": [
    "segments.date",
    "segments.ad_network_type",
    "segments.device",
    ...
  ]
}

W tym przykładzie ważne tablice to:

attributeResources
Zasoby, które można dołączyć do zasobu w klauzuli FROM.
metrics
Dane, które można wybrać z zasobami w klauzuli FROM. Wartość jest podawana tylko w przypadku pól, w których wartość category to RESOURCE.
segments
Klucze segmentów, które można wybrać z zasobami w nawiasach klamrowych FROM. Dzielą one dane określone w zapytaniu. Wartość jest podawana tylko w przypadku pól, w których category ma wartość RESOURCE.
selectableWith
Pola, które można wybrać obok danego pola, gdy nie znajdują się w klauzuli FROM. Ten atrybut ma znaczenie tylko wtedy, gdy identyfikujesz zasoby lub segmenty, które mogą być wybrane w zapytaniu, ale nie są uwzględnione przez zapytanie w klauzuli FROM. Jeśli np. z poziomu ad_group wybierasz atrybuty ad_group.idsegments.date, a chcesz uwzględnić atrybuty z poziomu campaign, musisz sprawdzić, czy atrybut segments.date znajduje się w atrybucie selectableWith kampanii, ponieważ jest on wybierany obok istniejącego pola segments.date.

Szczegóły metadanych

Katalog możesz zamówić za pomocą SearchAds360FieldService na tych poziomach:

Zasób
Na przykład: searchAds360Fields/campaign.
Pole zasobu
Na przykład: searchAds360Fields/campaign.name.
Pole podziału na segmenty
Na przykład: searchAds360Fields/segments.ad_network_type.
Dane
Na przykład: searchAds360Fields/metrics.clicks.

Uzyskiwanie szczegółów pola za pomocą zapytania

Szczegóły pola można uzyskać, wysyłając zapytanie do

https://searchads360.googleapis.com/v0/searchAds360Fields:search

Przykład 1. Użycie wyrażenia regularnego.

SELECT
  name,
  category,
  selectable,
  filterable,
  sortable,
  selectable_with,
  data_type,
  is_repeated
WHERE name LIKE 'ad_group.%'"

Przykład 2. Wyszukiwanie konkretnych pól, danych lub segmentów.

SELECT
  name,
  category,
  selectable,
  filterable,
  sortable,
  selectable_with,
  data_type,
  is_repeated
WHERE
  name IN (
    "ad_group.id",
    "ad_group.name",
    "segments.date",
    "customer.id",
    "customer.manager",
    "metrics.clicks"
  )