Struktura interfejsu API do raportowania Search Ads 360

Głównymi komponentami interfejsu Search Ads 360 Reporting API są zasoby i usługi. Zasób reprezentuje jednostkę Search Ads 360, a do pobierania jednostek Search Ads 360 używasz usługi.

Hierarchia obiektów

Konto Search Ads 360 to hierarchia obiektów.

  • Zasobem najwyższego poziomu na koncie jest klient.

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

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

  • Każda AdGroup zawiera co najmniej 1 reklamę w grupie reklam.

  • Do grupy reklam lub kampanii możesz dołączyć co najmniej 1 AdGroupCriterion lub CampaignCriterion. Kryteria określają, jak są wywoływane reklamy.

    • Istnieje wiele rodzajów kryteriów, takich jak słowa kluczowe, przedziały wiekowe i lokalizacje. Kryteria zdefiniowane na poziomie kampanii wpływają na wszystkie inne zasoby w kampanii. Możesz też określić budżety i daty dla całej kampanii.

Zasoby

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

Identyfikatory obiektów

Każdy obiekt w Search Ads 360 jest identyfikowany na podstawie własnego identyfikatora. Niektóre identyfikatory są unikalne w skali globalnej, czyli na wszystkich kontach Search Ads 360, a inne są unikalne tylko w określonym zakresie.

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 niepowtarzalna na całym świecie.
Identyfikator kryterium w grupie reklam Grupa reklam

Każda para AdGroupId / CriterionId jest niepowtarzalna na całym świecie.
Identyfikator CampaignCriterion Kampania

Każda para CampaignId / CriterionId jest niepowtarzalna na całym świecie.
Rozszerzenia reklam Kampania

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

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

Typy obiektów

Niektóre obiekty mogą być używane w przypadku wielu typów podmiotów. W takim przypadku obiekt zawiera pole type, które opisuje jego zawartość. Na przykład AdGroupAd może odnosić się do reklamy tekstowej, reklamy hotelu lub reklamy lokalnej. Wartość typu możesz uzyskać za pomocą pola AdGroupAd.ad.type. Jej wartość jest zwracana w wyliczeniu AdType.

Nazwy zasobów

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

Nazwy zasobów kampanii mają na przykład postać:

customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID

Kampania o identyfikatorze 987654 na koncie Search Ads 360 z identyfikatorem klienta1234567 ma resource_name:

customers/1234567/campaigns/987654

Usługi

Usługi umożliwiają pobieranie jednostek i metadanych Search Ads 360. Dostępne są 3 typy usług:

Usługa wyszukiwania
SearchAds360Service to pojedyncza, ujednolicona usługa do pobierania wszystkich obiektów zasobów i statystyk wydajności. Udostępnia 2 metody: Search i SearchStream. Obie metody wymagają zapytania, które określa zasób, do którego ma być kierowane zapytanie, atrybuty zasobu i dane o skuteczności do pobrania, predykaty do filtrowania żądania oraz segmenty do dalszego podziału statystyk skuteczności. Więcej informacji znajdziesz w artykułach Tworzenie raportów wyszukiwania i Język zapytań Search Ads 360.
Usługi serwisowe w terenie
SearchAds360FieldService pobiera metadane zasobów, np. dostępne atrybuty zasobu i jego typ danych. Możesz poprosić o katalog zasobów, pól zasobów, kluczy segmentacji i danych dostępnych w SearchAds360Service metodach wyszukiwania. Więcej informacji znajdziesz w artykule Pobieranie metadanych zasobów.
Usługi specyficzne dla podmiotu

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

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

  • CustomColumnService zwracający żądaną kolumnę niestandardową ze wszystkimi szczegółami.