Struktura interfejsu API do raportowania Search Ads 360

Głównymi składnikami interfejsu Search Ads 360 Reporting API są zasoby i usługi. Zasób reprezentuje jednostkę Search Ads 360, a Ty używasz usługi do pobierania elementów z Search Ads 360.

Hierarchia obiektów

Konto Search Ads 360 to hierarchia obiektów.

  • Zasobem najwyższego poziomu konta jest klient.

  • Każde konto zawiera co najmniej jedną aktywną kampanię.

  • Każdy element Campaign zawiera co najmniej 1 grupę reklam, która grupuje reklamy w zbiory logiczne.

  • Każdy element AdGroup zawiera co najmniej 1 reklamę z grupy reklam.

  • Do grupy reklam lub kampanii możesz dołączyć 1 lub więcej elementów AdGroupCriterion bądź CampaignCriterion. Kryteria określają sposób wyświetlania reklam.

    • Występuje wiele typów kryteriów, np. słowa kluczowe, przedziały wiekowe i lokalizacje. Kryteria zdefiniowane na poziomie kampanii mają wpływ na wszystkie inne zasoby w tej kampanii. Możesz też określać budżety i daty dla całej kampanii.

Zasoby

Zasoby reprezentują elementy na Twoim koncie Search Ads 360. Przykładowe zasoby to Customer, Campaign i AdGroup.

Identyfikatory obiektów

Każdy obiekt w Search Ads 360 ma własny identyfikator. Niektóre identyfikatory są unikalne globalnie, tzn. na wszystkich kontach Search Ads 360, a inne tylko w obrębie ograniczonego zakresu.

Zakres unikalności identyfikatora obiektu
Identyfikator budżetu Cały świat
Identyfikator kampanii Cały świat
Identyfikator grupy reklam Cały świat
Identyfikator reklamy Grupa reklam

Każda para AdGroupId / AdId jest globalnie niepowtarzalna.
Identyfikator kryterium grupy reklam Grupa reklam

Każda para AdGroupId / CriterionId jest globalnie niepowtarzalna.
Identyfikator CampaignCriterion Priorytet

Każda para CampaignId / CriterionId jest globalnie niepowtarzalna.
Rozszerzenia reklam Priorytet

Każda para CampaignId / AdExtensionId jest globalnie niepowtarzalna.
Identyfikator kanału RSS Cały świat
Identyfikator elementu kanału RSS Cały świat
Identyfikator atrybutu w pliku danych Kanał
Identyfikator mapowania kanału Cały świat
Identyfikator etykiety Cały świat
Identyfikator listy użytkowników Cały świat

Te reguły dotyczące identyfikatorów mogą być przydatne podczas projektowania pamięci lokalnej obiektów Search Ads 360.

Typy obiektów

Niektórych obiektów można używać z wieloma typami encji. W takim przypadku obiekt zawiera pole type opisujące jego zawartość. Na przykład AdGroupAd może odnosić się do reklamy tekstowej, reklamy hotelu lub reklamy lokalnej. Wartość typu jest dostępna w polu AdGroupAd.ad.type. Jej wartość jest zwracana w wyliczeniu AdType.

Nazwy zasobów

Każdy zasób jest jednoznacznie identyfikowany przez ciąg resource_name, który stanowi ścieżkę łączącą zasób i jego elementy nadrzędne.

Na przykład nazwy zasobów kampanii mają postać:

customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID

Kampania o identyfikatorze 987654 na koncie Search Ads 360 z identyfikatorem klienta 1234567 zawiera resource_name:

customers/1234567/campaigns/987654

Usługi

Usługi umożliwiają pobieranie jednostek i metadanych z Search Ads 360. Są 3 rodzaje usług:

Usługa wyszukiwania
SearchAds360Service to pojedyncza, ujednolicona usługa do pobierania wszystkich obiektów zasobów i statystyk wydajności. Możesz to zrobić na 2 sposoby: Search i SearchStream. Obie metody wymagają zapytania określającego zasób, którego ma dotyczyć zapytanie, atrybutów zasobów i wskaźników wydajności do pobrania, predykatów używanych do filtrowania żądania oraz segmentów, które mają być używane w celu dalszego szczegółowego podziału statystyk wydajności. Więcej informacji znajdziesz w artykułach Tworzenie raportów wyszukiwania i Język zapytań Search Ads 360.
Obsługa w terenie
SearchAds360FieldService pobiera metadane zasobów, takie jak dostępne atrybuty zasobu i jego typ danych. Możesz poprosić o katalog zasobów, pól zasobów, kluczy podziału na segmenty i wskaźników dostępnych w ramach metod wyszukiwania SearchAds360Service. Więcej informacji znajdziesz w artykule Pobieranie metadanych zasobów.
Usługi dla poszczególnych podmiotów

Te usługi udostępniają metodę żądania GET, która pobiera pojedynczą instancję zasobu. Jest to przydatne podczas analizowania struktury zasobu.

Przykłady usług związanych z podmiotem:

  • CustomColumnService – usługa, która w szczegółach zwraca żądaną kolumnę niestandardową.